Introdução aos Relatórios de atribuição

Veja aqui por onde começar, incluindo a configuração e uma rápida visão geral.

Escolher um tipo de relatório

Com a API Attribution Reporting, é possível gerar dois tipos de relatório: de evento e de resumo. Os relatórios de eventos exigem menos configuração do que os relatórios agregáveis ou resumidos, portanto, podem ser um bom ponto de partida. Os relatórios de resumo exigem integração com o serviço de agregação, o que não é o caso dos relatórios de eventos.

É possível configurar relatórios de eventos e de resumo. Elas são complementares.

Relatórios de eventos

Os relatórios de evento associam um determinado clique ou visualização do anúncio (no lado do anúncio) aos dados do lado da conversão. Para preservar a privacidade do usuário limitando a combinação de identidades de usuário entre sites, os dados de conversão são muito limitados e têm ruído.

Relatórios de resumo

Um relatório de resumo é um tipo de relatório da API Attribution Reporting e da API Private Aggregate. Um relatório de resumo inclui dados agregados do usuário e pode conter dados de conversão detalhados, com ruído. Os relatórios de resumo são compostos por relatórios agregados.

Implementação

Para começar, siga as etapas a seguir.

Para uma determinada fonte de eventos, é possível gerar um relatório agregável e um de evento. A demonstração explica o processo.

Geração de relatórios de eventos

Siga estas etapas mínimas para gerar relatórios de eventos:

  1. Registre uma fonte. Consulte Registrar fontes de atribuição para mais instruções. As etapas são diferentes para cliques e visualizações.

  2. Registre um gatilho. Consulte Registrar acionadores de atribuição para ver as instruções.

  3. Configure um endpoint com o seguinte URL:
    {REPORTING_ENDPOINT}/.well-known/attribution-reporting/report-event-attribution.
    Consulte o exemplo de código em adtech.js para consultar o método POST e a Wikipédia para mais informações sobre .well-known.

Mais detalhes estão disponíveis na explicação do relatório de eventos.

Geração de relatórios de resumo

Para gerar relatórios de resumo, siga estas etapas:

  1. Registre uma fonte. Consulte Registrar fontes de atribuição para mais instruções. As etapas são diferentes para cliques e visualizações. Confira mais detalhes em Registro da fonte de atribuição.

  2. Registre um gatilho. Consulte Registrar acionadores de atribuição para ver as instruções.

  3. Configure um endpoint para relatórios agregáveis com o seguinte URL:
    {REPORTING_ENDPOINT}/.well-known/attribution-reporting/report-aggregate-attribution.
    Consulte o exemplo de código em adtech.js para consultar o método POST e a Wikipédia para mais informações sobre .well-known.

  4. Agrupar e enviar os relatórios para processamento adicional pelo serviço de agregação, que gera relatórios de resumo. Consulte os relatórios agregáveis em lote.

Saiba mais na explicação sobre o relatório agregável.

Saiba como configurar relatórios de depuração na série de depuração de Relatórios de atribuição.

Conceitos adicionais dos relatórios de resumo

Além de entender as etapas de implementação aqui, os conceitos a seguir ajudarão você a planejar sua estratégia de relatórios resumidos:

Etapas opcionais

  1. Configurar filtros (opcional):
    1. Siga as instruções em Definir regras personalizadas usando filtros.
    2. Revise os detalhes específicos dos filtros de relatórios agregáveis na seção de acionadores da explicação.

Não se esqueça da detecção de recursos

Antes de usar a API, detecte se ela não foi bloqueada na página com uma política de permissões. Para fazer isso, execute este código:

if (document.featurePolicy.allowsFeature('attribution-reporting')) {
  // the Attribution Reporting API is enabled
}

Se essa verificação de detecção de recursos retornar verdadeiro, a API será permitida no contexto (página) em que a verificação é executada.

Essa verificação por si só não garante o uso da API na página. O usuário pode ter desativado a API nas configurações do navegador ou ter outras configurações que impedem o uso da API. Para proteger a privacidade do usuário, não é possível verificar isso de maneira programática.

Próximas etapas

Se você estiver com tudo pronto para começar a implementação, confira estes documentos:

Configuração

Contexto

Demonstrações e ferramentas

planejamento

Se você ainda estiver na fase de planejamento, confira estes documentos: