アプリ内課金(IAP)プラグインのメソッドとイベント


アプリ内課金(IAP)プラグインのメソッドとイベント

はじめに

このドキュメントでは、アプリ内課金(IAP)v2.0プラグインについて、サポートされているクロスプラットフォームエンジンで使用可能なメソッドとイベントの概要を示します。

プラグインのメソッド

リクエストは、メソッド呼び出しとして開始されます。使用可能なメソッドを次の表に示します。戻り値の型がRequestOutputのメソッドは、非同期のイベント(システムで生成されたメッセージ)を受け取ります。パラメーターとイベントについては、この後の関連データオブジェクトの表を参照してください。

戻り値の型 メソッド メソッドの概要 イベント
RequestOutput GetUserData() 現在ログインしているユーザーのユーザーIDおよびマーケットプレイスを取得するリクエストを開始します。 GetUserDataResponse
RequestOutput Purchase(SkuInput input) 商品の購入フローを開始します。 PurchaseResponse
RequestOutput GetProductData(SkusInput input) 最大100個のSKUのアイテムデータを取得するリクエストを開始します。 GetProductDataResponse
RequestOutput GetPurchaseUpdates(ResetInput input) ユーザーが購入またはキャンセルしたアイテムに関するアップデートを取得するリクエストを開始します。 GetPurchaseUpdatesResponse
void NotifyFulfillment(NotifyFulfillmentInput input) 購入アイテムの付与完了についてAmazonに通知します。 なし

関連データオブジェクト

次の表では、メソッドやイベントのパラメーターとして使用されるオブジェクトについて説明します。

オブジェクト メンバー 説明
AmazonUserData string userId ユーザーID。
string marketplace ユーザーのマーケットプレイスを示す2文字のISO 3166-1 Alpha-2コード。マーケットプレイス情報を入手できない場合はnullになります。以前のバージョンのAmazonアプリストアでは、そのケースが発生する可能性があります。
GetProductDataResponse string requestId GetProductDataから返されたリクエストID。
ProductDataMap productDataMap ProductDataMapを参照してください。
List < string > unavaliableSkus 元のリクエストで指定されたSKUのうち、商品データが入手できないSKUのリスト。
string status SUCCESSFUL、NOT_SUPPORTED、FAILEDのいずれか。SUCCESSFULは、リクエストが成功したことを示します。NOT_SUPPORTEDは、この呼び出しがサポートされていないことを示します。FAILEDは、リクエストが失敗したことを示します。
GetPurchaseUpdatesResponse string requestId GetPurchaseUpdatesから返されたリクエストID。
AmazonUserData amazonUserData AmazonUserDataを参照してください。
List <PurchaseReceipt> receipts レシートのリストを返します。ステータスがSUCCESSFULでない場合やレシートがない場合は、空のリストを返します。
string status SUCCESSFUL、NOT_SUPPORTED、FAILEDのいずれか。SUCCESSFULは、リクエストが成功したことを示します。NOT_SUPPORTEDは、この呼び出しがサポートされていないことを示します。FAILEDは、リクエストが失敗したことを示します。
boolean hasMore 結果がさらに存在する場合はtrue。
GetUserDataResponse string requestId GetUserDataから返されたリクエストID。
AmazonUserData amazonUserData AmazonUserDataを参照してください。
string status SUCCESSFUL、NOT_SUPPORTED、FAILEDのいずれか。SUCCESSFULは、リクエストが成功したことを示します。NOT_SUPPORTEDは、この呼び出しがサポートされていないことを示します。FAILEDは、リクエストが失敗したことを示します。
NotifyFulfillmentInput string receiptId レシートID。購入の一意の識別子であり、購入レスポンスの一部として返されます。
string fulfillmentResult FULFILLEDまたはUNAVAILABLE。FULFILLEDは、アプリで購入が正常に完了したことを意味します。このステータスを指定して呼び出すと、Amazonアプリストアで、この購入が正常に完了したものとしてマークされます。UNAVAILABLEは、アプリで購入を完了できないことを意味します。このステータスを指定して呼び出すと、Amazonアプリストアで購入が強制的にキャンセルされます。
ProductData string sku 購入のSKU。
string productType 商品の種類。CONSUMABLE(消費型アイテム)、ENTITLED(非消費型アイテム)、SUBSCRIPTION(定期購入型アイテム)のいずれかです。詳細については、アプリ内課金(IAP)の概要を参照してください。
string price 商品の価格。通貨記号と数値を含みます。定期購入型アイテムの親商品ではnullになります。
string title ローカライズされた商品タイトル。ロケールに対応するタイトルがない場合は、デフォルト値(英語)を返します。
string description ローカライズされた商品説明。ロケールに対応する説明がない場合は、デフォルト値(英語)を返します。
string smallIconUrl 小アイコンのURL。
ProductDataMap キー:string sku SKUをキーとして使用し、ProductDataオブジェクトを値として使用するマップ。
値: ProductData productData
PurchaseReceipt string receiptId レシートID。購入の一意の識別子です。
long cancelDate 購入のキャンセル日。1970年1月1日00:00:00 GMTからのミリ秒単位で表されます。キャンセルされていない場合は0になります。
long purchaseDate 購入日。1970年1月1日00:00:00 GMTからのミリ秒単位で表されます。
string sku 購入のSKU。定期購入型アイテムの場合、このSKUは、特定の期間ではなく、定期購入を表します。定期購入の開始日と終了日を特定するには、PurchaseDateCancelDateを調べます。
string productType 商品の種類。CONSUMABLE(消費型アイテム)、ENTITLED(非消費型アイテム)、SUBSCRIPTION(定期購入型アイテム)のいずれかです。詳細については、アプリ内課金(IAP)の概要を参照してください。
PurchaseResponse string requestId Purchaseから返されたリクエストID。
AmazonUserData amazonUserData AmazonUserDataを参照してください。
PurchaseReceipt purchaseReceipt PurchaseReceiptを参照してください。
string status SUCCESSFUL、NOT_SUPPORTED、FAILED、INVALID_SKU、ALREADY_PURCHASEDのいずれか。SUCCESSFULは、リクエストが成功したことを示します。NOT_SUPPORTEDは、この呼び出しがサポートされていないことを示します。FAILEDは、リクエストが失敗したことを示します。INVALID_SKUは、Purchaseオペレーションに指定された元のSKUが有効でないことを示します。ALREADY_PURCHASEDは、指定されたSKUをユーザーが既に所有していることを示します。
RequestOutput string requestId アプリ内課金リクエストの一意のID。
ResetInput boolean reset すべての購入のリストを取得するには、trueに設定します。前回の呼び出し以降に行われた購入のリストを取得するには、falseに設定します。
SkuInput string sku SKUは、購入可能な商品の一意の識別子です。SKUは、Amazonアプリストアの開発者アカウントごとに固有になります。これは、英数字、アンダースコア、ピリオド、ダッシュのみから成る文字列で、大文字と小文字が区別されます。150文字以下にする必要があります。
SkusInput List <string> skus SKUのリスト。