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,
  "externalOfferInitialAcquisitionDetails": {
    object (ExternalOfferInitialAcquisitionDetails)
  },

  // 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/) 的开发者在报告备选结算系统交易时必须提供计划代码。如果您是符合条件的开发者,请与您的业务发展经理联系,详细了解如何设置此字段。注意:此字段不能用于外部优惠交易。

externalOfferInitialAcquisitionDetails

object (ExternalOfferInitialAcquisitionDetails)

可选。有关用户/设备首次使用外部优惠完成交易的详细信息。对于使用用户自选结算方式或仅限备选结算系统进行的交易,不需要提供此属性。

联合字段 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" "ANDAMAN AND NICOBAR NICOBAR ISLANDS", "ANDHRA PRA "

ExternalOfferInitialAcquisitionDetails

有关用户/设备首次使用外部优惠完成交易的详细信息。

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

string

必需。用户完成的首次购买交易的外部交易 ID。

方法

createexternaltransaction

创建新的外部事务。

getexternaltransaction

获取现有的外部事务。

refundexternaltransaction

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