ChannelSections: list

返回符合 API 请求条件的 channelSection 资源列表。

对配额的影响:调用此方法的配额费用为 1 个单位。

常见使用场景

请求

HTTP 请求

GET https://www.googleapis.com/youtube/v3/channelSections

参数

下表列出了此查询支持的参数。列出的所有参数都是查询参数。

参数
必需参数
part string
part 参数会指定一个逗号分隔列表,其中包含 API 响应将包含的一个或多个 channelSection 资源属性。

如果该参数标识了包含子属性的媒体资源,相应子属性将包含在响应中。例如,在 channelSection 资源中,snippet 属性包含其他属性,例如相应部分的显示标题。如果您设置了 part=snippet,API 响应还将包含所有这些嵌套属性。

以下列表包含您可以包含在参数值中的 part 名称:
  • contentDetails
  • id
  • snippet
过滤条件(请仅指定以下参数之一)
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 内容管理系统用户。此参数适用于拥有和管理众多不同 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 请求和响应。