Returns a list of categories that can be associated with YouTube videos.
Quota impact: A call to this method has a quota cost of 1 unit in addition to the costs of the specified resource parts.
Common use cases
Request
HTTP request
GET https://www.googleapis.com/youtube/v3/videoCategories
Parameters
The following table lists the parameters that this query supports. All of the parameters listed are query parameters.
Parameters | ||
---|---|---|
Required parameters | ||
part |
string The part parameter specifies the videoCategory resource properties that the API response will include. Set the parameter value to snippet . The snippet part has a quota cost of 2 units.
|
|
Filters (specify exactly one of the following parameters) | ||
id |
string The id parameter specifies a comma-separated list of video category IDs for the resources that you are retrieving. |
|
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 country code. |
|
Optional parameters | ||
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 . |
Request body
Do not provide a request body when calling this method.
Response
If successful, this method returns a response body with the following structure:
{ "kind": "youtube#videoCategoryListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ videoCategory resource ] }
Properties
The following table defines the properties that appear in this resource:
Properties | |
---|---|
kind |
string Identifies the API resource's type. The value will be youtube#videoCategoryListResponse . |
etag |
etag The Etag of this resource. |
nextPageToken |
string The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. |
prevPageToken |
string The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. |
pageInfo |
object The pageInfo object encapsulates paging information for the result set. |
pageInfo.totalResults |
integer The total number of results in the result set. |
pageInfo.resultsPerPage |
integer The number of results included in the API response. |
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. |
Errors
The following table identifies error messages that the API could return in response to a call to this method. Please see the error message documentation for more detail.
Error type | Error detail | Description |
---|---|---|
notFound (404) |
videoCategoryNotFound |
The video category identified by the id parameter cannot be found. Use the videoCategories.list method to retrieve a list of valid values. |
Try it!
Use the APIs Explorer to call this API and see the API request and response.