AMP

将 AMP 与应用集成

Important: this documentation is not applicable to your currently selected format email!

本指南面向希望集成和链接到 AMP 网页的移动应用和网络应用开发者。例如,某移动聊天应用可以加载所分享网址的 AMP 版本,为用户带来更快的体验。

转换指向 AMP 的链接

借助 AMP,您可以近乎即时地在原生或移动网络应用内呈现外部网站。要实现此效果,您可以将内容中的网址与对应的 AMP 网址(如果存在)相匹配并打开 AMP 版本(而非原始版本)。您可以使用 Google 的 AMP URL API 等工具来实现此效果。

例如,通过将所有网址替换为与之匹配的 AMP 版本(如果存在),可以转换以下消息来提供 AMP 版本。为缩短加载时间并保证提供有效的 AMP 网页,您应当链接到 AMP 缓存中的缓存 AMP 网页。

原始消息:

This is a message with links to an <a href="http://www.example.org/a">
article with AMP version</a> and an <a href="http://www.example.org/b"> article without AMP version</a>.

转换后的消息:

This is a message with links to an <a href="https://www-example-org.cdn.ampproject.org/c/www.example.org/a">
article with AMP version</a> and an <a href="www.example.org/b"> article without AMP version</a>.

提示:建议在应用的偏好设置中给用户提供选项,以便他们能够选择查看非 AMP 版本,而不是 AMP 版本。

转换链接的方式

您可以通过以下三种方式程序化地转换链接:

  1. 写入时服务器端(首选):通过 Google 的 AMP URL API 在写入网址时检索 AMP 网址,并将 AMP 网址存储在服务器端。将两种网址都传递到客户端,因为分享时可能会用到原始网址。建议您使用此方式,因为客户端网络请求数更少。采用此方式时,请务必定期(例如,每天)检查是否有 AMP 版本的链接,因为越来越多的网站在采用 AMP 格式。
  2. 读取时服务器端(某些情况):通过 Google 的 AMP URL API 检索 AMP 网址,然后再将内容传递到客户端。如上所述,请将两种网址(AMP 和非 AMP)都传递到客户端,因为在分享时可能会用到原始网址。此方式适用于低扇出服务。
  3. 客户端(如果无法采用服务器端网址转换):通过 Google 的 AMP URL API 从客户端检索 AMP 网址。如果无法使用服务器端网址转换,请使用此方式(例如,对于使用端到端加密的即时通讯应用)。确保在内容可用后、发生任何用户互动之前立即触发网址转换。

重要提示:请勿在用户互动后通过 Google 的 AMP API 请求 AMP 网址,因为这样做会导致网络请求增加,进而降低应用性能。请使用如上所述的三种方式之一。

Google 的 AMP URL API

借助 Google 的 AMP URL API,您可以检索与给定网址列表匹配的 AMP HTML 网址(官方文档/演示)。这些网址无需是规范版本。如果存在 AMP 版本,响应中将包括原始 AMP 网址和 Google AMP 缓存中的缓存 AMP 网页对应的网址。

例如,对于给定的网址列表:

{"urls": [
  "https://www.example.org/article-with-amp-version",
  "http://www.example.com/no-amp-version.html"
]}

响应正文包含 JSON 格式的 AMP 网址映射:

{
  "ampUrls": [
    {
      "originalUrl": "https://www.example.org/article-with-amp-version",
      "ampUrl": "https://www.example.org/article-with-amp-version/amp",
      "cdnAmpUrl": "https://www-example-org.cdn.ampproject.org/c/s/www.example.org/article-with-amp-version"
    }
  ],
  "urlErrors": [
    {
      "errorCode": "NO_AMP_URL",
      "errorMessage": "AMP URL not found.",
      "originalUrl": "http://www.example.com/no-amp-version.html"
    }
  ]
}

:您无法通过 AMP URL API 检索非 Google AMP 缓存中的缓存 AMP 网页对应的网址。但是,您可以从返回的 AMP 网址 (ampURL) 轻松得出缓存的网址。

使用 AMP 缓存

AMP 缓存是一种基于代理的内容分发网络 (CDN),用于分发有效的 AMP 文档。AMP 缓存旨在:

  • 仅提供有效的 AMP 网页。
  • 让 AMP 网页能够安全高效地预加载。
  • 对内容进行额外的性能优化,以提升用户体验。

目前,有 2 个 AMP 缓存提供商:

这意味着您可以通过两种方式使用以下任一版本在应用中显示 AMP 文件:

  1. 由发布商托管的版本
  2. 在 AMP 缓存中托管的版本

我们建议使用 AMP 缓存,原因如下:

  • 加载速度更快且延迟更短(加载时间缩短 1 秒以上),所以用户体验更佳。
  • 额外缓存依赖于客户端的工件(例如,缓存同一图片的不同版本,具体取决于客户端的视口大小),因此可提高性能并节省带宽。
  • 原始 AMP 文件可能不再是有效的 AMP,这样可能会导致糟糕的用户体验。在这种情况下,AMP 缓存会提供 AMP 文件的最后一个有效版本。
  • 不太正派的发布商可能会向 AMP 缓存抓取工具和您的用户提供两个不同的文档。使用 AMP 缓存可保证用户看到的 AMP 文件始终与 AMP 缓存看到的相同。

重要提示:通过 AMP 缓存提供 AMP 网页时,提供的查看工具体验应清楚地显示 AMP 来源并使用户能够分享规范网址(要了解详情,另请参阅以下两部分内容)。

实现 AMP 查看工具

AMP 运行时提供了一个 Viewer API,后者提供了在 AMP 运行时与查看工具之间收发消息的协议。这样,您就可以控制 AMP 文档的预呈现、在报道之间的滑动以及 AMP 运行时插桩行为。要详细了解 AMP Viewer API,请参阅将 AMP 查看工具与 AMP 网页相关联指南。您可以在 GitHub 上找到针对网络iOS 的查看工具实现方式。Android 查看工具尚未推出,请参阅 Stack Overflow 上的此回答,了解如何以最佳方式配置 WebView 以显示 AMP 网页。

下面介绍了一些关于实现 AMP 查看工具的一般最佳做法:

  • 从 AMP 缓存提供 AMP 网页(加载时间缩短 1 秒以上)。
  • 显示报道的发布商来源(例如,在可收起标头中)。
  • 提供分享操作(另请参阅下方的“分享 AMP 内容”部分)。
  • 在基于 WebView 的查看工具中,启用第三方 Cookie。
  • 为您的平台/应用设置引荐来源。

分享 AMP 内容

在平台的 AMP 查看工具内分享 AMP 文档时,平台应当分享规范网址(如果在技术上可行)。例如,如果平台提供了分享按钮,则此按钮应当分享规范网址。

AMP 项目的理念是平台应当选择向用户提供哪个版本的文档。因此,在分享到不同平台时,应当分享规范版本(而不是 AMP 版本),然后让目标平台做出正确的选择。