返回与 API 请求参数匹配的 YouTube 广播列表。
常见使用场景
请求
HTTP 请求
GET https://www.googleapis.com/youtube/v3/liveBroadcasts
授权
此请求需要获得以下至少一个范围的授权(详细了解身份验证和授权)。
范围 |
---|
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 响应进行过滤,以便仅包含具有指定状态的广播。可接受的值为:
|
|
id |
string id 参数指定了以逗号分隔的 YouTube 广播 ID 列表,用于标识正在检索的广播。在 liveBroadcast 资源中,id 属性用于指定广播的 ID。 |
|
mine |
boolean mine 参数可用于指示 API 仅返回归经过身份验证的用户拥有的广播。将参数值设为 true 可仅检索您自己的广播。 |
|
可选参数 | ||
broadcastType |
string broadcastType 参数会过滤 API 响应,使其仅包含指定类型的广播。该参数应在将 mine 参数设置为 true 或使用 broadcastStatus 参数的请求中使用。默认值为 event 。可接受的值为:
|
|
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 上直播实时视频的权限。用户可以访问 https://www.youtube.com/features 了解详情。 |
试试看!
使用 APIs Explorer 调用此 API 并查看 API 请求和响应。