围栏：setReportEventDataForAutomaticBeacons() 方法

实验性： 这是一个 实验性技术
在生产环境中使用此功能之前，请仔细查看 浏览器兼容性表。

setReportEventDataForAutomaticBeacons() 方法是 Fence 接口的一部分，用于指定在 <fencedframe> 内部发生导航时将发送的事件数据。此数据将通过自动 信标 发送到通过 registerAdBeacon() 方法（受保护受众 API）注册的一个或多个特定 URL，用于收集广告拍卖结果的报告数据。

注意： reportEvent() 提供类似的报告数据提交，区别在于在这种情况下，提交是通过显式方法调用触发的，而不是导航触发的。

语法

js
setReportEventDataForAutomaticBeacons(event)

参数

event

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

eventType

表示正在报告的事件类型的字符串。可用的值是：

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

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

destination

包含一个或多个枚举值（表示目标类型）的数组。这些是将接收数据的相关方（即通过 registerAdBeacon()）。可能的值是：

  • "buyer"：广告拍卖中的竞价者。
  • "seller"：运行广告拍卖的顶级卖家。
  • "component-seller"：多级拍卖中组件拍卖的卖家。
  • "direct-seller"：直接运行竞价者竞标的拍卖的卖家。如果广告是单级拍卖，则使用 "seller" 值。如果广告是多级拍卖，则使用 "component-seller" 值。
  • "shared-storage-select-url"：共享存储 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

浏览器兼容性

BCD 表仅在启用 JavaScript 的浏览器中加载。

另请参阅