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

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

Obsolète
En cours de suppression

Cette fonctionnalité est en cours de suppression des navigateurs. L'utiliser maintenant peut entraîner un dysfonctionnement dans les futures mises à jour. Following the announcement that Chrome will maintain its current approach to third-party cookies, Chrome decided to withdraw certain Privacy Sandbox features including the <fencedframe> element and related APIs.

La méthode reportEvent() de l'interface Fence déclenche l'envoi de données de rapport avec un signal vers une ou plusieurs URL spécifiques enregistrées avec 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 de caractères peut être n'importe quel nom d'évènement pertinent (par exemple click). Elle doit correspondre au type d'évènement défini 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 reçoivent les données à leurs URL enregistrées (avec 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é est une enchère à un seul niveau, la valeur utilisée est "seller". Si c'est une enchère à plusieurs niveaux, la valeur est "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 de caractères est passée à reportEvent(), cela déclenche l'envoi de toutes les contributions Private Aggregation conditionnées à ce type d'évènement (par exemple avec 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

Spécification
Fenced Frame
# dom-fence-reportevent

Compatibilité des navigateurs

Voir aussi

Aider à améliorer MDN

Apprendre à contribuer

Cette page a été modifiée le par les contributeur·ice·s du MDN.

Voir cette page sur GitHub • Signaler un problème avec ce contenu