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,以便識別一次性購買和訂閱。否則,您會收到多個使用相同 PurchaseToken 的訂閱訂單,因為訂閱續訂訂單會共用相同的 PurchaseToken。

要求主體

要求主體必須為空白。

回應主體

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

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 要求參數的類型,用於定義 apks.list 作業應傳回的結果數量和數量。

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

integer (uint32 format)

定義清單作業應傳回多少結果。預設數字取決於資源集合。

startIndex

integer (uint32 format)

用於指定要傳回的第一個元素的索引。只有在已啟用建立索引的分頁的情況下才能使用這個選項。

token

string

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