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 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如 "2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
createTime

string (Timestamp format)

僅供輸出。建立此交易的時間。這是 Google 收到交易通知的時間。

RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如 "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

 退還或部分退還現有外部交易。