GuideCategories: list

注意:这是一则弃用公告。

自 2020 年 9 月 9 日起,guideCategories 资源和 guideCategories.list 方法均已被弃用。

返回可与 YouTube 频道相关联的类别列表。

配额影响:对该方法的调用会产生 1 个单位的配额费用

请求

HTTP 请求

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

参数

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

参数
必需参数
part string
part 参数用于指定 API 响应将包含的 guideCategory 资源属性。将参数值设置为 snippet
过滤条件(指定以下参数之一)
id string
id 参数用于指定要检索的资源的 YouTube 频道类别 ID 列表(以英文逗号分隔)。在 guideCategory 资源中,id 属性用于指定 YouTube 频道类别 ID。
regionCode string
regionCode 参数指示 API 返回指定国家/地区中可用的指南类别列表。此参数值是 ISO 3166-1 alpha-2 国家/地区代码。
可选参数
hl string
hl 参数用于指定 API 响应中使用的文本值的语言。默认值为 en-US

请求正文

调用此方法时,请勿提供请求正文。

响应

如果成功,此方法将返回采用以下结构的响应正文:

{
  "kind": "youtube#guideCategoryListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    guideCategory resource
  ]
}

属性

下表定义了此资源中显示的属性:

属性
kind string
用于标识 API 资源的类型。该值为 youtube#guideCategoryListResponse
etag etag
相应资源的 ETag。
nextPageToken string
可用作 pageToken 参数的值的令牌,用于检索结果集中的下一页。
prevPageToken string
可用作 pageToken 参数值的令牌,用于检索结果集中的上一页。
pageInfo object
pageInfo 对象封装了结果集的分页信息。
pageInfo.totalResults integer
结果集中的结果总数。
pageInfo.resultsPerPage integer
API 响应中包含的结果数。
items[] list
可与 YouTube 频道相关联的类别列表。在此映射中,类别 ID 是映射键,其值是相应的 guideCategory 资源。

错误

下表列出了该 API 可能会在响应对此方法的调用时返回的错误消息。如需了解详情,请参阅错误消息文档。

错误类型 错误详情 说明
notFound (404) notFound 找不到 id 参数所标识的指南类别。使用 guideCategories.list 方法检索有效值列表。

试试看!

使用 APIs Explorer 调用此 API,并查看 API 请求和响应。