amp-iframe

1.0 0.1

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

<script async custom-element="amp-iframe" src="https://cdn.ampproject.org/v0/amp-iframe-1.0.js"></script>
<link rel="stylesheet" href="https://cdn.ampproject.org/v0/amp-iframe-1.0.css">

用法

显示一个有效的 AMP iframe。amp-iframe 与普通的 iframe 有几个重要的区别，这些区别旨在使其更安全，并避免 AMP 文件被单个 iframe 占据

• amp-iframe 不能出现在文档顶部附近（使用 placeholder 的 iframe 除外，如下所述）。当滚动到顶部时，iframe 必须距离顶部 600 像素，或者不在视口前 75% 的范围内，以较小者为准。
• 默认情况下，amp-iframe 是沙盒化的（请参阅详细信息）。
• amp-iframe 必须仅通过 HTTPS、数据 URI 或通过 srcdoc 属性请求资源。
• amp-iframe 不得与容器位于同一源中，除非它们不允许在 sandbox 属性中使用 allow-same-origin。有关 iframe 允许的来源的更多详细信息，请参阅“Iframe 来源策略”文档。

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

从 0.1 迁移

与 0.1 不同，实验性的 1.0 版本 amp-iframe 已弃用 frameborder 属性。使用 CSS border 属性来控制 <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 可能无法获得可见性信息。

在有效 AMP 文档之外的独立使用

Bento 允许您在非 AMP 页面中使用 AMP 组件，而无需提交到完全有效的 AMP。您可以将这些组件放置在使用不支持 AMP 的框架和 CMS 的实现中。请参阅我们的指南在非 AMP 页面中使用 AMP 组件，了解更多信息。

要查找 amp-iframe 的独立版本，请参阅bento-iframe。

带占位符的 Iframe

当 amp-iframe 具有 placeholder 元素时，可以使 amp-iframe 出现在文档顶部，如下例所示。

• amp-iframe 必须包含一个带有 placeholder 属性的元素（例如 amp-img 元素），该元素将作为占位符渲染，直到 iframe 准备好显示。
• 可以通过监听 iframe 的 onload 或 iframe 文档发送的 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 元素一样，amp-iframe 必须具有定义的静态布局。但是，可以在运行时调整 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 运行时会尽快尝试满足请求，但它会考虑读者当前的阅读位置、滚动是否正在进行以及任何其他 UX 或性能因素。如果运行时无法满足调整大小请求，则 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);
  });
});

当交叉率在阈值 [0, 0.05, 0.1, ... 0.9, 0.95, 1] 之间发生变化时，父级会将交叉消息以 IntersectionObserver 条目的格式发送到 iframe。

属性

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。

如果您要嵌入一个并非专门为沙盒化而创建的文档，则很可能需要在 sandbox 属性中添加 allow-scripts allow-same-origin，并且可能需要允许其他功能。

另请注意，沙盒应用于从沙盒化 iframe 打开的所有窗口。这包括使用 target=_blank 创建的新窗口（添加 allow-popups 以允许这种情况发生）。在 sandbox 属性中添加 allow-popups-to-escape-sandbox 会使这些新窗口的行为类似于非沙盒化的新窗口。这很可能就是您想要和期望的结果。不幸的是，截至撰写本文时，allow-popups-to-escape-sandbox 受 Chrome、Firefox、Safari 和 Opera 支持，但 Edge 不支持。

有关 sandbox 属性的更多详细信息，请参阅 MDN 上的文档。

常用属性

amp-iframe 包含扩展到 AMP 组件的通用属性。

分析

我们强烈建议将 amp-analytics 用于分析目的，因为它是一种更加强大、完整且高效的解决方案，可以为各种分析供应商进行配置。

AMP 每页只允许一个用于分析和跟踪目的的 iframe。为了节省资源，这些 iframe 将在加载后的 5 秒从 DOM 中删除，这应该足以完成需要完成的任何工作。

如果 iframe 看起来没有直接的用户目的（例如不可见或很小），则它们将被标识为跟踪/分析 iframe。

验证

请参阅 AMP 验证器规范中的 amp-iframe 规则。