Introdução aos Relatórios de depuração da API Attribution Reporting

Parte 1 de 3 sobre depuração dos Relatórios de atribuição. Saiba por que a depuração é importante e quando usar relatórios de depuração nos testes.

Por que você precisa de relatórios de depuração

Se você estiver testando a API Attribution Reporting, verifique se a integração está funcionando corretamente, entenda as lacunas nos resultados de medição entre a implementação baseada em cookies e a implementação da Attribution Reporting e resolva problemas com a integração.

Os relatórios de depuração são necessários para concluir essas tarefas. Por isso, recomendamos que você configure essas opções.

Glossário

:

Principais aspectos dos relatórios de depuração

Dois tipos de relatórios de depuração

Há dois tipos de relatórios de depuração disponíveis. Use os dois, já que eles atendem a casos de uso diferentes.

Relatórios de depuração de sucesso

Os relatórios de depuração de sucesso rastreiam a geração de um relatório de atribuição. Eles se relacionam diretamente a um relatório de atribuição.

Os relatórios de depuração de sucesso estão disponíveis desde o Chrome 101 (abril de 2022).

Relatórios de depuração detalhados

Os relatórios de depuração detalhados oferecem mais visibilidade sobre os eventos de origem e acionador. Assim, você pode garantir que as origens foram registradas ou rastrear relatórios ausentes e determinar por que eles estão faltando (falha nos eventos de origem ou acionador, falha ao enviar ou gerar o relatório). Os relatórios de depuração detalhados indicam:

  • Casos em que o navegador registrou uma fonte.
  • Casos em que o navegador não registrou um evento de origem ou acionador, o que significa que ele não vai gerar um relatório de atribuição.
  • Casos em que um relatório de atribuição não pode ser gerado ou enviado por algum motivo.

Os relatórios de depuração detalhados incluem um campo type que descreve um registro de origem bem-sucedido ou o motivo pelo qual um relatório de origem, acionador ou atribuição não foi gerado.

Os relatórios de depuração detalhados estão disponíveis desde o Chrome 109 (janeiro de 2023), exceto os relatórios de depuração detalhados de sucesso de registro de origem que foram adicionados mais tarde no Chrome 112.

Confira os exemplos de relatórios na Parte 2: configurar relatórios de depuração.

Para usar relatórios de depuração, a origem do relatório precisa definir um cookie.

Se a origem configurada para receber relatórios for de terceiros, esse cookie será um cookie de terceiros. Isso significa que os relatórios de depuração só são gerados se os cookies de terceiros estiverem permitidos no navegador do usuário.

Os relatórios de depuração são enviados imediatamente

Os relatórios de depuração são enviados imediatamente pelo navegador à origem do relatório. Isso é diferente dos relatórios de atribuição, que são enviados com um atraso.

Os relatórios de depuração de sucesso são gerados e enviados assim que o relatório de atribuição correspondente é gerado, ou seja, no registro do acionador.

Os relatórios de depuração detalhados são enviados imediatamente após o registro da fonte ou do acionador.

Os relatórios de depuração têm caminhos de endpoint diferentes.

Assim como os relatórios de atribuição, todos os relatórios de depuração são enviados à origem do relatório. Os relatórios de depuração são enviados para três endpoints separados da origem do relatório:

  • Endpoint para relatórios de depuração de sucesso, no nível do evento
  • Endpoint para relatórios de depuração de sucesso, que podem ser agregados
  • Endpoint para relatórios de depuração detalhados, no nível do evento e agregáveis.

Saiba mais na Parte 2: configurar relatórios de depuração.

Casos de uso

Verificação básica de integração em tempo real

Os relatórios de depuração são enviados ao seu endpoint imediatamente, ao contrário dos relatórios de atribuição, que são atrasados para proteger a privacidade do usuário. Use relatórios de depuração como um indicador em tempo real de que a integração com a API Attribution Reporting está funcionando.

Saiba como fazer isso na Parte 3: guia prático de depuração.

Análise de perdas

Ao contrário dos cookies de terceiros, a API Attribution Reporting inclui proteções de privacidade integradas, que foram projetadas para encontrar um equilíbrio entre utilidade e privacidade. Isso significa que, com a API Attribution Reporting, talvez não seja possível coletar todos os dados de medição que você poderia coletar com cookies. Nem todas as conversões que você pode acompanhar com cookies de terceiros geram um relatório de atribuição.

Por exemplo, nos relatórios de eventos, você pode registrar no máximo uma conversão por impressão. Isso significa que, para uma determinada impressão de anúncio, você só vai receber um relatório de atribuição, não importa quantas vezes o usuário converter.

Use relatórios de depuração para conferir as diferenças entre os resultados de medição com base em cookies e os resultados que você recebe com a API Attribution Reporting. Identifique quais conversões são informadas, quantas não são e, especificamente, quais são e por quê.

Saiba como fazer uma análise de perdas na Parte 3: Manual de depuração.

Solução de problemas

Embora a perda causada por proteções de privacidade ou de recursos seja esperada, outras perdas podem ser involuntárias. As configurações incorretas na implementação ou bugs no próprio navegador podem fazer com que os relatórios desapareçam.

Você pode usar relatórios de depuração para detectar e corrigir um problema de implementação do seu lado ou relatar um possível bug para as equipes do navegador. Saiba como fazer isso na Parte 3: guia de depuração.

Verificação de configuração avançada

Alguns recursos da API Attribution Reporting permitem personalizar os comportamentos dela. Regras de filtragem, deduplicação e prioridade são alguns exemplos.

Ao usar esses recursos, use relatórios de depuração para verificar se a lógica leva ao comportamento pretendido na produção, sem esperar pelos relatórios de atribuição. Saiba como fazer isso na Parte 3: guia prático de depuração.

Testes locais com relatórios agregáveis

Ao contrário dos relatórios de atribuição agregáveis que são criptografados, os relatórios de depuração agregáveis incluem o payload não criptografado.

Use relatórios de depuração agregáveis para validar o conteúdo de relatórios agregáveis e gerar relatórios de resumo com a ferramenta de agregação local para testes.

Reprocessar relatórios do serviço de agregação

Outra vantagem do uso do modo de depuração é que ele permite processar relatórios novamente. Portanto, para processar relatórios mais de uma vez, ative os relatórios de depuração. Talvez você queira processar relatórios novamente se:

  • tentar depurar o serviço de agregação.
  • Teste diferentes estratégias de loteamento.
  • Teste diferentes valores de epsilon.

Recuperação de dados

Recomendamos que as adtechs ativem o modo de depuração para receber relatórios de depuração e recuperar os dados dos relatórios. Isso é útil em casos de problemas com o serviço de agregação, como serviços indisponíveis ou não responsivos que podem causar falhas na geração de relatórios de resumo.

Próximo

Parte 2: configurar relatórios de depuração