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 像素，或者在滚动到顶部时，iframe 不在视口的头 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 的 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>

以下示例显示了一个带有嵌入就绪请求的 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. 如果请求高度低于某个阈值（100px），则将拒绝 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。

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 响应只会发送一次，并且在同意状态更改时不会更新 iframe（例如，当用户决定使用提示后 UI 拒绝同意时）
• 当省略 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 属性中，会使这些新窗口的行为类似于非沙箱新窗口。这很可能是您在大多数情况下想要和期望的。遗憾的是，截至本文撰写时，allow-popups-to-escape-sandbox 受 Chrome、Firefox、Safari 和 Opera 支持，但不受 Edge 支持。

请参阅 MDN 上的文档，以进一步了解 sandbox 属性。

通用属性

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

分析

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

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

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

验证

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