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

瀏覽器相容性

另見