LiveBroadcasts: list

返回与 API 请求参数匹配的 YouTube 直播列表。

常见应用场景

请求

HTTP 请求

GET https://www.googleapis.com/youtube/v3/liveBroadcasts

授权

此请求需要使用至少以下一个范围进行授权。如需详细了解身份验证和授权，请参阅实现 OAuth 2.0 身份验证。

范围
https://www.googleapis.com/auth/youtube.readonly
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

参数

下表列出了此查询支持的参数。列出的所有参数都是查询参数。

参数
必需参数
part string
part 参数用于指定一个逗号分隔列表，其中包含一个或多个 liveBroadcast 资源属性，API 响应将包含这些属性。您可以包含在参数值中的 part 名称包括 id、snippet、contentDetails、monetizationDetails 和 status。
过滤条件 （指定以下参数中的一个）
broadcastStatus string
broadcastStatus 参数用于过滤 API 响应，使其仅包含具有指定状态的直播。

可接受的值包括：
  • active：返回当前直播。
  • all：返回所有直播。
  • completed：返回已结束的直播。
  • upcoming：返回尚未开始的直播。
id string
id 参数用于指定一个逗号分隔列表，其中包含用于标识要检索的直播的 YouTube 直播 ID。在 liveBroadcast 资源中，id 属性用于指定直播的 ID。
mine boolean
mine 参数可用于指示 API 仅返回经过身份验证的用户拥有的直播。将参数值设置为 true，即可仅检索您自己的直播。
可选参数
broadcastType string
broadcastType 参数用于过滤 API 响应，使其仅包含具有指定类型的直播。此参数应在将 mine 参数设置为 true 或使用 broadcastStatus 参数的请求中使用。默认值为 event。

可接受的值包括：
  • all：返回所有直播。
  • event：仅返回已安排的活动直播。
  • persistent：仅返回永久直播。
maxResults unsigned integer
maxResults 参数用于指定结果集中应返回的项数上限。可接受的值为 0 到 50（含端点值）。默认值为 5。
onBehalfOfContentOwner string
此参数只能在经过适当授权的请求中使用。
注意：此参数仅供 YouTube 内容合作伙伴使用。

onBehalfOfContentOwner 参数表示请求的授权凭据标识的是一个 YouTube 内容管理系统 (CMS) 用户，该用户代表参数值中指定的内容所有者行事。此参数适用于拥有和管理许多不同 YouTube 频道的 YouTube 内容合作伙伴。它允许内容所有者进行一次身份验证，即可访问其所有视频和频道数据，而无需为每个频道提供身份验证凭据。用户进行身份验证时使用的 CMS 账号必须与指定的 YouTube 内容所有者相关联。
onBehalfOfContentOwnerChannel string
此参数只能在经过适当授权的请求中使用。
注意：此参数仅供 YouTube 内容合作伙伴使用。

onBehalfOfContentOwnerChannel 参数用于指定要向其添加视频的频道的 YouTube 频道 ID。当请求为 onBehalfOfContentOwner 参数指定值时，此参数是必需的，并且只能与该参数搭配使用。此外，请求必须使用与 onBehalfOfContentOwner 参数指定的内容所有者相关联的 CMS 账号进行授权。最后，onBehalfOfContentOwnerChannel 参数值指定的频道必须与 onBehalfOfContentOwner 参数指定的内容所有者相关联。

此参数适用于拥有和管理许多不同 YouTube 频道的 YouTube 内容合作伙伴。它允许内容所有者进行一次身份验证，即可代表参数值中指定的频道执行操作，而无需为每个单独的频道提供身份验证凭据。
pageToken string
pageToken 参数用于标识结果集中应返回的特定页面。在 API 响应中，nextPageToken 和 prevPageToken 属性用于标识可以检索的其他页面。

请求正文

调用此方法时，请勿提供请求正文。

响应

如果成功，此方法将返回采用以下结构的响应正文：

{
  "kind": "youtube#liveBroadcastListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveBroadcast Resource
  ]
}

属性

下表定义了此资源中显示的属性：

属性
kind string
标识 API 资源的类型。该值将为 youtube#liveBroadcastListResponse。
etag etag
此资源的 ETag。
nextPageToken string
可用作 pageToken 参数值的令牌，用于检索结果集中的下一页。
prevPageToken string
可用作 pageToken 参数值的令牌，用于检索结果集中的上一页。
pageInfo object
pageInfo 对象用于封装结果集的分页信息。
pageInfo.totalResults integer
结果集中的结果总数。
pageInfo.resultsPerPage integer
API 响应中包含的结果数。
items[] list
与请求条件匹配的直播列表。

错误

下表列出了 API 在响应对此方法的调用时可能会返回的出错提示。如需了解详情，请参阅出错提示。

错误类型 错误详情 说明
insufficientPermissions insufficientLivePermissions 请求无权检索直播。
insufficientPermissions liveStreamingNotEnabled 授权请求的用户无权在 YouTube 上直播视频。如需了解详情，请参阅功能使用资格。

试试看！

使用 APIs Explorer 调用此 API，并查看 API 请求和响应。