API 参考文档

此 API 参考文档介绍了如何使用 YouTube Live Streaming API 在 YouTube 上安排直播和视频在线播放。

资源类型

LiveBroadcasts

liveBroadcast 资源表示将在 YouTube 上通过直播视频流式传输的活动。

如需详细了解此资源，请参阅其资源表示形式和属性列表。

方法 HTTP 请求 说明
相对于 https://www.googleapis.com/youtube/v3 的 URI
bind POST /liveBroadcasts/bind 将 YouTube 直播绑定到直播，或解除直播与直播之间的现有绑定。一个直播只能绑定到一个视频流，但一个视频流可以绑定到多个直播。
delete DELETE /liveBroadcasts 删除广播。
insert POST /liveBroadcasts 创建广播。
list GET /liveBroadcasts 返回与 API 请求参数匹配的 YouTube 直播的列表。
transition POST /liveBroadcasts/transition 更改 YouTube 直播的状态，并启动与新状态相关的所有进程。例如，当您将直播的状态转换为 testing 时，YouTube 会开始向该直播的监控数据流传输视频。在调用此方法之前，您应确认绑定到广播的串流的 status.streamStatus 属性的值为 active。
update PUT /liveBroadcasts 更新广播。例如，您可以修改 liveBroadcast 资源的 contentDetails 对象中定义的广播设置。
cuepoint POST /liveBroadcasts/cuepoint 在直播中插入 cuepoint。该 cue 点可能会触发广告插播时间点。

LiveChatBans

liveChatBan 资源用于标识 YouTube 用户以及该用户被禁止参与的 YouTube 实时聊天。

如需详细了解此资源，请参阅其资源表示形式和属性列表。

方法 HTTP 请求 说明
相对于 https://www.googleapis.com/youtube/v3 的 URI
delete DELETE /liveChat/bans 解除禁止特定用户参与实时聊天的禁令，以便该用户重新加入聊天。此 API 请求必须由频道所有者或与禁播相关的直播聊天室的管理员授权。
insert POST /liveChat/bans 禁止特定用户参与实时聊天。此 API 请求必须由频道所有者或与禁播相关联的直播聊天室的管理员授权。

LiveChatMessages

liveChatMessage 资源表示 YouTube 实时聊天中的聊天消息。该资源可以包含有关多种类型消息的详细信息，包括新发布的短信或粉丝赞助活动。

直播聊天功能默认为直播启用，并在直播活动期间可用。（活动结束后，该活动将无法再进行实时聊天。）

如需详细了解此资源，请参阅其资源表示形式和属性列表。

方法 HTTP 请求 说明
相对于 https://www.googleapis.com/youtube/v3 的 URI
delete DELETE /liveChat/messages 删除聊天消息。此 API 请求必须由频道所有者或与禁播相关联的直播聊天室的管理员授权。
insert POST /liveChat/messages 向实时聊天添加消息。
list GET /liveChat/messages 列出特定聊天的实时聊天消息。

LiveChatModerators

liveChatModerator 资源表示 YouTube 实时聊天的管理员。聊天管理员可以禁止或解除用户的聊天禁言、移除消息，以及对实时聊天执行其他管理操作。

如需详细了解此资源，请参阅其资源表示形式和属性列表。

方法 HTTP 请求 说明
相对于 https://www.googleapis.com/youtube/v3 的 URI
delete DELETE /liveChat/moderators 移除聊天管理员。该请求必须获得直播频道所有者的授权。
insert POST /liveChat/moderators 为聊天添加新管理员。该请求必须获得直播频道所有者的授权。
list GET /liveChat/moderators 列出实时聊天的管理员。该请求必须获得直播频道所有者的授权。

LiveStreams

liveStream 资源包含有关您要传输到 YouTube 的视频串流的信息。该数据流提供将向 YouTube 用户广播的内容。创建后，liveStream 资源可以绑定到一个或多个 liveBroadcast 资源。

如需详细了解此资源，请参阅其资源表示形式和属性列表。

方法 HTTP 请求 说明
相对于 https://www.googleapis.com/youtube/v3 的 URI
delete DELETE /liveStreams 删除视频串流。
insert POST /liveStreams 创建视频流。借助此流式传输功能，您可以将视频发送到 YouTube，然后 YouTube 会将视频广播给您的观众。
list GET /liveStreams 返回与 API 请求参数匹配的视频串流列表。
update PUT /liveStreams 更新视频流。如果您要更改的属性无法更新，则需要使用正确的设置创建新的数据流。

SuperChatEvents

superChatEvent 资源代表粉丝在 YouTube 直播期间购买的超级留言。在 YouTube 实时聊天中，超级留言以两种方式让您的消息更引人注目：

  • 超级留言会以某种颜色突出显示。
  • 超级留言会在置顶栏中固定展示一段时间。

超级留言的颜色、在置顶栏中固定展示的时长以及消息的最大长度都取决于购买金额。请访问 YouTube 帮助中心，详细了解超级留言。

如需详细了解此资源，请参阅其资源表示形式和属性列表。

方法 HTTP 请求 说明
相对于 https://www.googleapis.com/youtube/v3 的 URI
list GET /superChatEvents 列出频道过去 30 天内直播中的超级留言活动。

已废弃的资源类型

FanFundingEvents

fanFundingEvent 资源表示 YouTube 频道上的粉丝赞助活动。粉丝赞助功能让您可以通过金钱的方式支持 YouTube 创作者。当用户向频道进行一次性自愿付款时，就会发生粉丝赞助事件。如需详细了解粉丝赞助，请访问 YouTube 帮助中心。

如需详细了解此资源，请参阅其资源表示形式和属性列表。

方法 HTTP 请求 说明
相对于 https://www.googleapis.com/youtube/v3 的 URI
list GET /fanFundingEvents 列出频道的粉丝赞助活动。API 请求必须由频道所有者授权。

LiveCuepoints

liveCuepoint 资源用于在直播视频串流中开始广告插播。

注意：用于控制 cue 点的 API 命令实际上是 YouTube Content ID API 的一部分，其授权要求与管理 liveBroadcast 和 liveStream 资源的请求不同。

如需详细了解此资源，请参阅其资源表示形式和属性列表。

方法 HTTP 请求 说明
相对于 https://www.googleapis.com/ 的 URI
insert POST /liveCuepoints 在直播中插入 cuepoint。目前，使用此方法提交的请求必须由与 YouTube 内容所有者关联的账号授权。

赞助商

sponsor 资源表示 YouTube 频道的赞助商。赞助商向创作者提供定期的金钱支持（例如订阅费或会员费），并获得特殊福利。例如，当创作者为聊天开启赞助者专享模式时，赞助者就可以参与聊天。

如需详细了解此资源，请参阅其资源表示形式和属性列表。

方法 HTTP 请求 说明
相对于 https://www.googleapis.com/youtube/v3 的 URI
list GET /sponsors 列出频道的赞助商。API 请求必须由频道所有者授权。