在非 AMP 站点上使用 Web Story 播放器创建 Web Story 体验

重要提示：此文档不适用于您当前选择的广告格式！

什么是 Web Story 播放器？

Web Story 播放器演示

Web Story 播放器是您使用 Web Story 为用户提供丰富用户体验的最佳方式。把它想象成一个视频播放器：在您的设备中只有一个视频很好，但将其放在网络上的视频播放器中，它会解锁许多特性和优势：有额外的控件（例如，字幕），它与数百万其他视频一起存在，这些视频可以在您的原始视频结束时提供相关内容——这增加了可发现性，等等。

您可以类似地考虑 Web Story 播放器。仅链接到一个故事，您可能会错过其他故事平台（例如 Instagram、Snapchat）中存在且对故事用户来说很自然的许多功能和体验。请参阅下表了解一些示例。

本指南主要包含非 AMP 版本播放器上可用的功能。要了解使用 AMP 兼容版本播放器可以实现什么，请访问在 AMP 页面中集成故事文章。

	单个故事	Web Story 播放器
更丰富的用户体验
向下滑动以退出故事并返回您的站点	❌	✅
滑动到下一个/上一个故事	❌	✅
同一站点入口点	❌	✅
自定义能力
自定义事件（例如，在故事之间导航）	❌	✅
其他 UI 控件	❌	✅
向故事添加署名	❌	✅
以编程方式获取更多故事	❌	✅
自定义行为（例如，循环包裹）	❌	✅

常见实现

您可以使用 Web Story 播放器在您自己的平台上创建多种体验，从轮播到单张卡片，再到直接将故事嵌入页面。我们开发了一份详细的 UX 指南，其中包含与这些示例相关的最佳实践。我们推荐的最常见模式是轮播。我们将概述创建此类体验的最佳实践，但您可以随意进行实验并实施最适合您用例的实践。我们将在未来几周内分享更广泛的 UX 模式列表。

轮播（UX 细节）

Web Story 播放器轮播

故事轮播有多个彼此相邻的故事。它通常包括故事的预览，如缩略图和标题。单击后，它将打开故事。然后，用户可以消费故事或在故事之间滑动。

在此处查看实时演示！

此示例中的重要方面

在桌面上
- 播放器有一个“关闭”按钮以退出灯箱体验
- 播放器有一个“跳至下一个”按钮以跳至下一个故事
- 入口点在悬停时显示背景卡片
在移动设备上
- 支持滑动以在故事之间导航
- “滚动背景页面”被禁用，以便将该手势用于滑动关闭
- 入口点卡片比桌面小
- 没有背景卡片（因为在移动设备中没有悬停）
- 启用向下滑动以关闭故事
在两种屏幕尺寸上
- 播放器开始时处于暂停状态，只有在用户单击入口点后才开始播放。
- 轮播遵循剧本中的 UX 最佳实践。

要查看构建此所需的所有代码，请访问codepen 项目。

向播放器添加故事

向播放器添加故事主要有三种方法。

将它们声明为播放器 HTML 中的锚标记。
使用获取行为从端点获取更多故事。
使用 add() API 添加一个或多个故事。

如果您只想在播放器中显示一组静态故事，则最佳选择是 (1)。但如果您想动态添加故事，则可以使用选项 (2) 或 (3)。

显示故事

在播放器中显示和添加故事的最简单方法是直接在 <amp-story-player> 元素所在的 HTML 中将其声明为 <a> 标记。请参阅本指南的“显示 Web Story”部分中的代码示例。

从端点获取更多故事

当用户在 Web Story 播放器中浏览故事时，您可以创建“无限滚动”体验。为此，请包含fetch 操作并在 JSON 配置中指定端点。当用户接近最后加载的故事时，播放器会自动获取更多故事。您可以通过设置后端个性化系统并使用 fetch 操作来为用户提供个性化的故事。

使用 add() API 添加故事

您可以使用add() API手动添加一个或多个故事。

可自定义的 UI

播放器解锁了许多功能，可让您自定义系统显示的 UI。除了控件之外，您还可以为播放器内的故事添加署名，以便用户知道他们当前正在与之互动的故事的发布者。

为创建者/发布者添加署名

Web Story 中的署名

故事顶部的创建者标题

故事署名显示实体或发布者的名称和徽标。单击后，它会将用户导航到实体 URL 或发布者的规范域。

要在故事上显示署名，请使用播放器的 display 和 attribution 选项。请参阅JSON 配置。

数据将来自故事文档中 <amp-story> 的元数据属性，如所述

对于徽标：entity-logo-src 属性（如果提供），否则为 publisher-logo-src 属性。
对于文本字符串：entity 属性（如果提供），否则为 publisher 属性。
当单击署名时，它会将用户导航到 URL。如果提供，则将来自 entity-url 属性，否则将使用故事的规范域。

在amp-story 的元数据指南中了解有关这些属性的更多信息。

修改和添加现有控件

这包括用于创建类似灯箱体验的“关闭”按钮和用于在桌面上在故事之间导航的“跳至下一个”按钮。您还可以添加自己的自定义控件并侦听其事件以执行自定义操作。请参阅以下示例以了解您可以执行的操作。

要配置它们，请将具有 type=”application/json” 属性的 JSON 配置指定为 <amp-story-player> 元素的子项。

在配置内部，指定一个“controls”数组。“controls”结构如下所述。

配置最终将如下所示

<amp-story-player>

 <script type="application/json">
   {
     "controls": [
       {
         "name": "close",
         "position": "start"
       },
       {
         "name": "skip-to-next"
       }
     ]
   }
 </script>

<a href="./story1.html"> ... </a>
<a href="./story2.html"> ... </a>
</amp-story-player>

示例 #1 - 起始位置的关闭按钮

由于默认值（当包含自定义 UI 配置 JSON 时）会将所有这些按钮设置到右侧，因此我们所要做的就是将关闭按钮移动到开头。

<amp-story-player>
 <script type="application/json">
   {
     "controls": [
       {
         "name": "close",
         "position": "start"
       }
     ],
   }
 </script>
 ...

在起始位置对播放器进行精细控制

在桌面设备上，您现在可以显示一个按钮，该按钮可从当前故事导航到下一个故事。一旦用户到达播放器中故事的末尾，该按钮也会自动禁用。

<amp-story-player>
 <script type="application/json">
   {
     "controls": [
       {
         "name": "skip-to-next"
       }
     ],
   }
 </script>
 ...
</amp-story-player>

播放器的跳至下一个控制

示例 #3 - 更改关闭按钮的图标

<amp-story-player>
 <script type="application/json">
   {
     "controls": [
       {
         "name": "close",
         "backgroundImageUrl": "data:image\/svg+xml;charset=utf-8,<svg width=\"24\" height=\"24\" viewBox=\"0 0 24 24\" fill=\"none\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\"><path fill-rule=\"evenodd\" clip-rule=\"evenodd\" d=\"M5.77778 9.33333H4V4H9.33333V5.77778H5.77778V9.33333ZM4 14.6667H5.77778V18.2222H9.33333V20H4V14.6667ZM18.2222 18.2222H14.6667V20H20V14.6667H18.2222V18.2222ZM14.6667 5.77778V4H20V9.33333H18.2222V5.77778H14.6667Z\" fill=\"white\"\/><\/svg>",
         "position": "start"
       }
     ]
   }
 </script>
 ...
</amp-story-player>

使用自定义图标的播放器关闭控制

修改行为

有许多选项可以自定义播放器的行为。请阅读以下部分，了解您可以执行的操作。

循环包裹

如果您希望用户在看完最后一个故事后返回第一个故事，则可以启用循环包裹选项。

在后台倒回故事

如果您想倒回用户在播放器中已经看过的故事，可以使用rewind() API来执行此操作。

您可以在播放器内以编程方式在故事和页面之间导航。如果您想在播放器外部创建自己的导航按钮，或者想根据事件（例如）在页面之间切换，这可能会很有用。为此，请使用go() 和 show() API 及其变体。

优化性能和 SEO

播放器会在后台执行许多操作，以确保它仅使用在任何给定时刻所需的资源。也就是说，您可以在自己的终端上做一些事情，以确保您的网站在使用播放器时性能良好。

对于首屏上方的播放器

如果您希望将故事嵌入到首屏上方（在网页的上半部分；无需向下滚动页面即可看到），我们建议等到用户交互后再加载和播放第一个故事。为此，请按照以下步骤操作

使用 JSON 配置禁用自动播放。
添加将开始播放故事的用户交互。
使用播放器 API 在检测到用户交互时调用 play()。

对于首屏下方的播放器

首屏下方的播放器会自动针对性能进行优化，并且只会预加载第一个故事，直到检测到滚动。一旦播放器在视口中可见，故事就会开始播放。