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

Este guia apresenta uma visão geral e instruções de configuração para relatórios de atribuição de resumo e de eventos usando a API Attribution Reporting.

Para começar, você vai aprender a:

  • Diferenciar os tipos de relatório 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 de nível de evento:forneça dados detalhados que vinculam um clique ou visualização de anúncio específico (a origem) aos 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. Elas são ideais para casos em que a atribuição de eventos individuais é fundamental, como medir o alcance da campanha.

  • Relatórios de resumo:oferecem dados agregados do usuário e podem incluir informações de conversão mais detalhadas com mais ruído. Usando a API Attribution Reporting e a API Private Aggregation, elas são criadas a partir de relatórios agregados e oferecem um modelo de dados mais rico do que os relatórios de eventos. Os relatórios de resumo são ú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 seguir a demonstração da API Attribution Reporting para conferir o processo completo.

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

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

As etapas a seguir descrevem como gerar relatórios de evento:

  1. Registrar uma origem:associa um clique ou 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 origem registrada anteriormente. Consulte Registrar acionadores de atribuição para ver instruções.

  3. Configurar um endpoint de relatórios:crie um endpoint no 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 saber mais sobre os relatórios no nível do evento, consulte Explicação dos relatórios no nível do evento.

Geração de relatórios de resumo

  1. Registrar uma fonte:igual aos relatórios de 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 conferir um exemplo de método POST e Wikipédia para informações sobre .well-known.

  4. Enviar e agrupar relatórios:agrupar os relatórios agregados e enviá-los ao serviço de agregação para processamento. O serviço de agregação vai gerar relatórios de resumo. Consulte Estratégias para agrupar para mais informações.

Para saber mais sobre os relatórios de resumo, consulte Explicação sobre relatórios agregáveis.

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

Configurar filtros (opcional)

Para ter mais controle sobre os dados de atribuição que você recebe, configure filtros.

A filtragem fornece uma análise de dados refinada que isola subconjuntos específicos de dados para a análise, reduzindo o ruído. Ele 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 sobre 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 oferecem 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