REST Resource: purchases.products

リソース: ProductPurchase

ProductPurchase リソースは、ユーザーのアプリ内でのアイテム購入の状態を示します。

JSON 表現
{
  "kind": string,
  "purchaseTimeMillis": string,
  "purchaseState": integer,
  "consumptionState": integer,
  "developerPayload": string,
  "orderId": string,
  "purchaseType": integer,
  "acknowledgementState": integer,
  "purchaseToken": string,
  "productId": string,
  "quantity": integer,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string,
  "regionCode": string,
  "refundableQuantity": integer
}
フィールド
kind

string

この kind は、androidpublisher サービスの inappPurchase オブジェクトを表します。

purchaseTimeMillis

string (int64 format)

商品が購入された時刻を、エポック(1970 年 1 月 1 日)からのミリ秒で示します。

purchaseState

integer

オーダーの購入状態。値は次のいずれかです。0. 購入済み 1. キャンセル済み 2. 保留

consumptionState

integer

アプリ内アイテムの消費状態。値は次のいずれかです。0. 未消費 1. 消費しました

developerPayload

string

注文に関する補足情報が含まれる文字列で、デベロッパーが指定します。

orderId

string

アプリ内アイテムの購入に関連付けられているオーダー ID。

purchaseType

integer

アプリ内アイテムの購入の種類。このフィールドは、標準のアプリ内課金フローを使用して処理された定期購入ではない場合にのみ設定します。値は次のいずれかです。0. テスト(ライセンス テスト用アカウントでの購入)、1. プロモーション(プロモーション コードを使用した購入)。Play ポイントによる購入は含まれません。2. リワード(支払いではなく、動画広告の視聴によるもの)

acknowledgementState

integer

アプリ内アイテムの承認状態。値は次のいずれかです。0. 未承認、1. 確認済み

purchaseToken

string

この購入を識別するために生成された購入トークン。存在しない場合があります。

productId

string

アプリ内アイテムの SKU。存在しない場合があります。

quantity

integer

アプリ内アイテムの購入に関連付けられている数量。存在しない場合、数量は 1 です。

obfuscatedExternalAccountId

string

アプリのユーザー アカウントに一意に関連付けられている難読化されたバージョンの ID。購入時に https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid を使用して指定された場合にのみ存在します。

obfuscatedExternalProfileId

string

アプリのユーザー プロファイルに一意に関連付けられている難読化されたバージョンの ID。購入時に https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid を使用して指定された場合にのみ存在します。

regionCode

string

アイテムが承認された時点でのユーザーの請求先住所の地域コード(ISO 3166-1 alpha-2 形式)。

refundableQuantity

integer

払い戻しの対象となる数量(払い戻しが行われていない数量)。値には、数量ベースの一部払い戻しと全額払い戻しが反映されます。

メソッド

acknowledge

アプリ内アイテムの購入を承認します。

consume

アプリ内アイテムの購入を消費します。

get

アプリ内アイテムの購入と消費のステータスを確認します。