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 元件)，則應將 amp-iframe 元件視為備用方案。這是因為使用針對特定使用案例量身打造的 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 沙箱屬性。
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 不支援。

如需 sandbox 屬性的詳細資訊，請參閱 MDN 上的文件。

通用屬性

amp-iframe 包含延伸至 AMP 元件的 通用屬性。

分析

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

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

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

驗證

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