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 参数用于指定 API 响应将包含的一个或多个 liveBroadcast 资源属性的英文逗号分隔列表。您可以在参数值中添加的 part 名称包括 id、snippet、contentDetails、monetizationDetails 和 status。
过滤条件（请仅指定以下参数之一）
broadcastStatus string
broadcastStatus 参数用于过滤 API 响应，使其仅包含具有指定状态的广播。

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

可接受的值为： <ph type="x-smartling-placeholder">
    </ph>
  • all - 返回所有广播。
  • event - 仅返回已安排的活动广播。
  • persistent - 仅返回持久性广播。
maxResults unsigned integer
maxResults 参数用于指定结果集中应返回的最大项数。可接受的值包括0到50（含 0 和 50000）。默认值为 5。
onBehalfOfContentOwner string
此参数只能在适当授权的请求中使用。
注意：此参数专供 YouTube 内容合作伙伴使用。

onBehalfOfContentOwner 参数用于指明请求的授权凭据可标识代表参数值中指定的内容所有者的 YouTube 内容管理系统 (CMS) 用户。此参数适用于拥有和管理多个不同 YouTube 频道的 YouTube 内容合作伙伴。通过它，内容所有者只需验证一次身份，即可访问自己所有的视频和频道数据，而无需为每个频道提供身份验证凭据。用户进行身份验证时使用的内容管理系统账号必须与指定的 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 请求和响应。