Fence: reportEvent() Methode

Limited availability

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

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Die reportEvent() Methode des Fence Interface löst die Übermittlung von Berichtsdaten über ein Beacon an eine oder mehrere spezifische URLs aus, die über die registerAdBeacon() Methode der Protected Audience API registriert wurden, um Ergebnisse von Anzeigenauktionen zu sammeln.

Hinweis:>setReportEventDataForAutomaticBeacons() bietet eine ähnliche Übermittlung von Berichtsdaten, außer dass in diesem Fall die Übermittlung über eine Navigation und nicht durch einen expliziten Methodenaufruf ausgelöst wird.

Syntax

js
reportEvent(event)

Parameter

event

Ein Objekt oder String, das die zu sendenden Daten darstellt.

  • Ein Objektwert definiert ein spezifisches Berichtsereignis, das Sie senden möchten. Die erforderlichen Eigenschaften sind wie folgt:
    eventType

    Ein String, der den Typ des gemeldeten Ereignisses darstellt — zum Beispiel könnten Sie daran interessiert sein, wie oft auf eine Anzeige geklickt wird. Dieser String kann jeden relevanten Ereignisnamen tragen (zum Beispiel click). Dieser muss mit dem Ereignistyp im zugehörigen registerAdBeacon() Aufruf in einem Protected Audience API Worklet übereinstimmen.

    eventData

    Ein String, der die zu sendenden Daten repräsentiert.

    destination

    Ein Array, das einen oder mehrere aufgezählte Werte enthält, die Zieltypen darstellen. Dies sind die beteiligten Parteien, die die Daten an ihre registrierten URLs erhalten (d.h. über registerAdBeacon()). Die möglichen Werte sind:

    • "buyer": Der Bieter in der Anzeigenauktion.
    • "seller": Der übergeordnete Verkäufer, der die Anzeigenauktion durchführt.
    • "component-seller": Der Verkäufer für eine Komponentenausschreibung in einer mehrstufigen Auktion.
    • "direct-seller": Der Verkäufer, der direkt die Auktion durchgeführt hat, an der der Käufer geboten hat. War die Anzeige eine einstufige Auktion, wird der Wert "seller" verwendet. War die Anzeige eine mehrstufige Auktion, wird der Wert "component-seller" verwendet.
    • "shared-storage-select-url": Ein Speicherort der Shared Storage API, wie in einem Window.sharedStorage.selectURL() Methodenaufruf definiert.
  • Ein Stringwert stellt ein eventType dar, zum Beispiel "click" (siehe frühere Definition von eventType). Wenn ein eventType String als Wert von reportEvent() übergeben wird, werden alle Private Aggregation Beiträge, die bedingt von diesem Ereignistyp gemacht wurden (zum Beispiel über PrivateAggregation.contributeToHistogramOnEvent()), ausgelöst, um gesendet zu werden.

Rückgabewert

Keiner (Undefined).

Beispiele

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

Spezifikationen

Specification
Fenced Frame
# dom-fence-reportevent

Browser-Kompatibilität

Siehe auch