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)

示例

以下是一个示例请求：

curl -X GET \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  'https://androidpublisher.googleapis.com/androidpublisher/v3/applications/com.some.thing/purchases/voidedpurchases?endTime=1678886400000&includeQuantityBasedPartialRefund=true&maxResults=10&startIndex=0&startTime=1676208000000&token=SAMPLE_PAGINATION_TOKEN&type=1'

以下是示例响应：

{
  "pageInfo": {
    "resultPerPage": 10,
    "startIndex": 0,
    "totalResults": 25
  },
  "tokenPagination": {
    "nextPageToken": "c3RhdGVfZm9yX3BhZ2VfMg==",
    "previousPageToken": null
  },
  "voidedPurchases": [
    {
      "kind": "androidpublisher#voidedPurchase",
      "orderId": "GPA.3315-1234-5678-90123",
      "purchaseTimeMillis": "1678886400000",
      "purchaseToken": "aebkhenchpfeidbefgkcjmfi.AO-J1OykGjJh9r_V7_v0kI6bA4v88e5c44f4e0c4b4a8e0e4f4g4h4i4j4k4l4m4n4o4p4q4r4s4t4u4v4w4x4y4z",
      "voidedQuantity": 1,
      "voidedReason": 1,
      "voidedSource": 0,
      "voidedTimeMillis": "1678972800000"
    },
    {
      "kind": "androidpublisher#voidedPurchase",
      "orderId": "GPA.3377-9876-5432-10987.0",
      "purchaseTimeMillis": "1678713600000",
      "purchaseToken": "fkgdjdmfgmcmflekdgmdncj.AO-J1OyU6sXvB9LqRt3jD2wZ_pE8gXyF5hT3mN1zK0aP7bV4qL9cO6iR2sD0kM7oU1bL8jI3sF5tY9vU4wO1eP2g",
      "voidedQuantity": 1,
      "voidedReason": 7,
      "voidedSource": 2,
      "voidedTimeMillis": "1678800000000"
    }
  ]
}

授权范围

需要以下 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。仅当启用令牌分页时，才能使用此参数。