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

O nome do pacote do app para o qual compras anuladas precisam ser retornadas (por exemplo, "com.alguma.coisa").

Parâmetros de consulta

Parâmetros
pageSelection.maxResults

integer (uint32 format)

Define quantos resultados a operação de lista precisa 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. Isso só pode ser usado se a paginação indexada estiver ativada.
pageSelection.token

string

Define o token da página a ser retornada, geralmente retirado da TokenPagination. Isso só poderá ser usado se a paginação de tokens estiver ativada.
startTime

string (int64 format)

O tempo, em milissegundos, desde a época, da compra anulada mais antiga que você quer ver na resposta. O valor desse parâmetro não pode ser anterior a 30 dias e será ignorado se um token de paginação estiver definido. O valor padrão é o horário atual menos 30 dias. Observação: esse filtro é aplicado no momento em que o registro é considerado anulado pelos nossos sistemas, e não no momento em que o registro é anulado na resposta.
endTime

string (int64 format)

O tempo, em milissegundos, desde a é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 um token de paginação estiver definido. O valor padrão é o horário atual. Observação: esse filtro é aplicado no momento em que o registro é considerado anulado pelos nossos sistemas, e não no momento em que o registro é anulado na resposta.
type

integer

O tipo de compras anuladas que você quer ver na resposta. Os valores possíveis são: 0. Somente compras de produtos no app anuladas serão retornadas na resposta. Esse é o valor padrão. 1. Tanto compras no app quanto compras de assinaturas anuladas 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 compras e assinaturas únicas. Caso contrário, você receberá vários pedidos de assinatura com o mesmo PurchaseToken, porque os pedidos de renovação de assinatura compartilham o mesmo PurchaseToken.
includeQuantityBasedPartialRefund

boolean

Opcional. Indica se compras anuladas de reembolsos parciais com base em quantidade serão incluídas, que são aplicáveis somente a compras de quantidade múltipla. Se verdadeiro, outras compras anuladas poderão ser retornadas com voidedQuantity que indica a quantidade de reembolso de um reembolso parcial baseado em quantidade. O valor padrão é falso.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta para a 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 para paginação de tokens.
voidedPurchases[]

object (VoidedPurchase)

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 uma operação voidedpurchases.list deve retornar.

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

integer (uint32 format)

Define quantos resultados a operação de lista deve 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. Isso só pode ser usado se a paginação indexada estiver ativada.
token

string

Define o token da página a ser retornada, geralmente retirado da TokenPagination. Isso só poderá ser usado se a paginação de tokens estiver ativada.