App Store インテグレーションの設定
iOS アプリを Adapty に接続するには、App settings > iOS SDK にアプリの App Store 認証情報を入力します。設定後、Adapty は次の処理を行います:
- 購入を検証する。
- サブスクリプションイベントを受信する。
- プロダクトを App Store Connect と同期し続ける。
購入やサブスクリプションのイベントが Adapty に届かなくなった場合は、各認証情報を確認するを参照してください。
始める前に:
- App Store Connect のターゲットアプリへのアクセス権が必要です。まだアプリがない場合は、App Store Connect のセットアップを行ってください。プラットフォームへのアクセス権がない場合は、担当者にリクエストしてください。
- チームが App Store Connect API にアクセスできる必要があります。これは必要なアクセスキーを生成するために必要です。まだアクセスできない場合は、Account Holder にリクエストするよう依頼してください。Apple は各リクエストを審査します。
- ブラウザのタブを2つ開いてください:一方に App Store Connect のアプリ画面、もう一方に Adapty の App settings > iOS SDK を開きます。このガイドを通じて、2つのタブ間で値をコピーします。
概要
このガイドで紹介するすべての認証情報は必須です。Adapty はそれぞれを App Store とのデータ交換の異なる部分に使用します。設定を完了するには、以下の7つのステップに従ってください。
- バンドルIDとApple App IDを入力する
- アプリ固有の共有シークレットを入力する
- AdaptyのURLを使用してApp Serverサーバー通知を有効にする
- アプリ内購入キーを追加する
- App Store Connect APIキーを追加する
- Adapty SDKをインストールしてサンドボックス購入を行う
- すべての認証情報を確認する
Bundle IDとApple App IDを入力する
App Store Connectでアプリを識別するために、Bundle IDとApple IDの2つの値が必要です。AdaptyではこのApple IDをApple App IDと表示しています。AdaptyはアプリNの購入を処理するためにBundle IDを使用します。Apple IDを使用することで、Adaptyは以下のことができます:
- App Store Connectでプロダクトを検索し、新しいプロダクトを作成する。
- プロダクトのApp Storeのステータスと価格を表示する。
- リテンションメッセージングのリアルタイムメッセージを配信する。
- AppsFlyerなどのアトリビューション連携でアプリを識別する。
AppleはアプリをApp Store Connectに追加したときにApple IDを割り当てます。そのため、アプリがApp Storeに公開される前でもこの値を入力してください。
-
Open App Store Connect. Select your app and proceed to General > App Information section.
-
Copy the Bundle ID in the General Information sub-section.
Copy only the identifier — reverse-DNS format with no spaces, for example,
com.company.app. App Store Connect shows the app name next to it in other views, like the apps list; pasting that instead of the identifier makes the connection between Adapty and the App Store fail to validate.
- Open the App settings > iOS SDK tab from the Adapty top menu and paste the copied value to the Bundle ID field.
- Get back to the App information page in App Store Connect and copy Apple ID from there.
- On the App settings > iOS SDK page in the Adapty dashboard, paste the ID to the Apple App ID field.
アプリ固有の共有シークレットを入力する
Adaptyが購入レシートを検証し、App Store Connectでプロダクトを作成するには、アプリ固有の共有シークレットが必要です。
-
App Store Connectで、アプリの App Information ページを開きます。App-Specific Shared Secret セクションで、Manage をクリックします。
-
シークレットをコピーします。アプリにまだシークレットがない場合は、先に Generate をクリックしてください。シークレットを生成するには、App Store Connect の Account Holder または Admin ロールが必要です。どちらのロールも持っていない場合は、該当するロールを持つ人にシークレットの生成と共有を依頼してください。
アプリ転送でアプリを受け取った場合を除き、Regenerate はクリックしないでください。クリックすると、現在のシークレットが使用されているすべての場所で機能しなくなります。
-
Adapty で、シークレットを App Store Connect shared secret フィールドに貼り付けます。
-
Save をクリックします。
AdaptyのURLを使ってApp Storeサーバー通知を有効にする
メイン記事:App Storeサーバー通知を有効にする
Appleはサブスクリプションの更新、返金、その他のイベントが発生すると、サーバー通知をAdaptyに送信します。アプリがトランザクションを報告しない場合でも、Adaptyはこれらのイベントを記録します。
もし Apple がすでにこれらの通知を別のサーバーに送信している場合は、App Store Connect でその URL を置き換える前に、そのサーバーへの転送を設定してください。Adapty の URL for forwarding raw Apple events フィールドに転送先サーバーの URL を入力し、Save をクリックしてください。その後、Adapty は Apple から受け取った通知をそのサーバーに転送します。
バックエンドが App Store Connect に自身の URL を維持する必要がある場合は、代わりにバックエンドから Adapty に通知を渡してください。
-
Adaptyで、接続するアプリを開きます。各AdaptyアプリにはそれぞれのNotification URLがあります。App settings > iOS SDKに移動します。App Store server notificationsセクションで、URL for App Store server notificationsフィールドからURLをコピーします。
-
App Store Connectで、アプリのApp Informationページを開きます。
-
App Store Server Notificationsセクションで、Production Server URLを探します。すでにURLが設定されている場合はEditをクリックし、設定されていない場合はSet Up URLをクリックします。
-
AdaptyのURLを貼り付け、Saveをクリックします。
-
サンドボックステストからの通知もAdaptyに届くようにするには、Sandbox Server URLについて手順3と4を繰り返します。
アプリ内課金キーの追加
メイン記事: アプリ内課金キーをAdaptyに追加する
Adaptyはアプリ内課金キーを使用して、購入の検証とプロモーションオファーの署名を行います。キーファイルをまだお持ちでない場合は、まずApp Store Connectでキーを生成してください。Adaptyにキーを追加するには:
-
Issuer ID と Key ID を確認するには、App Store Connect で Users and Access > Integrations > In-App Purchase に移動します。他の人がキーを生成し、Issuer ID、Key ID、ファイルを送ってもらった場合は、このステップをスキップしてください。
-
Adapty で App settings > iOS SDK に移動します。In-app purchase API (StoreKit 2) セクションで、各フィールドを入力してください:
- Issuer ID:App Store Connect の In-App Purchase ページからコピーします。
- Key ID:In-App Purchase ページの Active リストで、ダウンロードしたキーの横に表示されている値をコピーします。
- Private key (.p8 file):ダウンロードしたファイルをアップロードします。
-
Adapty は In-App Purchase キーを使ってプロモーションオファーに署名します。App Store promotional offers セクションで、同じキーを再度入力してください:
- Subscription key ID:手順 2 の Key ID を入力します。
- Subscription key (.p8 file):手順 2 のファイルをアップロードします。
別のキーを入力してもエラーなく保存されますが、ユーザーはプロモーションオファーを受け取れなくなります。
-
Save をクリックします。Adapty はページを保存する前に、In-app purchase API (StoreKit 2) セクションのキーを Apple に対して検証します。Apple がキーを拒否した場合、ページに「The provided field values are incorrect」と表示されます。値を確認してください。
App Store Connect APIキーを追加する
AdaptyはApp Store Connect APIキーを使って、App Store Connectでプロダクトを作成したり、ステータスや価格を同期したりします。これはIn-App Purchase keyとは別のキーですが、Issuer IDとKey IDというフィールド名は共通です。
Adapty には Admin アクセス権限を持つチームキーが必要です。まだお持ちでない場合は、先に App Store Connect でチームキーを生成してください。Adapty でキーを連携するには:
-
Issuer ID と Key ID を確認するには、App Store Connect で Users and Access > Integrations > App Store Connect API に移動し、Team Keys タブを開きます。他の担当者がキーを生成し、Issuer ID、Key ID、ファイルを送ってくれた場合は、この手順をスキップしてください。
-
Adapty で App settings > iOS SDK に移動します。App Store Connect API key セクションで Connect API Key をクリックします。
-
各フィールドを入力します:
- Issuer ID:App Store Connect の Team Keys タブからコピーします。
- Key ID:Team Keys タブの Active リストから、ダウンロードしたキーの横にある値をコピーします。
- Private key (.p8 file):チームキー用にダウンロードしたファイルをアップロードします。
-
接続済みのキーは後から置き換えることができますが、削除はできません。キーがこのアプリを所有する App Store Connect チームのものであることを確認し、Connect をクリックします。以降は、App Store Product ID をキーボードで入力するのではなく、App Store Connect 内のプロダクトから選択できるようになります。
Adapty は接続時に Apple でキーを検証しません。誤ったキーを設定した場合、キーに関するエラーメッセージは表示されず、プロダクトに App Store のステータスが表示されなくなり、App Store Product ID のドロップダウンが空のままになります。誤ったキーを修正するには、キーを置き換えてください。
各認証情報が機能しているかを確認する
Adapty が購入を検証していることを確認するには、アプリに Adapty SDK をインストールし、サンドボックス購入を実行してください。
サンドボックス購入では、一部の認証情報のみが使用されます。購入後に各認証情報を確認し、購入やサブスクリプションイベントが Adapty に届かなくなった際にも再度確認してください:
- Bundle ID、Apple App ID、App Store Connect shared secret: この3つの値を、App Store Connectの App Information ページにある Bundle ID、Apple ID、および App-Specific Shared Secret のシークレットと照合してください。
- App Store server notifications: このセクションのステータスは、購入または更新に関する通知がAdaptyに届くと Active と表示されます。それ以外の表示になっている場合は、サーバーURLを確認してください。
- In-app purchase API (StoreKit 2): 保存時にAdaptyがAppleでキーを検証します。その後、アプリ内での購入でアクセスが解除されない場合、キーが機能しなくなっている可能性があります。キーを置き換えてください。
- App Store promotional offers: Subscription key ID が In-app purchase API (StoreKit 2) セクションの Key ID と一致していることを確認してください。異なる場合は、両方のセクションに同じキーを入力してください。
- App Store Connect API key: 各App StoreプロダクトのステータスはAdaptyの Products ページの App Store status 列に表示されます。プロダクトにダッシュまたは Not Connected が表示されている場合は、キーとApple App IDを確認してください。
セットアップ直後は、Analytics でトライアルや購入がインストール数より多くカウントされたり、イベントフィードに表示される数より多くなることがあります。この差はプロファイルのないトランザクションによるものです。これは、Adapty SDK を含むバージョンのアプリをまだ開いていないユーザーの購入です。
Adapty とストアのレポートにおけるその他の差異は、認証情報の問題ではなく、それぞれの購入カウント方法の違いによるものです。
次のステップ
アプリのリリース準備を進めるには、リリースチェックリストを確認してください。
アプリが Google Play にも対応している場合は、そのストアを接続してください。