Method: purchases.voidedpurchases.list

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

HTTP-запрос

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

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

includeQuantityBasedPartialRefund

boolean

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

Тело запроса

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

Тело ответа

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

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

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. Это можно использовать только в том случае, если включен пейджинг токенов.