Começar a usar os relatórios de atribuição

Este guia oferece uma visão geral e instruções de configuração para relatórios de atribuição no nível do evento e de resumo usando a API Attribution Reporting.

Para começar, você vai aprender a:

  • Diferenciar os tipos de relatórios da API Attribution Reporting

  • Concluir as etapas de implementação da API e geração de relatórios

  • Encontrar informações de referência e solução de problemas

Escolher um tipo de relatório

Para medir a performance da campanha publicitária com diferentes níveis de detalhes e privacidade, a API Attribution Reporting oferece dois tipos de relatórios distintos:

  • Relatórios no nível do evento:fornecem dados granulares que vinculam um clique ou uma visualização de anúncio específico (a origem) com os dados de conversão correspondentes (o acionador). Os relatórios de eventos limitam a quantidade de dados de conversão e adicionam ruído aos relatórios. Eles são ideais para casos de uso em que a atribuição de eventos individuais é fundamental, como a medição do alcance da campanha.

  • Relatórios de resumo:oferecem dados agregados do usuário e podem incluir informações de conversão mais detalhadas com ruído adicionado. Usando as APIs Attribution Reporting e Private Aggregation, eles são construídos com base em relatórios agregados e oferecem um modelo de dados mais completo do que os relatórios no nível do evento. Os relatórios de resumo são especialmente úteis para cenários que exigem insights agregados, como calcular valores de conversão ou analisar a performance da campanha em segmentos de usuários.

Visão geral da implementação

As seções a seguir descrevem as etapas gerais para gerar cada tipo de relatório. Você também pode acompanhar a demonstração da API Attribution Reporting para ver um tutorial detalhado de todo o processo.

Pré-requisito:seus sites precisam ter certificados SSL/TLS (HTTPS) antes de você registrar origens e acionadores e receber relatórios.

Geração de relatórios no nível do evento

As etapas a seguir descrevem como gerar relatórios no nível do evento:

  1. Registrar uma origem:associa um clique ou uma visualização de anúncio a informações de atribuição. Consulte Registrar fontes de atribuição e Registro de fontes de atribuição para instruções detalhadas. O processo de registro é um pouco diferente para cliques e visualizações.

  2. Registrar um acionador:registra um evento de conversão e o vincula a uma fonte registrada anteriormente. Consulte Registrar gatilhos de atribuição para instruções.

  3. Configure um endpoint de relatórios:crie um endpoint no seu servidor para receber relatórios no nível do evento. O URL do endpoint precisa seguir este formato: {REPORTING_ENDPOINT}/.well-known/attribution-reporting/report-event-attribution. Confira o código de exemplo em adtech.js para ver um exemplo do método POST. Para mais informações sobre .well-known, consulte a Wikipedia.

Para mais detalhes sobre os relatórios no nível do evento, consulte a explicação sobre relatórios no nível do evento.

Geração de relatórios de resumo

  1. Registrar uma fonte:igual aos relatórios no nível do evento. Consulte Registrar fontes de atribuição e Registro de fontes de atribuição para mais detalhes.

  2. Registrar um acionador:igual aos relatórios de eventos. Consulte Registrar acionadores de atribuição.

  3. Configurar um endpoint de relatórios:crie um endpoint para receber relatórios agregados. O URL precisa ser: {REPORTING_ENDPOINT}/.well-known/attribution-reporting/report-aggregate-attribution. Consulte adtech.js para um exemplo de método POST e Wikipedia para informações sobre .well-known.

  4. Agrupar e enviar relatórios:agrupe os relatórios agregados e envie-os ao serviço de agregação para processamento. Em seguida, o serviço de agregação vai gerar relatórios de resumo. Consulte Estratégias para agrupamento em lote para mais informações.

Para mais detalhes sobre os relatórios de resumo, consulte a explicação sobre relatórios agregáveis.

Além das etapas de implementação, os tópicos a seguir vão ajudar você a planejar sua estratégia de relatórios de resumo:

Configurar filtros (opcional)

Para ter um controle mais granular sobre os dados de atribuição recebidos, configure filtros.

A filtragem oferece uma análise de dados refinada que isola subconjuntos específicos de dados para sua análise, reduzindo o ruído. Também ajuda a acompanhar a performance de campanhas publicitárias e eventos de conversão específicos para uma medição mais precisa.

Para configurar a filtragem, consulte Definir regras personalizadas usando filtros e a seção de acionadores do Registro de acionadores de atribuição para detalhes específicos dos relatórios agregáveis.

Confirmar se a API está ativada

Antes de usar a API, verifique se ela está ativada usando o seguinte código:

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

Essa verificação indica se a API é permitida no contexto atual. No entanto, as configurações do navegador do usuário ou outros fatores ainda podem impedir o uso da API. Por motivos de privacidade, não há uma maneira programática de confirmar definitivamente a usabilidade da API.

Próximas etapas

As seções a seguir fornecem mais informações sobre como começar a usar os relatórios de atribuição.

Implementação

Contexto e conceitos

Demonstrações e ferramentas

Planejamento