列出已取消、退款或已退單的購買交易。
HTTP 要求
GET https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/purchases/voidedpurchases
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
packageName |
必須傳回作廢交易的應用程式套件名稱 (例如「com.some.thing」)。 |
查詢參數
參數 | |
---|---|
pageSelection.maxResults |
定義清單作業應傳回的結果數量。預設數量取決於資源集合。 |
pageSelection.startIndex |
定義要傳回的第一個元素的索引。只有在已啟用已建立索引的分頁功能時,才能使用這個選項。 |
pageSelection.token |
定義要傳回網頁的符記 (通常來自 TokenPagination)。只有在已啟用權杖分頁功能的情況下,才能使用這個引數。 |
startTime |
您要在回應中查看的最早作廢交易時間 (以毫秒為單位)。這個參數的值不得超過 30 天,如果已設定分頁符記,則將遭到忽略。預設值為目前時間減 30 天。注意:這個篩選器會在系統判定記錄已經作廢時套用,而不是在回應中傳回的實際作廢時間。 |
endTime |
距離 Epoch 紀元時間起算,且想在回應中查看的最新作廢交易所花費的時間 (以毫秒為單位)。這個參數的值不得大於目前時間,如果設定了分頁符記,則將遭到忽略。預設值為目前時間。注意:這個篩選器會在系統判定記錄已經作廢時套用,而不是在回應中傳回的實際作廢時間。 |
type |
你想在回應中查看的作廢交易類型。可能的值包括:0。系統只會在回應中傳回作廢的應用程式內產品購買交易。此為預設值。1. 應用程式內購買交易和作廢的訂閱項目交易都會在回應中傳回。 注意:在要求接收作廢的訂閱交易之前,您必須在回應中使用 orderId,以便識別一次性消費和訂閱項目。否則,您會以同一個 PurchaseToken 收到多筆訂閱訂單,因為續訂訂單共用同一個 PurchaseToken。 |
includeQuantityBasedPartialRefund |
選用設定。是否加入作廢交易時,依數量提供的部分退款,僅適用於多件購買交易。如為 true,系統可能會退還其他作廢的交易,並傳回 voidedQuantity,表示依數量計算的部分退款金額。預設值為否。 |
要求主體
要求主體必須為空白。
回應主體
voidedpurchases.list API 的回應。
如果成功,回應主體會含有以下結構的資料:
JSON 表示法 |
---|
{ "pageInfo": { object ( |
欄位 | |
---|---|
pageInfo |
一般分頁資訊。 |
tokenPagination |
權杖分頁的分頁資訊。 |
voidedPurchases[] |
|
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/androidpublisher
PageSelection
pageSelection 要求參數類型,用來定義 voidedpurchases.list 作業應傳回的結果和結果數量。
JSON 表示法 |
---|
{ "maxResults": integer, "startIndex": integer, "token": string } |
欄位 | |
---|---|
maxResults |
定義清單作業應傳回的結果數量。預設數量取決於資源集合。 |
startIndex |
定義要傳回的第一個元素的索引。只有在已啟用已建立索引的分頁功能時,才能使用這個選項。 |
token |
定義要傳回網頁的符記 (通常來自 TokenPagination)。只有在已啟用權杖分頁功能的情況下,才能使用這個引數。 |