Orientações de integração de back-end para monetização fora do Google Play Faturamento

A API Google Play Developer inclui mais funcionalidades para informar transações de programas de faturamento e vinculação. Este guia descreve como informar transações desses programas de faturamento.

Há alguns componentes que podem ser necessários para processar transações externas no seu back-end. Para criá-los, você precisa configurar sua integração de back-end conforme indicado em Configurar a API Google Play Developer. Para criar funcionalidades de back-end do desenvolvedor que não são específicas de programas de faturamento e vinculação, consulte Sistema de faturamento do Google Play.

Glossário de termos

Convenções de termos seguidas por este guia:

  • Programas de faturamento e vinculação: programas que facilitam compras de conteúdo digital ou downloads de apps fora do Google Play. Isso inclui os programas de faturamento alternativo e de conteúdo externo.
  • APIs de transação externa: APIs usadas para informar transações de programas de faturamento e vinculação qualificados.
  • Transação externa: uma transação qualificada que ocorre fora do app, conforme definido pelos programas de faturamento alternativo e conteúdo externo.
  • Token de transação externa: um token fornecido pela Biblioteca Play Faturamento para você usar quando o usuário iniciar uma transação externa. Esse token é usado para notificar o Google Play sobre uma transação externa autorizada.
  • ID da transação externa: um identificador exclusivo gerado por você para identificar uma transação externa.

Informar novas transações externas ao Google Play

Integre com a externaltransactions API para informar transações que acontecem fora do sistema de faturamento do Google Play em países aceitos, incluindo transações de US $0 resultantes de compras de testes sem custo financeiro e instalações de apps. Só inicie e informe transações em programas de faturamento e vinculação para países de usuários qualificados, conforme permitido pelos programas de faturamento alternativo e de conteúdo externo. Caso contrário, a chamada de API será rejeitada. Isso inclui novas compras, renovações, recargas, upgrades, downgrades e downloads de apps.

Relatórios de transações externas

Chame a API externaltransactions para informar uma transação externa depois que um pagamento for autorizado por um programa de faturamento e vinculação. Isso se aplica a todas as transações, incluindo cobranças iniciais, renovações, reembolsos e outros. Consulte as diretrizes do programa de faturamento e vinculação para conferir os requisitos de relatórios.

Cada transação externa é informada com um ID da transação externo. Para compras recorrentes (como assinaturas renováveis automaticamente), é necessário enviar o ID da transação externa associado à primeira transação na compra recorrente como um parâmetro para qualquer transação seguinte, incluindo reembolsos. Isso registra a série de transações para a compra. Envie um novo ID de transação externa para compras quando o produto mudar (como um upgrade ou downgrade) ou se a transação recorrente for cancelada ou expirar e o mesmo produto for comprado de novo mais tarde. Não inclua informações de identificação pessoal, reservadas ou confidenciais como parte do ID da transação externa.

Informar uma transação inicial

Sempre que uma nova compra ou download de app for autorizado em programas de faturamento e vinculação, chame a externaltransactions API.

O externalTransactionToken recebido pelo app pela Biblioteca Google Play Faturamento é necessário como parte do corpo da solicitação para downloads de apps, compras únicas e primeira transação em uma compra recorrente, como uma assinatura. Isso é chamado de transação inicial. Após a transação inicial, informe as transações seguintes, como renovações de assinatura, fornecendo um novo externalTransactionId exclusivo. Para mais informações, consulte Informar transações seguintes de uma compra.

Exemplo:

  1. O desenvolvedor configura e ativa o faturamento alternativo no app.
  2. O usuário 1 está na Coreia do Sul, um país aceito, e está tentando comprar o product1 por 12.634, 10 KRW por mês, com uma oferta de teste sem custo financeiro de um mês.
  3. O app inicia o fluxo de compra com o ProductDetails para product1 e a oferta que o usuário selecionou.
  4. O usuário 1 seleciona o sistema alternativo de faturamento do desenvolvedor.
  5. O UserChoiceBillingListener recebe o valor my_token como o externalTransactionToken.
  6. Em seguida, o desenvolvedor envia as informações pertinentes para o back-end (valor de externalTransactionToken e produtos sendo comprados). Em seguida, ele inicia o fluxo de compra para product1 no sistema alternativo de faturamento. Essa transação recebe um ID da transação exclusivo no lado do desenvolvedor, que é usado para reportar ao Google Play: 123-456-789. O ID da transação é obrigatório, mesmo que o usuário esteja recebendo um teste sem custo financeiro.
  7. Depois que a transação é realizada no sistema alternativo de faturamento, o desenvolvedor informa a transação ao Google Play com a solicitação abaixo. Ela é registrada inicialmente como uma transação de zero dólar, porque o usuário recebe um mês sem custos.
POST /androidpublisher/v3/applications/com.myapp.android/externalTransactions?externalTransactionId=123-456-789

Body
 {
"originalPreTaxAmount" : {
   "priceMicros" : "0",
   "currency" : "KRW"
 },
 "originalTaxAmount" : {
   "priceMicros" : "0",
   "currency" : "KRW"
 },
"transactionTime" : "2022-02-22T12:45:00Z",
 "recurringTransaction" : {
   "externalTransactionToken" : "my_token",
   "externalSubscription" : {
     "subscriptionType" : "RECURRING"
   }
 },
 "userTaxAddress" : {
   "regionCode" : "KR"
 }
}

Ao informar uma transação inicial, esteja ciente do seguinte:

  • O subscriptionType pode ser RECURRING (para assinaturas de renovação automática) ou PREPAID (para assinaturas pré-pagas).
  • O OtherRecurringProduct precisa ser usado para representar compras únicas que exigem vários pagamentos ou um pagamento atrasado. Por exemplo, uma pré-encomenda pode ter uma transação inicial de US $0 seguida por uma segunda transação em uma data posterior pelo preço da SKU quando a pré-encomenda for concluída. Consulte Informar transações seguintes de uma compra para mais detalhes sobre como informar transações seguintes.
  • Você precisa fornecer ExternalOfferDetails ao informar transações de ofertas externas iniciais. Isso não é necessário para transações seguintes.

Se você estiver fazendo transações com um usuário na Índia, onde o tributo depende da área político-administrativa (como um estado ou província), inclua essa área em userTaxAddress. Consulte a lista predefinida de strings no guia de referência da API para conferir as áreas político-administrativas aplicáveis.

POST /androidpublisher/v3/applications/com.myapp.android/externalTransactions?externalTransactionId=123-456-789

Body
 {
"originalPreTaxAmount" : {
   "priceMicros" : "0",
   "currency" : "INR"
 },
 "originalTaxAmount" : {
   "priceMicros" : "0",
   "currency" : "INR"
 },
"transactionTime" : "2023-11-01T12:45:00Z",
 "recurringTransaction" : {
   "externalTransactionToken" : "my_token",
   "externalSubscription" : {
     "subscriptionType" : "RECURRING"
   }
 },
 "userTaxAddress" : {
   # Tax varies in India based on state, so include that information in
   # administrativeArea
   "regionCode" : "IN",
   "administrativeArea" : "KERALA"
 }
}

Promoções externas

Se a transação informada estiver no programa de promoções externas, defina o campo externalOfferDetails se a transação for única ou a primeira de uma série recorrente:

  • Ao informar transações de download de apps, defina linkType como LINK_TO_APP_DOWNLOAD e forneça os valores adequados para installedAppPackage e installedAppCategory. Consulte Informar um download de app para mais detalhes.
  • Ao informar transações de ofertas de conteúdo digital, defina linkType como LINK_TO_DIGITAL_CONTENT_OFFER.
  • Depois que um app externo for instalado pelo programa de promoções externas, informe as transações feitas no app externo. Ao informar essas transações, vincule-as ao evento de download do app original:
    • Forneça o externalTransactionToken do evento de download do app.
    • No campo externalOfferDetails, defina appDownloadEventExternalTransactionId como o externalTransactionId do evento de download do app. Outros campos em externalOfferDetails não são obrigatórios.

Exemplo de solicitação de transação em um app externo baixado por promoções externas:

POST /androidpublisher/v3/applications/com.myapp.android/externalTransactions?externalTransactionId=ABC-DEF-GHI

Body
 {
"originalPreTaxAmount" : {
   "priceMicros" : "990000", # 0.99 EUR
   "currency" : "EUR"
 },
 "originalTaxAmount" : {
   "priceMicros" : "90000", # 0.09 EUR
   "currency" : "EUR"
 },
"transactionTime" : "2025-11-22T12:45:00Z",
 "oneTimeTransaction" : {
   "externalTransactionToken" : "my_external_transaction_token_for_link_to_download_event"
 },
 "userTaxAddress" : {
   "regionCode" : "DE"
 },
 "externalOfferDetails" : {
   "appDownloadEventExternalTransactionId" : "my_external_transaction_id_for_link_to_download_event"
 }
}

Os detalhes atualizados da taxa de serviço do Google Play para diferentes tipos de transação podem ser encontrados em Mudanças no Programa de Promoções Externas para usuários no Espaço Econômico Europeu (EEE).

Informar transações seguintes de uma compra

Em alguns casos, há mais de um pagamento do usuário associado à mesma compra externa. Por exemplo, renovações de assinatura ou recargas de planos pré-pagos. É possível informar essas transações seguintes usando a mesma API em Externaltransactions. Conforme descrito em Informar uma nova compra, o externalTransactionToken não é necessário para as transações seguintes. Em vez disso, um novo externalTransactionId exclusivo é enviado como parâmetro de consulta para cada transação de renovação ou recarga, com o ID da transação inicial incluído no campo initialExternalTransactionId.

Seguindo o exemplo anterior:

  1. A primeira renovação do usuário 1 ocorre no sistema alternativo de faturamento. O ID da transação inicial era 123-456-789.
  2. O desenvolvedor informa a recorrência da transação no parâmetro de consulta do URL como o ID externo dessa nova transação, fazendo referência ao ID externo da transação inicial no campo initialExternalTransactionId.

Exemplo de solicitação:

POST /androidpublisher/v3/applications/com.myapp.android/externalTransactions?externalTransactionId=abc-def-ghi

Body
 {
"originalPreTaxAmount" : {
   "priceMicros" : "12634000000", # 12634 KRW
   "currency" : "KRW"
 },
 "originalTaxAmount" : {
   "priceMicros" : "1263000000", # 1263 KRW
   "currency" : "KRW"
 },
"transactionTime" : "2022-02-22T12:45:00Z",
 "recurringTransaction" : {
   "initialExternalTransactionId" : "123-456-789",

   "externalSubscription" : {
     "subscriptionType" : "RECURRING"
   }
 },
 "userTaxAddress" : {
   "regionCode" : "KR"
 }
}

Informar upgrade ou downgrade

Para informar um upgrade ou downgrade quando o usuário for proprietário de uma assinatura no sistema alternativo de faturamento, use o mesmo endpoint e função na API Externaltransactions enviando o externalTransactionToken que foi fornecido ao app para a transação de upgrade ou downgrade. Isso é parecido com o processo de informar uma nova compra.

Informar um download de app

Para informar uma instalação de app no sistema de faturamento de promoções externas, você deve chamar Externaltransactions.createexternaltransaction, enviando o externalTransactionToken que foi fornecido ao app. Informe isso como uma transação única de custo zero. Esse processo é semelhante a informar uma transação inicial. Inclua ExternalOfferDetails no corpo da solicitação.

Exemplo de solicitação:

POST /androidpublisher/v3/applications/com.myapp.android/externalTransactions?externalTransactionId=123-456-789

Body
 {
"originalPreTaxAmount" : {
   "priceMicros" : "0",
   "currency" : "USD"
 },
 "originalTaxAmount" : {
   "priceMicros" : "0",
   "currency" : "USD"
 },
"transactionTime" : "2025-12-22T12:45:00Z",
 "oneTimeTransaction" : {
   "externalTransactionToken" : "my_token",
 },
 "userTaxAddress" : {
   "regionCode" : "US"
 },
 "externalOfferDetails" : {
   "linkType" : "LINK_TO_APP_DOWNLOAD",
   "installedAppPackage" : "my.external.app",
   "installedAppCategory" : "APP"
 }
}

Migrar dos relatórios manuais de transações de faturamento alternativo

Para migrar assinaturas ativas iniciadas enquanto você oferecia faturamento alternativo sem relatórios automatizados, crie uma nova transação de custo zero usando o campo migratedTransactionProgram em vez de especificar um initialExternalTransactionId ou externalTransactionToken. Defina transactionTime como a hora em que o usuário se inscreveu inicialmente para cada assinatura ativa. Em seguida, informe normalmente cada transação subsequente para essas assinaturas usando as APIs, fornecendo o initialExternalTransactionId usado anteriormente para criar as transações de renovação. Depois que a assinatura for migrada, não será mais necessário informar manualmente as próximas transações, desde que elas sejam informadas pelos métodos automatizados descritos nesta página.

Ao migrar assinaturas, considere os limites de cota para verificar se a migração não causa uma interrupção da cota. Se muitas assinaturas precisarem ser migradas, distribua-as em vários dias ou solicite um aumento da cota.

O campo migratedTransactionProgram só pode ser usado ao migrar de relatórios manuais. Ele será descontinuado quando os relatórios manuais não forem mais aceitos.

Exemplo de solicitação:

# Note that the externalTransactionId specified here will used to report
# subsequent transactions.

POST /androidpublisher/v3/applications/com.myapp.android/externalTransactions?externalTransactionId=abc-def-ghi

Body
 {
 # Be sure to set the price to 0 for this transaction since it does not reflect
 # an actual subscription renewal.
 "originalPreTaxAmount" : {
   "priceMicros" : "0",
   "currency" : "KRW"
 },
 "originalTaxAmount" : {
   "priceMicros" : "0",
   "currency" : "KRW"
 },

 # The transaction time should be set to when the user signed up for this
 # subscription.
 "transactionTime" : "2022-02-22T12:45:00Z",
  "recurringTransaction" : {
    "migratedTransactionProgram" : "USER_CHOICE_BILLING",

    "externalSubscription" : {
      "subscriptionType" : "RECURRING"
    }
  },
 "userTaxAddress" : {
   "regionCode" : "KR"
 }
}

Requisitos para programas de parceiros do Google Play

Os desenvolvedores que participam de programas de parceiros, como o Programa de experiência de mídia do Google Play, precisam fornecer o transaction_program_code ao informar transações externas. Se você for um desenvolvedor qualificado, entre em contato com o gerente de desenvolvimento comercial para mais informações sobre como definir esse campo.

Informar reembolsos de compras ao Google Play

Integre com a API externaltransactions para informar transações reembolsadas a usuários fora do sistema de faturamento do Google Play. Para que o Google Play identifique corretamente qual transação foi reembolsada, inclua o externalTransactionId correspondente para a transação informada anteriormente como parte dos parâmetros de URL.

Ao informar reembolsos de compras de assinatura, consulte o externalTransactionId da recorrência específica da assinatura que está sendo reembolsada.

Exemplo: suponha que uma assinatura tenha estas transações:

  • Uma transação inicial com o ID da transação externa ABC.1234-5678-9012-34567

  • A primeira transação recorrente com o ID da transação externa ABC.1234-5678-9012-34567..0

  • A segunda transação recorrente com o ID da transação externa ABC.1234-5678-9012-34567..1

Para informar um reembolso de todas as transações de assinatura, faça três solicitações de reembolso separadas: uma para a transação inicial e duas para as seguintes.

Esse método aceita reembolsos totais, em que o valor é o mesmo que o usuário pagou na transação externa original, e reembolsos parciais, em que o valor é menor do que o usuário pagou na transação externa original. Para reembolsos parciais, é necessário especificar o valor sem tributos que foi reembolsado.

Cotas da API

A API Externaltransactions está sujeita a cotas de API para todas as chamadas, assim como qualquer outro endpoint da API Google Play Developer.

Além disso, a API Externaltransactions tem um limite de 1.200 consultas por minuto (QPM) para chamadas de Externaltransactions.createexternaltransaction ou Externaltransactions.refundexternaltransaction. As chamadas de Externaltransactions.getexternaltransaction não são contabilizadas no limite de 1.200 QPM.