Capacitor SDKでストアメッセージを制御する

App StoreやGoogle Playは、サブスクリプションに関するメッセージをユーザーに表示することがあります:

  • App Store: 価格引き上げへの同意、請求に関する問題の通知、またはウィンバックオファーのリクエスト。デフォルトでは、アプリが開いている間にStoreKitが自動的にこれらのメッセージを表示します。
  • Google Play: サブスクリプションの支払いが拒否され、支払い方法の更新が必要であることを通知するメッセージ。SDK 4.3.0以降、Adapty SDKはactivate後にアプリのActivityが起動するたびに(アプリがフォアグラウンドに戻った場合を含む)、デフォルトでこれらのメッセージをリクエストします。

いずれにしても、メッセージはフロー、オンボーディング、またはチェックアウトの上に表示される場合があります。表示するタイミングを自分で制御するには、Adapty SDK を手動メッセージ処理モードに切り替え、ユーザーの操作を妨げないタイミングで showStoreMessages を呼び出してください。

Warning

手動モードでは、ストアが自動的にメッセージを表示することはありません。アプリが showStoreMessages を一度も呼び出さない場合、ユーザーは価格変更の同意リクエスト、請求に関するお知らせ、または支払い拒否の通知を一切受け取れません。

始める前に

以下が必要です:

  • Adapty Capacitor SDK 4.3.0 以降:それより古いバージョンにはストアメッセージ API がありません。
  • iOS 16 以降(App Store メッセージ用):StoreKit はそれより古いバージョンのアプリにはメッセージを配信しません。iOS 15 では、getPendingStoreMessageTypes と showStoreMessages が decodingFailed エラーをスローするため、アプリが iOS 15 をサポートしている場合は、以下の例のようにエラーをキャッチしてください。

手動処理を有効にする

ストアメッセージをアプリが showStoreMessages を呼び出したときのみ表示するには、SDKを有効化する際に storeMessagesHandling を 'manual' に設定します:


await adapty.activate({
  apiKey: 'YOUR_PUBLIC_SDK_KEY',
  params: {
    storeMessagesHandling: 'manual', // 'auto' is the default
  },
});

iOS では、SDK は各 App Store メッセージを現在のアプリセッションの保留リストに追加します。Android では、SDK は独自に Google Play メッセージのリクエストを停止します。デフォルトの 'auto' 値では、SDK は App Store メッセージをキャプチャしないため、iOS では getPendingStoreMessageTypes と showStoreMessages は返すべき内容や表示すべき内容がありません。

保留中のメッセージタイプを取得する

iOS では、App Store のメッセージが保留中かどうかを確認するには、getPendingStoreMessageTypes を呼び出します。これにより、保留中のメッセージのタイプが返されますが、メッセージの表示や削除は行われません。

try {
  const pendingTypes = await adapty.getPendingStoreMessageTypes();

  if (pendingTypes === null) {
    // Android: Google Play decides whether a message applies when you show it
    await adapty.showStoreMessages();
  } else if (pendingTypes.includes('billing_issue')) {
    // For example, skip the upsell and show the billing message first
  }
} catch (error) {
  // On iOS 15, the call fails with decodingFailed (2006)
}

Android では、このメソッドはネイティブ SDK を呼び出さずに null を返します。Google Play は保留中のメッセージを通知せず、アプリがリクエストしたときにのみメッセージが適用されるかどうかを判断します。空の配列は、iOS に保留中のメッセージがないことを意味します。activate が完了するまで、配列は常に空です。

各 App Store メッセージには、次のいずれかのタイプがあります。

タイプメッセージ
genericApp Store の一般的なメッセージ。
price_increase_consentサブスクリプションの値上げへの同意リクエスト。
billing_issueサブスクリプションの請求に関するお知らせ。iOS 16.4 以降で利用可能。
win_back_offer対象となるウィンバックオファー。iOS 18 以降で利用可能。

新しい StoreKit メッセージタイプは storekit_<number> という値で届きます。上記の表にない値は、SDK が認識できないタイプとして扱ってください。

メッセージを表示する

フローを閉じた後やオンボーディングが完了した後など、ストアのメッセージがユーザーの操作を妨げないタイミングになったら、showStoreMessages を呼び出します:

try {
  await adapty.showStoreMessages();
} catch (error) {
  // handle the error
}
  • iOS: SDKは保留中のメッセージを1件ずつ表示します。StoreKitがメッセージを表示した後、SDKはそのメッセージを保留リストから削除します。StoreKitがメッセージの表示に失敗した場合、SDKは次の呼び出しに備えてそのメッセージを保持し、他のメッセージの処理を続行します。
  • Android: SDKは現在のActivityに対してGoogle Playのメッセージをリクエストします。Google Playがメッセージをそのユーザーに適用するかどうかを判断するため、リクエストしても必ずしもメッセージが表示されるわけではありません。この呼び出しはGoogle Playを待たずに即座に返り、Google Playのエラーは報告しません。ユーザーがメッセージから支払い方法を修正した場合、SDKはユーザーの購入情報をAdaptyと同期し、プロファイルリスナーが更新されたアクセスレベルを受け取ります。

Android での起動時にメッセージを表示する

デフォルトの 'auto' モードでは、アプリをホストする Activity が activate の実行前に起動するため、リクエストがトリガーされず、Google Play のメッセージが起動時に表示されません。起動時に表示するには、activate の後に Android のみで showStoreMessages を一度呼び出してください。


await adapty.activate({ apiKey: 'YOUR_PUBLIC_SDK_KEY' });

if (Capacitor.getPlatform() === 'android') {
  await adapty.showStoreMessages();
}

iOSではこの呼び出しを行わないでください:'auto' モードでは表示するものが何もなく、iOS 15ではエラーが発生します。

一部のメッセージタイプのみ表示する

表示したい App Store のメッセージタイプを ios.filter に指定すると、指定したタイプのみが表示され、それ以外のメッセージは保留状態のまま残ります。

await adapty.showStoreMessages({
  ios: { filter: ['billing_issue', 'price_increase_consent'] },
});

filter を指定しない場合、SDK は認識できないタイプを含むすべての保留中メッセージを表示します。空の配列を指定した場合は何も表示されません。Android は filter を無視し、すべての Google Play メッセージをリクエストします。

エラー

iOS では、showStoreMessages は以下のいずれかのコードを持つ AdaptyError をスローします:

コード名前原因
2006decodingFailedデバイスが iOS 15 以前で動作しています。このメソッドは iOS 16 以降でのみ呼び出してください。
3201operationInProgress別の showStoreMessages 呼び出しがまだメッセージを表示中であり、今回の呼び出しにも表示すべきメッセージがあります。最初の呼び出しが完了するまで待ってから再試行してください。
3202resolverFailureSDK がメッセージを表示するためのフォアグラウンドアクティブなウィンドウシーンを見つけられませんでした。エラー発生前に表示されたメッセージは保留リストから削除されます。残りのメッセージを表示するには、アプリがフォアグラウンドにある状態でメソッドを再度呼び出してください。