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

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

Por que os relatórios de depuração são necessários

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

Os relatórios de depuração são necessários para concluir essas tarefas. Portanto, recomendamos que você os configure.

Glossário

Principais aspectos dos relatórios de depuração

Dois tipos de relatórios de depuração

Dois tipos de relatórios de depuração estão disponíveis. Use os dois, porque atendem a diferentes casos de uso.

Relatórios de depuração bem-sucedidos

Os relatórios de depuração de sucesso acompanham a geração de um Relatório de atribuição bem-sucedida. 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 dos eventos de origem e acionador. Assim, é possível garantir que as origens sejam registradas ou rastrear relatórios ausentes e determinar o motivo da ausência (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 origem.
  • Casos em que o navegador não registrou um evento de origem ou acionador. Isso 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 fonte bem-sucedido ou o motivo pelo qual um relatório de fonte, 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 do registro da fonte que foram adicionados posteriormente no Chrome 112.

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

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

Se a origem configurada para receber relatórios for de terceiros, esse cookie será de terceiros. Isso tem algumas implicações importantes:

  • Os relatórios de depuração só serão gerados se cookies de terceiros forem permitidos no navegador do usuário.
  • Os relatórios de depuração não estarão mais disponíveis após a desativação dos cookies de terceiros.

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

Os relatórios de depuração são enviados imediatamente pelo navegador para a origem dos relatórios. 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 para a origem de relatórios. Os relatórios de depuração são enviados para três endpoints diferentes da origem dos relatórios:

  • Endpoint para relatórios de depuração sucessos, no nível do evento
  • Endpoint para relatórios de depuração sucessos, agregáveis
  • 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 para o endpoint imediatamente, ao contrário dos Relatórios de atribuição, que são atrasados para proteger a privacidade do usuário. Use os relatórios de depuração como um indicador em tempo real de que sua integração com a API Attribution Reporting está funcionando.

Aprenda a fazer isso na Parte 3: manual 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 criadas 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 coletados com os cookies. Nem todas as conversões que podem ser rastreadas com cookies de terceiros vão gerar um relatório de atribuição.

Por exemplo: para relatórios de eventos, é possível 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 fizer uma conversão.

Use os relatórios de depuração para ter visibilidade sobre as diferenças entre os resultados da medição com base em cookies e os da API Attribution Reporting. Identifique quais conversões foram registradas, quantas não foram informadas e, especificamente, quais e por quê.

Aprenda a executar uma análise de perda na Parte 3: manual de depuração.

Solução de problemas

Embora a perda causada pela proteção de privacidade ou recursos seja esperada, outras perdas podem ser não intencionais. Configurações incorretas na sua implementação ou bugs no próprio navegador podem fazer com que os relatórios não sejam exibidos.

Você pode usar os relatórios de depuração para detectar e corrigir um problema de implementação ou para informar um possível bug às equipes do navegador. Aprenda a fazer isso na Parte 3: manual de depuração.

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

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

Ao usar esses recursos, use relatórios de depuração para verificar se sua lógica leva ao comportamento pretendido na produção, sem esperar pelos Relatórios de atribuição. Aprenda a fazer isso na Parte 3: manual de depuração.

Teste local 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 dos relatórios agregáveis e gerar relatórios de resumo com a ferramenta de agregação local para testes.

Como reprocessar relatórios do serviço de agregação

Outra vantagem de usar o 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. Será possível reprocessar os relatórios quando você estiver:

  • ao tentar depurar o serviço de agregação.
  • testando diferentes estratégias de agrupamento.
  • diferentes valores de épsilon.

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 deles. 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 do relatório de resumo.

A seguir

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