Unity SDKでストアメッセージを制御する
App Store や Google Play は、サブスクリプションに関するメッセージをユーザーに表示する必要がある場合があります:
- App Store: 価格改定への同意リクエスト、請求に関するお知らせ、またはウィンバックオファー。デフォルトでは、アプリが開いている間に StoreKit が自動的にこれらのメッセージを表示します。
- Google Play: サブスクリプションの支払いが拒否され、支払い方法の更新が必要であることを知らせる通知。SDK 4.3.0 以降、Adapty SDK はアクティベーション後にアプリの
Activityが開始されるたびに、デフォルトでこれらのメッセージをリクエストします。これはアプリがフォアグラウンドに戻ったときや、フローまたはオンボーディングが開いたり閉じたりするときも含みます。
どちらの場合でも、メッセージはフロー、オンボーディング、またはチェックアウトの上に表示される可能性があります。表示タイミングを自分で制御するには、Adapty SDK を手動メッセージ処理モードに切り替え、メッセージがユーザーの操作を妨げないタイミングで Adapty.ShowStoreMessages を呼び出してください。
手動モードでは、ストアは独自にメッセージを表示しません。アプリが Adapty.ShowStoreMessages を一度も呼び出さない場合、ユーザーは価格変更の同意リクエスト、請求に関する通知、または支払い拒否の通知を受け取ることができません。
始める前に
必要なもの:
- Adapty Unity SDK 4.3.0 以降:それより古いバージョンにはストアメッセージ API がありません。
- iOS 16 以降(App Store メッセージ用):StoreKit はそれより古いバージョンのアプリにはメッセージを配信しません。iOS 15 では、
Adapty.GetPendingStoreMessageTypesとAdapty.ShowStoreMessagesがDecodingFailedエラーで失敗します。そのため、アプリが iOS 15 をサポートしている場合は、iOS 16 以降でのみ呼び出してください:
#if UNITY_IOS && !UNITY_EDITOR
var iosMajorVersion = int.Parse(UnityEngine.iOS.Device.systemVersion.Split('.')[0]);
if (iosMajorVersion >= 16) {
Adapty.ShowStoreMessages((error) => {
// handle the error
});
}
#endif
手動処理を有効にする
ストアメッセージをアプリが Adapty.ShowStoreMessages を呼び出したときのみ表示するには、SDKを有効化する際に SetStoreMessagesHandling を AdaptyStoreMessagesHandling.Manual で呼び出してください:
var builder = new AdaptyConfiguration.Builder("YOUR_PUBLIC_SDK_KEY")
.SetStoreMessagesHandling(AdaptyStoreMessagesHandling.Manual); // Auto is the default
Adapty.Activate(builder.Build(), (error) => {
// handle the error
});
iOSでは、SDKは各App Storeメッセージを現在のアプリセッションの保留リストに追加します。Androidでは、SDKはGoogle Playメッセージのリクエストを自動的に停止します。デフォルトのAuto値では、SDKはApp Storeメッセージをキャプチャしないため、iOSではAdapty.GetPendingStoreMessageTypesとAdapty.ShowStoreMessagesは返すべきもの、または表示するものが何もありません。
保留中のメッセージタイプを取得する
iOS では、App Store のメッセージが待機中かどうかを確認するには、Adapty.GetPendingStoreMessageTypes を呼び出します。これは保留中のメッセージのタイプを返しますが、メッセージの表示や削除は行いません:
Adapty.GetPendingStoreMessageTypes((pendingTypes, error) => {
if (error != null) {
// handle the error
return;
}
if (pendingTypes == null) {
// Android: Google Play decides whether a message applies when you show it
} else if (pendingTypes.Contains(AdaptyStoreMessageType.BillingIssue)) {
// For example, skip the upsell and show the billing message first
}
});
Android では、このメソッドは null をエラーなしで返します。これは Google Play が保留中のメッセージを通知せず、アプリがリクエストしたときにのみそのメッセージが適用されるかどうかを判断するためです。空のリストは、iOS に保留中のメッセージがないことを意味します。Adapty.Activate が完了するまで、リストは常に空です。
各 App Store メッセージには、次のいずれかのタイプがあります:
| タイプ | メッセージ |
|---|---|
AdaptyStoreMessageType.Generic | App Store の一般的なメッセージ。 |
AdaptyStoreMessageType.PriceIncreaseConsent | サブスクリプション価格の値上げへの同意を求めるリクエスト。 |
AdaptyStoreMessageType.BillingIssue | サブスクリプションの請求に関する問題のお知らせ。iOS 16.4 以降で利用可能。 |
AdaptyStoreMessageType.WinBackOffer | 対象となるウィンバックオファー。iOS 18 以降で利用可能。 |
新しい StoreKit のメッセージタイプは RawValue として storekit_<number> の形式で届きます。タイプを確認するには、上記のいずれかの値と == で比較し、それ以外の値は SDK が認識できないタイプとして処理してください。
メッセージを表示する
ストアメッセージがユーザーの操作を妨げない場面(例えば、ユーザーがフローを閉じた後やオンボーディングを完了した後など)になったら、Adapty.ShowStoreMessages を呼び出します。
Adapty.ShowStoreMessages((error) => {
if (error != null) {
// handle the error
}
});
- iOS: SDKはペンディング中のメッセージを1つずつ表示します。StoreKitがメッセージを表示した後、SDKはそのメッセージをペンディングリストから削除します。StoreKitがメッセージの表示に失敗した場合、SDKはそのメッセージを次回の呼び出しのために保持し、他のメッセージの処理を続けます。
- Android: SDKは現在の
Activityに対してGoogle Playのメッセージをリクエストします。メッセージがユーザーに適用されるかどうかはGoogle Playが判断するため、リクエストしても必ずしもメッセージが表示されるわけではありません。ユーザーがメッセージから支払い方法を修正した場合、SDKはユーザーの購入情報をAdaptyと同期し、プロファイルリスナーが更新されたアクセスレベルを受け取ります。
Android での起動時にメッセージを表示する
デフォルトの Auto モードでは、アクティベーション前に開始した Activity はリクエストをトリガーしないため、起動時に Google Play メッセージが表示されません。起動時に表示するには、Adapty.Activate の完了後、Android のみで Adapty.ShowStoreMessages を一度呼び出してください:
Adapty.Activate(builder.Build(), (error) => {
if (error != null) {
// handle the error
return;
}
#if UNITY_ANDROID
Adapty.ShowStoreMessages((showError) => {
// handle the error
});
#endif
});
iOS ではこの呼び出しを行わないでください: Auto モードでは表示するものがなく、iOS 15 ではエラーが発生します。
一部のメッセージタイプのみを表示する
保留中のApp Storeメッセージのうち一部のみを表示するには、最初の引数としてタイプを指定します。それ以外のメッセージは保留のままになります。
var iosFilter = new List<AdaptyStoreMessageType> {
AdaptyStoreMessageType.BillingIssue,
AdaptyStoreMessageType.PriceIncreaseConsent,
};
Adapty.ShowStoreMessages(iosFilter, (error) => {
// handle the error
});
フィルターなし、または null の場合、SDKは認識できないタイプを含むすべての保留中メッセージを表示します。空のリストを指定すると、何も表示されません。Android はフィルターを無視し、Google Play のすべてのメッセージをリクエストします。
エラー
Adapty.ShowStoreMessages は、以下のコードのいずれかを持つ AdaptyError で失敗することがあります。WrongParam を除くすべてのエラーは iOS のみで発生します。
| コード | 名前 | 原因 |
|---|---|---|
| 2006 | DecodingFailed | デバイスが iOS 15 以前で動作しています。このメソッドは iOS 16 以降でのみ呼び出してください。 |
| 3201 | OperationInProgress | 別の Adapty.ShowStoreMessages の呼び出しがまだメッセージを表示中であり、今回の呼び出しにも表示すべきメッセージがあります。最初の呼び出しが完了するまで待ってから再試行してください。 |
| 3202 | ResolverFailure | SDK がメッセージを表示するためのフォアグラウンドのアクティブなウィンドウシーンを見つけられませんでした。アプリがフォアグラウンドにある状態で再度メソッドを呼び出してください。 |
| 3001 | WrongParam | フィルターリストに null が含まれています。SDK はストアに到達する前にこの呼び出しを拒否します。 |