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

属性

data-api-key (必需)	API 密钥用于标识发布商，必须提供才能使用该播放器。每个 API 密钥都与代表发布商域的封闭域列表相关联。只有属于这些域之一的 URL 才能通过网络播放器播放。在试用阶段，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 播放器（无无限滚动）非常有用。此值会覆盖它，并且仅在以下情况下才需要发布商设置它其他页面 - 当播放器嵌入在与应该大声朗读其内容的页面不同的页面时。在这种情况下，将此参数设置为另一个页面的规范 URL。多个播放器 - 当同一页面上有多个播放器时，请参阅多个播放器（无限滚动）。在这种情况下，将此参数设置为播放器应大声朗读的文章的规范 URL。缺少规范 URL 标记 - 当当前页面的规范 URL 链接标记缺失（且无法添加）时。在这种情况下，将此参数设置为页面的规范 URL。
data-speakable	控制要大声朗读的内容。如果存在，则仅使用带有 speakable 标记注释的元素中的文本；否则，Google 会自动分析文档以选择合适的文本部分。
data-call-to-action-label	在用户第一次按下“播放”之前显示的操作号召标签。发布商可以使用它作为预告，以邀请用户按下“播放”按钮。如果不存在，则显示“收听文章”（已本地化）。该字符串可以是任何语言。
data-intro	在播放器开始从头开始阅读之前播放的 MP3 音频文件的 URL。发布商可以使用 intro 为每个回放创建独特的开头。每当听众从头开始播放时，都会播放 intro。
data-outro	在播放器结束阅读后播放的 MP3 音频文件的 URL。发布商可以使用 outro 为每个回放创建独特的结尾。
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