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)
  },

  // 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 aplicativo foram vendidos (por exemplo, "com.some.app").

externalTransactionId

string

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

originalPreTaxAmount

object (Price)

Obrigatório. O valor original da transação, sem tributos. Ele representa o valor sem tributos informado originalmente ao Google antes da aplicação de qualquer reembolso.

originalTaxAmount

object (Price)

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

currentPreTaxAmount

object (Price)

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

currentTaxAmount

object (Price)

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

testPurchase

object (ExternalTransactionTestPurchase)

Apenas saída. Se definido, essa transação foi uma compra de teste. O Google não cobra por transações 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 UTC "Zulu" RFC3339, 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. Esse é o momento em que o Google foi notificado sobre a transação.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, 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.

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)

Essa 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 pelo Google.

OneTimeExternalTransaction

Representa uma transação única.

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

string

Apenas entrada. Fornecido durante a chamada para o Create. Extraído 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 de aquisição única 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 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

Apenas entrada. Fornecido durante a chamada para o Create. Extraído do cliente quando o fluxo de faturamento alternativo é iniciado. Necessário apenas para a compra inicial.

migratedTransactionProgram

enum (ExternalTransactionProgram)

Apenas entrada. Fornecido durante a chamada para o Create. Só pode ser usado 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 ele 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 da 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 Essa é 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 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 informada 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. "ANDAMAN AND NICOBAR ISLANDS", "ANDHRA PRADESH", "ARUNACHAL PRADESH", "ASSAM", "BIHAR", "CHANDIGARH", "CHHATTISGARH", "DADRA AND NAGAR HAVELI", "DADRA AND NAGAR

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.