Method: purchases.voidedpurchases.list

Список покупок, которые были отменены, возвращены или оплачены повторно.

HTTP-запрос

GET https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/purchases/voidedpurchases

URL-адрес использует синтаксис gRPC Transcoding .

Параметры пути

Параметры
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 в ответе, который однозначно идентифицирует разовые покупки и подписки. В противном случае вы получите несколько заказов на подписку с одним и тем же PurchaseToken, поскольку заказы на продление подписки используют один и тот же PurchaseToken.

includeQuantityBasedPartialRefund

boolean

Необязательно. Включать ли аннулированные покупки частичных возвратов на основе количества, которые применимы только к покупкам с несколькими количествами. Если true, дополнительные аннулированные покупки могут быть возвращены с voidedQuantity, который указывает количество возврата частичного возврата на основе количества. Значение по умолчанию — false.

Текст запроса

Тело запроса должно быть пустым.

Тело ответа

Ответ для API voidedpurchases.list.

В случае успеха тело ответа содержит данные со следующей структурой:

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, который определяет, какие и сколько результатов должна возвращать операция voidedpurchases.list.

JSON-представление 
{
  "maxResults": integer,
  "startIndex": integer,
  "token": string
}
Поля
maxResults

integer ( uint32 format)

Определяет, сколько результатов должна возвращать операция списка. Число по умолчанию зависит от коллекции ресурсов.

startIndex

integer ( uint32 format)

Определяет индекс первого возвращаемого элемента. Может использоваться только при включенном индексированном разбиении на страницы.

token

string

Определяет токен страницы для возврата, обычно берется из TokenPagination. Может использоваться только если включено пейджинг токенов.