REST Resource: purchases.productsv2

リソース: ProductPurchaseV2

ProductPurchaseV2 リソースは、ユーザーのアプリ内アイテム購入のステータスを示します。

JSON 表現 
{
  "productLineItem": [
    {
      object (ProductLineItem)
    }
  ],
  "kind": string,
  "purchaseStateContext": {
    object (PurchaseStateContext)
  },
  "testPurchaseContext": {
    object (TestPurchaseContext)
  },
  "orderId": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string,
  "regionCode": string,
  "purchaseCompletionTime": string,
  "acknowledgementState": enum (AcknowledgementState)
}
フィールド
productLineItem[]

object (ProductLineItem)

ProductPurchaseV2 のアイテム単位の情報が含まれます。
kind

string

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

object (PurchaseStateContext)

購入の購入ステータスに関する情報。
testPurchaseContext

object (TestPurchaseContext)

テスト購入に関する情報。これはテスト購入の場合にのみ設定されます。
orderId

string

アプリ内アイテムの購入に関連付けられているオーダー ID。購入に関連付けられた注文がない場合は設定できません。
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 形式）。
purchaseCompletionTime

string (Timestamp format)

購入が成功した時刻（PurchaseState が PURCHASED に変更された時刻）。このフィールドは、お支払いが完了するまで表示されません。たとえば、ユーザーが保留中の取引（https://developer.android.com/google/play/billing/integrate#pending)）を開始した場合、ユーザーが取引を完了するために必要な手順を正常に完了するまで、このフィールドには値が入力されません。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
acknowledgementState

enum (AcknowledgementState)

出力専用。購入の承認状態。

PurchaseStateContext

購入ステータスに関するコンテキスト。

JSON 表現 
{
  "purchaseState": enum (PurchaseState)
}
フィールド
purchaseState

enum (PurchaseState)

出力専用。購入の購入ステータス。

PurchaseState

購入の状態。

列挙型
PURCHASE_STATE_UNSPECIFIED 購入ステータスは指定されていません。この値は決して設定しないでください。
PURCHASED 購入が完了しました。
CANCELLED 注文がキャンセルされました。
PENDING 購入は保留中であり、まだ完了していません。保留中の購入の処理について詳しくは、https://developer.android.com/google/play/billing/integrate#pending をご覧ください。

TestPurchaseContext

テスト購入に関するコンテキスト。

JSON 表現 
{
  "fopType": enum (FopType)
}
フィールド
fopType

enum (FopType)

テスト購入の fop タイプ。

FopType

使用できる fop のタイプ。

列挙型
FOP_TYPE_UNSPECIFIED 販売者タイプが指定されていません。この値は決して設定しないでください。
TEST テストカードを使用して購入された。

ProductLineItem

ProductPurchaseV2 のアイテム単位の情報が含まれます。

JSON 表現 
{
  "productId": string,
  "productOfferDetails": {
    object (ProductOfferDetails)
  }
}
フィールド
productId

string

購入したアイテムの ID（例: 「monthly001」）。
productOfferDetails

object (ProductOfferDetails)

このアイテムの特典詳細。

ProductOfferDetails

購入項目に関する特典の詳細情報。

JSON 表現 
{
  "offerTags": [
    string
  ],
  "offerId": string,
  "purchaseOptionId": string,
  "rentOfferDetails": {
    object (RentOfferDetails)
  },
  "offerToken": string,
  "quantity": integer,
  "refundableQuantity": integer,
  "consumptionState": enum (ConsumptionState)
}
フィールド
offerTags[]

string

特典に関連付けられた最新の特典タグ。購入オプションから継承されたタグを含みます。
offerId

string

特典 ID。特典でのみ存在します。
purchaseOptionId

string

購入オプション ID。
rentOfferDetails

object (RentOfferDetails)

レンタル オファーの詳細を提供する。これは、レンタルの広告申込情報にのみ設定されます。
offerToken

string

この購入広告申込情報の作成に使用されたトランザクションごとの特典トークン。
quantity

integer

アプリ内アイテムの購入に関連付けられている数量。
refundableQuantity

integer

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

enum (ConsumptionState)

出力専用。購入の消費状態。

RentOfferDetails

この型にはフィールドがありません。

レンタル項目に関する特典の詳細情報。

ConsumptionState

考えられる消費状態。

列挙型
CONSUMPTION_STATE_UNSPECIFIED 消費状態は指定されていません。この値は決して設定しないでください。
CONSUMPTION_STATE_YET_TO_BE_CONSUMED 未消費。
CONSUMPTION_STATE_CONSUMED すでに消費済み。

AcknowledgementState

1 回限りのアイテムの承認状態。

列挙型
ACKNOWLEDGEMENT_STATE_UNSPECIFIED 未指定の承認状態。
ACKNOWLEDGEMENT_STATE_PENDING 購入はまだ承認されていません。
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED 購入は承認されます。

メソッド

getproductpurchasev2

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