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。

请求正文

请求正文必须为空。

响应正文

如果成功，响应正文将包含结构如下的数据：

对 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 操作应返回的结果数量和数量。

JSON 表示法 
{
  "maxResults": integer,
  "startIndex": integer,
  "token": string
}
字段
maxResults

integer (uint32 format)

定义列表操作应返回的结果数量。默认数量取决于资源集合。
startIndex

integer (uint32 format)

定义要返回的第一个元素的索引。只有在启用了分页分页的情况下，才能使用此参数。
token

string

定义要返回的页面的令牌（通常从 TokenPagination 获取）。只有在启用了令牌分页的情况下，才能使用此参数。