返回与 API 请求条件匹配的 channelSection 资源列表。
配额影响: 调用此方法会消耗 1 个配额单位。
常见应用场景
请求
HTTP 请求
GET https://www.googleapis.com/youtube/v3/channelSections
参数
下表列出了此查询支持的参数。列出的所有参数都是查询参数。
| 参数 | ||
|---|---|---|
| 必需参数 | ||
part |
stringpart 参数用于指定一个或多个 channelSection 资源属性的英文逗号分隔列表,API 响应将包含这些属性。如果该参数标识的属性包含子属性,则子属性将包含在响应中。例如,在 channelSection 资源中,snippet 属性包含其他属性,例如版块的显示标题。如果您设置 part=snippet,API 响应还将包含所有这些嵌套属性。以下列表包含您可以包含在参数值中的 part 名称:
|
|
| 过滤条件 (准确指定以下参数之一) | ||
channelId |
stringchannelId 参数用于指定 YouTube 频道 ID。如果请求为此参数指定了值,API 将仅返回指定频道的版块。 |
|
id |
stringid 参数用于指定一个逗号分隔列表的 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与请求条件匹配的 ChannelSection 列表。 |
错误
下表列出了 API 在响应对此方法的调用时可能会返回的出错提示。如需了解详情,请参阅错误消息文档。
| 错误类型 | 错误详情 | 说明 |
|---|---|---|
forbidden (403) |
channelSectionForbidden |
请求者无权访问所请求的频道版块。 |
invalidValue (400) |
idInvalid |
请求指定了无效的频道版块 ID。 |
invalidValue (400) |
invalidCriteria |
由于过滤条件无效,无法完成请求。 |
notFound (404) |
channelNotFound |
找不到与请求关联的频道。 |
notFound (404) |
channelSectionNotFound |
找不到与请求关联的频道版块。 |
试试看!
使用 APIs Explorer 调用此 API,并查看 API 请求和响应。