Adapty iOS SDK を v4.0 に移行する

Adapty iOS SDK 4.0 (beta) ではフローが導入され、それに伴いペイウォール API の名称が変更されました。新しい API は新しい Flow Builder と既存の Paywall Builder の両方に対応しており、Adapty ダッシュボード側での設定変更は不要です。

クイックリファレンス

v3	v4
`Adapty.getPaywall(placementId:locale:)`	`Adapty.getFlow(placementId:)`
`AdaptyUI.getPaywallConfiguration(forPaywall:)`	`AdaptyUI.getFlowConfiguration(forFlow:locale:)`
`Adapty.getPaywallProducts(paywall:)`	`Adapty.getPaywallProducts(flow:)`
`Adapty.logShowPaywall(_:)`	`Adapty.logShowFlow(_:)`
`AdaptyPaywallController`	`AdaptyFlowController`
`AdaptyPaywallControllerDelegate`	`AdaptyFlowControllerDelegate`
`AdaptyUI.paywallController(with:delegate:)`	`AdaptyUI.flowController(with:delegate:)`
`.paywall()` (SwiftUI modifier)	`.flow()`
`AdaptyPaywallView`	`AdaptyFlowView`
`didFailRenderingWith:` / `didFailRendering:`	`didReceiveError:`
`Adapty.updateAttribution(_:source:)` (`source: String`)	`Adapty.updateAttribution(_:source:)` (`source: AdaptyAttributionSource`)
`Adapty.setIntegrationIdentifier(key:value:)`	`Adapty.setIntegrationIdentifier(_:)` (`AdaptyIntegrationIdentifier`)

iOS 最小バージョン

Adapty iOS SDK 4.0 では、最小デプロイメントターゲットが iOS 13.0 から iOS 15.0 に引き上げられました。アップグレードの前に、プロジェクトの iOS Deployment Target を 15.0 以上に設定してください。

インストール：CocoaPods のサポート終了

Adapty iOS SDK 4.0 では CocoaPods のサポートが廃止されました。SDK のインストールには Swift Package Manager をご利用ください。

プロジェクトで引き続き CocoaPods を使用している場合は、Podfile から Adapty および AdaptyUI の pod を削除し、pod install を実行してクリーンアップした後、Xcode の File → Add Package Dependency から https://github.com/adaptyteam/AdaptySDK-iOS.git を使ってパッケージを追加してください。

削除された API

Adapty.getPaywallProductsWithoutDeterminingOffer(paywall:) — 削除されました。すべてのプロダクトにオファー情報が含まれるようになったため、個別の対象資格確認パスは不要になりました。
AdaptyPaywallProductWithoutDeterminingOffer — 削除されました。以前このタイプを渡していたコールバック（didSelectProduct など）は、今後 AdaptyPaywallProduct を渡すようになります。

App Store プロモートアプリ内課金の一時的な削除

StoreKit 2 への移行の一環として、Adapty iOS SDK 4.0 では App Store プロモートアプリ内課金のサポートが削除されました。shouldAddStorePayment(for:) デリゲートメソッドおよびそれが受け取る AdaptyDeferredProduct 型は、4.0 では使用できません。

この削除は一時的なものです — プロモートアプリ内課金のサポートは、今後の 4.x リリースで復活する予定です。アプリがプロモートアプリ内課金に依存している場合は、サポートが戻るまで iOS SDK 3.x をご利用ください。

ペイウォールの取得

getPaywall + getPaywallConfiguration → getFlow + getFlowConfiguration

返却される型は AdaptyPaywall / AdaptyUI.PaywallConfiguration から AdaptyFlow / AdaptyUI.FlowConfiguration に変わります。locale パラメータはフェッチ呼び出しから getFlowConfiguration に移動します。

- let paywall = try await Adapty.getPaywall(placementId: "YOUR_PLACEMENT_ID", locale: "en")
- let paywallConfiguration = try await AdaptyUI.getPaywallConfiguration(forPaywall: paywall)
+ let flow = try await Adapty.getFlow(placementId: "YOUR_PLACEMENT_ID")
+ let flowConfiguration = try await AdaptyUI.getFlowConfiguration(forFlow: flow, locale: "en")

getPaywallProducts(paywall:) → getPaywallProducts(flow:)

getPaywallProducts は、Adapty.getFlow によって返された AdaptyFlow を受け取るようになりました：

- let products = try await Adapty.getPaywallProducts(paywall: paywall)
+ let products = try await Adapty.getPaywallProducts(flow: flow)

ペイウォールの表示を記録する

logShowPaywall(:) → logShowFlow(:)

logShowPaywall は logShowFlow にリネームされ、AdaptyPaywall の代わりに AdaptyFlow を受け取るようになりました。イベントは引き続き同じバリアントに対して記録されるため、既存のファネルや A/B テストの指標はダッシュボードの変更なしに引き続き機能します。

- try await Adapty.logShowPaywall(paywall)
+ try await Adapty.logShowFlow(flow)

v3と同様に、Flow BuilderやPaywall Builderでレンダリングされたフローやペイウォールを表示する際には、このメソッドを呼び出す必要はありません。これらのビューはAdaptyが自動的にトラッキングします。

UIKit

AdaptyPaywallController → AdaptyFlowController

コントローラーの型とファクトリーメソッドの名前を変更します：

- let controller = try AdaptyUI.paywallController(
-     with: paywallConfiguration,
-     delegate: self
- )
+ let controller = try AdaptyUI.flowController(
+     with: flowConfiguration,
+     delegate: self
+ )

AdaptyPaywallControllerDelegate → AdaptyFlowControllerDelegate

プロトコルの名前を変更し、すべてのメソッドシグネチャを更新してください。なお、didSelectProduct は削除された AdaptyPaywallProductWithoutDeterminingOffer の代わりに AdaptyPaywallProduct を受け取るようになりました。

- class YourClass: AdaptyPaywallControllerDelegate {
+ class YourClass: AdaptyFlowControllerDelegate {

-     func paywallControllerDidAppear(_ controller: AdaptyPaywallController) { }
+     func flowControllerDidAppear(_ controller: AdaptyFlowController) { }

-     func paywallControllerDidDisappear(_ controller: AdaptyPaywallController) { }
+     func flowControllerDidDisappear(_ controller: AdaptyFlowController) { }

-     func paywallController(_ controller: AdaptyPaywallController,
-                            didPerform action: AdaptyUI.Action) { }
+     func flowController(_ controller: AdaptyFlowController,
+                         didPerform action: AdaptyUI.Action) { }

-     func paywallController(_ controller: AdaptyPaywallController,
-                            didSelectProduct product: AdaptyPaywallProductWithoutDeterminingOffer) { }
+     func flowController(_ controller: AdaptyFlowController,
+                         didSelectProduct product: AdaptyPaywallProduct) { }

-     func paywallController(_ controller: AdaptyPaywallController,
-                            didStartPurchase product: AdaptyPaywallProduct) { }
+     func flowController(_ controller: AdaptyFlowController,
+                         didStartPurchase product: AdaptyPaywallProduct) { }

-     func paywallController(_ controller: AdaptyPaywallController,
-                            didFinishPurchase product: AdaptyPaywallProduct,
-                            purchaseResult: AdaptyPurchaseResult) { }
+     func flowController(_ controller: AdaptyFlowController,
+                         didFinishPurchase product: AdaptyPaywallProduct,
+                         purchaseResult: AdaptyPurchaseResult) { }

-     func paywallController(_ controller: AdaptyPaywallController,
-                            didFailPurchase product: AdaptyPaywallProduct,
-                            error: AdaptyError) { }
+     func flowController(_ controller: AdaptyFlowController,
+                         didFailPurchase product: AdaptyPaywallProduct,
+                         error: AdaptyError) { }

-     func paywallControllerDidStartRestore(_ controller: AdaptyPaywallController) { }
+     func flowControllerDidStartRestore(_ controller: AdaptyFlowController) { }

-     func paywallController(_ controller: AdaptyPaywallController,
-                            didFinishRestoreWith profile: AdaptyProfile) { }
+     func flowController(_ controller: AdaptyFlowController,
+                         didFinishRestoreWith profile: AdaptyProfile) { }

-     func paywallController(_ controller: AdaptyPaywallController,
-                            didFailRestoreWith error: AdaptyError) { }
+     func flowController(_ controller: AdaptyFlowController,
+                         didFailRestoreWith error: AdaptyError) { }

-     func paywallController(_ controller: AdaptyPaywallController,
-                            didFailRenderingWith error: AdaptyUIError) { }
+     func flowController(_ controller: AdaptyFlowController,
+                         didReceiveError error: AdaptyUIError) { }

-     func paywallController(_ controller: AdaptyPaywallController,
-                            didFailLoadingProductsWith error: AdaptyError) -> Bool { }
+     func flowController(_ controller: AdaptyFlowController,
+                         didFailLoadingProductsWith error: AdaptyError) -> Bool { }

-     func paywallController(_ controller: AdaptyPaywallController,
-                            didPartiallyLoadProducts failedIds: [String]) { }
+     func flowController(_ controller: AdaptyFlowController,
+                         didPartiallyLoadProducts failedIds: [String]) { }

-     func paywallController(_ controller: AdaptyPaywallController,
-                            didFinishWebPaymentNavigation product: AdaptyPaywallProduct?,
-                            error: AdaptyError?) { }
+     func flowController(_ controller: AdaptyFlowController,
+                         didFinishWebPaymentNavigation product: AdaptyPaywallProduct?,
+                         error: AdaptyError?) { }
 }

SwiftUI

.paywall() モディファイアを .flow() に変更する

モディファイアの名前を変更し、設定パラメータ名を更新してください。

 @State var flowPresented = false // rename freely — the variable name is your choice

 var body: some View {
     Text("Hello, AdaptyUI!")
-        .paywall(
+        .flow(
             isPresented: $flowPresented,
-            paywallConfiguration: paywallConfiguration,
+            flowConfiguration: flowConfiguration,
             didFailPurchase: { product, error in /* handle the error */ },
             didFinishRestore: { profile in /* check access level and dismiss */ },
             didFailRestore: { error in /* handle the error */ },
-            didFailRendering: { error in flowPresented = false }
+            didReceiveError: { error in flowPresented = false }
         )
 }

名前が変更されたコールバックは、didFailRendering が対応していたのと同じレンダリングエラーに加え、フロースクリプトの新しいランタイムエラー（AdaptyUIError コード 4105 — .jsException の JavaScript 例外）にも対応します。既存のハンドラー本体はコードを変更する必要はありません。パラメーターの名前を変更するだけです。

AdaptyPaywallView → AdaptyFlowView

ビューの名前を変更し、設定パラメーターを更新し、didSelectProduct クロージャを更新してください — AdaptyPaywallProductWithoutDeterminingOffer が削除され、代わりに AdaptyPaywallProduct を受け取るようになりました:

- AdaptyPaywallView(
-     paywallConfiguration: paywallConfiguration,
-     didSelectProduct: { product: AdaptyPaywallProductWithoutDeterminingOffer in /* handle */ },
+ AdaptyFlowView(
+     flowConfiguration: flowConfiguration,
+     didSelectProduct: { product: AdaptyPaywallProduct in /* handle */ },
     didFailPurchase: { product, error in /* handle the error */ },
     didFinishRestore: { profile in /* check access level and dismiss */ },
     didFailRestore: { error in /* handle the error */ },
-    didFailRendering: { error in /* handle the error */ }
+    didReceiveError: { error in /* handle the error */ }
 )

AdaptyUI カスタムアセット

AdaptyUICustomVideoAsset

既存のすべての呼び出し箇所に影響する変更が2点あります。

.player が AVQueuePlayer の代わりに AVPlayer を受け取るようになりました。
すべてのケースに末尾の resolution: CGSize? パラメータが追加されました。現在の動作を維持するには nil を渡してください。動画が読み込まれる前にプレイヤーがレイアウトスペースを確保できるよう（アスペクト比 = width / height）、実際のピクセルサイズを渡すこともできます。

- case file(url: URL, preview: AdaptyUICustomImageAsset?)
- case remote(url: URL, preview: AdaptyUICustomImageAsset?)
- case player(item: AVPlayerItem, player: AVQueuePlayer, preview: AdaptyUICustomImageAsset?)
+ case file(url: URL, preview: AdaptyUICustomImageAsset?, resolution: CGSize?)
+ case remote(url: URL, preview: AdaptyUICustomImageAsset?, resolution: CGSize?)
+ case player(item: AVPlayerItem, player: AVPlayer, preview: AdaptyUICustomImageAsset?, resolution: CGSize?)

アトリビューションと連携識別子

updateAttribution(_:source:)

source パラメーターの型が String から新しい AdaptyAttributionSource 型に変更され、以前はネストされていた AdaptyProfile.AttributionSource がトップレベルの AdaptyAttributionSource に改名されました。定義済みのソースを使用するか、その他のソースには文字列リテラルを渡してください。AdaptyAttributionSource は ExpressibleByStringLiteral に準拠しているため、既存の文字列リテラルによる呼び出しはそのままコンパイルできます。

- try await Adapty.updateAttribution(attribution, source: "adjust")
+ try await Adapty.updateAttribution(attribution, source: .adjust)

定義済みソース: .appleAds、.adjust、.appsflyer、.branch、.tenjin。ソースを String 変数で保持している場合は、AdaptyAttributionSource(rawValue: yourSource) でラップしてください。

setIntegrationIdentifier(_:)

setIntegrationIdentifier(key:value:) は、1つ以上の AdaptyIntegrationIdentifier 値を受け取る可変長引数メソッドに置き換えられました。生の文字列キーの代わりに、定義済みのファクトリーメソッドを使用してください：

- try await Adapty.setIntegrationIdentifier(key: "appsflyer_id", value: uid)
+ try await Adapty.setIntegrationIdentifier(.appsflyerId(uid))

1回の呼び出しで複数の識別子を設定できます：

try await Adapty.setIntegrationIdentifier(
    .appsflyerId(uid),
    .adjustDeviceId(adid)
)

各古いキー文字列をそのファクトリーメソッドに置き換えます:

v3 キー	v4 ファクトリー
`"adjust_device_id"`	`.adjustDeviceId(_:)`
`"airbridge_device_id"`	`.airbridgeDeviceId(_:)`
`"amplitude_user_id"`	`.amplitudeUserId(_:)`
`"amplitude_device_id"`	`.amplitudeDeviceId(_:)`
`"appmetrica_device_id"`	`.appmetricaDeviceId(_:)`
`"appmetrica_profile_id"`	`.appmetricaProfileId(_:)`
`"appsflyer_id"`	`.appsflyerId(_:)`
`"branch_id"`	`.branchId(_:)`
`"facebook_anonymous_id"`	`.facebookAnonymousId(_:)`
`"firebase_app_instance_id"`	`.firebaseAppInstanceId(_:)`
`"mixpanel_user_id"`	`.mixpanelUserId(_:)`
`"one_signal_subscription_id"`	`.oneSignalSubscriptionId(_:)`
`"one_signal_player_id"`	`.oneSignalPlayerId(_:)`
`"posthog_distinct_user_id"`	`.posthogDistinctUserId(_:)`
`"pushwoosh_hwid"`	`.pushwooshHWID(_:)`
`"tenjin_analytics_installation_id"`	`.tenjinAnalyticsInstallationId(_:)`