Kotlin Multiplatform SDKでモバイルアプリ内購入を行う

モバイルアプリ内でペイウォールを表示することは、ユーザーにプレミアムコンテンツやサービスへのアクセスを提供するための重要なステップです。ただし、ペイウォールを表示するだけで購入が成立するのは、Adapty が画面をレンダリングする場合のみです。具体的には、フロー、または旧ペイウォールビルダーで作成したペイウォールが該当します。

自分のコードで画面をレンダリングする場合は、購入を完了してコンテンツをアンロックするために、.makePurchase() という別のメソッドを使用する必要があります。このメソッドは、ユーザーがペイウォールを通じて目的のトランザクションを行うための入口となります。

ペイウォールにプロモーションオファーが設定されている場合、ユーザーが購入しようとしたときに Adapty が自動的にそのオファーを適用します。

初期設定をすべての手順を飛ばさずに完了していることを確認してください。これが完了していないと、購入を検証できません。

購入を実行する

Adapty.makePurchase(product = product).onSuccess { purchaseResult ->
    when (purchaseResult) {
        is AdaptyPurchaseResult.Success -> {
            val profile = purchaseResult.profile
            if (profile.accessLevels["YOUR_ACCESS_LEVEL"]?.isActive == true) {
                // Grant access to the paid features
            }
        }
        is AdaptyPurchaseResult.UserCanceled -> {
            // Handle the case where the user canceled the purchase
        }
        is AdaptyPurchaseResult.Pending -> {
            // Handle deferred purchases (e.g., the user will pay offline with cash)
        }
    }
}.onError { error ->
    // Handle the error
}

リクエストパラメータ：

レスポンスパラメータ：

購入時にサブスクリプションを変更する

ユーザーが現在のサブスクリプションを更新する代わりに新しいサブスクリプションを選択した場合、その動作はアプリストアによって異なります。Google Play の場合、サブスクリプションは自動的に更新されません。以下の説明に従って、モバイルアプリのコードで切り替えを管理する必要があります。

Android でサブスクリプションを別のものに切り替えるには、追加パラメータを指定して .makePurchase() メソッドを呼び出してください：

val subscriptionUpdateParams = AdaptyAndroidSubscriptionUpdateParameters(
    oldSubVendorProductId = "old_subscription_product_id",
    replacementMode = AdaptyAndroidSubscriptionUpdateReplacementMode.CHARGE_FULL_PRICE
)

val purchaseParams = AdaptyPurchaseParameters.Builder()
    .setSubscriptionUpdateParams(subscriptionUpdateParams)
    .build()

Adapty.makePurchase(
    product = product,
    parameters = purchaseParams
).onSuccess { purchaseResult ->
    when (purchaseResult) {
        is AdaptyPurchaseResult.Success -> {
            val profile = purchaseResult.profile
            // successful cross-grade
        }
        is AdaptyPurchaseResult.UserCanceled -> {
            // user canceled the purchase flow
        }
        is AdaptyPurchaseResult.Pending -> {
            // the purchase has not been finished yet, e.g. user will pay offline by cash
        }
    }
}.onError { error ->
    // Handle the error
}

追加リクエストパラメータ：

サブスクリプションと切り替えモードについては、Google Developer ドキュメントで詳しく確認できます：

• 切り替えモードについて
• 切り替えモードに関する Google の推奨事項
• 切り替えモード CHARGE_PRORATED_PRICE。注意：このメソッドはサブスクリプションのアップグレードにのみ対応しています。ダウングレードはサポートされていません。
• 切り替えモード DEFERRED。注意：実際のサブスクリプション変更は、現在のサブスクリプションの請求期間が終了した時点でのみ適用されます。

iOS でオファーコードを利用する

アプリ内でコード引き換えシートを表示するには：

Adapty.presentCodeRedemptionSheet()
    .onSuccess {
        // code redemption sheet presented successfully
    }
    .onError { error ->
        // handle the error
    }

プリペイドプランを管理する（Android）

アプリユーザーがプリペイドプラン（例：数か月分の非更新型サブスクリプションを購入するなど）を利用できる場合、プリペイドプランの保留中のトランザクションを有効にすることができます。

Adapty.activate(
    AdaptyConfig.Builder("PUBLIC_SDK_KEY")
        .withGoogleEnablePendingPrepaidPlans(true)
        .build()
).onSuccess {
    // successful activation
}.onError { error ->
    // handle the error
}

App Storeのプロモーションアプリ内課金

ユーザーがApp Storeのプロダクトページから購入を開始し、そのトランザクションがアプリに引き継がれると、SDKはOnPromotedPurchaseListenerを通じてプロダクトを渡します。購入を完了するのはアプリ側の責任です。makePromotedPurchaseにプロダクトを渡してください。タイミングはアプリが制御できるため、購入が始まる前に独自の画面を表示することも可能です。

プロモート購入をサポートするには、リスナーを登録し、そこから購入を完了させます。

Adapty.setOnPromotedPurchaseListener(OnPromotedPurchaseListener { product ->
    scope.launch {
        Adapty.makePromotedPurchase(product)
            .onSuccess { result -> /* process the purchase result */ }
            .onError { error -> /* handle the error */ }
    }
})

リスナーはアプリ起動時、Adapty.activate の直後に登録してください。プロモーション購入はアプリをコールドラン（初回起動）させることが多いため、登録処理が実行される前に SDK へ到達するケースがよくあります。SDK はそのような購入を1件保持しておき、登録が完了した時点で即座に配信します。保持されるのは最新の1件のみで、購入を保持するたびにコンソールに警告が出力されます。

プロモート対象のプロダクトにサブスクリプションオファーが含まれている場合、SDK は購入時に自動的にそのオファーを適用します。オファーは App Store の購入インテントから読み取られます。これは iOS 18.0 以降で利用可能です。iOS 16.4〜17.x では、通常価格で購入が処理されます。

makePromotedPurchase は購入パラメーターを受け取りません。プロモート対象のプロダクトはペイウォールではなく App Store から取得されるため、ペイウォールのコンテキストを持ちません。戻り値は makePurchase と同じ AdaptyPurchaseResult です。

AdaptyPromotedProductは、vendorProductId、localizedTitle、localizedDescription、price、regionCode、isFamilyShareable、およびAdaptyProductSubscription型のsubscriptionを持ちます。