Method: orders.reviewrefund

Fornecer preferência de reembolso e uso da compra para uma solicitação de estorno

Solicitação HTTP

POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/orders/{orderId}:reviewrefund

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

Parâmetros de caminho

Parâmetros
packageName

string

Obrigatório. O nome do pacote do aplicativo da assinatura ou do item no app comprado. Por exemplo, "com.some.thing".
orderId

string

Obrigatório. O ID do pedido enviado ao usuário quando a assinatura ou item no app foi comprado.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "pendingRefundToken": string,
  "sampleContentProvided": boolean,
  "refundPreference": enum (RefundPreference),
  "consumptionPercentageMilliunits": integer,
  "consumptionUsageEvents": [
    {
      object (ConsumptionUsageEvent)
    }
  ]
}
Campos
pendingRefundToken

string

Obrigatório. O token de reembolso pendente incluído na notificação de análise de reembolso pendente.
sampleContentProvided

boolean

Obrigatório. Indica se você ofereceu uma amostra sem custo financeiro, um teste ou informações sobre a funcionalidade antes da compra.
refundPreference

enum (RefundPreference)

Obrigatório. Indica sua preferência, com base na sua lógica operacional, sobre se a Play Store deve conceder o reembolso.
consumptionPercentageMilliunits

integer

Opcional. Porcentagem da compra no app consumida pelo cliente, em miliunidades. Mínimo: 0. Máximo: 100.000. Para apps pagos, isso pode ser omitido. Exemplo : 45200 representa 45,2%.
consumptionUsageEvents[]

object (ConsumptionUsageEvent)

Opcional. Lista de eventos, cada um representando uma instância em que o usuário consumiu ou usou o item ou serviço comprado. Listas com mais de mil itens serão rejeitadas.

Corpo da resposta

Se a solicitação for concluída, o corpo da resposta estará vazio.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

RefundPreference

Indica sua preferência, com base na sua lógica operacional, sobre se a Play Store deve conceder o reembolso.

Tipos enumerados
REFUND_PREFERENCE_UNSPECIFIED A preferência de orders.refund não foi especificada. Esse valor não é usado.
DECLINE O desenvolvedor prefere que o Google Play recuse o reembolso.
APPROVE O desenvolvedor prefere que o Google Play conceda o reembolso total.
NEUTRAL O desenvolvedor não tem preferência sobre a decisão do Google Play de emitir um reembolso

ConsumptionUsageEvent

Lista de eventos, cada um representando uma instância em que o usuário consumiu ou usou o item ou serviço comprado.

Representação JSON 
{
  "obfuscatedAccountId": string,
  "obfuscatedProfileId": string,
  "consumptionTime": string,
  "ipAddress": string,
  "consumptionItemDescription": string,
  "location": {
    object (CoarseLocation)
  }
}
Campos
obfuscatedAccountId

string

Opcional. String ofuscada associada exclusivamente à conta de usuário do comprador no app. https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setObfuscatedAccountId(java.lang.String)
obfuscatedProfileId

string

Opcional. String ofuscada associada exclusivamente ao perfil do usuário comprador no app. https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setObfuscatedProfileId(java.lang.String)
consumptionTime

string (Timestamp format)

Opcional. O momento em que o usuário consumiu, usou, fez o download, abriu ou transmitiu o conteúdo.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
ipAddress

string

Opcional. O endereço IP de onde o consumo ocorreu.
consumptionItemDescription

string

Opcional. Texto de formato livre que permite aos desenvolvedores fornecer mais informações sobre o item consumido. O tamanho máximo é de 5.000 caracteres.
location

object (CoarseLocation)

Opcional. Localização geográfica em que o consumo ocorreu.

CoarseLocation

Detalhes aproximados da localização geográfica de onde o consumo aconteceu.

Representação JSON 
{
  "regionCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string
}
Campos
regionCode

string

Obrigatório. Código regional do CLDR do país/região do endereço. Esse valor nunca é inferido, e você precisa garantir que ele esteja correto. Exemplo: "CH" para Suíça.
administrativeArea

string

Opcional. A maior subdivisão administrativa que é usada para endereços postais de um país ou uma região. Por exemplo, pode ser um estado, uma província, uma zona ou uma prefeitura. Na Espanha, é a província, e não a comunidade autônoma (por exemplo, "Barcelona", não "Catalunha"). Muitos países não usam área administrativa em endereços postais. Por exemplo, na Suíça, ela deve ficar em branco.
locality

string

Opcional. Geralmente se refere à parte do endereço relacionada à cidade/município. Exemplos: cidade nos EUA, comunidade na Itália, distrito postal no Reino Unido. Em regiões do mundo com localizações que não são bem definidas ou que não se encaixam nessa estrutura, deixe locality em branco.
sublocality

string

Opcional. Sublocalidade do endereço. Por exemplo, pode ser um bairro ou distrito. Na maioria dos endereços, é possível omitir essa informação.