Configurando a mensuração de receita de compras in-app e assinaturas

Pré-requisitos: Acesso ao Google Play Console e ao Google Cloud Project.

Para vincular sua Google Play Developer Account ao seu Google Cloud Project

1. No Google Play Console, acesse sua Google Play Developer Account.
2. Vincule a conta ao seu Google Cloud Project. Para mais instruções, veja esse artigo de ajuda do Google.
3. Ative a Google Play Developer API. Para mais instruções, veja esse artigo de ajuda do Google.

Pré-requisitos: Acesso à Google Cloud Platform.

Para configurar sua service account:

1. Crie ou encontre a Service Account:
   1. Na Google Cloud Platform, vá para a seção Service Accounts e clique em Create Service Account.
       
   2. Insira os detalhes da service account.
      
   3. Copie o endereço de e-mail.
      
   4. Clique em create and continue.
      
   5. Em Grant this service account access to the project , selecione a função Pub/sub.
      
   6. Clique em Continue > Done.
      
2. Baixe a Service Account Private Key:
   1. Na Google Cloud Platform, vá para Service accounts, encontre a conta desejada (a que você acabou de criar) e clique no ícone More actions.
   2. Clique em Manage keys.
      
   3. Clique em Add key > Create new key.
      
   4. No popup Create private key, em Key type, selecione JSON e clique em Create.
   5. Clique em Create. O arquivo private key JSON é baixado.
      
   6. Salve o arquivo JSON, que será enviado para a AppsFlyer mais tarde. Atenção! Você deve salvar a chave; ela não pode ser recuperada depois. Se você não salvá-la, terá que criar uma nova chave.

Pré-requisitos: Acesso de administrador à AppsFlyer.

Para enviar a Service Account Private Key para a AppsFlyer:

1. Na AppsFlyer, no menu lateral, selecione configurações > configurações de receita e selecione o seu app.
   
2. Na aba Compras e assinaturas, clique em para enviar o arquivo JSON.
   
3. Envie o arquivo JSON private key.
4. Clique em Salvar.

Pré-requisitos: Acesso ao Google Play Console.

Atenção: pode levar algum tempo (às vezes até 24 horas) após a configuração das credenciais e permissões da conta de serviço para poder usá-las. Isso pode fazer com que você receba mensagens de erro em etapas posteriores.

Para definir permissões de acesso à API no Google Play Console:

1. No Google Play Console, vá para Users and permissions, encontre a conta de serviço que você criou e clique em Invite new users.
   
2. Digite o endereço de e-mail que você copiou ao configurar sua conta de serviço na etapa 1.2.1.3.
    
3. Na aba Permissions, vá para a seção Account permissions e selecione ambos:
   • View financial data, orders, and cancellation survey responses.
   • Manage orders and subscriptions.
     
4. Clique Invite user.
   
5. Na janela de confirmação, clique em Send invite.
   

Para receber dados de receita de compras in-app e assinaturas do Google Play, selecione entre as seguintes opções:

• (Recomendado) O Google Play envia as notificações diretamente para a AppsFlyer. Com essa opção, nenhuma cópia de notificação pode ser encaminhada para seu endpoint. Se você quiser selecionar essa opção, siga as instruções nesta etapa.
• O Google Play envia as notificações para você primeiro, que são então encaminhadas para a AppsFlyer. Se você escolher essa opção, pule para a próxima etapa.

Pré-requisitos: Acesso ao Google Play Console e à interface da AppsFlyer.

Para enviar notificações do Google Play diretamente à AppsFlyer:

1. Na AppsFlyer, no menu lateral, vá para Configurações > Configurações de receita, selecione seu aplicativo e na aba Compras e assinaturas, selecione Permitir que o tópico da AppsFlyer receba mensagens RTDN diretamente do Google.
   
2. Copie o tópico da AppsFlyer para a área de transferência.
   
3. Em Google Play Console > Home, selecione para visualizar seu aplicativo. O painel é aberto.
   
4. Vá para Monetize with Play > Monetization setup e, em Google Play Billing, certifique-se de selecionar Enable real-time notification.
   
5. No campo Topic name, cole o endereço do tópico da AppsFlyer.
   
6. Para Notification content, selecione Subscriptions, voided purchases, and all one-time products.
   
7. Clique em Save changes.
   Pode levar um tempo (às vezes até 24 horas) para que essa alteração tenha algum efeito. Por isso, é importante esperar antes de testar.

Atenção: Essa etapa somente é necessária se você não optar por seguir o método recomendado de envio de dados de receita de compras in-app e assinaturas via notificações diretas enviadas pelo Google Play à AppsFlyer. Se você completou as etapas para o método recomendado, para criar um tópico onde a AppsFlyer recebe diretamente as notificações RTDN do Google Play, pule essa etapa.

Se você quiser configurar a AppsFlyer como um assinante do seu tópico PUB/SUB existente, continue com as instruções abaixo.

Pré-requisitos: Acesso ao Google Cloud Platform e à interface da AppsFlyer.

Para encaminhar notificações do Google Play para a AppsFlyer:

1. No AppsFlyer, no menu lateral, vá para Configurações > Configurações de receita; selecione seu aplicativo e na aba Compras e assinaturas, selecione Encaminhar mensagens de tópico RTDN para a AppsFlyer.
   
2. Copie a URL do endpoint para a área de transferência.
   
3. Na plataforma do Google Cloud, em seu projeto, pesquise Pub/Sub.
   
4. Em Pub/Sub, vá para a seção Topics e verifique se você tem um tópico de pub/sub dedicado para assinaturas.
   
5. Em Pub/Sub vá para Subscriptions e clique em Create subscription.
   
6. Digite o Subscription ID.
   
7. Selecione o tópico relevante do pub/sub no menu suspenso.
   
8. Para Delivery type, selecione Push.
   
9. Cole a URL do endpoint que você copiou da AppsFlyer.
   
10. Para Expiry period, selecione Never expire.
    
11. Clique em Create.
    
12. Vá para a seção Subscriptions e clique no nome do tópico que você deseja.
    
13. Copie o nome do tópico para a área de transferência.
    
14. No Google Play Console, vá para Monetize with Play > Monetization setup e, na seção Google Play Billing, no campo Topic name, cole o nome do tópico que você copiou na etapa anterior.
    
15. Para Notification content, selecione Subscriptions, voided purchases, and all one-time products.
    
16. Clique em Save changes.
    Pode levar um tempo (às vezes até 24 horas) para que essa alteração tenha algum efeito. Por isso, é importante esperar antes de testar.

Para selecionar os tipos de mensuração de receita:

1. Na AppsFlyer, no menu lateral, vá para Configurações > Configurações de receita > Compras e assinaturas, e clique em Validar chave.
    
   Atenção:
   • após definir as credenciais e permissões da conta de serviço, pode levar até 24 horas para que você possa usá-las. Isso pode fazer com que você receba mensagens de erro ao tentar validar a chave ou realizar um teste de validação.
   • Para contornar esse problema, no Google Play Console, vá para qualquer aplicativo, acesse Monetize > Products > Subscriptions/In-app products, e faça qualquer mudança. Por exemplo, edite a descrição do seu produto e salve-a. Isso deve atualizar instantaneamente as credenciais e permissões da conta. Feito isso, você pode desfazer as alterações.
2. Ative um ou ambos:
   • Validar compras com o Google Play .
   • Atribuir e relatar assinaturas auto-renováveis.
      
3. [Opcional] Selecione Permitir que a AppsFlyer desduplique transações que já foram relatadas. Isso garante que nenhuma transação duplicada seja registrada.
4. [Opcional] Marque Permitir que a AppsFlyer verifique automaticamente as transações pendentes, adiadas ou reembolsadas em meu nome. Isso permite que a AppsFlyer registre corretamente todas as transações.
5. Clique em Salvar.
   Pode levar um tempo (às vezes até 24 horas) para que essa alteração tenha algum efeito. Por isso, é importante esperar antes de testar.

Obtenha as seguintes credenciais do App Store Connect e insira-as na página de Configurações de receita dentro da plataforma AppsFlyer.

• In-App Purchase key
• Key ID
• Issuer ID

Antes de começar:

• Para configurar as credenciais, você deve realizar ações tanto no App Store Connect quanto na AppsFlyer. Durante a configuração, mantenha as abas da App Store Connect e da AppsFlyer abertas.
• Você precisa de permissões de administrador para configurar chaves na AppsFlyer.

Para definir as credenciais do iOS:

1. Na App Store Connect, vá para Users and Access
2. Vá para Users and Access > Integrations e, na lista Keys, selecione In-App Purchase.
   
3. Clique + para gerar uma nova In-App Purchase key.
   
4. Digite um nome para sua chave de API.
5. Clique em Generate.
6. Clique em Download In-App Purchase Key ao lado da chave que você acabou de gerar para baixá-la. Atenção: você só pode baixar a chave uma vez.
7. Na AppsFlyer, no menu lateral, selecione configurações > configurações de receita.
8. Selecione seu aplicativo na lista.
9. Abra a aba Compras e assinaturas.
10. No campo In-App Purchase key, clique no ícone de upload ( ) para enviar o arquivo p8.
11. Na App Store Connect, copie o Key ID da chave que você acabou de gerar e cole-o na configuração de compras e assinaturas da AppsFlyer, em Key ID.

12. Na App Store Connect, copie o Issuer ID e cole-o na configuração de compras e assinaturas da AppsFlyer em Issuer ID. Atenção: se o Issuer ID não for exibido na parte superior da página, crie uma chave de API da App Store Connect (com qualquer nível de acesso). Depois disso, o Issuer ID aparecerá no topo da página para a In-App Purchase key. 

    

13. Nas configurações de compras e assinaturas da AppsFlyer, clique em validar chaves para garantir que as chaves que você inseriu estão corretas. Atenção: a opção de validar chave pode não funcionar se seu aplicativo ainda não estiver publicado na App Store.
     

A Apple só pode enviar notificações de servidor para um único endpoint, seja para o endpoint da AppsFlyer (recomendado) ou para o seu próprio endpoint (e você então encaminha as notificações para a AppsFlyer).

Se você quiser seguir a opção recomendada, para enviar notificações diretamente para a AppsFlyer, continue com as instruções abaixo.

Se você optar por encaminhar notificações do seu endpoint para a AppsFlyer, pule para a próxima etapa.

Para enviar notificações diretamente para a AppsFlyer:

1. Nas configurações de receita da AppsFlyer, copie o endpoint de notificações de servidor do AppsFlyer para inseri-lo na sua configuração do App Store Connect.
    
2. Na App Store Connect, em App Information, vá para App Store Server Notifications e, ao lado de Production Server URL, clique em Edit.
    
3. Cole a URL copiada da AppsFlyer, selecione Version 2 Notifications e clique em Save.
   
4. Na App Store Connect, em App Information, vá paraApp Store Server Notifications e, ao lado de Sandbox Server URL, clique em Edit.
    
5. Cole a URL copiada da AppsFlyer, selecione Version 2 Notifications e clique em Save.
   
6. Se você quiser receber uma cópia das notificações, na AppsFlyer, insira seu endpoint de encaminhamento de notificações e clique em Salvar.
    

Atenção: essa etapa só é válida caso você não tenha escolhido seguir o método recomendado. Se você completou as etapas para o método recomendado, pule essa etapa.

Se em vez disso, você quiser enviar notificações para seu endpoint e depois encaminhá-las do seu endpoint para a AppsFlyer, continue com as instruções abaixo.

Para encaminhar notificações de servidor do seu endpoint para a AppsFlyer:

1. Na App Store Connect, em App Information, vá para App Store Server Notifications e, ao lado de Production Server URL, clique em Edit.  
2. Cole sua URL de endpoint, selecione Version 2 Notifications, e clique em Save.
   
3. Na App Store Connect, em App Information, vá paraApp Store Server Notifications e, ao lado de Sandbox Server URL, clique em Edit.
    
4. Cole sua URL de endpoint, selecione Version 2 Notifications e clique em Save.
    
5. Configure o envio das notificações do servidor da Apple do seu backend para a URL do endpoint de notificações da AppsFlyer. Atenção: as solicitações devem ser enviadas exatamente conforme recebidas da App Store. Veja os requisitos de formato da Apple 

1. Na página de configuração de receita de compras in-app e assinaturas da AppsFlyer, ative uma ou ambas as opções:
   • Atribuir e registrar assinaturas auto-renováveis (ARS).
   • Validar compras com a Apple App Store.
     
2. [Opcional] Marque Permitir que a AppsFlyer desduplique transações que já foram relatadas.
   Isso garante que nenhuma transação duplicada seja registrada.
3. [Opcional] Marque Permitir que a AppsFlyer relate automaticamente receitas negativas para reembolsos de transações. Isso garante que reembolsos, cancelamentos, etc. sejam registrados.
4. [Opcional] Marque Desduplicar receita de compras de compartilhamento familiar.
   Isso garante que nenhuma receita duplicada seja registrada para compras de compartilhamento familiar. Eventos de receita para outros membros da família incluem o parâmetro purchase_ownership_type=FAMILY_SHARED e exibem receita zero.

No ambiente sandbox:

• Apenas eventos de compra iniciais fazem com que o conector do SDK produza um evento que é registrado pela AppsFlyer. Um evento de compra in-app é chamado de af_purchase_sandbox_sdk. Um evento de assinatura é chamado de af_ars_sandbox_sdk. 
• As notificações do servidor só são processadas se o conector SDK registrar primeiro a transação original. Nesse caso, um evento de compra in-app é chamado af_purchase_sandbox_s2s. Um evento de assinatura é chamado af_ars_sandbox_s2s.
• Um evento não é produzido para nenhuma notificação de servidor para a qual o conector SDK não registrou primeiro a transação original.
• Eventos de sandbox têm uma receita de 0.
• Para iOS, se o evento af_purchase_sandbox_sdk contiver o parâmetro af_sandbox_revenue com um valor de receita, isso significa que em produção, esse seria um evento regular af_purchase. Se não houver receita, em produção seria um evento af_purchase_free.
• Para Android, os testes realizados por Testadores de Licença resultam em eventos Sandbox mesmo que o ambiente Sandbox no SDK não esteja configurado.

Pré-requisitos:

• Para iOS, certifique-se de que, em App Store Server Notifications na App Store connects, o endpoint da AppsFlyer esteja configurado como sua URL do servidor Sandbox.
  

Para testar a receita de compras e assinaturas no aplicativo:

1. Diga aos seus desenvolvedores para seguirem as instruções do Android, iOS e Unity para configurar um ambiente Sandbox no SDK Connector.
2. Faça uma compra de teste ou inicie uma assinatura usando o License Tester no Google Play e TestFlight no iOS.
   Atenção: Qualquer produto de assinatura pode ser testado apenas uma vez de cada dispositivo de teste. Em outras palavras, você não pode registrar várias compras de teste da mesma assinatura no mesmo dispositivo, pois elas não serão registradas.
3. Verifique se o evento é exibido no dashboard de Atividade da AppsFlyer. Na AppsFlyer, no menu lateral, vá para Analisar > Atividade e, no gráfico Tendência de atividade, vá para a aba Eventos in-app e selecione o evento que você quer testar. Um evento de compra in-app é chamado de af_purchase_sandbox_sdk. Um evento de assinatura é chamado de af_ars_sandbox_sdk. Esses eventos incluem:
   • Uma receita com valor 0 (para não distorcer os relatórios reais da AppsFlyer).
   • Um parâmetro af_sandbox_revenue que inclui o valor da receita do produto comprado para que você se certifique de que a receita correta seja relatada.
4. Faça um evento de reembolso de teste, renovação de assinatura ou cancelamento de assinatura usando o License Tester no Google Play e TestFlight no iOS.
   Atenção: se você estiver testando um produto por assinatura, espere até que a AppsFlyer receba uma notificação do servidor. Geralmente isso ocorre alguns minutos após a compra inicial. 
5. Verifique se o evento é exibido no dashboard de Atividade da AppsFlyer. Na AppsFlyer, no menu lateral, vá para Analisar > Atividade e, no gráfico Tendência de atividade, vá para a aba Eventos in-app e selecione o evento que você quer testar. Uma compra de assinatura auto-renovável é chamada de af_ars_sandbox_s2s. O evento inclui:
   • Uma receita com valor 0 (para não distorcer os relatórios reais da AppsFlyer).
   • Um parâmetro af_sandbox_revenue que inclui o valor da receita do produto comprado para que você se certifique de que a receita correta seja relatada.