Adapty Capacitor SDK を v4.3 に移行する

Adapty Capacitor SDK 4.3 では、Google Play アプリ内メッセージがデフォルトで表示されるようになり、getOnboardingForDefaultAudience から未使用のパラメーターが削除され、エラーコードの型が拡張され、イベントからのプロモーション対象プロダクトが必須になりました。アプリの動作を維持し、TypeScript のビルドが通るよう、このガイドで各変更点を確認してください。

3.x をお使いの場合は、まず v4.1.1 への移行 を行ってから、このガイドに従ってください。

クイックリファレンス

v4.2v4.3
params: undefined または fetchPolicy: undefined が失敗するデフォルト値が適用される
Google Play メッセージがリクエストされないAndroid ではデフォルトで Google Play メッセージが表示される
getOnboardingForDefaultAudience が params.loadTimeoutMs を受け付けて無視するparams.loadTimeoutMs がその型から削除される
error.adaptyCode が既知のコードとして型付けされているその型は SDK バージョンが認識しないコードも許容する
iOS で makePromotedPurchase が自分でビルドしたプロダクトを受け付ける'onPromotedPurchaseReceived' イベントからのプロダクトが必要
accessLevel.android.offerId非推奨 — トップレベルの offerId を参照してください

undefined として渡されたオプションはデフォルト値にフォールバックする

4.2 では、getFlow、getOnboarding、またはそれらのデフォルトオーディエンス向けバリアントに params: undefined を渡すと TypeError が発生し、fetchPolicy: undefined はネイティブ側でエラーになっていました。4.3 からは、undefined として渡されたオプションはデフォルト値を維持するようになりました。fetchPolicy は 'reload_revalidating_cache_data' に、loadTimeoutMs は 5000 ms にフォールバックします。このエラーを回避するためにキーを省略していた場合、設定からオプションの値をそのまま渡せるようになりました。

Google Play メッセージはデフォルトで表示されます

4.3 以降、SDK は activate の後にアプリの Activity が起動するたびに(アプリがフォアグラウンドに戻ったときを含む)、支払い拒否通知などの Google Play アプリ内メッセージをリクエストします。そのため、ペイウォールの上にメッセージが表示されることがあります。

アプリにとって問題なければ、変更は不要です。'auto' モードでは、コールドローンチ時にメッセージは表示されません。詳細は Android でのローンチ時のメッセージ表示 を参照してください。4.2 の動作を維持したい場合は、Android で手動処理を使用し、showStoreMessages を呼び出さないでください。メッセージを表示するタイミングを選択したい場合は、Android で手動処理を使用して SDK を有効化し、アプリに適したタイミングで showStoreMessages を呼び出してください。


await adapty.activate({
  apiKey: 'YOUR_PUBLIC_SDK_KEY',
  params: {
    storeMessagesHandling: Capacitor.getPlatform() === 'android' ? 'manual' : 'auto',
  },
});

Android のみ手動処理に設定することで、iOS への影響を避けられます。iOS 16 以降では、手動処理に設定すると、アプリが showStoreMessages を呼び出すまで App Store のメッセージが保留されます。API の詳細については、ストアメッセージの制御を参照してください。

Warning

手動モードでは、ストアは自動的にメッセージを表示しません。アプリが showStoreMessages を呼び出さない場合、ユーザーは決済失敗の通知を受け取れません。

loadTimeoutMs が getOnboardingForDefaultAudience から削除されました

getOnboardingForDefaultAudience は params.loadTimeoutMs を使用していませんでした。デフォルトオーディエンスのリクエストにはタイムアウトがないためです。4.3 以降、このパラメーターは型定義からも削除されたため、オブジェクトリテラルで渡すと TypeScript のビルドが失敗します。いずれにせよ削除してください。SDK はこのパラメーターを無視します。

  const onboarding = await adapty.getOnboardingForDefaultAudience({
    placementId: 'YOUR_PLACEMENT_ID',
    params: {
      fetchPolicy: 'reload_revalidating_cache_data',
-     loadTimeoutMs: 5000,
    },
  });

getOnboarding は loadTimeoutMs を保持します。

エラーコードの型が未知のコードを受け入れるようになりました

ネイティブ SDK は、Capacitor SDK よりも新しいエラーコードを返す場合があります。4.3 以降、ErrorCode 型はこれらのコードも受け入れるようになったため、ErrorCode[error.adaptyCode] のようなルックアップや、error.adaptyCode に対する網羅的な switch はコンパイルが通らなくなる場合があります。代わりに error.codeName、getErrorCodeName()、または isKnownErrorCode() を使用してください。error.adaptyCode === ErrorCodeName.paymentCancelled のような比較や、default ブランチを持つ switch は変更不要です。

4.3では、以前のバージョンで不明として報告されていたコードにも名前が付けられているため、getErrorPrompt(1050) は 'Unknown code: 1050' の代わりに 'paymentPendingError' を返すようになりました。エラーヘルパーの詳細については、エラーの処理を参照してください。

プロモーションプロダクトをそのまま渡す

iOS では、makePromotedPurchase に 'onPromotedPurchaseReceived' イベントが持つ App Store の購入インテントが必要になりました。自分でビルドしたプロダクトや getPaywallProducts で取得したプロダクトは 4.2 では動作しますが、4.3 では失敗します。イベントからプロダクトを渡してください:

await adapty.addListener('onPromotedPurchaseReceived', async ({ product }) => {
  const result = await adapty.makePromotedPurchase({ product });
});

App Storeからのアプリ内課金のプロモーションを参照してください。

android.offerId は非推奨

アクセスレベルとサブスクリプションには、トップレベルの offerId が追加されました。これは、サブスクリプションの購入に使用された Google Play のオファーを示します。アクセスレベルでは android.offerId は引き続き使用できますが、非推奨となっています。代わりに、トップレベルの offerId を参照してください。これはデバイスの OS ではなく、購入したストアに依存します。

4.3 の新機能

これらの追加機能はオプトインです。既存のコードはそのまま動作します:

  • ストアメッセージの制御: App Store と Google Play のメッセージを表示するタイミングを選択します。
  • プレースメントのプリロード: preloadFlows と preloadFlowsForDefaultAudience でフローキャッシュをウォームアップします。
  • クローズ済みフローの保持: view.dismiss({ destroy: false }) でフローを保持して後で再表示でき、view.destroy() で解放します。
  • 12か月コミットメントプラン: iOS では product.subscription?.ios?.pricingTerms プロパティでプランを確認でき、アクセスレベルは billingPlan と commitmentInfo を報告します。
  • オブザーバーモード: reportTransaction にオプションの ios.jwsTransaction を渡せます。
  • 4.3 機能向けの新しいエラーコード: billingPlanUnavailable(1060)、operationInProgress(3201)、resolverFailure(3202)はいずれも iOS 専用です。エラーの処理を参照してください。
  • デバッグログレベル: 'debug' はネイティブ SDK の低レベルな内部詳細をログ出力します。ロギングを参照してください。