Method: purchases.voidedpurchases.list

Lista as compras que foram canceladas, reembolsadas ou estornadas.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
packageName

string

Nome do pacote do aplicativo para devolução das compras anuladas (por exemplo, "com.some.thing").

Parâmetros de consulta

Parâmetros
pageSelection.maxResults

integer (uint32 format)

Define quantos resultados a operação de listagem vai retornar. O número padrão depende da coleção de recursos.
pageSelection.startIndex

integer (uint32 format)

Define o índice do primeiro elemento a ser retornado. Só poderá ser usado se a paginação indexada estiver ativada.
pageSelection.token

string

Define o token da página a ser retornada, normalmente com TokenPagination. Só poderá ser usado se a paginação com tokens estiver ativada.
startTime

string (int64 format)

A hora, em milésimos de segundo, com base na época, da compra anulada mais antiga que você quer ver na resposta. O valor desse parâmetro não pode ser de mais de 30 dias e será ignorado se o token de paginação estiver definido. O valor padrão é o horário atual menos 30 dias. Observação: este filtro é aplicado no momento em que o registro é considerado nulo nos nossos sistemas, e não no momento da anulação retornado na resposta.
endTime

string (int64 format)

A hora, em milésimos de segundo, com base na época, da compra anulada mais recente que você quer ver na resposta. O valor desse parâmetro não pode ser maior do que o horário atual e será ignorado se o token de paginação estiver definido. O valor padrão é o horário atual. Observação: este filtro é aplicado no momento em que o registro é considerado nulo nos nossos sistemas, e não no momento da anulação retornado na resposta.
type

integer

O tipo de compras anuladas que você quer ver na resposta. Os valores possíveis são: 0. Apenas compras de produtos no app anuladas serão retornadas na resposta. Esse é o valor padrão. 1. Tanto compras no app quanto assinaturas serão retornadas na resposta.

Observação: antes de solicitar o recebimento de compras de assinatura anuladas, é necessário usar o orderId na resposta, que identifica exclusivamente assinaturas e compras únicas. Caso contrário, você vai receber vários pedidos de assinatura com o mesmo PurchaseToken, porque os pedidos de renovação de assinatura o compartilham.
includeQuantityBasedPartialRefund

boolean

Opcional. Incluir ou não compras anuladas de reembolsos parciais com base na quantidade, que só podem ser aplicados a compras de várias quantidades. Se definido como "true", outras compras anuladas podem ser retornadas com voidedQuantity, que indica a quantidade do reembolso parcial. O valor padrão é falso.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta da API voidedpurchases.list.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "pageInfo": {
    object (PageInfo)
  },
  "tokenPagination": {
    object (TokenPagination)
  },
  "voidedPurchases": [
    {
      object (VoidedPurchase)
    }
  ]
}
Campos
pageInfo

object (PageInfo)

Informações gerais de paginação.
tokenPagination

object (TokenPagination)

Informações de paginação com token.
voidedPurchases[]

object (VoidedPurchase)

Exemplo

Confira a seguir um exemplo de solicitação:

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'

Veja a seguir um exemplo de resposta:

{
  "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"
    }
  ]
}

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/androidpublisher

PageSelection

Tipo do parâmetro de solicitação pageSelection que define quais e quantos resultados a operação voidedpurchases.list vai retornar.

Representação JSON 
{
  "maxResults": integer,
  "startIndex": integer,
  "token": string
}
Campos
maxResults

integer (uint32 format)

Define quantos resultados a operação de listagem vai retornar. O número padrão depende da coleção de recursos.
startIndex

integer (uint32 format)

Define o índice do primeiro elemento a ser retornado. Só poderá ser usado se a paginação indexada estiver ativada.
token

string

Define o token da página a ser retornada, normalmente com TokenPagination. Só poderá ser usado se a paginação com tokens estiver ativada.