Livre de recettes sur le débogage d'Attribution Reporting

Troisième partie sur le débogage de l'API Attribution Reporting. Découvrez comment utiliser les rapports de débogage.

Dans ce cookbook, vous trouverez des instructions sur l'utilisation des rapports de débogage pour différents cas d'utilisation décrits dans la Partie 1 : Introduction aux rapports de débogage.

Glossaire

  • L'origine des rapports est l'origine qui définit les en-têtes de source et de déclencheur d'Attribution Reporting. Tous les rapports générés par le navigateur sont envoyés à cette origine. Dans ce guide, nous utilisons https://adtech.example comme exemple d'origine de création de rapports.
  • Un rapport sur l'attribution (rapport en abrégé) est le rapport final (au niveau des événements ou agrégable) qui contient les données de mesure que vous avez demandées.
  • Un rapport de débogage contient des données supplémentaires sur un rapport sur l'attribution, ou sur une source ou un événement déclencheur. L'envoi d'un rapport de débogage ne signifie pas nécessairement que quelque chose ne fonctionne pas correctement. Il existe deux types de rapports de débogage.
  • Un rapport de débogage de transition est un rapport de débogage qui nécessite la définition d'un cookie pour être généré et envoyé. Les rapports de débogage de transition ne seront pas disponibles si aucun cookie n'est défini et une fois les cookies tiers obsolètes. Tous les rapports de débogage décrits dans ce guide sont des rapports de débogage de transition.
  • Les rapports de débogage de réussite permettent d'assurer le suivi des rapports sur l'attribution générés correctement. Elles sont directement liées à un rapport sur l'attribution. Les rapports de débogage de réussite sont disponibles depuis Chrome 101 (avril 2022).
  • Les rapports de débogage détaillés peuvent suivre les rapports manquants et vous aider à déterminer pourquoi ils sont manquants. Elles indiquent les cas où le navigateur n'a enregistré aucun événement de source ou déclencheur (ce qui signifie qu'il ne génère pas de rapport sur l'attribution), et les cas où un rapport sur l'attribution ne peut pas être généré ou envoyé pour une raison quelconque. Les rapports de débogage détaillés incluent un champ type qui décrit la raison pour laquelle un événement source, un événement déclencheur ou un rapport d'attribution n'a pas été généré. Les rapports de débogage détaillés sont disponibles à partir de Chrome 109 (version stable en janvier 2023).
  • Les clés de débogage sont des identifiants uniques que vous pouvez définir côté source et côté déclencheur. Les clés de débogage vous permettent de mapper les conversions basées sur les cookies et les conversions basées sur l'attribution. Une fois que vous avez configuré votre système pour générer des rapports de débogage et définir des clés de débogage, le navigateur inclut ces clés de débogage dans tous les rapports sur l'attribution et dans tous les rapports de débogage.

Pour découvrir d'autres concepts et termes clés utilisés dans notre documentation, consultez le glossaire de la Privacy Sandbox.

Tutoriel : Vérifier votre intégration en temps réel

  1. Configurez votre système pour générer des rapports de débogage de réussite. Pour en savoir plus, consultez Partie 2 : Configurer les rapports de débogage.
  2. Chaque fois que vous déployez du code Attribution Reporting, vérifiez en temps réel si vous recevez des rapports de débogage de réussite sur votre point de terminaison. Si tel est le cas, votre configuration Attribution Reporting fonctionne.
  3. Les rapports de débogage de réussite ne sont envoyés que lorsqu'une conversion a lieu. Vous pouvez plutôt vérifier que votre intégration est correctement configurée, indépendamment des conversions. En d'autres termes, vous devez vérifier que les sources sont correctement enregistrées. Pour ce faire, vous pouvez vous appuyer sur les rapports de débogage détaillés "source-registration-success". Découvrez comment les configurer dans Partie 2 : Configurer les rapports de débogage.

Tutoriel : analyser les pertes et résoudre les problèmes d'intégration

Pour comparer les résultats de la mesure des conversions basées sur les cookies avec les rapports Attribution Reporting, utilisez des clés de débogage et mettez en correspondance les conversions basées sur les cookies avec les rapports de débogage. N'oubliez pas que les rapports de débogage sont envoyés immédiatement à votre point de terminaison.

Présentation

Étapes d'une analyse des pertes
Étapes d'une analyse des pertes

Utilisez les clés de débogage (paire <source_debug_key, trigger_debug_key>) pour mapper les conversions de cookies aux rapports de débogage de réussite. Pour chaque conversion par cookie, avez-vous reçu un rapport de débogage de réussite correspondant au moment de la conversion ?

Si la réponse est "oui" : pour tous ces rapports de débogage "success", vous recevrez un rapport sur l'attribution ultérieurement, à quelques exceptions près. Pour en savoir plus, consultez Scénario de rapport de débogage "Succès".

Si ce n'est pas le cas : cela signifie que la conversion n'a pas été enregistrée avec Attribution Reporting. Utilisez la paire <source_debug_key, trigger_debug_key> (ou la clé de débogage source si la clé de débogage du déclencheur est absente) pour mapper les conversions de cookies aux rapports de débogage détaillés. Pour chacune de ces conversions, avez-vous reçu à un moment donné (heure de la source ou du déclencheur) un rapport de débogage détaillé correspondant ?

  • Si vous n'avez pas reçu de rapport de débogage détaillé, cela peut être dû au comportement de l'utilisateur ou à un problème d'intégration. Pour en savoir plus, consultez Scénario sans rapport de débogage.

  • Si vous avez reçu un rapport de débogage détaillé, examinez son champ type.

    • Si la valeur type est source-success, cela signifie que la source a bien été enregistrée, mais pas le déclencheur. Pour identifier la raison pour laquelle le rapport de débogage "success" est manquant, recherchez un rapport de débogage "verbose" correspondant d'un autre type. Ce rapport indiquera un problème au niveau du déclencheur.

    • Si son type est différent, la source ou le déclencheur n'ont pas été enregistrés. type vous explique pourquoi. Le rapport sur l'attribution (et le rapport de débogage "success") correspondant sera manquant. En fonction de la type d'un rapport de débogage détaillé, vous pouvez simplement considérer ces informations comme un point de données d'analyse des pertes (en d'autres termes, aucune action n'est requise de votre part), ou vous pouvez signaler un bug ou résoudre les problèmes liés à votre implémentation. Pour en savoir plus, consultez le scénario de rapport de débogage détaillé.

Scénarios possibles

Rapport de débogage "success"

Si vous avez reçu un rapport de débogage indiquant que la conversion par cookie a réussi, cela signifie que cette conversion a bien été enregistrée avec Attribution Reporting.

Vous recevrez ultérieurement un rapport sur l'attribution de cette conversion. Voici quelques exceptions :

  • Comportement de l'utilisateur : suppression des données après la conversion et avant l'envoi du rapport sur l'attribution, fermeture du navigateur, etc. Si un utilisateur ferme son navigateur après avoir effectué une conversion et ne l'ouvre pas pendant une semaine, le rapport ne sera pas envoyé avant une semaine ou plus. Vous pouvez considérer ce délai comme une perte.
  • Applicable uniquement au niveau des événements : un rapport au niveau des événements est remplacé par un autre rapport de priorité plus élevée.
  • Problèmes de réseau possibles.

Rapport de débogage détaillé de type source-success

Si vous avez reçu un rapport de débogage détaillé de type source-success pour la source d'une conversion par cookie donnée, cela signifie que l'enregistrement de la source a réussi. Selon que l'enregistrement du déclencheur réussit ou non par la suite, vous pouvez recevoir ou non un rapport pour cette conversion.

Il existe toutefois une exception :

Rapport de débogage détaillé d'un autre type

Si, pour une conversion par cookie donnée, vous avez reçu un rapport de débogage détaillé d'un autre type, vous ne recevrez pas de rapport de débogage de réussite, et donc pas de rapport d'attribution par la suite, car un rapport détaillé signifie qu'un échec pouvant être signalé s'est produit. Un problème a empêché l'enregistrement de la source ou du déclencheur, ou la génération ou l'envoi du rapport. Causes possibles :

  • Limites de confidentialité
  • Limites de stockage
  • Règles personnalisées
  • Problème d'implémentation dans votre code
  • Bug du navigateur

Certaines sont normales. L'action à entreprendre dépend du type de chaque rapport détaillé. Consultez la documentation de référence sur les rapports détaillés.

Aucun rapport de débogage

Si, pour une conversion de cookie donnée, vous n'avez reçu qu'un rapport sur l'attribution (et aucun rapport de débogage de type "success" ni "verbose"), cela signifie qu'un problème a empêché la génération des rapports de débogage. Causes possibles :

  • Préférences de l'utilisateur (l'utilisateur a désactivé les cookies tiers)
  • Cookie ou clés de débogage manquants (clé de débogage effacée en raison d'un cookie manquant). Dans chrome://attribution-internals, ouvrez l'onglet Journaux et vérifiez si un problème y est signalé.
  • Problèmes de réseau survenus au moment de la source ou du déclencheur, mais pas lors de l'envoi du rapport sur l'attribution.

Recevez-vous des rapports sur l'attribution ?

Il s'agit d'un sous-cas de non-réception d'un rapport de débogage : si, pour une conversion de cookie donnée, vous n'avez reçu aucun type de rapport (aucun rapport de débogage, aucun rapport d'attribution), cela signifie qu'un échec non signalable s'est produit. Causes possibles :

  • Problème d'intégration fondamental. Découvrez comment résoudre ces problèmes dans Résoudre les problèmes d'intégration fondamentaux.
  • Problèmes de réseau possibles.
  • Les préférences utilisateur dans les paramètres du navigateur, comme la Privacy Sandbox, sont désactivées.

Référence des rapports de débogage détaillés

Chaque rapport de débogage détaillé comporte un champ type qui indique la raison pour laquelle le rapport d'attribution correspondant a été abandonné. Utilisez la référence pour déterminer l'action à effectuer pour chaque type du rapport détaillé.

Enregistrement de la source réussi

Une source a bien été enregistrée.

source-success
Détails et corps du rapport

Rapports sur les limites de confidentialité

Ces rapports sont attendus. Elles indiquent des limites de confidentialité pour réduire les fuites d'identité des utilisateurs sur les sites.

source-destination-limit
Corps du rapport et détails
source-noised
Corps du rapport et détails
trigger-attributions-per-source-destination-limit
Corps du rapport et détails
trigger-reporting-origin-limit
Corps du rapport et détails
trigger-event-noise
Corps du rapport et détails
trigger-event-excessive-reports
 Ce message s'affiche si le nombre de rapports dépasse la limite. Vous pouvez enregistrer au maximum une conversion pour les vues et trois pour les clics. Notez que vous pouvez configurer les rapports que vous souhaitez recevoir en définissant des priorités. Détails et corps du rapport

Rapports sur les limites de stockage

Ces rapports sont attendus. Elles indiquent les limites de stockage pour éviter une utilisation excessive des ressources.

source-storage-limit
Corps du rapport et détails
trigger-event-storage-limit
Corps du rapport et détails
trigger-aggregate-storage-limit
Corps du rapport et détails

Rapports sur les règles personnalisées

Ces rapports sont attendus si vous utilisez le filtrage, la déduplication, les priorités ou le filtrage basé sur une fenêtre. Par précaution, vérifiez les règles personnalisées correspondantes pour confirmer que le rapport correspondant à ce rapport détaillé est bien celui que vous souhaitez supprimer. Si c'est bien le cas, aucune action n'est requise de votre part.

trigger-no-matching-filter-data
Corps du rapport et détails
trigger-event-no-matching-configuration
Corps du rapport et détails
trigger-event-deduplicated
Corps du rapport et détails
trigger-aggregate-deduplicated
Corps du rapport et détails
trigger-event-low-priority
Corps du rapport et détails
trigger-event-report-window-passed
Corps du rapport et détails
trigger-aggregate-report-window-passed
Corps du rapport et détails

Autres rapports détaillés

Ces rapports peuvent indiquer des problèmes d'implémentation potentiels dans votre code.

trigger-no-matching-source
Il peut s'agir d'un problème d'implémentation. Vérifiez qu'il n'y a pas d'erreur de configuration dans votre configuration de <reporting origin, destination>. Il peut également s'agir du comportement attendu de l'API. Par exemple, l'utilisateur a effacé des données à un moment donné après avoir interagi avec une annonce et avant d'effectuer une conversion, ou il a effectué une conversion sans jamais voir d'annonce associée. Corps du rapport et détails
trigger-aggregate-no-contributions
Ce n'est probablement pas le comportement que vous souhaitez pour votre code. Résolvez les problèmes liés à votre code d'enregistrement du déclencheur et assurez-vous que votre configuration de contribution est correcte. Corps du rapport et détails
trigger-aggregate-insufficient-budget
Ce n'est probablement pas le comportement que vous souhaitez pour votre code. Vérifiez votre code d'enregistrement du déclencheur pour vous assurer que la somme de toutes les contributions ne dépasse pas le budget de contribution. Détails et corps du rapport

Erreurs inattendues (éventuels bugs du navigateur)

Ces rapports sont inattendus. Il peut s'agir d'un bug du navigateur. Créez un rapport de bug et décrivez la procédure permettant de le reproduire.

source-unknown-error
Corps du rapport et détails
trigger-unknown-error
Corps du rapport et détails

Exemple d'analyse des pertes

Étape 1 : Configuration et mappage avec les cookies

Suivez les instructions de la Partie 2 : Configurer les rapports de débogage pour configurer votre système afin qu'il génère des rapports de débogage de réussite et des rapports de débogage détaillés.

Vous pouvez ainsi utiliser les informations sur les conversions basées sur les cookies pour rechercher les rapports de débogage ou d'attribution correspondants.

Étape 2 : Identifiez les enregistrements réussis et les rapports manquants

Dans cet exemple, supposons que vous ayez suivi 100 conversions avec votre système basé sur les cookies.

Chaque fois que vous enregistrez une conversion basée sur un cookie, recherchez le rapport de débogage de réussite (envoyé immédiatement) qui présente la même paire <source_debug_key, trigger_debug_key> que cette conversion basée sur un cookie.

Supposons que vous ayez reçu un rapport de débogage indiquant que 70 de ces conversions de cookies ont réussi.

  • Les rapports de réussite indiquent que l'attribution a bien été enregistrée. Vous pouvez donc supposer que vous recevrez un rapport d'attribution correspondant à chaque rapport de réussite, à quelques exceptions près.
  • Vous pouvez choisir de surveiller ces exceptions. Pour ce faire, lorsque des rapports d'attribution seront envoyés à votre point de terminaison au cours des prochains jours ou semaines (selon la date d'expiration), recherchez ceux qui ont la même paire de clés de débogage que chaque rapport de débogage "success". Veillez à patienter un peu : les rapports ne sont pas toujours envoyés immédiatement à la fin de chaque période. Supposons que vous ne trouviez que 60 rapports sur l'attribution. Les 10 rapports sur l'attribution manquants peuvent être dus au comportement des utilisateurs.

Étape 3 : Évaluation rapide des pertes

Il manque 30 rapports de débogage "attribution-success" (100 - 70 = 30). Cela signifie que ces 30 conversions (qui ont été suivies dans votre implémentation basée sur les cookies) n'ont pas été enregistrées avec les rapports sur l'attribution. Vous ne recevrez pas de rapports sur l'attribution pour ces conversions.

Comme vous avez enregistré 100 conversions basées sur les cookies et seulement 70 conversions basées sur l'attribution, votre perte est de 30 %. Vous disposez désormais d'une brève évaluation des pertes.

Étape 4 : Analyser les causes

Pour comprendre pourquoi ces rapports sont manquants, recherchez les rapports de débogage détaillés correspondants que vous avez reçus au moment de la conversion (enregistrement du déclencheur) ou plus tôt au moment de l'enregistrement de la source. Utilisez les clés des conversions basées sur les cookies pour les mapper aux rapports de débogage détaillés.

  • Supposons qu'il existe 10 clés pour lesquelles aucun rapport de débogage détaillé n'est disponible. Vérifiez s'il y a un problème d'intégration. Sinon, cela peut être dû au comportement de l'utilisateur.
  • Vous avez 20 rapports de débogage détaillés. Vous pouvez maintenant affiner votre analyse des pertes. Analysez le champ type de chaque rapport détaillé. Par exemple, vous pouvez constater que :
    • Il manque 10 rapports (soit 10 % dans notre exemple) en raison de pending destination limit.
    • Il manque 5 rapports (soit 5 %) en raison de trigger-aggregate-no-contributions.
    • Il manque 5 rapports (soit 5 %) en raison de unknown-error.

Étape 5 : Prenez des mesures et résolvez les problèmes

Maintenant que vous savez pourquoi des rapports sont manquants, vous pouvez agir en conséquence.

L'action à entreprendre dépend du type de chaque rapport détaillé. Pour en savoir plus, consultez la documentation de référence sur les rapports détaillés. Exemple :

  • pending-destination-limit est une protection de la confidentialité. Aucune action n'est requise de votre part. Utilisez ce nombre comme point de données pour votre propre visibilité et surveillance.
  • trigger-aggregate-no-contributions peut indiquer un problème d'implémentation de votre côté. Analysez cela plus en détail. Utilisez les informations contenues dans le corps du rapport détaillé pour résoudre le problème, si nécessaire.
  • unknown-error peut indiquer un bug du navigateur ou une erreur réseau. Si vous rencontrez ce problème à plusieurs reprises, signalez un bug aux développeurs du navigateur.