本 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 |
在直播中插入广告插入点。广告插入点可能会触发广告插播时间点。 |
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 资源可在直播视频流中开始广告插播。
注意：用于控制广告插入点的 API 命令实际上是 YouTube Content ID API 的一部分，与管理 liveBroadcast 和 liveStream 资源的请求不同的授权要求。
| 方法 | HTTP 请求 | 说明 |
|---|---|---|
相对于 https://www.googleapis.com/ 的 URI |
||
insert |
POST /liveCuepoints |
在直播中插入广告插入点。目前，对此方法的请求必须由与 YouTube 内容所有者相关联的帐号进行授权。 |
赞助商
sponsor 资源表示 YouTube 频道的赞助商。赞助者向创作者提供经常性资金支持（如订阅费或会员费），并获享特殊福利。例如，如果创作者为聊天对话开启了赞助者专享模式，则赞助者将能够与他人聊天。
| 方法 | HTTP 请求 | 说明 |
|---|---|---|
相对于 https://www.googleapis.com/youtube/v3 的 URI |
||
list |
GET /sponsors |
列出频道的赞助者。此 API 请求必须获得频道所有者的授权。 |