API Attribution Reporting: guia de integração

A API Attribution Reporting foi projetada para melhorar a privacidade ao remover a dependência de identificadores do usuário entre diferentes partes e também para oferecer suporte aos principais casos de uso de medição de conversões e atribuição em apps. Este documento inclui diretrizes para ajudar você a se preparar para a integração da API Attribution Reporting.

Este guia tenta fornecer uma visão abrangente, que pode incluir recursos que ainda não foram implementados no estágio atual do Sandbox de privacidade na prévia para desenvolvedores do Android. Nesses casos, os detalhes relacionados vão ser marcados como ainda não implementados.

Metas de integração

Neste estágio da prévia para desenvolvedores do Sandbox de privacidade, as metas do planejamento de integração incluem o seguinte:

Suporte atual e futuro

Atualmente, os casos de uso e recursos com suporte na versão mais recente da prévia para desenvolvedores incluem o seguinte:

  • Atribuição de último toque com prioridade de fonte e atribuição pós-instalação.
  • Registro de fontes de atribuição e acionadores de apps.
  • Recebimento de relatórios no nível do evento.
  • Recebimento de relatórios agregados não criptografados.

As próximas versões da prévia para desenvolvedores planejam adicionar suporte aos casos de uso e recursos técnicos a seguir. À medida que esses recursos forem disponibilizados, este guia vai ser atualizado para refletir detalhes relevantes.

  • Registro na plataforma de tecnologias de publicidade.
  • Suporte à depuração para ajudar os desenvolvedores a comparar relatórios agregados com os de mecanismos já existentes.
  • Registro de fontes de atribuição e acionadores da Web para oferecer suporte à atribuição do app para a Web.
  • Recebimento de relatórios criptografados agregados da API e envio de lotes para o serviço de agregação.
  • Recebimento de relatórios de resumo do serviço de agregação.
  • O uso da API vai exigir uma nova permissão normal.

Público-alvo das tecnologias de publicidade

Para receber um relatório da API Attribution Reporting, uma plataforma de tecnologias de publicidade precisa registrar a fonte de atribuição e o acionador. Para oferecer um teste completo, tanto as tecnologias de publicidade quanto os parceiros de medição para dispositivos móveis precisam trabalhar juntos para chamar a API do mesmo anunciante e podem precisar usar redirecionamentos nas chamadas de registro. Talvez você também precise trabalhar com o app do anunciante ou do editor.

Para o registro da fonte de atribuição, a chamada de API normalmente é iniciada pelo SDK das tecnologias de publicidade usado para veicular anúncios no app do editor. No entanto, a API também pode ser chamada diretamente pelo app.

Para o registro de acionadores, a chamada de API normalmente é iniciada pelo SDK do parceiro de medição em dispositivos móveis no app do anunciante ou pelo app em si.

Pré-requisitos

Etapas de integração

Se quiser se preparar para integrar a API Attribution Reporting à sua solução, conclua as etapas descritas nas seções a seguir.

Verificar a precisão técnica no ambiente de teste

  • Crie um aplicativo de teste para se acostumar com o Sandbox de privacidade na API Attribution Reporting do Android. Nesta fase, você também pode começar com o app de exemplo (link em inglês) no GitHub.
  • Configure endpoints simulados de servidor ou use nosso servidor de amostras (links em inglês) para se acostumar com as assinaturas da API REST usadas pelas APIs Attribution Reporting clientes.
  • Registre eventos, incluindo eventos de visualização, clique e conversão (acionador).
  • Para fins de teste, force a execução de jobs de geração de relatórios usando os comandos adequados do adb para reduzir o tempo previsto. Assim, você pode receber dados do relatório tanto para os relatórios no nível do evento quanto para os agregados.
  • Avalie a aplicabilidade das assinaturas de API para a pilha de tecnologia atual. Isso inclui parâmetros de entrada e valores de retorno. Identifique lacunas no fluxo de dados e mitigações.

Verificar a compatibilidade com a infraestrutura técnica

  • Ambiente de desenvolvimento do lado do cliente e base de código:
    • Após a prévia para desenvolvedores, o Sandbox de privacidade no Android vai exigir um nível desejado da API de no mínimo 33. Identifique um caminho de migração para sua base de código atual. Avalie a compatibilidade do app ou do SDK com outras mudanças introduzidas no Android 13.
  • Do lado do servidor:
    • Adicione endpoints de stub da API à infraestrutura técnica já existente para encontrar e verificar limitações técnicas.
    • Adicione callbacks para aceitar relatórios na infraestrutura técnica.

Definir e verificar os requisitos de integração

  • Verifique nos dados de registros ou do servidor se os relatórios contêm dados de visualizações, cliques e conversões.
  • Verifique os relatórios no nível do evento e em nível agregado.