HTMLFencedFrameElement: config 屬性

可用性有限

此特性不是基線特性,因為它在一些最廣泛使用的瀏覽器中不起作用。

實驗性: 這是一項實驗性技術
在生產中使用此技術之前,請仔細檢查瀏覽器相容性表格

HTMLFencedFrameElement 介面的 config 屬性包含一個 FencedFrameConfig 物件,該物件代表了 <fencedframe> 的導航,即它將顯示什麼內容。FencedFrameConfig 物件通常來自 Protected Audience API 等來源。

config 的初始值為 null

當其值被設定為一個 FencedFrameConfig 物件例項時,FencedFrameConfig 的內部屬性(例如 mappedURL)將決定在關聯的 <fencedframe> 中載入什麼內容。此外

  • 導航型別將是 "replace"(參見 NavigateEvent.navigationType),這意味著當前歷史記錄條目將被新條目替換,而不是為其新增新的歷史記錄條目。
  • 導航的 Referrer-Policy 被設定為 "no-referrer"

示例

要設定 <fencedframe> 中將顯示的內容,使用的 API(例如 Protected AudienceShared Storage)會生成一個 FencedFrameConfig 物件,然後將其設定為 <fencedframe>config 屬性的值。

以下示例從 Protected Audience API 的廣告競價中獲取一個 FencedFrameConfig,然後用於在 <fencedframe> 中顯示中標廣告

js
const frameConfig = await navigator.runAdAuction({
  // … auction configuration
  resolveToConfig: true,
});

const frame = document.createElement("fencedframe");
frame.config = frameConfig;

注意:必須將 resolveToConfig: true 傳遞給 runAdAuction() 呼叫才能獲取 FencedFrameConfig 物件。如果未設定,結果的Promise 將解析為一個 URN,該 URN 只能在<iframe> 中使用。

規範

規範
圍欄框架
# dom-htmlfencedframeelement-config

瀏覽器相容性

另見