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 reportEvent()

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 reportEvent() de l'interface Fence déclenche l'envoi de données de rapport via un beacon vers une ou plusieurs URL spécifiques enregistrées via la méthode registerAdBeacon() de l'API Protected Audience, dans le but de collecter les résultats d'enchères publicitaires.

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

Syntaxe

js
reportEvent(event)

Paramètres

event

Un objet ou une chaîne de caractères représentant les données à envoyer.

  • Un objet définit un événement de rapport spécifique à envoyer. Les propriétés requises sont :
    eventType

    Chaîne de caractères représentant le type d'événement à rapporter — par exemple, le nombre de clics sur une publicité. Cette chaîne peut être n'importe quel nom d'événement pertinent (par exemple click). Elle doit correspondre au type d'événement spécifié dans l'appel associé à registerAdBeacon() dans un worklet de l'API Protected Audience.

    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().
  • Une chaîne de caractères représente un eventType, par exemple "click" (voir la définition précédente de eventType). Lorsqu'une chaîne est passée à reportEvent(), cela déclenche l'envoi de toutes les contributions Private Aggregation conditionnées à ce type d'événement (par exemple via PrivateAggregation.contributeToHistogramOnEvent()).

Valeur de retour

Aucune (undefined).

Exemples

js
window.fence.reportEvent({
  eventType: "click",
  eventData: JSON.stringify({ clickX: "123", clickY: "456" }),
  destination: ["buyer", "seller"],
});

Spécifications

Specification
Fenced Frame
# dom-fence-reportevent

Compatibilité des navigateurs

Voir aussi