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 spezifiziert Ereignisdaten, die gesendet werden, wenn eine Navigation innerhalb eines <fencedframe> stattfindet. Diese Daten werden automatisch über einen Beacon an eine oder mehrere spezifische URLs gesendet, die über die registerAdBeacon()-Methode der Protected Audience API registriert wurden, um Berichterstattungsdaten für Auktionsergebnisse von Anzeigen zu sammeln.

Note: reportEvent() bietet eine ähnliche Möglichkeit zur Ü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 repräsentiert. Die möglichen Eigenschaften sind wie folgt:

eventType

Ein String, der den Typ des zu berichtenden 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 ist.
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 (z. B. ü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 die Auktion direkt durchgeführt hat, bei der der Bieter geboten hat. Wenn es sich um eine einstufige Auktion handelt, wird der Wert "seller" verwendet. Bei einer mehrstufigen Auktion wird der Wert "component-seller" verwendet.
  • "shared-storage-select-url": Ein Speicherort der Shared Storage API, wie in einem Methodenaufruf von Window.sharedStorage.selectURL() definiert.
once Optional

Ein boolescher Wert. Wenn true gesetzt ist, wird der automatische Beacon nur für das nächste Ereignis gesendet, und Beacons werden für nachfolgende Ereignisse nicht gesendet, bis setReportEventDataForAutomaticBeacons() erneut aufgerufen wird. Zum Beispiel kann dies, wenn es mit einem click-Handler verwendet wird, genutzt werden, um Beacon-Daten nur für bestimmte Top-Level-Navigationen zu senden und nicht für jede Top-Level-Navigation. 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

Siehe auch