返回与 API 请求参数匹配的视频流列表。
常见使用场景
请求
HTTP 请求
GET https://www.googleapis.com/youtube/v3/liveStreams
授权
此请求需要获得以下至少一个范围的授权(详细了解身份验证和授权)。
范围 |
---|
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 响应将包含的一个或多个 liveStream 资源属性的英文逗号分隔列表。您可以在参数值中添加的 part 名称为 id 、snippet 、cdn 和 status 。 |
|
过滤器(请准确指定以下参数之一) | ||
id |
string id 参数用于指定以英文逗号分隔的 YouTube 直播 ID 列表,此 ID 用于标识要检索的直播。在 liveStream 资源中,id 属性指定数据流的 ID。 |
|
mine |
boolean 此参数只能在正确的授权请求中使用。 mine 参数可用于指示 API 仅返回已通过身份验证的用户拥有的视频流。将参数值设为 true 即可仅检索您自己的视频流。 |
|
可选参数 | ||
maxResults |
unsigned integer maxResults 参数用于指定结果集中应返回的最大项数。可接受的值包括0 到50 (含 0 和 5000)。默认值为 5 。 |
|
onBehalfOfContentOwner |
string 此参数只能在正确的授权请求中使用。注意:此参数专供 YouTube 内容合作伙伴使用。 onBehalfOfContentOwner 参数表示请求的授权凭据用于标识代表参数值中指定的内容所有者执行操作的 YouTube CMS 用户。此参数适用于拥有和管理许多不同 YouTube 频道的 YouTube 内容合作伙伴。内容所有者只需进行一次身份验证,即可访问自己所有的视频和频道数据,而无需为每个频道提供身份验证凭据。用户身份验证所用的 CMS 帐号必须与指定的 YouTube 内容所有者相关联。 |
|
onBehalfOfContentOwnerChannel |
string 此参数只能在正确的授权请求中使用。此参数只能在适当的授权请求中使用。注意:此参数仅适用于 YouTube 内容合作伙伴。 onBehalfOfContentOwnerChannel 参数用于指定要添加视频的频道的 YouTube 频道 ID。当请求为 onBehalfOfContentOwner 参数指定值时,必须提供此参数,并且该参数只能与该参数结合使用。此外,必须使用与 onBehalfOfContentOwner 参数指定的内容所有者相关联的 CMS 帐号对请求进行授权。最后,onBehalfOfContentOwnerChannel 参数值指定的频道必须与 onBehalfOfContentOwner 参数指定的内容所有者相关联。此参数适用于拥有和管理许多不同 YouTube 频道的 YouTube 内容合作伙伴。使用 Content ID,内容所有者只需进行一次身份验证,即可代表参数值中指定的频道执行操作,而无需为每个单独的频道提供身份验证凭据。 |
|
pageToken |
string pageToken 参数用于标识结果集中应返回的特定网页。在 API 响应中,nextPageToken 和 prevPageToken 属性用于标识可检索的其他页面。 |
请求正文
调用此方法时请勿提供请求正文。
响应
如果成功,此方法将返回采用以下结构的响应正文:
{ "kind": "youtube#liveStreamListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveStream Resource ] }
属性
下表定义了此资源中显示的属性:
属性 | |
---|---|
kind |
string 标识 API 资源类型。值为 youtube#liveStreamListResponse 。 |
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 请求和响应。