メインコンテンツまでスキップ

通知タイプのペイロード

概要​

RTDN ペイロードは、購入について何が変更されたかをバックエンドに通知します。このリファレンスでは、各通知が持つフィールド、すなわち OneTimeProductNotification、SubscriptionNotification、VoidedPurchaseNotification と、それぞれの処理方法について説明します。

OneTimeProductNotification​

OneTimeProductNotification には以下のペイロードが含まれます:

{
  "version": String,
  "notificationType": Int,
  "purchaseToken": String,
  "sku": String
}

このペイロードのパラメータは以下のとおりです:

名前型説明
versionString受信したペイロードのバージョン。
notificationTypeInt消費アイテム製品の購入について受信した通知のタイプ。指定可能な値はこちらで確認できます。
purchaseTokenString消費アイテムの購入の購入トークン。これは一意の値であり、購入に関する詳細情報を取得するために使用する必要があります。
skuString購入における製品の SKU。

NotificationType​

notificationType の指定可能な値は以下のとおりです:

値タイトル説明
1COMPLETEDアプリ内購入が正常に完了しました。
2CANCELEDアプリ内購入がキャンセルされました。

OneTimeProductNotification ペイロードの処理​

OneTimeProductNotification タイプの通知を受信した場合は、orderId パラメータを使用して、その通知に関連する購入に関する詳細情報を取得し、その情報でバックエンドのデータを更新してください。

InApp タイプの製品の orderId を使用して購入データを取得するには、当社のアプリ内購入検証エンドポイントを使用してください。

SubscriptionNotification​

SubscriptionNotification には以下のペイロードが含まれます:

{
  "version": String,
  "notificationType": Int,
  "purchaseToken": String,
  "subscriptionId": String
}

このペイロードのパラメータは以下のとおりです:

名前型説明
versionString受信したペイロードのバージョン。
notificationTypeIntサブスクリプション購入について受信した通知のタイプ。指定可能な値はこちらで確認できます。
purchaseTokenStringサブスクリプション購入の購入トークン。これは一意の値であり、購入に関する詳細情報を取得するために使用する必要があります。
subscriptionIdString購入における製品の SKU。

NotificationType​

notificationType の指定可能な値は以下のとおりです:

値タイトル説明
2SUBSCRIPTION_RENEWEDアクティブなサブスクリプションが正常に更新されました。
3SUBSCRIPTION_CANCELEDサブスクリプションが、ユーザーによる自発的または非自発的なかたちでキャンセルされました。自発的なキャンセルの場合、この通知はユーザーがキャンセルを開始した時点で送信されます。
4SUBSCRIPTION_PURCHASED新しいサブスクリプションが購入されました。
5SUBSCRIPTION_ON_HOLDサブスクリプションがアカウント保留状態になりました（この機能が有効になっている場合）。
6SUBSCRIPTION_IN_GRACE_PERIOD支払い失敗などの問題により、サブスクリプションが猶予期間に入りました（この機能が有効になっている場合）。
7SUBSCRIPTION_RESTARTEDユーザーが Aptoide Wallet > Settings > Manage Subscriptions からサブスクリプションを復元しました。サブスクリプションはキャンセルされていましたが、復元時にはまだ有効期間内でした。
12SUBSCRIPTION_REVOKEDサブスクリプションが、有効期限前にシステムによって取り消されました。
13SUBSCRIPTION_EXPIREDサブスクリプションが有効期限に達し、更新されませんでした。

SubscriptionNotification ペイロードの処理​

SubscriptionNotification タイプの通知を受信した場合は、orderId パラメータを使用して、その通知に関連する購入に関する詳細情報を取得し、その情報でバックエンドのデータを更新してください。

サブスクリプションタイプの製品の orderId を使用して購入データを取得するには、当社のサブスクリプション購入検証エンドポイントを使用してください。

VoidedPurchaseNotification​

VoidedPurchaseNotification には以下のペイロードが含まれます:

{
  "purchaseToken": String,
  "orderId": String,
  "productType": Int,
  "refundType": Int
}

このペイロードのパラメータは以下のとおりです:

名前型説明
purchaseTokenString無効化された購入の購入トークン。これは一意の値であり、購入に関する詳細情報を取得するために使用する必要があります。
orderIdStringAptoide 内部で使用される注文 UID（一意の識別子）。
productTypeInt無効化された購入における SKU のタイプ。
refundTypeInt無効化された購入について受信した通知のタイプ。指定可能な値はこちらで確認できます。

productType​

productType の指定可能な値は以下のとおりです:

値タイトル説明
1SUBSサブスクリプション用の SKU タイプ。
2INAPPアプリ内製品用の SKU タイプ。

refundType​

refundType の指定可能な値は以下のとおりです:

値タイトル説明
1REFUND_TYPE_FULL_REFUND購入が全額返金されました。
2REFUND_TYPE_QUANTITY_BASED_PARTIAL_REFUND購入が一部返金されました。

VoidedPurchaseNotification ペイロードの処理​

VoidedPurchaseNotification タイプの通知を受信した場合は、orderId パラメータを使用して、その通知に関連する無効化された購入に関する詳細情報を取得し、その情報でバックエンドのデータを更新してください。

無効化された購入そのものに関する詳細情報を取得するには、当社のアプリ内無効化購入の統合に関するガイドに従ってください。

FAQ​

購入に関する詳細情報を取得するにはどうすればよいですか?​

購入に関する詳細情報を取得するには、利用可能な情報に基づいた完全な情報を持つ利用可能な API をご確認ください。