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

此类型代表 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 规范化（即转换为 UTC 零时区格式并在末尾附加 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 未指定 fop 类型。此值不应设置。
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)
  },
  "preorderOfferDetails": {
    object (PreorderOfferDetails)
  },
  "offerToken": string,
  "quantity": integer,
  "refundableQuantity": integer,
  "consumptionState": enum (ConsumptionState)
}
字段
offerTags[]

string

与优惠相关联的最新优惠标记。这包括从购买选项继承的标记。
offerId

string

优惠 ID。仅针对优惠显示。
purchaseOptionId

string

购买选项 ID。
rentOfferDetails

object (RentOfferDetails)

有关租用优惠的优惠详情。此字段仅针对租用订单项设置。
preorderOfferDetails

object (PreorderOfferDetails)

预订优惠的优惠详情。此字段仅针对预订设置。
offerToken

string

用于创建此购买订单项的每笔交易优惠令牌。
quantity

integer

与应用内商品购买相关的数量。
refundableQuantity

integer

符合退款条件的数量，即尚未退款的数量。该值反映基于数量的部分退款和全额退款。
consumptionState

enum (ConsumptionState)

仅限输出。购买交易的消耗状态。

RentOfferDetails

此类型没有字段。

与租用订单项相关的优惠详情。

PreorderOfferDetails

与预订订单项相关的优惠详情。

JSON 表示法 
{
  "preorderReleaseTime": string
}
字段
preorderReleaseTime

string (Timestamp format)

预订商品在预订购买交易中发布的时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

ConsumptionState

可能的消耗状态。

枚举
CONSUMPTION_STATE_UNSPECIFIED 未指定消耗状态。此值不应设置。
CONSUMPTION_STATE_YET_TO_BE_CONSUMED 尚未消耗。
CONSUMPTION_STATE_CONSUMED 已消耗。

AcknowledgementState

一次性商品的确认状态。

枚举
ACKNOWLEDGEMENT_STATE_UNSPECIFIED 未指定确认状态。
ACKNOWLEDGEMENT_STATE_PENDING 购买交易尚未确认。
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED 购买交易已确认。

方法

getproductpurchasev2

 检查应用内商品的购买和消耗状态。

错误代码

此资源相关操作将返回以下 HTTP 错误代码：

错误代码 原因 说明 解决方案