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 在直播中插入提示点。提示点可能会触发广告插播。

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 列出特定聊天中的实时聊天消息。
streamList 代码演示 启用服务器流式传输连接，以低延迟接收特定聊天中的实时聊天消息。

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 请求必须获得频道所有者的授权。