Migrate Adapty iOS SDK lên v4.3 và v4.4

Để cập nhật ứng dụng của bạn từ Adapty iOS SDK 4.1 hoặc 4.2 lên 4.4, hãy áp dụng tất cả các thay đổi trong hướng dẫn này. Nếu ứng dụng của bạn đã dùng 4.3, chỉ cần áp dụng các thay đổi trong v4.4. Ứng dụng đang dùng 4.0 cần thực hiện các thay đổi v4.1 trước.

Warning

Định dạng file dự phòng đã thay đổi trong phiên bản 4.4, và compiler không thể phát hiện file lỗi thời. Nếu không có file dự phòng mới, mọi placement sẽ mất đi paywall dự phòng của nó.

Tham khảo nhanh

TrướcSauPhiên bản
localizedPrice và currencyCode có thể là nilCả hai thuộc tính luôn trả về một chuỗi4.3.0
Không có mã lỗi billingPlanUnavailableAdaptyError.ErrorCode bao gồm billingPlanUnavailable4.3.0
Adapty.reportTransaction với một Transaction đơn thuầnAdapty.reportTransaction với VerificationResult<Transaction>; overload Transaction đã bị deprecated4.3.2
case let .custom(id)case let .custom(id, _)4.4.0
AdaptyUICustomAssetAdaptyUIAsset; AdaptyCustomAsset không thay đổi4.4.0
.color(.uiColor(x)) và .color(.swiftUIColor(c)).color(Color(uiColor: x)) và .color(c)4.4.0
AdaptyUICustomFontAsset(font:defaultColor:defaultLetterSpacing:defaultLineHeight:)AdaptyUIFontAsset(font:color:letterSpacing:lineHeight:)4.4.0
Không có data assetAdaptyUIAsset bao gồm .data cho data asset4.4.0
AdaptyProduct.localizedBillingPeriodsubscriptionPricingTerms?.localizedBillingPeriod4.4.0
File dự phòng đã tải xuống cho 4.1–4.3Định dạng file dự phòng mới; tải lại file4.4.0

Thay đổi trong v4.3

localizedPrice và currencyCode không còn là optional nữa

Từ phiên bản 4.3, thuộc tính localizedPrice và currencyCode của AdaptyPaywallProduct và AdaptySubscriptionOffer luôn trả về một chuỗi, không bao giờ là nil. Code kiểm tra nil bằng if let, guard let, hoặc ?. sẽ không thể biên dịch. Hãy xóa các kiểm tra này:

- if let price = product.localizedPrice {
-     priceLabel.text = price
- }
+ priceLabel.text = product.localizedPrice

Xóa cả các giá trị mặc định ?? cho những thuộc tính này: chúng vẫn biên dịch được, nhưng sẽ có cảnh báo.

AdaptyError.ErrorCode bao gồm billingPlanUnavailable

4.3 bổ sung mã lỗi billingPlanUnavailable. Câu lệnh switch liệt kê tất cả mã lỗi mà không có nhánh default sẽ ngừng biên dịch. Để khắc phục, hãy thêm nhánh case .billingPlanUnavailable hoặc nhánh default.

Overload reportTransaction với Transaction đã bị deprecated

Trong phiên bản 4.3.2, overload Adapty.reportTransaction(_:withVariationId:) nhận một Transaction thuần túy (không có chữ ký App Store) sẽ hiển thị cảnh báo deprecated. Để báo cáo giao dịch kèm chữ ký App Store, hãy truyền VerificationResult<Transaction> mà StoreKit trả về:

- try await Adapty.reportTransaction(transaction, withVariationId: variationId)
+ try await Adapty.reportTransaction(verificationResult, withVariationId: variationId)

Thay đổi trong v4.4

AdaptyUI.Action.custom chứa hai giá trị

Khi người dùng nhấn vào nút có custom action, ứng dụng sẽ nhận được AdaptyUI.Action.custom. Trong phiên bản 4.4, nó chứa thêm một giá trị thứ hai là arguments sau action ID. Trong closure didPerformAction và phương thức delegate flowController(_:didPerform:), thêm _ cho giá trị thứ hai này:

  switch action {
- case let .custom(id):
+ case let .custom(id, _):
      if id == "openNewPaywall" {
          // Display another flow or paywall
      }
  default:
      break
  }
switch id {
case .introductory:
    break
case .custom(let productId, _):
    break
}

Tài nguyên tùy chỉnh

Trong phiên bản 4.4, AdaptyUICustomAsset được đổi tên thành AdaptyUIAsset. Tên cũ sẽ kích hoạt cảnh báo deprecation.

Tài nguyên màu sắc, font chữ và dữ liệu thay đổi theo ba cách:

  • Tài nguyên màu sắc: .color nhận một Color của SwiftUI. AdaptyUICustomColorAsset đã bị xóa. Hãy bọc UIColor trong Color(uiColor:) và truyền trực tiếp một Color của SwiftUI:

    - "brand_color": .color(.uiColor(brandColor)),
    + "brand_color": .color(Color(uiColor: brandColor)),
  • Tài nguyên font: AdaptyUIFontAsset nhận color:, letterSpacing:, và lineHeight: thay vì defaultColor:, defaultLetterSpacing:, và defaultLineHeight:. Tham số color: nhận một Color của SwiftUI:

    - "title_font": .font(AdaptyUICustomFontAsset(font: titleFont, defaultColor: .uiColor(.white), defaultLineHeight: 24)),
    + "title_font": .font(AdaptyUIFontAsset(font: titleFont, color: .white, lineHeight: 24)),
  • Tài sản dữ liệu: AdaptyUIAsset có thêm một loại tài sản mới là .data. Câu lệnh switch liệt kê mọi loại tài sản mà không có nhánh default sẽ không còn biên dịch được. Chỉ có các phần tử tùy chỉnh mới đọc tài sản dữ liệu, vì vậy nhánh mới có thể để trống: case .data: break.

AdaptyProduct.localizedBillingPeriod không còn được hỗ trợ

AdaptyProduct có thuộc tính subscriptionPricingTerms mô tả từng lần thanh toán cho sản phẩm: giá và tần suất người dùng thanh toán. Trong phiên bản 4.4, localizedBillingPeriod — văn bản hiển thị tần suất thanh toán — được chuyển từ AdaptyProduct sang subscriptionPricingTerms. AdaptyProduct.localizedBillingPeriod vẫn hoạt động nhưng sẽ hiển thị cảnh báo deprecation: nó trả về subscriptionPricingTerms?.localizedBillingPeriod. Để xóa cảnh báo, hãy đọc thuộc tính từ pricing terms:

- let period = product.localizedBillingPeriod
+ let period = product.subscriptionPricingTerms?.localizedBillingPeriod

Tệp dự phòng

Định dạng tệp dự phòng đã thay đổi trong SDK 4.4. Tải lại tệp từ Placements > Fallbacks, chọn Adapty SDK v4.4.0 and higher, và đóng gói vào ứng dụng của bạn.

Tệp được tải xuống có tên ios_4_4_0_fallback.json. Đặt tên tệp trùng với tên mà ứng dụng của bạn truyền vào Bundle.main.url(forResource:withExtension:), hoặc cập nhật tên trong lời gọi đó.

Warning

Một file dự phòng lỗi thời sẽ không gây ra lỗi biên dịch nào. Mỗi placement sẽ âm thầm mất paywall dự phòng của nó. Khi đó, log của SDK sẽ hiển thị “The fallback paywalls version is not correct. Download a new one from the Adapty Dashboard.”