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

定義 voidedpurchases.list 作業應傳回哪些結果和結果數量的 pageSelection 要求參數類型。

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

integer (uint32 format)

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

integer (uint32 format)

定義要傳回的第一個元素的索引。只有在啟用索引分頁時才能使用。
token

string

定義要傳回的頁面符記，通常是從 TokenPagination 取得。只有在啟用權杖分頁時才能使用。