Method: purchases.voidedpurchases.list

列出已取消、已退款或已退費的購買交易。

HTTP 要求

GET https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/purchases/voidedpurchases

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
packageName

string

必須退回作廢交易的應用程式套件名稱 (例如「com.some.thing」)。

查詢參數

參數
pageSelection.maxResults

integer (uint32 format)

定義清單作業應傳回的結果數量。預設數量取決於資源集合。
pageSelection.startIndex

integer (uint32 format)

定義要傳回的第一個元素的索引。只有在啟用已建立索引的分頁的情況下，才能使用這個做法。
pageSelection.token

string

定義要傳回的網頁權杖，通常來自 TokenPagination。只有在已啟用權杖分頁功能的情況下，才能使用這個做法。
startTime

string (int64 format)

您想在回應中看到的最舊交易從 Epoch 紀元時間起算的時間，以毫秒為單位。這項參數的值不得超過 30 天，如果設定分頁符記，則系統會忽略這個參數。預設值為目前時間減 30 天。注意：此篩選器會套用至系統認定記錄作廢的時間，而非回應中傳回的實際作廢時間。
endTime

string (int64 format)

您希望在回應中看到的最新作廢交易的時間 (以毫秒為單位)，自 Epoch 紀元時間起算。此參數的值不得大於目前時間；如果設定分頁符記，則系統會忽略這個參數。預設值為目前時間。注意：此篩選器會套用至系統認定記錄作廢的時間，而非回應中傳回的實際作廢時間。
type

integer

您想在回應中看到的作廢交易類型。可能的值包括：0。回覆中只會傳回作廢的應用程式內產品交易。此為預設值。1. 交易時，我們會一併傳回作廢的應用程式內購交易和作廢的訂閱項目交易。

注意： 要求接收作廢的訂閱購買交易之前，您必須先在回應中改用 orderId，這個 ID 可明確識別一次性消費和訂閱項目。否則，您會收到多筆訂閱憑證相同的 PurchaseToken，因為訂閱項目續約訂單會共用相同的 PurchaseToken。
includeQuantityBasedPartialRefund

boolean

選用設定。是否加入作廢的以數量為基準部分退款，這僅適用於多件購買交易。如果為 true，其他作廢的購買交易可能會傳回 voidedQuantity，指明相應數量的部分退款數量。預設值為否。

要求主體

要求主體必須為空白。

回應主體

voidedpurchases.list API 的回應。

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "pageInfo": {
    object (PageInfo)
  },
  "tokenPagination": {
    object (TokenPagination)
  },
  "voidedPurchases": [
    {
      object (VoidedPurchase)
    }
  ]
}
欄位
pageInfo

object (PageInfo)

一般分頁資訊。
tokenPagination

object (TokenPagination)

權杖分頁作業的分頁資訊。
voidedPurchases[]

object (VoidedPurchase)

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/androidpublisher

PageSelection

pageSelection 要求參數的類型，用於定義 voidedpurchases.list 作業應傳回哪些結果以及多少結果。

JSON 表示法 
{
  "maxResults": integer,
  "startIndex": integer,
  "token": string
}
欄位
maxResults

integer (uint32 format)

定義清單作業應傳回的結果數量。預設數量取決於資源集合。
startIndex

integer (uint32 format)

定義要傳回的第一個元素的索引。只有在啟用已建立索引的分頁的情況下，才能使用這個做法。
token

string

定義要傳回的網頁權杖，通常來自 TokenPagination。只有在已啟用權杖分頁功能的情況下，才能使用這個做法。