AMP

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

amp-google-read-aloud-player

描述

嵌入 Google Read Aloud Player。

 

必需的脚本

<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 Read Aloud Player。此播放器会大声朗读您的页面内容。

属性

data-api-key (必填) API 密钥标识发布商,必须提供才能使用播放器。

每个 API 密钥都与代表发布商域名的封闭域名列表相关联。只有属于这些域名之一的 URL 才能通过 Web 播放器播放。

在试用阶段,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 链接标记。这对于大声朗读当前页面的内容非常有用,并且页面中只嵌入了一个 Read Aloud 播放器(无无限滚动)。

此值会覆盖它,并且发布商仅在以下情况下需要设置它
  1. 其他页面 - 当播放器嵌入到与应大声朗读其内容的页面不同的页面中时。在这种情况下,将此参数设置为另一个页面的规范 URL。
  2. 多个播放器 - 当同一页面上有多个播放器时,请参阅多个播放器(无限滚动)。在这种情况下,将此参数设置为播放器应大声朗读的文章的规范 URL。
  3. 缺少规范 URL 标记 - 当当前页面的规范 URL 链接标记丢失时(且无法添加)。在这种情况下,将此参数设置为页面的规范 URL。
data-speakable 控制要大声朗读的内容。

存在时,仅使用带有 speakable 标记注释的元素中的文本,否则,Google 会自动分析文档以选择合适的文本部分。
data-call-to-action-label 首次按下播放按钮之前显示的号召性用语标签。发布商可以使用它作为预告片,邀请用户按下播放按钮。如果不存在,则会显示“收听文章”(已本地化)。字符串可以是任何语言。
data-intro MP3 音频文件的 URL,该音频文件将在播放器开始从头朗读之前播放。发布商可以使用介绍为每个回放创建独特的开头。每当听众从头开始回放时,都会播放介绍。
data-outro MP3 音频文件的 URL,该音频文件将在播放器结束朗读后播放。发布商可以使用结尾为每个回放创建独特的结尾。
data-ad-tag-url 一个完整的 VAST 广告代码网址,带有用于播放前置音频广告的参数。存在时,音频广告将在大声朗读页面内容之前播放,在用户第一次单击播放按钮后。如果不存在,则只会播放页面内容。
广告代码网址必须包含以下参数
  • 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