我们正在更新 Data API,以便与 YouTube 统计 Shorts 短视频观看次数的方式保持一致。
了解详情
VideoCategories: list
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
返回可与 YouTube 视频相关联的类别列表。
对配额的影响:调用此方法的配额费用为 1 个单位。
常见使用场景
请求
HTTP 请求
GET https://www.googleapis.com/youtube/v3/videoCategories
参数
下表列出了此查询支持的参数。列出的所有参数都是查询参数。
参数 |
必需参数 |
part |
string
part 参数指定 API 响应将包含的 videoCategory 资源属性。将参数值设为 snippet 。
|
过滤条件(请仅指定以下参数之一) |
id |
string
id 参数用于指定要检索的资源的视频类别 ID 列表(以英文逗号分隔)。 |
regionCode |
string
regionCode 参数指示 API 返回在指定国家/地区提供的视频类别列表。此参数值是 ISO 3166-1 alpha-2 国家/地区代码。 |
可选参数 |
hl |
string
hl 参数指定 API 响应中文本值应使用的语言。默认值为 en_US 。 |
响应
如果成功,此方法将返回采用以下结构的响应正文:
{
"kind": "youtube#videoCategoryListResponse",
"etag": etag,
"nextPageToken": string,
"prevPageToken": string,
"pageInfo": {
"totalResults": integer,
"resultsPerPage": integer
},
"items": [
videoCategory resource
]
}
属性
下表定义了此资源中显示的属性:
属性 |
kind |
string 标识 API 资源的类型。其值为 youtube#videoCategoryListResponse 。 |
etag |
etag
此资源的 Etag。 |
nextPageToken |
string
可用作 pageToken 参数值的令牌,用于检索结果集中的下一页。 |
prevPageToken |
string
可用作 pageToken 参数值的令牌,用于检索结果集中的上一页。 |
pageInfo |
object
pageInfo 对象可封装结果集的分页信息。 |
pageInfo.totalResults |
integer
结果集中的结果总数。 |
pageInfo.resultsPerPage |
integer
API 响应中包含的结果数量。 |
items[] |
list
可与 YouTube 视频相关联的视频类别列表。在此映射中,视频类别 ID 是映射键,其值是相应的 videoCategory 资源。 |
错误
下表列出了 API 在响应对此方法的调用时可能会返回的错误消息。如需了解详情,请参阅错误消息文档。
错误类型 |
错误详情 |
说明 |
notFound (404) |
videoCategoryNotFound |
找不到由 id 参数标识的视频类别。使用 videoCategories.list 方法检索了有效值列表。 |
试试看!
使用 APIs Explorer 调用此 API 并查看 API 请求和响应。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2024-04-26。
[null,null,["最后更新时间 (UTC):2024-04-26。"],[],[],null,["# VideoCategories: list\n\nReturns a list of categories that can be associated with YouTube videos.\n\n**Quota impact:** A call to this method has a [quota cost](/youtube/v3/getting-started#quota) of 1 unit.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/youtube/v3/videoCategories\n```\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `part` | `string` The **part** parameter specifies the `videoCategory` resource properties that the API response will include. Set the parameter value to `snippet`. |\n| **Filters (specify exactly one of the following parameters)** |||\n| `id` | `string` The **id** parameter specifies a comma-separated list of video category IDs for the resources that you are retrieving. |\n| `regionCode` | `string` The **regionCode** parameter instructs the API to return the list of video categories available in the specified country. The parameter value is an [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes/iso_3166_code_lists/country_names_and_code_elements.htm) country code. |\n| **Optional parameters** |||\n| `hl` | `string` The **hl** parameter specifies the language that should be used for text values in the API response. The default value is `en_US`. |\n\n### Request body\n\nDo not provide a request body when calling this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure: \n\n```objective-c\n{\n \"kind\": \"youtube#videoCategoryListResponse\",\n \"etag\": etag,\n \"nextPageToken\": string,\n \"prevPageToken\": string,\n \"pageInfo\": {\n \"totalResults\": integer,\n \"resultsPerPage\": integer\n },\n \"items\": [\n videoCategory resource\n ]\n}\n```\n\n### Properties\n\nThe following table defines the properties that appear in this resource:\n\n| Properties ||\n|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the API resource's type. The value will be `youtube#videoCategoryListResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `nextPageToken` | `string` The token that can be used as the value of the `pageToken` parameter to retrieve the next page in the result set. |\n| `prevPageToken` | `string` The token that can be used as the value of the `pageToken` parameter to retrieve the previous page in the result set. |\n| `pageInfo` | `object` The `pageInfo` object encapsulates paging information for the result set. |\n| pageInfo.`totalResults` | `integer` The total number of results in the result set. |\n| pageInfo.`resultsPerPage` | `integer` The number of results included in the API response. |\n| `items[]` | `list` A list of video categories that can be associated with YouTube videos. In this map, the video category ID is the map key, and its value is the corresponding `videoCategory` resource. |\n\nErrors\n------\n\nThe following table identifies error messages that the API could return in response to a call to this method. Please see the [error message](/youtube/v3/docs/errors) documentation for more detail.\n\n| Error type | Error detail | Description |\n|------------------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `notFound (404)` | `videoCategoryNotFound` | The video category identified by the `id` parameter cannot be found. Use the [videoCategories.list](/youtube/v3/docs/videoCategories/list) method to retrieve a list of valid values. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]