REST Resource: externaltransactions

资源：ExternalTransaction

外部交易的详细信息。

JSON 表示法 
{
  "packageName": string,
  "externalTransactionId": string,
  "originalPreTaxAmount": {
    object (Price)
  },
  "originalTaxAmount": {
    object (Price)
  },
  "currentPreTaxAmount": {
    object (Price)
  },
  "currentTaxAmount": {
    object (Price)
  },
  "testPurchase": {
    object (ExternalTransactionTestPurchase)
  },
  "transactionTime": string,
  "createTime": string,
  "transactionState": enum (TransactionState),
  "userTaxAddress": {
    object (ExternalTransactionAddress)
  },
  "transactionProgramCode": integer,

  // Union field transaction_type can be only one of the following:
  "oneTimeTransaction": {
    object (OneTimeExternalTransaction)
  },
  "recurringTransaction": {
    object (RecurringExternalTransaction)
  }
  // End of list of possible types for union field transaction_type.
}
字段
packageName

string

仅限输出。外部交易的资源名称。售出了相应应用内商品的应用的软件包名称（例如：“com.some.app”）。
externalTransactionId

string

仅限输出。相应交易的 ID。同一软件包名称下的所有交易 ID 必须具有唯一性。在创建外部交易时设置。
originalPreTaxAmount

object (Price)

必需。最初的税前交易金额。表示最初向 Google 通知的税前金额，是未执行任何退款之前的金额。
originalTaxAmount

object (Price)

必需。最初的税费金额。表示最初向 Google 通知的税费金额，是未执行任何退款之前的金额。
currentPreTaxAmount

object (Price)

仅限输出。税前的当前交易金额。表示当前税前金额，包含可能已针对相应交易执行的所有退款。
currentTaxAmount

object (Price)

仅限输出。当前税费金额。表示当前税费金额，包含可能已针对相应交易执行的所有退款。
testPurchase

object (ExternalTransactionTestPurchase)

仅限输出。如果已设置，则表示相应交易是一项购买测试。Google 不会对测试交易收费。
transactionTime

string (Timestamp format)

必需。完成交易的时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
createTime

string (Timestamp format)

仅限输出。创建相应交易的时间。这是将相应交易通知 Google 的时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
transactionState

enum (TransactionState)

仅限输出。交易的当前状态。
userTaxAddress

object (ExternalTransactionAddress)

必需。用于计算税费的用户地址。
transactionProgramCode

integer

可选。交易计划代码，用于帮助确定参与合作伙伴计划的符合条件的应用的服务费。参与 Play 媒体体验计划 (https://play.google.com/console/about/programs/mediaprogram/) 的开发者在报告备选结算系统交易时，必须提供计划代码。如果您是符合条件的开发者，请与您的 BDM 联系，详细了解如何设置此字段。注意：此字段不能用于外部商品交易。
联合字段 transaction_type。所执行的交易类型。transaction_type 只能是下列其中一项：
oneTimeTransaction

object (OneTimeExternalTransaction)

这是一次性交易，不是订阅的一部分。
recurringTransaction

object (RecurringExternalTransaction)

相应交易是一系列周期性交易的一部分。

ExternalTransactionTestPurchase

此类型没有字段。

表示使用测试账号执行的交易。Google 不会对这些交易收费。

OneTimeExternalTransaction

表示一次性交易。

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

string

仅限输入。在调用 Create 期间提供。在启动备选结算流程时从客户端检索。

RecurringExternalTransaction

表示一笔交易，该交易是一系列周期性付款的一部分。可以是包含多笔付款的订阅或一次性商品（例如预订）。

JSON 表示法 
{

  // Union field source can be only one of the following:
  "initialExternalTransactionId": string,
  "externalTransactionToken": string,
  "migratedTransactionProgram": enum (ExternalTransactionProgram)
  // End of list of possible types for union field source.

  // Union field product_details can be only one of the following:
  "externalSubscription": {
    object (ExternalSubscription)
  },
  "otherRecurringProduct": {
    object (OtherRecurringProduct)
  }
  // End of list of possible types for union field product_details.
}
字段

联合字段 source。

source 只能是下列其中一项：
initialExternalTransactionId

string

该系列周期性交易中第一笔交易的外部交易 ID。例如，对于订阅，其值为第一笔付款的交易 ID。在创建周期性外部交易时为必需。
externalTransactionToken

string

仅限输入。在调用 Create 期间提供。在启动备选结算流程时从客户端检索。仅首次购买时为必需。
migratedTransactionProgram

enum (ExternalTransactionProgram)

仅限输入。在调用 Create 期间提供。仅可在将订阅从手动每月报告迁移至自动报告时使用。
联合字段 product_details。必需。周期性外部交易的商品详情信息。product_details 只能是下列其中一项：
externalSubscription

object (ExternalSubscription)

外部订阅的详细信息。
otherRecurringProduct

object (OtherRecurringProduct)

不属于任何其他特定类别的周期性外部交易商品的详细信息。

ExternalTransactionProgram

表示用户完成交易所体验的外部交易计划。

枚举
EXTERNAL_TRANSACTION_PROGRAM_UNSPECIFIED 未指定交易计划。未使用。
USER_CHOICE_BILLING 用户自选结算方式，即用户可以在 Google Play 结算服务和开发者管理的结算服务之间进行选择。
ALTERNATIVE_BILLING_ONLY 仅限备选结算系统，即用户仅可使用开发者管理的结算服务。

ExternalSubscription

外部订阅的详细信息。

JSON 表示法 
{
  "subscriptionType": enum (SubscriptionType)
}
字段
subscriptionType

enum (SubscriptionType)

必需。外部订阅的类型。

SubscriptionType

外部订阅的类型。

枚举
SUBSCRIPTION_TYPE_UNSPECIFIED 未指定，请勿使用。
RECURRING 这是周期性订阅，即在每个结算周期向用户收费。
PREPAID 这是预付款订阅，即用户需提前付款。

OtherRecurringProduct

此类型没有字段。

不属于任何其他更具体类别的周期性外部交易商品的详细信息。

TransactionState

正在进行的交易的状态。

枚举
TRANSACTION_STATE_UNSPECIFIED 未指定交易状态。未使用。
TRANSACTION_REPORTED 交易已成功报告给 Google。
TRANSACTION_CANCELED 交易已成功全额退款。

ExternalTransactionAddress

用于外部交易的用户地址。

JSON 表示法 
{
  "regionCode": string,
  "administrativeArea": string
}
字段
regionCode

string

必需。基于 ISO-3166-1 Alpha-2（联合国地区代码）的双字母地区代码。
administrativeArea

string

可选。国家/地区的顶级行政区划。仅对于印度交易为必需。有效值包括“ANDAMAN AND NICOBAR ISLANDS”“ANDHRA PRADESH”“ARUNACHAL PRADESH”“ASSAM”“BIHAR”“CHANDIGARH”“CHHATTISGARH”“DADRA AND NAGAR HAVELI”“DADRA AND NAGAR HAVELI AND DAMAN AND DIU”“DAMAN AND DIU”“DELHI”“GOA”“GUJARAT”“HARYANA”“HIMACHAL PRADESH”“JAMMU AND KASHMIR”“JHARKHAND”“KARNATAKA”“KERALA”“LADAKH”“LAKSHADWEEP”“MADHYA PRADESH”“MAHARASHTRA”“MANIPUR”“MEGHALAYA”“MIZORAM”“NAGALAND”“ODISHA”“PUDUCHERRY”“PUNJAB”“RAJASTHAN”“SIKKIM”“TAMIL NADU”“TELANGANA”“TRIPURA”“UTTAR PRADESH”“UTTARAKHAND”和“WEST BENGAL”。

方法

createexternaltransaction

 创建新的外部交易。

getexternaltransaction

 获取现有外部交易。

refundexternaltransaction

 针对现有外部交易进行退款或部分退款。