amp-iframe

1.0 0.1

<script async custom-element="amp-iframe" src="https://cdn.ampproject.org/v0/amp-iframe-0.1.js"></script>

用法

顯示 AMP 有效的 iframe。amp-iframe 與原生 iframe 有幾個重要的差異，這些差異旨在使其更安全，並避免 AMP 檔案由單一 iframe 佔據

• amp-iframe 不得靠近文件頂端顯示（使用 placeholder 的 iframe 除外，如下文 所述）。iframe 必須距離頂端 600 像素，或在捲動至頂端時不得位於視窗前 75% 範圍內，以較小者為準。
• 依預設，amp-iframe 會進行沙箱處理 (請參閱 詳細資訊)。
• amp-iframe 僅能透過 HTTPS、data-URI 或 srcdoc 屬性要求資源。
• amp-iframe 不得與容器位於相同來源，除非它們在 sandbox 屬性中不允許 allow-same-origin。請參閱 「Iframe 來源政策」文件，以進一步瞭解 iframe 允許的來源。

<amp-iframe
  width="200"
  height="100"
  sandbox="allow-scripts allow-same-origin"
  layout="responsive"
  frameborder="0"
  src="https://www.google.com/maps/embed/v1/place?key=AIzaSyAyAS599A2GGPKTmtNr9CptD61LE4gN6oQ&q=iceland"
>
</amp-iframe>

使用現有的 AMP 元件，而非 amp-iframe

如果無法透過 AMP 中的其他方式達成所需的使用者體驗，則應將 amp-iframe 元件視為備用方案，也就是說，針對該使用案例，目前沒有現有的 AMP 元件。這是因為使用針對特定使用案例量身打造的 AMP 元件有許多好處，例如

• 更佳的資源管理和效能
• 在某些情況下，自訂元件可以提供內建的預留位置圖片。這表示在影片載入前，先取得正確的影片縮圖，並減少手動新增預留位置的編碼工作。
• 內建調整大小功能。這表示具有不可預測大小的 iframe 內容，通常會更常以如同頁面原生內容的方式呈現給使用者，而不是在可捲動的框架中呈現
• 可以內建其他額外功能 (例如，影片播放器的自動播放功能)

amp-iframe 用於廣告的用法

絕對不得將 amp-iframe 用於顯示廣告的主要目的。將 amp-iframe 用於顯示影片的目的 (其中部分影片是廣告) 則可以接受。AMP 政策可能會透過不轉譯各自的 iframe 來強制執行。

廣告使用案例應改用 amp-ad。

此政策的原因如下

• amp-iframe 強制執行沙箱處理，且沙箱也適用於子 iframe。這表示到達網頁可能會損壞，即使廣告本身看起來可以運作。
• amp-iframe 未提供任何機制可將設定傳遞至 iframe。
• amp-iframe 沒有完全由 iframe 控制的調整大小機制。
• amp-iframe 可能無法取得可見度資訊。

具有預留位置的 Iframe

當 amp-iframe 具有 placeholder 元素時 (如下方範例所示)，amp-iframe 可能會顯示在文件頂端。

• amp-iframe 必須包含具有 placeholder 屬性的元素 (例如 amp-img 元素)，該元素會在 iframe 準備好顯示之前轉譯為預留位置。
• iframe 的就緒狀態可透過監聽 iframe 的 onload 或 embed-ready postMessage (將由 iframe 文件傳送，以先到者為準) 來得知。

以下範例顯示具有預留位置的 iframe

<amp-iframe
  width="300"
  height="300"
  layout="responsive"
  sandbox="allow-scripts allow-same-origin"
  src="https://foo.com/iframe"
>
  <amp-img layout="fill" src="https://foo.com/foo.png" placeholder></amp-img>
</amp-iframe>

以下範例顯示具有 embed-ready 要求的 iframe

window.parent.postMessage(
  {
    sentinel: 'amp',
    type: 'embed-ready',
  },
  '*'
);

Iframe 調整大小

amp-iframe 必須具有定義的靜態版面配置，如同任何其他 AMP 元素的情況一樣。但是，可以在執行階段調整 amp-iframe 的大小。若要執行此操作

1. 必須使用 resizable 屬性定義 amp-iframe。
2. amp-iframe 必須具有 overflow 子元素。此元素通常可以是 div。但是，如果 amp-iframe 是 p 元素的子元素，建議使用 span 或 button (以消除 p 元素的 詞組內容 所造成的問題)。
3. amp-iframe 必須設定 allow-same-origin sandbox 屬性。
4. iframe 文件必須以視窗訊息的形式傳送 embed-size 要求。
5. 如果要求的高度小於特定閾值 (100 像素)，則會拒絕 embed-size 要求。

請注意，resizable 會將 scrolling 的值覆寫為 no。

以下範例顯示具有 overflow 元素的 amp-iframe

<amp-iframe
  width="300"
  height="300"
  layout="responsive"
  sandbox="allow-scripts allow-same-origin"
  resizable
  src="https://foo.com/iframe"
>
  <div overflow tabindex="0" role="button" aria-label="Read more">
    Read more!
  </div>
</amp-iframe>

以下範例顯示 iframe 調整大小要求

window.parent.postMessage(
  {
    sentinel: 'amp',
    type: 'embed-size',
    height: document.body.scrollHeight,
  },
  '*'
);

一旦收到此訊息，AMP 執行階段會盡快嘗試配合要求，但會考量讀取器目前的讀取位置、捲動是否正在進行中，以及任何其他使用者體驗或效能因素。如果執行階段無法滿足調整大小要求，amp-iframe 將會顯示 overflow 元素。按一下 overflow 元素會立即調整 amp-iframe 的大小，因為這是由使用者動作觸發的。

以下是一些會影響調整大小執行速度的因素

• 調整大小是否由使用者動作觸發。
• 是否針對目前作用中的 iframe 要求調整大小。
• 是否針對視窗下方或視窗上方的 iframe 要求調整大小。

Iframe 可見度

Iframe 可以將 send-intersections 訊息傳送給其父項，以開始接收 iframe 與父項視窗交集的 IntersectionObserver 樣式 變更記錄。

以下範例顯示 iframe send-intersections 要求

window.parent.postMessage(
  {
    sentinel: 'amp',
    type: 'send-intersections',
  },
  '*'
);

iframe 可以監聽來自父視窗的 intersection 訊息，以接收交集資料。

以下範例顯示 iframe send-intersections 要求

function isAmpMessage(event, type) {
  return (
    event.source == window.parent &&
    event.origin != window.location.origin &&
    event.data &&
    event.data.sentinel == 'amp' &&
    event.data.type == type
  );
}
window.addEventListener('message', function (event) {
  if (!isAmpMessage(event, 'intersection')) {
    return;
  }
  event.data.changes.forEach(function (change) {
    console.log(change);
  });
});

當 intersectionRatio 跨越閾值 [0, 0.05, 0.1, ... 0.9, 0.95, 1] 變更時，父項會以 IntersectionObserver 條目的格式將交集訊息傳送至 iframe。

Iframe 與同意聲明資料

如果父頁面上存在 CMP，Iframe 可以傳送 send-consent-data 訊息以接收同意聲明資料。

注意：在以下範例中，我們假設指令碼位於建立的 iframe 中，其中 window.parent 是頂層視窗。如果指令碼位於巢狀 iframe 中，請將 window.parent 變更為頂層 AMP 視窗。

範例：iframe send-consent-data 要求

window.parent.postMessage(
  {
    sentinel: 'amp',
    type: 'send-consent-data',
  },
  '*'
);

iframe 可以透過監聽 consent-data 訊息來接收同意聲明資料回應。

請注意

• consent-data 回應只會傳送一次，且不會在同意聲明狀態變更時 (例如，當使用者決定透過使用後續提示 UI 拒絕同意聲明時) 更新 iframe
• 當省略 data-block-on-consent 時，會使用 default 政策，且 iframe 會立即載入。consent-data 回應可能會根據選取的政策而延遲。請參閱 amp-consent 以取得更多資訊。

範例：iframe send-consent-data 要求

function isAmpMessage(event, type) {
  return (
    event.source == window.parent &&
    event.origin != window.location.origin &&
    event.data &&
    event.data.sentinel == 'amp' &&
    event.data.type == type
  );
}
window.addEventListener('message', function (event) {
  if (!isAmpMessage(event, 'consent-data')) {
    return;
  }
  console.log(event.data.consentMetadata);
  console.log(event.data.consentString);
});

屬性

src

src 屬性的行為主要與標準 iframe 上的行為類似，但有一個例外：#amp=1 片段會新增至 URL，讓來源文件知道它們嵌入在 AMP 環境中。只有在 src 指定的 URL 尚未具有片段時，才會新增此片段。

srcdoc、frameborder、allowfullscreen、allowpaymentrequest、allowtransparency 和 referrerpolicy

這些屬性的行為應與標準 iframe 上的行為相同。

如果未指定 frameborder，則預設會設定為 0。

sandbox

由 amp-iframe 建立的 Iframe 始終在其上定義了 sandbox 屬性。依預設，值為空，這表示它們是「最大沙箱化」。透過設定 sandbox 值，可以選擇讓 iframe 減少沙箱化。瀏覽器支援的所有值都允許使用。例如，設定 sandbox="allow-scripts" 可讓 iframe 執行 JavaScript，或 sandbox="allow-scripts allow-same-origin" 可讓 iframe 執行 JavaScript、進行非 CORS XHR，以及讀取/寫入 Cookie。

如果您要將未特別考慮沙箱處理的文件設為 iframe，則很可能需要將 allow-scripts allow-same-origin 新增至 sandbox 屬性，而且您可能需要允許其他功能。

另請注意，沙箱適用於從沙箱化 iframe 開啟的所有視窗。這包括透過具有 target=_blank 的連結建立的新視窗 (新增 allow-popups 以允許這種情況發生)。將 allow-popups-to-escape-sandbox 新增至 sandbox 屬性，可讓這些新視窗的行為如同非沙箱化的新視窗。在大多數情況下，這很可能是您想要且期望的行為。遺憾的是，在撰寫本文時，Chrome、Firefox、Safari 和 Opera 支援 allow-popups-to-escape-sandbox，但 Edge 不支援。

請參閱 MDN 上的文件，以進一步瞭解 sandbox 屬性。

通用屬性

amp-iframe 包含擴充至 AMP 元件的 通用屬性。

分析

我們強烈建議基於分析目的使用 amp-analytics，因為它是一個更穩健、完整且有效率的解決方案，可以針對各種分析供應商進行設定。

AMP 每個頁面僅允許使用單一 iframe，用於分析和追蹤目的。為了節省資源，這些 iframe 將在載入後 5 秒從 DOM 中移除，這應該足以完成任何需要完成的工作。

如果 iframe 看起來沒有直接的使用者用途 (例如不可見或很小)，則會將其識別為追蹤/分析 iframe。

驗證

請參閱 AMP 驗證器規格中的 amp-iframe 規則。