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)

您想在响应中看到的最早作废的购买交易的时间（以自纪元以来的毫秒数表示）。此参数的值不得超出 30 天，如果设置了分页令牌，则会被忽略。默认值为当前时间减去 30 天。注意：此过滤条件应用于系统认为记录作废的时间，而不是响应中返回的实际作废时间。
endTime

string (int64 format)

您想在响应中看到的最新作废的购买交易的时间（以自纪元以来的毫秒数表示）。此参数的值不能大于当前时间，如果已设置分页令牌，系统会忽略该值。默认值为当前时间。注意：此过滤条件应用于系统认为记录作废的时间，而不是响应中返回的实际作废时间。
type

integer

您想在响应中看到的已作废购买交易的类型。可能的值包括：0。响应中只会返回已作废的应用内商品购买交易。此设置为默认值。 1. 已作废的应用内购买交易和已作废的订阅购买交易将在响应中返回。

注意：在请求接收已作废的订阅购买交易之前，您必须在响应中改用 orderId，此 ID 可唯一标识一次性购买交易和订阅。否则，您将收到采用同一 PurchaseToken 的多个订阅订单，因为订阅续订订单会共用同一个 PurchaseToken。
includeQuantityBasedPartialRefund

boolean

可选。是否应包含已作废的部分退款购买交易（仅适用于多件购买交易）。如果为 true，系统可能会通过 voidedQuantity 返回其他作废的购买交易，用于表示基于数量的部分退款的退款数量。默认值为 false。

请求正文

请求正文必须为空。

响应正文

对 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。此方法只能在启用令牌分页的情况下使用。