Fence:setReportEventDataForAutomaticBeacons() 方法

可用性有限

此特性不是基线特性,因为它在一些最广泛使用的浏览器中不起作用。

实验性: 这是一项实验性技术
在生产中使用此技术之前,请仔细检查浏览器兼容性表格

Fence 接口的 setReportEventDataForAutomaticBeacons() 方法指定当导航发生在 <fencedframe> 内部时将发送的事件数据。这些数据将通过一个自动 信标 发送到一个或多个通过 registerAdBeacon() 方法在 Protected Audience API 中注册的特定 URL,目的是收集广告竞价结果的报告数据。

注意: reportEvent() 提供类似的数据提交,不同之处在于,在这种情况下,提交是由显式方法调用触发的,而不是由导航触发。

语法

js
setReportEventDataForAutomaticBeacons(event)

参数

event

一个表示要发送的数据的对象。可能的属性如下

eventType

一个表示正在报告的事件类型的字符串。可用值为

  • reserved.top_navigation_start:在顶级导航开始时触发的事件。
  • reserved.top_navigation_commit:在顶级导航完成时触发的事件。
eventData

一个表示要发送的数据的字符串。

destination

一个包含一个或多个枚举值的数组,表示目标类型。这些是接收数据到其注册 URL(即通过 registerAdBeacon())的参与方。可能的值为

  • "buyer":广告竞价中的竞价方。
  • "seller":运行广告竞价的顶级卖家。
  • "component-seller":多级竞价中的组件竞价的卖家。
  • "direct-seller":直接运行竞价的卖家(竞价方在该竞价中出价)。如果广告是单级竞价,则使用值 "seller"。如果广告是多级竞价,则使用值 "component-seller"
  • "shared-storage-select-url"Shared Storage API 的存储位置,在 Window.sharedStorage.selectURL() 方法调用中定义。
once 可选

一个布尔值。如果设置为 true,则自动信标仅为下一次事件发送,并且在再次调用 setReportEventDataForAutomaticBeacons() 之前,不会为后续事件发送信标。例如,当与 click 处理程序一起使用时,可以仅为特定的顶级导航发送信标数据,而不是为所有顶级导航发送。此属性默认为 false

返回值

无(Undefined)。

示例

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

规范

规范
围栏框架
# dom-fence-setreporteventdataforautomaticbeacons

浏览器兼容性

另见