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,
  "externalOfferInitialAcquisitionDetails": {
    object (ExternalOfferInitialAcquisitionDetails)
  },

  // 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 app em que os produtos no app foram vendidos (por exemplo, "com.some.app").
externalTransactionId

string

Apenas saída. ID desta transação. Todos os IDs de transações com o mesmo nome de pacote precisam ser exclusivos. Defina ao criar a transação externa.
originalPreTaxAmount

object (Price)

Obrigatório. O valor original da transação sem tributos. Esse valor representa o valor sem tributos originalmente notificado ao Google antes da aplicação dos reembolsos.
originalTaxAmount

object (Price)

Obrigatório. O valor do tributo original. Esse valor representa o valor dos tributos notificados originalmente ao Google antes da aplicação de qualquer reembolso.
currentPreTaxAmount

object (Price)

Apenas saída. O valor da transação atual sem tributos. Representa o valor atual sem tributos, incluindo todos os reembolsos que podem ter sido aplicados a essa transação.
currentTaxAmount

object (Price)

Apenas saída. O valor dos tributos atuais. Ele representa o valor dos tributos atuais, incluindo os reembolsos que podem ter sido aplicados a essa transação.
testPurchase

object (ExternalTransactionTestPurchase)

Apenas saída. Se definido, significa que a transação foi uma compra de teste. O Google não vai cobrar por uma transação de teste.
transactionTime

string (Timestamp format)

Obrigatório. 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 esta transação foi criada. É o momento em que o Google foi notificado sobre a 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 de tributos.
transactionProgramCode

integer

Opcional. O código do programa de transações usado para ajudar a determinar a taxa de serviço dos apps qualificados que participam de programas de parcerias. Os desenvolvedores que participam do Programa Play Media Experience (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 o BDM para mais informações sobre como definir esse campo. Observação: este campo não pode ser usado para transações de promoções externas.
externalOfferInitialAcquisitionDetails

object (ExternalOfferInitialAcquisitionDetails)

Opcional. Detalhes sobre a primeira vez que um usuário/dispositivo concluiu uma transação usando promoções externas. Não é obrigatório para transações feitas usando apenas a escolha de faturamento do usuário ou o faturamento alternativo.
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)

Essa transação é única e 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 usando uma conta de teste. Essas transações não serão cobradas do Google.

OneTimeExternalTransaction

Representa uma transação única.

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

string

Somente entrada. Fornecidos durante a chamada para criar. Recuperado do cliente quando o fluxo de faturamento alternativo é iniciado.

RecurringExternalTransaction

Representa uma transação que faz parte de uma série recorrente de pagamentos. Pode ser uma assinatura ou um produto único com vários pagamentos (como comprar na 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 de transações. Por exemplo, para uma assinatura, esse seria o ID da transação do primeiro pagamento. Obrigatório ao criar transações externas recorrentes.
externalTransactionToken

string

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

enum (ExternalTransactionProgram)

Somente entrada. Fornecidos durante a chamada para criar. Use 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 experimentado 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, em que o usuário pode escolher entre o faturamento gerenciado pelo desenvolvedor do Google Play Faturamento.
ALTERNATIVE_BILLING_ONLY Somente faturamento alternativo, em que os usuários só podem usar o faturamento de gerente do 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 uma assinatura externa.

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

OtherRecurringProduct

Esse tipo não tem campos.

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

TransactionState

O estado de uma transação que está sendo feita.

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

ExternalTransactionAddress

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 com base no ISO-3166-1 Alfa-2 (códigos de região das Nações Unidas).
administrativeArea

string

Opcional. Subdivisão administrativa de nível superior do país/região. Obrigatório apenas para transações na Índia. Os valores válidos são "ANDAMAN AND NICOBAR NICOBAR ISLANDS E NICOBAR ILOBAR ISLANDS, "ANDAMAN AND NICOBAR

ExternalOfferInitialAcquisitionDetails

Detalhes sobre a primeira vez que um usuário/dispositivo concluiu uma transação usando promoções externas.

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

string

Obrigatório. O ID da transação externa da primeira compra concluída feita pelo usuário.

Métodos

createexternaltransaction

 Cria uma nova transação externa.

getexternaltransaction

 Recebe uma transação externa existente.

refundexternaltransaction

 Reembolsa ou reembolsa parcialmente uma transação externa existente.