Adapty iOS SDK を v4.3 および v4.4 に移行する

Adapty iOS SDK 4.1 または 4.2 からアプリを 4.4 に更新するには、このガイドのすべての変更を適用してください。アプリがすでに 4.3 を使用している場合は、v4.4 で導入された変更のみを適用してください。4.0 を使用しているアプリには、まず v4.1 の変更が必要です。

Warning

フォールバックファイルのフォーマットは4.4で変更されました。コンパイラーは古いファイルを検出できません。新しいフォールバックファイルがない場合、すべてのプレースメントでフォールバックが機能しなくなります。

クイックリファレンス

変更前変更後バージョン
localizedPrice と currencyCode が nil になる場合がある両プロパティは常に文字列を返す4.3.0
billingPlanUnavailable エラーコードなしAdaptyError.ErrorCode に billingPlanUnavailable を追加4.3.0
Adapty.reportTransaction に Transaction を直接渡すAdapty.reportTransaction に VerificationResult<Transaction> を渡す(Transaction オーバーロードは非推奨)4.3.2
case let .custom(id)case let .custom(id, _)4.4.0
AdaptyUICustomAssetAdaptyUIAsset(AdaptyCustomAsset は変更なし)4.4.0
.color(.uiColor(x)) と .color(.swiftUIColor(c)).color(Color(uiColor: x)) と .color(c)4.4.0
AdaptyUICustomFontAsset(font:defaultColor:defaultLetterSpacing:defaultLineHeight:)AdaptyUIFontAsset(font:color:letterSpacing:lineHeight:)4.4.0
データアセットなしAdaptyUIAsset にデータアセット用の .data を追加4.4.0
AdaptyProduct.localizedBillingPeriodsubscriptionPricingTerms?.localizedBillingPeriod4.4.0
4.1〜4.3 向けフォールバックファイルをダウンロード済みフォールバックファイルの形式が変更されたため、再ダウンロードが必要4.4.0

v4.3 の変更点

localizedPrice と currencyCode が Optional でなくなりました

4.3 では、AdaptyPaywallProduct と AdaptySubscriptionOffer の localizedPrice および currencyCode プロパティは常に文字列を返し、nil を返すことはありません。if let、guard let、?. を使って nil チェックをしているコードはコンパイルエラーになります。これらのチェックを削除してください:

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

これらのプロパティに対する ?? によるデフォルト値も削除してください。コンパイルは通りますが、警告が表示されます。

AdaptyError.ErrorCode に billingPlanUnavailable が追加されました

4.3 では billingPlanUnavailable エラーコードが追加されました。すべてのエラーコードを列挙した switch 文に default ブランチがない場合、コンパイルが失敗します。修正するには、case .billingPlanUnavailable ブランチまたは default ブランチを追加してください。

Transaction オーバーロードの reportTransaction は非推奨

4.3.2 では、App Store の署名なしで裸の Transaction を受け取る Adapty.reportTransaction(_:withVariationId:) オーバーロードが非推奨の警告を出すようになりました。App Store の署名付きでトランザクションを報告するには、StoreKit が返す VerificationResult<Transaction> を渡してください:

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

v4.4 の変更点

AdaptyUI.Action.custom に2つの値が含まれるようになりました

ユーザーがカスタムアクションのボタンをタップすると、アプリは AdaptyUI.Action.custom を受け取ります。4.4 では、アクション ID の後に2番目の値 arguments が追加されました。didPerformAction クロージャおよび flowController(_:didPerform:) デリゲートメソッドで、この2番目の値に _ を追加してください:

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

カスタムアセット

4.4では、AdaptyUICustomAssetがAdaptyUIAssetに名称変更されました。旧名称を使用すると非推奨の警告が表示されます。

カラー、フォント、データアセットには以下の3つの変更点があります:

  • カラーアセット: .colorはSwiftUIのColorを受け取ります。AdaptyUICustomColorAssetは削除されました。UIColorをColor(uiColor:)でラップするか、SwiftUIのColorを直接渡してください:

    - "brand_color": .color(.uiColor(brandColor)),
    + "brand_color": .color(Color(uiColor: brandColor)),
  • フォントアセット: AdaptyUIFontAsset では defaultColor:、defaultLetterSpacing:、defaultLineHeight: の代わりに color:、letterSpacing:、lineHeight: を使用します。color: パラメータには SwiftUI の Color を指定します:

    - "title_font": .font(AdaptyUICustomFontAsset(font: titleFont, defaultColor: .uiColor(.white), defaultLineHeight: 24)),
    + "title_font": .font(AdaptyUIFontAsset(font: titleFont, color: .white, lineHeight: 24)),
  • データアセット: AdaptyUIAsset に新しいアセットタイプ .data が追加されました。すべてのアセットタイプを列挙した switch 文に default ブランチがない場合、コンパイルが通らなくなります。データアセットを読み取るのはカスタム要素のみのため、新しいブランチは空のままにできます: case .data: break。

AdaptyProduct.localizedBillingPeriod は非推奨です

AdaptyProduct には、各支払いの価格と支払い頻度を説明する subscriptionPricingTerms プロパティがあります。4.4 では、支払い頻度を示すテキストである localizedBillingPeriod が AdaptyProduct から subscriptionPricingTerms に移動しました。AdaptyProduct.localizedBillingPeriod は引き続き動作しますが、非推奨の警告が表示されます。これは subscriptionPricingTerms?.localizedBillingPeriod を返します。警告を解消するには、プライシングタームからプロパティを読み取ってください:

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

フォールバックファイル

フォールバックファイルのフォーマットは SDK 4.4 で変更されました。Placements > Fallbacks から再度ファイルをダウンロードし、Adapty SDK v4.4.0 and higher を選択して、アプリにバンドルしてください。

ダウンロードされるファイルの名前は ios_4_4_0_fallback.json です。アプリが Bundle.main.url(forResource:withExtension:) に渡している名前に合わせてファイルをリネームするか、その呼び出し内の名前を更新してください。

Warning

フォールバックファイルが古くても、コンパイルエラーは発生しません。すべてのプレースメントでフォールバックが静かに失われます。その後、SDKのログに「The fallback paywalls version is not correct. Download a new one from the Adapty Dashboard.」と表示されます。