Fence: setReportEventDataForAutomaticBeacons()-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 setReportEventDataForAutomaticBeacons()-Methode der Fence-Schnittstelle gibt die Ereignisdaten an, die gesendet werden, wenn eine Navigation innerhalb eines <fencedframe> erfolgt. Diese Daten werden über ein automatisches Beacon an eine oder mehrere spezifische URLs gesendet, die über die registerAdBeacon()-Methode der Protected Audience API registriert wurden, zum Zweck der Erfassung von Berichtsdaten für Auktionsergebnisse von Anzeigen.

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

Syntax

js
setReportEventDataForAutomaticBeacons(event)

Parameter

event

Ein Objekt, das die zu sendenden Daten darstellt. Die möglichen Eigenschaften sind wie folgt:

eventType

Ein String, der den Typ des gemeldeten Ereignisses darstellt. Die verfügbaren Werte sind:

  • reserved.top_navigation_start: Ein Ereignis, das ausgelöst wird, wenn eine Navigation auf oberster Ebene beginnt.
  • reserved.top_navigation_commit: Ein Ereignis, das ausgelöst wird, wenn eine Navigation auf oberster Ebene abgeschlossen wird.
eventData

Ein String, der die zu sendenden Daten darstellt.

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 Hauptverkä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. Wenn die Anzeige eine einstufige Auktion war, wird der Wert "seller" verwendet. Wenn die Anzeige eine mehrstufige Auktion war, wird der Wert "component-seller" verwendet.
  • "shared-storage-select-url": Ein Shared Storage API-Speicherort, wie in einem Window.sharedStorage.selectURL()-Methodenaufruf definiert.
once Optional

Ein boolescher Wert. Wenn auf true gesetzt, wird das automatische Beacon nur für das nächste Ereignis gesendet, und Beacons werden nicht für nachfolgende Ereignisse gesendet, bis setReportEventDataForAutomaticBeacons() erneut aufgerufen wird. Zum Beispiel kann dies in Verbindung mit einem click-Handler verwendet werden, um Beacon-Daten nur für bestimmte Navigationen auf oberster Ebene zu senden, anstatt für jede Navigation auf oberster Ebene. Diese Eigenschaft ist standardmäßig false.

Rückgabewert

Keiner (Undefined).

Beispiele

js
window.fence.setReportEventDataForAutomaticBeacons({
  eventType: "reserved.top_navigation_start",
  eventData: "an example string",
  destination: ["seller", "buyer"],
});

Spezifikationen

Specification
Fenced Frame
# dom-fence-setreporteventdataforautomaticbeacons

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch