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)
  },

  // 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)

必要欄位。計算稅金的使用者地址。
聯集欄位 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, NICOBARSH", "ANDHRA PRADESH", "ANDHRA PRADESH", "BIHAR", "CHANDIGARH", "CHHATTISGARSH"

方法

createexternaltransaction

 建立新的外部交易。

getexternaltransaction

 取得現有的外部交易。

refundexternaltransaction

 針對現有外部交易辦理退款或部分退款。