iOS SDKでApp Storeメッセージを制御する

App Storeがユーザーに対してサブスクリプションに関するメッセージを表示する必要がある場合があります。価格の引き上げへの同意を求めたり、請求に関する問題を通知したり、ウィンバックオファーを提示したりするためです。デフォルトでは、StoreKitはアプリが開いている間に独自のタイミングでこれらのメッセージを表示します。ペイウォール、オンボーディング、またはチェックアウト画面の上にも表示されることがあります。

表示タイミングを自分でコントロールするには、Adapty SDKをメッセージの手動処理モードに切り替えます。SDKは各メッセージを保留リストに追加し、アプリがshowStoreMessagesを呼び出したタイミングでリストを表示します。

始める前に

以下が必要です：

• Adapty iOS SDK 4.2 以降：それ以前のバージョンにはストアメッセージ API がありません。
• ユーザーのデバイスで iOS 16、Mac Catalyst 16、または visionOS 1 以降：StoreKit はそれ以前のバージョンのアプリにメッセージを配信しません。ストアメッセージ API は macOS では利用できません。

手動処理を有効にする

App Store のメッセージをキャプチャするには、SDK をアクティブ化する際に storeMessagesHandling を .manual に設定します。

let configurationBuilder = AdaptyConfiguration
    .builder(withAPIKey: "YOUR_PUBLIC_SDK_KEY")
    .with(storeMessagesHandling: .manual) // .auto is the default

SDKはアクティベート時からメッセージのキャプチャを開始し、現在のアプリセッション中はメモリに保持します。デフォルトの .auto 値の場合、SDKは何もキャプチャせず、getPendingStoreMessageTypes と showStoreMessages は何も行いません。

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

保留中のメッセージがあるかどうかを確認するには、getPendingStoreMessageTypes を呼び出します。このメソッドはメッセージを表示・削除せずに、保留中のメッセージのタイプだけを返します。

let pendingTypes = await Adapty.getPendingStoreMessageTypes()

if pendingTypes.contains(.billingIssue) {
    // For example, skip the upsell and show the billing message first
}

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

SDK が認識できないメッセージタイプには、storekit_<number> というローバリューが設定されます。

保留中のメッセージを表示する

アプリがシステムシートでユーザーの操作を妨げない状態になったタイミング（たとえば、ユーザーがフローを閉じたりオンボーディングを完了した後）で、showStoreMessages を呼び出します。

struct HomeView: View {
    @Environment(\.displayStoreKitMessage) private var displayStoreKitMessage

    var body: some View {
        Text("Home")
            .task {
                do {
                    try await Adapty.showStoreMessages(using: displayStoreKitMessage)
                } catch {
                    // handle the error
                }
            }
    }
}

do {
    try await Adapty.showStoreMessages(in: view.window?.windowScene)
} catch {
    // handle the error
}

SDK はメッセージを順番に表示します。StoreKit がメッセージを表示すると、SDK はそのメッセージを保留リストから削除します。StoreKit がメッセージの表示に失敗した場合、SDK はエラーを Adapty ログに記録し、そのメッセージを次回の呼び出し用に保持して、残りのメッセージの処理を続行します。

特定のメッセージタイプのみを表示する

一部の保留中のメッセージのみを表示するには、for にタイプを指定してください。指定しなかったメッセージは保留のままになります。

try await Adapty.showStoreMessages(
    for: [.billingIssue, .priceIncreaseConsent],
    using: displayStoreKitMessage
)

for を省略した場合、SDK は認識できないタイプを含む、すべての保留中のメッセージを表示します。

エラー

showStoreMessagesは以下のいずれかのコードでAdaptyErrorをスローします：