REST Resource: externaltransactions

Recurso: ExternalTransaction

Os detalhes de uma transação externa.

Representação JSON 
{
  "packageName": string,
  "externalTransactionId": string,
  "originalPreTaxAmount": {
    object (Price)
  },
  "originalTaxAmount": {
    object (Price)
  },
  "currentPreTaxAmount": {
    object (Price)
  },
  "currentTaxAmount": {
    object (Price)
  },
  "testPurchase": {
    object (ExternalTransactionTestPurchase)
  },
  "transactionTime": string,
  "createTime": string,
  "transactionState": enum (TransactionState),
  "userTaxAddress": {
    object (ExternalTransactionAddress)
  },
  "transactionProgramCode": integer,

  // Union field transaction_type can be only one of the following:
  "oneTimeTransaction": {
    object (OneTimeExternalTransaction)
  },
  "recurringTransaction": {
    object (RecurringExternalTransaction)
  }
  // End of list of possible types for union field transaction_type.
}
Campos
packageName

string

Apenas saída. O nome do recurso da transação externa. O nome do pacote do aplicativo em que os produtos no app foram vendidos. Por exemplo, "com.some.app".
externalTransactionId

string

Apenas saída. O ID desta transação. Todos os IDs da transação sob o mesmo nome de pacote precisam ser únicos. Definido ao criar a transação externa.
originalPreTaxAmount

object (Price)

Obrigatório. O valor original da transação antes dos tributos. Representa o valor notificado ao Google antes da aplicação de reembolsos.
originalTaxAmount

object (Price)

Obrigatório. O valor original dos tributos. Representa o valor notificado ao Google antes da aplicação de reembolsos.
currentPreTaxAmount

object (Price)

Apenas saída. O valor atual da transação antes dos tributos. Representa o valor atual, incluindo qualquer reembolso que pode ter sido aplicado à transação.
currentTaxAmount

object (Price)

Apenas saída. O valor atual dos tributos. Representa o valor atual, incluindo qualquer reembolso que pode ter sido aplicado à transação.
testPurchase

object (ExternalTransactionTestPurchase)

Apenas saída. Se definido, a transação foi uma compra de teste. O Google não cobra por transações de teste.
transactionTime

string (Timestamp format)

Obrigatório. A data e a hora em que a transação foi concluída.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
createTime

string (Timestamp format)

Apenas saída. A hora em que a transação foi criada. Este é o momento em que o Google foi notificado da transação.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
transactionState

enum (TransactionState)

Apenas saída. O estado atual da transação.
userTaxAddress

object (ExternalTransactionAddress)

Obrigatório. Endereço do usuário para cálculo dos tributos.
transactionProgramCode

integer

Opcional. O código do programa de transações, usado para ajudar a determinar a taxa de serviço de apps qualificados que participam de programas de parceria. Os desenvolvedores que participam do Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) precisam informar o código do programa ao informar transações de faturamento alternativo. Se você for um desenvolvedor qualificado, entre em contato com seu BDM para mais informações sobre como definir esse campo. Observação: esse campo não pode ser usado para transações de ofertas externas.
Campo de união transaction_type. O tipo de transação que foi realizada. transaction_type pode ser apenas de um dos tipos a seguir:
oneTimeTransaction

object (OneTimeExternalTransaction)

Esta é uma transação única, que não faz parte de uma assinatura.
recurringTransaction

object (RecurringExternalTransaction)

Esta transação faz parte de uma série recorrente de transações.

ExternalTransactionTestPurchase

Esse tipo não tem campos.

Representa uma transação realizada com uma conta de teste. Essas transações não serão cobradas pelo Google.

OneTimeExternalTransaction

Representa uma transação única.

Representação JSON 
{
  "externalTransactionToken": string
}
Campos
externalTransactionToken

string

Somente entrada. Enviado durante a chamada para criar. Recuperado do cliente quando o fluxo de faturamento alternativo é lançado.

RecurringExternalTransaction

Representa uma transação que faz parte de uma série recorrente. Pode ser uma assinatura ou um produto único com vários pagamentos, como uma compra em pré-venda.

Representação JSON 
{

  // Union field source can be only one of the following:
  "initialExternalTransactionId": string,
  "externalTransactionToken": string,
  "migratedTransactionProgram": enum (ExternalTransactionProgram)
  // End of list of possible types for union field source.

  // Union field product_details can be only one of the following:
  "externalSubscription": {
    object (ExternalSubscription)
  },
  "otherRecurringProduct": {
    object (OtherRecurringProduct)
  }
  // End of list of possible types for union field product_details.
}
Campos

Campo de união source.

source pode ser apenas de um dos tipos a seguir:
initialExternalTransactionId

string

O ID da transação externa da primeira transação desta série recorrente. Por exemplo, em uma assinatura, seria o ID da transação do primeiro pagamento. Obrigatório ao criar transações externas recorrentes.
externalTransactionToken

string

Somente entrada. Enviado durante a chamada para criar. Recuperado do cliente quando o fluxo de faturamento alternativo é lançado. Obrigatório apenas para a compra inicial.
migratedTransactionProgram

enum (ExternalTransactionProgram)

Somente entrada. Enviado durante a chamada para criar. Pode ser usado apenas ao migrar uma assinatura de relatórios mensais manuais para relatórios automáticos.
Campo de união product_details. Obrigatório. Detalhes do produto na transação externa recorrente. product_details pode ser apenas de um dos tipos a seguir:
externalSubscription

object (ExternalSubscription)

Detalhes de uma assinatura externa.
otherRecurringProduct

object (OtherRecurringProduct)

Detalhes de um produto de transação externa recorrente que não pertence a nenhuma outra categoria específica.

ExternalTransactionProgram

Representa o programa de transação externa usado pelo usuário para concluir a transação.

Enums
EXTERNAL_TRANSACTION_PROGRAM_UNSPECIFIED Programa de transação não especificado. Não utilizado.
USER_CHOICE_BILLING Escolha de faturamento do usuário, onde ele pode escolher entre o Google Play Faturamento ou faturamento gerenciado pelo desenvolvedor.
ALTERNATIVE_BILLING_ONLY Somente faturamento alternativo. Os usuários só podem usar faturamento gerenciado pelo desenvolvedor.

ExternalSubscription

Detalhes de uma assinatura externa.

Representação JSON 
{
  "subscriptionType": enum (SubscriptionType)
}
Campos
subscriptionType

enum (SubscriptionType)

Obrigatório. O tipo de assinatura externa.

SubscriptionType

Os tipos de assinatura externa.

Enums
SUBSCRIPTION_TYPE_UNSPECIFIED Não especificado, não use.
RECURRING Esta é uma assinatura recorrente em que o usuário é cobrado a cada ciclo de faturamento.
PREPAID Esta é uma assinatura pré-paga em que o usuário paga antecipadamente.

OtherRecurringProduct

Esse tipo não tem campos.

Detalhes de um produto de transação externa recorrente que não pertence a nenhuma outra categoria específica.

TransactionState

O estado de uma transação sendo feita.

Enums
TRANSACTION_STATE_UNSPECIFIED Estado de transação não especificado. Não utilizado.
TRANSACTION_REPORTED A transação foi informada ao Google.
TRANSACTION_CANCELED A transação foi totalmente reembolsada.

ExternalTransactionAddress

O endereço do usuário para a transação externa.

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

string

Obrigatório. Código regional de duas letras baseado no ISO-3166-1 Alfa-2 (códigos regionais da ONU).
administrativeArea

string

Opcional. Subdivisão administrativa de nível superior do país/região. Obrigatório somente para transações na Índia. Os valores válidos são "ANDAMAN AND NICOBAR ISLANDS", "ANDHRA PRADESH", "ARUNACHAL PRADESH", "ASSAM", "BIHAR", "CHANDIGARH", "CHHATTISGARH", "DADRA AND NAGAR HAVELI", "DADRA AND NAGAR HAVELI AND DAMAN AND DIU", "DAMAN AND DIU", "DELHI", "GOA", "GUJARAT", "HARYANA", "HIMACHAL PRADESH", "JAMMU AND KASHMIR", "JHARKHAND", "KARNATAKA", "KERALA", "LADAKH", "LAKSHADWEEP", "MADHYA PRADESH", "MAHARASHTRA", "MANIPUR", "MEGHALAYA", "MIZORAM", "NAGALAND", "ODISHA", "PUDUCHERRY", "PUNJAB", "RAJASTHAN", "SIKKIM", "TAMIL NADU", "TELANGANA", "TRIPURA", "UTTAR PRADESH", "UTTARAKHAND" e "WEST BENGAL".

Métodos

createexternaltransaction

 Cria uma nova transação externa.

getexternaltransaction

 Recebe uma transação externa.

refundexternaltransaction

 Reembolsa total ou parcialmente uma transação externa.