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

Parte 1 de 3 sobre depuração da API Attribution Reporting. 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, confira 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 Attribution Reporting e resolva problemas relacionados à 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 as duas, porque elas atendem a diferentes casos de uso.

Relatórios de depuração concluídos

Os relatórios de depuração com êxito acompanham a geração de um Relatório de atribuição bem-sucedida. Eles estão relacionados diretamente a um relatório de atribuição.

Os relatórios de depuração 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, você pode verificar se as origens foram registradas ou rastrear relatórios ausentes e determinar por que eles estão ausentes (falha em 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, 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 fonte bem-sucedido ou o motivo pelo qual uma fonte, um acionador ou um relatório de 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 pelos relatórios de depuração detalhados de sucesso no registro da fonte, adicionados posteriormente no Chrome 112.

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

Para usar relatórios de depuração, a origem 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 os cookies de terceiros forem permitidos no navegador do usuário.
  • Os relatórios de depuração não vão mais estar disponíveis após a descontinuação gradual 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 à 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 para a origem de relatórios. Os relatórios de depuração são enviados para três endpoints diferentes da origem do relatório:

  • Endpoint para relatórios de depuração bem-sucedidos, no nível do evento
  • Endpoint para relatórios de depuração de sucesso 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 ao endpoint imediatamente, ao contrário dos Relatórios de atribuição, que sofrem atraso para proteger a privacidade do usuário. Use 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 perda

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

Um 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ê terá apenas um relatório de atribuição, independentemente de quantas vezes o usuário fizer uma conversão.

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

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

Solução de problemas

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

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

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

Alguns recursos da API Attribution Reporting permitem personalizar o comportamento da API. Regras de filtragem, de eliminação de duplicação e de 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 por 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 desses relatórios 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 denúncias mais de uma vez, ative os relatórios de depuração. É possível reprocessar os relatórios quando você estiver:

  • tentando depurar o serviço de agregação.
  • testando diferentes estratégias de lotes.
  • testando 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 no serviço de agregação, como serviços indisponíveis ou sem resposta, que podem causar falhas na geração do relatório de resumo.

A seguir

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