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

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

Escolha 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 de resumo, então podem ser um bom ponto de partida. Os relatórios de resumo precisam ser integrados ao serviço de agregação, ao contrário dos relatórios de eventos.

É possível configurar relatórios de evento e de resumo. Eles 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 abaixo.

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 no nível do evento

Veja as etapas mínimas a seguir para gerar relatórios de evento:

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

  2. Registre um acionador. Consulte Registrar acionadores de atribuição para conferir 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 conferir o método post. Confira mais informações sobre .well-known.

Veja mais detalhes sobre os relatórios de eventos.

Geração de relatórios de resumo

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

  1. Registre uma fonte. Consulte Registrar fontes de atribuição para ver as instruções. As etapas são diferentes para cliques e visualizações. Mais detalhes podem ser encontrados em Registro da fonte de atribuição.

  2. Registre um acionador. Consulte Registrar acionadores de atribuição para conferir 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 conferir o método post. Confira mais informações sobre .well-known.

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

Veja mais detalhes sobre os relatórios de resumo aqui.

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

Outros conceitos 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 de 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, verifique se ela não foi bloqueada na página usando a Permissions-Policy. Para fazer isso, execute o seguinte 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 for executada.

Essa verificação por si só não garante que a API seja utilizável na página. O usuário pode ter desativado a API usando as configurações do navegador ou pode ter outras configurações impedindo o uso da API. Para proteger a privacidade do usuário, não há como verificar isso de forma programática.

Próximas etapas

Se estiver tudo pronto para começar a implementação, consulte estes documentos:

Configuração

Contexto

Demonstrações e ferramentas

Planejamento

Se você ainda está na fase de planejamento, consulte estes documentos: