Enregistrer des déclencheurs d'attribution

Découvrez comment enregistrer les déclencheurs d'attribution afin de comptabiliser vos conversions.

Un déclencheur d'attribution est un événement qui indique au navigateur de capturer les conversions.

En suivant la procédure décrite dans ce document, vous pouvez enregistrer des déclencheurs afin d'enregistrer des conversions que le navigateur attribue ensuite aux événements sources pertinents, à savoir les impressions d'annonces ou les clics sur les annonces.

Méthodes d'enregistrement

Pour enregistrer des déclencheurs, utilisez des éléments HTML ou des appels JavaScript:

• Balise <a>
• Balise <img>
• Balise <script>
• fetch appel
• XMLHttpRequest
• window.open

Cela génère des requêtes réseau auxquelles vous répondez ensuite avec un en-tête de réponse HTTP d'enregistrement du déclencheur.

Enregistrer un déclencheur pour attribuer une conversion

L'enregistrement d'un déclencheur est semblable à l'enregistrement d'un événement de source d'attribution. La procédure complète est décrite plus loin. Voici le résumé:

1. Lancez l'enregistrement du déclencheur. Utilisez un pixel ou un appel fetch() pour effectuer une requête.

2. Terminez l'enregistrement du déclencheur en répondant avec l'en-tête d'enregistrement du déclencheur.
   
   

   À la réception de la requête de pixel (envoyée au point de terminaison défini dans l'attribut src habituel, ou au point de terminaison défini dans attributionsrc si vous avez choisi d'utiliser attributionsrc et que vous lui avez attribué une valeur), répondez avec l'en-tête Attribution-Reporting-Register-Trigger.
   
   

   Dans cet en-tête, spécifiez les données du déclencheur que vous souhaitez voir apparaître dans les rapports. N'importe quelle réponse peut définir cet en-tête. Tant qu'il s'agit d'une réponse à une requête envoyée à partir d'un site correspondant à destination, les sources seront mises en correspondance. Une fois l'en-tête reçu, le navigateur recherche les sources correspondantes et planifie un rapport.

   Exemple pour les rapports au niveau des événements:

   {
     "event_trigger_data": [{
       "trigger_data": "[unsigned 64-bit integer]",
       "priority": "[signed 64-bit integer]",
       "deduplication_key": "[unsigned 64-bit integer]"
     }]
   }
   ```
   
   **Example for summary reports:**
   
   ```json
   {
     ... // existing fields, such as "event_trigger_data"
   
     "aggregatable_trigger_data": [
      {
        "key_piece": "0x400",
        "source_keys": ["campaignCounts"]
      },
      {
        "key_piece": "0xA80",
        "source_keys": ["geoValue", "nonMatchingKeyIdsAreIgnored"]
      }
     ],
     "aggregatable_values": {
       "campaignCounts": 32768,
       "geoValue": 1664
     }
   }
   ```
   

Remarque:Lorsque le navigateur reçoit une réponse de déclencheur d'attribution à partir d'une URL attributionsrc d'une page donnée, une recherche dans l'espace de stockage local est effectuée pour trouver une source qui correspond à la fois à l'origine attributionsrc et à l'eTLD+1 de l'URL de la page. <br> Si plusieurs sources sont détectées, le navigateur sélectionne celle qui a été stockée en dernier, sauf si les sources ont des priorités différentes, auquel cas le navigateur sélectionne celle ayant la priorité la plus élevée.

Gérer les sous-domaines

Si destination est défini sur https://advertiser.example, les conversions de https://advertiser.example et de ses sous-domaines, tels que https://shop.advertiser.example, peuvent être attribuées.

Si destination est défini sur https://shop.advertiser.example, les conversions de https://advertiser.example et de https://shop.advertiser.example peuvent être attribuées.

Attributs obligatoires et facultatifs

Lorsque vous utilisez des éléments HTML ou effectuez des appels JavaScript pour enregistrer des déclencheurs, vous devrez peut-être utiliser attributionsrc ou attributionReporting. Consultez le tableau suivant pour savoir dans quels cas ils sont requis.

Lorsque attributionsrc est facultatif, son utilisation indique que la requête est éligible pour Attribution Reporting. Si vous utilisez attributionsrc, le navigateur envoie l'en-tête Attribution-Reporting-Eligible. Il est également utile pour la mesure entre l'application et le Web: si attributionsrc est présent, le navigateur envoie l'en-tête Attribution-Reporting-Support.

Méthode d'inscription	Déclencheur
Balise <a>	N/A Les ancres ne peuvent pas enregistrer de déclencheur.
Balise <img>	attributionsrc est facultatif. L'en-tête est suffisant pour enregistrer un déclencheur.
Balise <script>	attributionsrc est facultatif. L'en-tête est suffisant pour enregistrer un déclencheur.
fetch appel	L'option attributionReporting est obligatoire.
XMLHttpRequest	L'option attributionReporting est obligatoire.
window.open()	N/A window.open ne peut pas enregistrer de déclencheur.

Étape 1: Lancez l'enregistrement du déclencheur

Vous pouvez enregistrer un déclencheur à l'aide d'un pixel (balise <img>) ou d'une balise de script.

Utiliser un pixel de conversion nouveau ou existant

<img src="https://ad-tech.example/conversionpixel"
     attributionsrc="https://adtech.example/attribution_trigger?purchase=13">

Important : * L'origine du champ src doit correspondre à celle de l'enregistrement de la source. * L'attribution ne peut être déclenchée que sur une page dont l'eTLD+1 correspond au site fourni dans la destination lors de l'enregistrement de la source.

Utiliser un tag de script

Vous pouvez effectuer l'enregistrement du déclencheur avec une balise de script. Son comportement est identique à celui de <img>. Les exemples de code suivants illustrent l'utilisation de fetch() et de XMLHttpRequest() (XHR).

Ce code simule efficacement le comportement d'une requête HTML avec attributionsrc:

// With fetch
const attributionReporting = {
  eventSourceEligible: false,
  triggerEligible: true,
};

// Optionally set keepalive to ensure the request outlives the page.
window.fetch("https://adtech.example/attribution_source?my_ad_id=123",
  { keepalive: true, attributionReporting });

// With XMLHttpRequest:
const attributionReporting = {
  eventSourceEligible: false,
  triggerEligible: true,
};

const req = new XMLHttpRequest();
  req.open('GET', url);
  req.setAttributionReporting(
      attributionReporting);
  req.send();

Point clé:L'origine de <code>src</code> doit correspondre à l'origine qui a effectué l'enregistrement de la source. - Une attribution ne peut être déclenchée que sur une page dont l'<a href="https://web.dev/same-site-same-origin/#%22schemeful-same-site%22">eTLD+1</a> correspond au site indiqué dans la <code>destination</code> lors de l'enregistrement de la source.

attributionsrc avec ou sans valeur

Vous pouvez ajouter attributionsrc avec ou sans valeur.

<!-- Without a value -->
<img src="..." width="1" height="1" attributionsrc>

<!--With a value (URL) -->
<img src="..." width="1" height="1" attributionsrc="https://...">

Si vous définissez une valeur pour attributionsrc, il doit s'agir d'une URL unique.

L'utilisation d'une URL amène le navigateur à lancer une requête de récupération séparée du message keepalive (une pour chaque URL), qui inclut l'en-tête de requête Attribution-Reporting-Eligible.

Cela est utile si vous souhaitez effectuer l'enregistrement de la source en répondant à une requête distincte de la requête principale de l'élément.

Par exemple, si vous devez enregistrer des sources pour les clics sur un élément d'ancrage, vous ne contrôlez peut-être pas réellement la destination. Dans ce cas, vous aurez besoin d'une configuration vous permettant d'envoyer l'en-tête d'enregistrement de la source en tant que réponse à une requête distincte de la navigation et que vous pouvez contrôler entièrement. En spécifiant une valeur explicite pour attributionsrc, vous demandez au navigateur d'effectuer cette requête supplémentaire et de configurer sa destination.

Étape 2: Répondez avec un en-tête

Lorsque vous recevez la requête du navigateur, répondez et incluez l'en-tête Attribution-Reporting-Register-Trigger dans votre réponse:

JSON.stringify({event_trigger_data: [{
      trigger_data: '412444888111012',
      // Optional
      priority: '1000000000000',
      deduplication_key: '2345698765'
    }], debug_key: '1115698977'})

Attention:La valeur du champ "event_trigger_data" doit être imbriquée entre crochets, car le navigateur attend un tableau JSON. Cette fonctionnalité est utile pour les filtres.

Étapes suivantes

Découvrez comment enregistrer des sources d'attribution.