返回与 API 请求条件匹配的 channelSection
资源列表。
配额影响:调用此方法的配额费用为 1 个单位。
常见使用场景
请求
HTTP 请求
GET https://www.googleapis.com/youtube/v3/channelSections
参数
下表列出了此查询支持的参数。列出的所有参数都是查询参数。
参数 | ||
---|---|---|
必需参数 | ||
part |
string part 参数用于指定 API 响应将包含的一个或多个 channelSection 资源属性的英文逗号分隔列表。如果该参数标识了一个包含子媒体资源的属性,则子媒体资源将包含在响应中。例如,在 channelSection 资源中,snippet 属性包含其他属性,例如相应部分的显示名。如果您设置了 part=snippet ,API 响应还将包含所有这些嵌套属性。以下列表包含可在参数值中包含的 part 名称:
|
|
过滤器(请准确指定以下参数之一) | ||
channelId |
string channelId 参数用于指定 YouTube 频道 ID。如果请求指定了该参数的值,该 API 将仅返回指定渠道的版块。 |
|
id |
string id 参数指定以英文逗号分隔的 ID 列表,用于唯一标识要检索的 channelSection 资源。在 channelSection 资源中,id 属性用于指定相应部分的 ID。 |
|
mine |
boolean 此参数只能在正确的授权请求中使用。将此参数的值设置为 true ,以检索与经过身份验证的用户的 YouTube 频道相关联的频道部分的 Feed。 |
|
可选参数 | ||
hl |
string 此参数已被弃用。 hl 参数支持检索频道部分的本地化元数据。不过,此功能已在 YouTube 工作室和 YouTube 应用中弃用。 |
|
onBehalfOfContentOwner |
string 此参数只能在正确的授权请求中使用。注意:此参数专供 YouTube 内容合作伙伴使用。 onBehalfOfContentOwner 参数表示请求的授权凭据用于标识代表参数值中指定的内容所有者执行操作的 YouTube CMS 用户。此参数适用于拥有和管理许多不同 YouTube 频道的 YouTube 内容合作伙伴。内容所有者只需进行一次身份验证,即可访问自己所有的视频和频道数据,而无需为每个频道提供身份验证凭据。用户身份验证所用的 CMS 帐号必须与指定的 YouTube 内容所有者相关联。 |
请求正文
调用此方法时请勿提供请求正文。
响应
如果成功,此方法将返回采用以下结构的响应正文:
{ "kind": "youtube#channelSectionListResponse", "etag": etag, "items": [ channelSection Resource ] }
属性
下表定义了此资源中显示的属性:
属性 | |
---|---|
kind |
string 标识 API 资源类型。值为 youtube#channelSectionListResponse 。 |
etag |
etag 此资源的 Etag。 |
items[] |
list 与请求条件匹配的 ChannelSections 列表。 |
错误
下表列出了该 API 为响应对此方法的调用可能返回的错误消息。如需了解详情,请参阅错误消息文档。
错误类型 | 错误详情 | 说明 |
---|---|---|
forbidden (403) |
channelSectionForbidden |
请求者无法访问所请求的频道部分。 |
invalidValue (400) |
idInvalid |
该请求指定的频道版块 ID 无效。 |
invalidValue (400) |
invalidCriteria |
由于过滤条件无效,因此请求无法完成。 |
notFound (404) |
channelNotFound |
找不到与该请求关联的频道。 |
notFound (404) |
channelSectionNotFound |
找不到与该请求关联的频道部分。 |
试试看!
使用 APIs Explorer 调用此 API,并查看 API 请求和响应。