1. Web
  2. Les API Web
  3. Fence
  4. setReportEventDataForAutomaticBeacons()

Cette page a été traduite à partir de l'anglais par la communauté. Vous pouvez contribuer en rejoignant la communauté francophone sur MDN Web Docs.

View in English Always switch to English

Fence : méthode setReportEventDataForAutomaticBeacons()

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Expérimental: Cette fonction est expérimentale
Puisque cette fonction est toujours en développement dans certains navigateurs, veuillez consulter le tableau de compatibilité pour les préfixes à utiliser selon les navigateurs.
Il convient de noter qu'une fonctionnalité expérimentale peut voir sa syntaxe ou son comportement modifié dans le futur en fonction des évolutions de la spécification.

La méthode setReportEventDataForAutomaticBeacons() de l'interface Fence définit les données d'événement qui seront envoyées lorsqu'une navigation a lieu dans un élément HTML <fencedframe>. Ces données sont envoyées via un beacon automatique vers une ou plusieurs URL spécifiques enregistrées via la méthode registerAdBeacon() de l'API Protected Audience, afin de collecter les données de rapport pour les résultats d'enchères publicitaires.

Note : reportEvent() permet un envoi similaire de données de rapport, sauf que dans ce cas l'envoi est déclenché par un appel explicite de méthode plutôt que par une navigation.

Syntaxe

js
setReportEventDataForAutomaticBeacons(event)

Paramètres

event

Un objet représentant les données à envoyer. Les propriétés possibles sont :

eventType

Chaîne de caractères représentant le type d'événement à rapporter. Les valeurs disponibles sont :

  • reserved.top_navigation_start : Un événement déclenché au début d'une navigation de niveau supérieur.
  • reserved.top_navigation_commit : Un événement déclenché à la fin d'une navigation de niveau supérieur.
eventData

Chaîne de caractères représentant les données à envoyer.

destination

Tableau contenant une ou plusieurs valeurs énumérées représentant les types de destinataires. Ce sont les parties qui recevront les données à leurs URL enregistrées (via registerAdBeacon()). Valeurs possibles :

  • "buyer" : L'enchérisseur dans l'enchère publicitaire.
  • "seller" : Le vendeur principal qui gère l'enchère publicitaire.
  • "component-seller" : Le vendeur d'une enchère composant dans une enchère à plusieurs niveaux.
  • "direct-seller" : Le vendeur qui a directement géré l'enchère à laquelle l'acheteur a participé. Si la publicité était une enchère à un seul niveau, la valeur utilisée sera "seller". Si c'était une enchère à plusieurs niveaux, la valeur sera "component-seller".
  • "shared-storage-select-url" : Un emplacement de stockage de l'API Shared Storage, tel que défini dans un appel à la méthode Window.sharedStorage.selectURL().
once Facultatif

Booléen. Si défini à true, le beacon automatique ne sera envoyé que pour le prochain événement, et aucun beacon ne sera envoyé pour les événements suivants tant que setReportEventDataForAutomaticBeacons() n'est pas invoqué à nouveau. Par exemple, utilisé avec un gestionnaire de clic, cela permet d'envoyer des données de beacon uniquement pour certaines navigations de niveau supérieur, et non pour toutes. Cette propriété vaut false par défaut.

Valeur de retour

Aucune (undefined).

Exemples

js
window.fence.setReportEventDataForAutomaticBeacons({
  eventType: "reserved.top_navigation_start",
  eventData: "une chaîne d'exemple",
  destination: ["seller", "buyer"],
});

Spécifications

Specification
Fenced Frame
# dom-fence-setreporteventdataforautomaticbeacons

Compatibilité des navigateurs

Voir aussi

Help improve MDN

Learn how to contribute

This page was last modified on by MDN contributors.

View this page on GitHub • Report a problem with this content