Fenced Frame API
Fence 接口的 reportEvent() 方法通过信标触发报告数据的提交,将数据发送到通过受保护的受众 API 的 InterestGroupReportingScriptRunnerGlobalScope.registerAdBeacon 方法注册的一个或多个特定 URL,以收集广告竞价结果。
[!NOTE] Fence.setReportEventDataForAutomaticBeacons 提供类似的报告数据提交功能,除非提交是通过导航而不是显式的方法调用触发的。
语法
reportEvent(event)
参数
event- : 表示要发送的数据的对象或字符串。
- 对象值定义一个你想要发送的特定报告事件。必需属性如下:
eventType- : 表示正在报告的事件类型的字符串——例如,你可能想要了解广告被点击的次数。这个字符串可以是任何相关的事件名称(例如
click)。这需要与受保护的受众 API worklet 中关联的 InterestGroupReportingScriptRunnerGlobalScope.registerAdBeacon 调用指定的事件类型相匹配。
- : 表示正在报告的事件类型的字符串——例如,你可能想要了解广告被点击的次数。这个字符串可以是任何相关的事件名称(例如
eventData- : 表示要发送的数据的字符串。
destination- : 包含一个或多个枚举值的数组,这些值代表目标类型。这些是将接收数据到其注册 URL(即通过 InterestGroupReportingScriptRunnerGlobalScope.registerAdBeacon)的涉及方。可能的值包括:
"buyer":广告竞价中的出价方。"seller":运行广告竞价的顶级卖方。"component-seller":多级竞价中组成竞价的卖方。"direct-seller":直接运行买家投标竞价的卖方。如果广告是单级竞价,则使用的值为"seller"。如果广告是多级竞价,则使用的值为"component-seller"。"shared-storage-select-url":共享存储 API 存储位置,如在 WindowSharedStorage.selectURL 方法调用中所定义。
- : 包含一个或多个枚举值的数组,这些值代表目标类型。这些是将接收数据到其注册 URL(即通过 InterestGroupReportingScriptRunnerGlobalScope.registerAdBeacon)的涉及方。可能的值包括:
- 字符串值表示一个
eventType,例如"click"(参见前面eventType的定义)。当将eventType字符串作为reportEvent()的值传递时,它会触发所有基于该事件类型(例如通过 PrivateAggregation.contributeToHistogramOnEvent())做出的隐私聚合贡献的发送。
- 对象值定义一个你想要发送的特定报告事件。必需属性如下:
- : 表示要发送的数据的对象或字符串。
返回值
无(undefined)。
示例
window.fence.reportEvent({
eventType: "click",
eventData: JSON.stringify({ clickX: "123", clickY: "456" }),
destination: ["buyer", "seller"],
});
规范
浏览器兼容性
参见
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
