amp-google-read-aloud-player

描述

嵌入 Google 朗读播放器。

所需脚本

<script async custom-element="amp-google-read-aloud-player" src="https://cdn.ampproject.org/v0/amp-google-read-aloud-player-0.1.js"></script>

支持的布局

固定固定高度

行为

嵌入 Google 朗读播放器。此播放器会大声朗读您页面上的内容。

属性

data-api-key（必需）	API 密钥标识发布者，必须提供此密钥才能使用播放器。每个 API 密钥都与一个封闭的域名列表相关，该列表代表发布者域名。只有属于这些域名之一的网址才能由网络播放器播放。在试用阶段，API 密钥将由 Google 提供给发布者。使用 Google Cloud Console 生成的其他 API 密钥将无法使用。
data-tracking-ids（必需）	Google Analytics 跟踪 ID 列表，用于发送播放器指标（以逗号分隔）。在试用期间使用此播放器时，您需要拥有 Google Analytics 跟踪 ID。跟踪 ID 将由 Google 提供给您。如果您还想将播放器指标发送到您的 Google Analytics 帐号，请将您的跟踪 ID（或 ID）添加到此列表中。
data-voice（必需）	用于生成文本转语音音频的声音。发布商应仅使用一个声音，并且仅从受支持的声音列表（待定）中选择。
data-url	要朗读的网页的规范 URL。该 URL 必须可公开访问，且不包含任何 PII。该 URL 必须位于 Google 配置的域中，并与特定 API 密钥相关联。当未提供该参数时，播放器将使用当前页面的规范 URL 链接标签。这对于朗读当前页面的内容非常有用，并且页面中仅嵌入了一个朗读播放器（无无限滚动）。此值会覆盖它，并且发布商仅在以下情况下需要设置它其他页面 - 当播放器嵌入到与应朗读其内容的页面不同的页面中时。在这种情况下，将此参数设置为另一个页面的规范 URL。多个播放器 - 当同一页面上有多个播放器时，请参阅多个播放器（无限滚动）。在这种情况下，将此参数设置为播放器应朗读的文章的规范 URL。缺少规范 URL 标记 - 当当前页面的规范 URL 链接标记丢失（且无法添加）时。在这种情况下，将此参数设置为页面的规范 URL。
data-speakable	控制要朗读的内容。存在时，仅使用标注有可朗读标记的元素中的文本，否则，Google 会自动分析文档以选择合适的文本部分。
data-call-to-action-label	用户第一次按下播放之前显示的号召性用语标签。发布商可以使用它作为预告，邀请用户按下播放按钮。如果不存在，则会显示“收听文章”（已本地化）。该字符串可以是任何语言。
data-intro	MP3 音频文件的 URL，该文件将在播放器开始从头开始朗读之前播放。发布商可以使用简介为每次播放创建独特的开头。每当听众从头开始播放时，都会播放简介。
data-outro	播放器结束朗读后将播放的 MP3 音频文件的 URL。发布商可以使用尾声为每次播放创建唯一的结尾。
data-ad-tag-url	一个完整的 VAST 广告标记 URL，其中包含用于播放前贴片音频广告的参数。如果存在，用户首次点击播放按钮后，将在朗读页面内容之前播放音频广告。如果不存在，则只播放页面内容。广告标记 URL 必须包含以下参数 iu=[广告单元代码] sz=1x1 ad_type=audio output=vast unviewed_position_start=1 env=instream vad_type=linear

用法

在 AMP 文档中包含一个 amp-google-read-aloud-player

<amp-google-read-aloud-player
  height="65"
  data-api-key="<YOUR_API_KEY>"
  data-tracking-ids="<YOUR_TRACKING_IDS>"
  data-voice="<YOUR_VOICE>"
></amp-google-read-aloud-player>

验证

请参阅 AMP 验证器规范中的 amp-google-read-aloud-player 规则。

需要更多帮助？

您已经阅读了本文档十几次，但它并没有真正涵盖您所有的问题？也许其他人也有同样的感觉：在 Stack Overflow 上联系他们。

转到 Stack Overflow

发现了一个错误或缺少某个功能？

AMP 项目强烈鼓励您参与和贡献！我们希望您成为我们开源社区的持续参与者，但我们也欢迎针对您特别热衷的问题进行一次性贡献。

转到 GitHub