List
|
|||||
|
|
||||
Returns a list of categories that can be associated with YouTube channels
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage your YouTube account
- See, edit, and permanently delete your YouTube videos, ratings, comments and captions
- View your YouTube account
- View and manage your assets and associated content on YouTube
Input
This building block consumes 4 input parameters
| Name | Format | Description |
|---|---|---|
part Required |
STRING |
The part parameter specifies the guideCategory resource properties that the API response will include. Set the parameter value to snippet |
hl |
STRING |
The hl parameter specifies the language that will be used for text values in the API response |
id |
STRING |
The id parameter specifies a comma-separated list of the YouTube channel category ID(s) for the resource(s) that are being retrieved. In a guideCategory resource, the id property specifies the YouTube channel category ID |
regionCode |
STRING |
The regionCode parameter instructs the API to return the list of guide categories available in the specified country. The parameter value is an ISO 3166-1 alpha-2 country code |
= Parameter name
= Format
|
part STRING Required The part parameter specifies the guideCategory resource properties that the API response will include. Set the parameter value to snippet |
|
hl STRING The hl parameter specifies the language that will be used for text values in the API response |
|
id STRING The id parameter specifies a comma-separated list of the YouTube channel category ID(s) for the resource(s) that are being retrieved. In a guideCategory resource, the id property specifies the YouTube channel category ID |
|
regionCode STRING The regionCode parameter instructs the API to return the list of guide categories available in the specified country. The parameter value is an ISO 3166-1 alpha-2 country code |
Output
This building block provides 17 output parameters
| Name | Format | Description |
|---|---|---|
etag |
STRING |
Etag of this resource |
eventId |
STRING |
Serialized EventId of the request which produced this response |
items[] |
OBJECT |
A guideCategory resource identifies a category that YouTube algorithmically assigns based on a channel's content or other indicators, such as the channel's popularity. The list is similar to video categories, with the difference being that a video's uploader can assign a video category but only YouTube can assign a channel category |
items[].etag |
STRING |
Etag of this resource |
items[].id |
STRING |
The ID that YouTube uses to uniquely identify the guide category |
items[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#guideCategory" |
items[].snippet |
OBJECT |
Basic details about a guide category |
items[].snippet.channelId |
STRING |
|
items[].snippet.title |
STRING |
Description of the guide category |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#guideCategoryListResponse" |
nextPageToken |
STRING |
The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set |
pageInfo |
OBJECT |
Paging details for lists of resources, including total number of items available and number of resources returned in a single page |
pageInfo.resultsPerPage |
INTEGER |
The number of results included in the API response |
pageInfo.totalResults |
INTEGER |
The total number of results 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 |
tokenPagination |
OBJECT |
Stub token pagination template to suppress results |
visitorId |
STRING |
The visitorId identifies the visitor |
= Parameter name
= Format
|
etag STRING Etag of this resource |
|
eventId STRING Serialized EventId of the request which produced this response |
|
items[] OBJECT A guideCategory resource identifies a category that YouTube algorithmically assigns based on a channel's content or other indicators, such as the channel's popularity. The list is similar to video categories, with the difference being that a video's uploader can assign a video category but only YouTube can assign a channel category |
|
items[].etag STRING Etag of this resource |
|
items[].id STRING The ID that YouTube uses to uniquely identify the guide category |
|
items[].kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#guideCategory" |
|
items[].snippet OBJECT Basic details about a guide category |
|
items[].snippet.channelId STRING |
|
items[].snippet.title STRING Description of the guide category |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#guideCategoryListResponse" |
|
nextPageToken STRING The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set |
|
pageInfo OBJECT Paging details for lists of resources, including total number of items available and number of resources returned in a single page |
|
pageInfo.resultsPerPage INTEGER The number of results included in the API response |
|
pageInfo.totalResults INTEGER The total number of results 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 |
|
tokenPagination OBJECT Stub token pagination template to suppress results |
|
visitorId STRING The visitorId identifies the visitor |