REST Resource: externaltransactions

資源：外部事務

外部交易的詳細資訊。

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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "oneTimeTransaction": {
    object (OneTimeExternalTransaction)
  },
  "recurringTransaction": {
    object (RecurringExternalTransaction)
  }
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "externalOfferDetails": {
    object (ExternalOfferDetails)
  },
  "externalContentLinkDetails": {
    object (ExternalContentLinkDetails)
  }
  // End of mutually exclusive fields.
}
欄位
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)

必填。交易完成的時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
createTime

string (Timestamp format)

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

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
transactionState

enum (TransactionState)

僅供輸出。交易目前的狀態。
userTaxAddress

object (ExternalTransactionAddress)

必填。用於計算稅額的使用者地址。
transactionProgramCode

integer

(選用步驟) 交易計畫代碼，用於判斷參與合作夥伴計畫的合格應用程式服務費。加入 Play 媒體體驗計畫 (https://play.google.com/console/about/programs/mediaprogram/) 的開發人員回報其他結帳系統交易時，必須提供計畫代碼。如果您是符合資格的開發人員，請與商務拓展經理聯絡，進一步瞭解如何設定這個欄位。注意：此欄位不能用於外部交易。
所執行的交易類型。以下列出互斥的欄位。回應中最多只會設定一個欄位：
oneTimeTransaction

object (OneTimeExternalTransaction)

這是一次性交易，不屬於訂閱項目。
recurringTransaction

object (RecurringExternalTransaction)

此交易是系列定期交易的一部分。
互斥欄位的結尾。
交易報表所需的方案特定詳細資料。詳細資料只能針對與交易相關聯的計畫設定。以下列出互斥的欄位。回應中最多只會設定一個欄位：
externalOfferDetails

object (ExternalOfferDetails)

(選用步驟) 準確回報外部優惠交易的必要詳細資料。
externalContentLinkDetails

object (ExternalContentLinkDetails)

(選用步驟) 準確回報外部內容連結交易的必要詳細資料。
互斥欄位的結尾。

ExternalTransactionTestPurchase

這個類型沒有任何欄位。

表示使用測試帳戶執行的交易。Google 不會收取這類交易的費用。

OneTimeExternalTransaction

代表一次性交易。

JSON 表示法 
{
  "externalTransactionToken": string
}
欄位
externalTransactionToken

string

僅供輸入。在呼叫 Create 時提供。啟動其他結帳系統流程時，從用戶端擷取。

RecurringExternalTransaction

代表週期性付款系列中的交易。這可能是訂閱項目，或需要多次付款的單次產品 (例如預購)。

JSON 表示法 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "initialExternalTransactionId": string,
  "externalTransactionToken": string,
  "migratedTransactionProgram": enum (ExternalTransactionProgram)
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "externalSubscription": {
    object (ExternalSubscription)
  },
  "otherRecurringProduct": {
    object (OtherRecurringProduct)
  }
  // End of mutually exclusive fields.
}
欄位
以下列出互斥的欄位。回應中最多只會設定一個欄位：
initialExternalTransactionId

string

此系列循環交易中第一筆交易的外部交易 ID。舉例來說，如果是訂閱項目，這就是第一筆款項的交易 ID。建立定期外部交易時需要此項。
externalTransactionToken

string

僅供輸入。在呼叫 Create 時提供。啟動其他結帳系統流程時，從用戶端擷取。僅首次購買時需要。
migratedTransactionProgram

enum (ExternalTransactionProgram)

僅供輸入。在呼叫 Create 時提供。只能用於將訂閱項目從手動月度回報遷移至自動回報。
互斥欄位的結尾。
必填。定期外部交易中的產品詳細資料。以下列出互斥的欄位。回應中最多只會設定一個欄位：
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 NA DIU」、「DELHI」、「GOA」、 「古吉拉特邦」、「哈里亞納邦」、「喜馬偕爾邦」、「查謨和克什米爾」、「賈坎德邦」、「卡納塔克邦」、「喀拉拉邦」、「拉達克」、「拉克沙威」、「中央邦」、「馬哈拉施特邦」、「喀拉拉邦」、梅邦加邦「奧裡薩邦」、「PUDUCHERRY」、「旁遮普邦」、「拉賈斯坦邦」、「錫金」、「泰米爾納德邦」、 「特蘭甘納邦」、「特里普拉邦」、「北方邦」、「北阿坎德邦」和「西孟加拉邦」。

ExternalOfferDetails

報告外部優惠計畫特有的詳細資訊。

JSON 表示法 
{
  "linkType": enum (ExternalOfferLinkType),
  "installedAppPackage": string,
  "installedAppCategory": enum (ExternalOfferAppCategory),
  "appDownloadEventExternalTransactionId": string
}
欄位
installedAppPackage

string

(選用步驟) 透過這筆交易下載的應用程式套件名稱。如果 linkType 為 LINK_TO_APP_DOWNLOAD，則為必填欄位。
installedAppCategory

enum (ExternalOfferAppCategory)

(選用步驟) 透過這筆交易下載的應用程式類別。這必須與外部應用程式驗證程序期間在 Play 管理中心提供的類別相符。僅適用於應用程式下載。
appDownloadEventExternalTransactionId

string

(選用步驟) 透過外部連結與應用程式下載事件關聯的外部交易 ID。回報在外部安裝應用程式中進行的交易時，此為必填屬性。

ExternalOfferLinkType

外部連結類型。

列舉
LINK_TO_DIGITAL_CONTENT_OFFER 用來購買數位內容的優惠。

ExternalOfferAppCategory

下載應用程式的類別。如要進一步瞭解應用程式類別，請參閱 https://support.google.com/googleplay/android-developer/answer/9859673。

列舉
EXTERNAL_OFFER_APP_CATEGORY_UNSPECIFIED 未指定，請勿使用。
APP 應用程式會歸類在應用程式類別下。
GAME 應用程式歸類為遊戲。

ExternalContentLinkDetails

外部內容連結計畫專用的報表詳細資料。

JSON 表示法 
{
  "linkType": enum (ExternalContentLinkType),
  "installedAppPackage": string,
  "externalAppCategory": enum (ExternalContentAppCategory)
}
欄位
installedAppPackage

string

(選用步驟) 透過這筆交易下載的應用程式套件名稱。僅限應用程式安裝廣告。
externalAppCategory

enum (ExternalContentAppCategory)

(選用步驟) 下載的應用程式類別。此類別必須與在 Play 管理中心進行外部應用程式驗證過程中提供的類別一致。僅限應用程式安裝廣告。

ExternalContentLinkType

外部連結類型。

列舉
EXTERNAL_CONTENT_LINK_TYPE_UNSPECIFIED 未指定，請勿使用。
LINK_TO_DIGITAL_CONTENT_OFFER 用來購買數位內容的優惠。

ExternalContentAppCategory

下載應用程式的類別。如要進一步瞭解應用程式類別，請參閱 https://support.google.com/googleplay/android-developer/answer/9859673。

列舉
EXTERNAL_CONTENT_APP_CATEGORY_UNSPECIFIED 未指定，請勿使用。
APP 應用程式會歸類在應用程式類別下。
GAME 該應用程式被歸類為遊戲類應用程式。

方法

createexternaltransaction

 建立一個新的外部交易。

getexternaltransaction

 取得現有的外部交易。

refundexternaltransaction

 退款或部分退款現有的外部交易。

錯誤代碼

這項資源的作業會傳回下列 HTTP 錯誤碼：

錯誤代碼 原因 說明 解析度