List
|
|||||
|
|
Returns channelSection resources that match the API request criteria
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 6 input parameters
Name | Format | Description |
---|---|---|
part Required |
STRING |
The part parameter specifies a comma-separated list of one or more channelSection resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channelSection resource, the snippet property contains other properties, such as a display title for the channelSection. If you set part=snippet, the API response will also contain all of those nested properties |
channelId |
STRING |
The channelId parameter specifies a YouTube channel ID. The API will only return that channel's channelSections |
hl |
STRING |
The hl parameter indicates that the snippet.localized property values in the returned channelSection resources should be in the specified language if localized values for that language are available. For example, if the API request specifies hl=de, the snippet.localized properties in the API response will contain German titles if German titles are available. Channel owners can provide localized channel section titles using either the channelSections.insert or channelSections.update method |
id |
STRING |
The id parameter specifies a comma-separated list of the YouTube channelSection ID(s) for the resource(s) that are being retrieved. In a channelSection resource, the id property specifies the YouTube channelSection ID |
mine |
BOOLEAN |
Set this parameter's value to true to retrieve a feed of the authenticated user's channelSections |
onBehalfOfContentOwner |
STRING |
Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner |
= Parameter name
= Format
part STRING Required The part parameter specifies a comma-separated list of one or more channelSection resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channelSection resource, the snippet property contains other properties, such as a display title for the channelSection. If you set part=snippet, the API response will also contain all of those nested properties |
channelId STRING The channelId parameter specifies a YouTube channel ID. The API will only return that channel's channelSections |
hl STRING The hl parameter indicates that the snippet.localized property values in the returned channelSection resources should be in the specified language if localized values for that language are available. For example, if the API request specifies hl=de, the snippet.localized properties in the API response will contain German titles if German titles are available. Channel owners can provide localized channel section titles using either the channelSections.insert or channelSections.update method |
id STRING The id parameter specifies a comma-separated list of the YouTube channelSection ID(s) for the resource(s) that are being retrieved. In a channelSection resource, the id property specifies the YouTube channelSection ID |
mine BOOLEAN Set this parameter's value to true to retrieve a feed of the authenticated user's channelSections |
onBehalfOfContentOwner STRING Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner |
Output
This building block provides 27 output parameters
Name | Format | Description |
---|---|---|
etag |
STRING |
Etag of this resource |
eventId |
STRING |
Serialized EventId of the request which produced this response |
items[] |
OBJECT |
|
items[].contentDetails |
OBJECT |
Details about a channelsection, including playlists and channels |
items[].contentDetails.channels[] |
STRING |
|
items[].contentDetails.playlists[] |
STRING |
|
items[].etag |
STRING |
Etag of this resource |
items[].id |
STRING |
The ID that YouTube uses to uniquely identify the channel section |
items[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection" |
items[].localizations |
OBJECT |
Localizations for different languages |
items[].localizations.customKey |
OBJECT |
Add additional named properties |
items[].localizations.customKey.title |
STRING |
The localized strings for channel section's title |
items[].snippet |
OBJECT |
Basic details about a channel section, including title, style and position |
items[].snippet.channelId |
STRING |
The ID that YouTube uses to uniquely identify the channel that published the channel section |
items[].snippet.defaultLanguage |
STRING |
The language of the channel section's default title and description |
items[].snippet.localized |
OBJECT |
ChannelSection localization setting |
items[].snippet.localized.title |
STRING |
The localized strings for channel section's title |
items[].snippet.position |
INTEGER |
The position of the channel section in the channel |
items[].snippet.style |
ENUMERATION |
The style of the channel section |
items[].snippet.title |
STRING |
The channel section's title for multiple_playlists and multiple_channels |
items[].snippet.type |
ENUMERATION |
The type of the channel section |
items[].targeting |
OBJECT |
ChannelSection targeting setting |
items[].targeting.countries[] |
STRING |
|
items[].targeting.languages[] |
STRING |
|
items[].targeting.regions[] |
STRING |
|
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#channelSectionListResponse" |
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 |
items[].contentDetails OBJECT Details about a channelsection, including playlists and channels |
items[].contentDetails.channels[] STRING |
items[].contentDetails.playlists[] STRING |
items[].etag STRING Etag of this resource |
items[].id STRING The ID that YouTube uses to uniquely identify the channel section |
items[].kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection" |
items[].localizations OBJECT Localizations for different languages |
items[].localizations.customKey OBJECT Add additional named properties |
items[].localizations.customKey.title STRING The localized strings for channel section's title |
items[].snippet OBJECT Basic details about a channel section, including title, style and position |
items[].snippet.channelId STRING The ID that YouTube uses to uniquely identify the channel that published the channel section |
items[].snippet.defaultLanguage STRING The language of the channel section's default title and description |
items[].snippet.localized OBJECT ChannelSection localization setting |
items[].snippet.localized.title STRING The localized strings for channel section's title |
items[].snippet.position INTEGER The position of the channel section in the channel |
items[].snippet.style ENUMERATION The style of the channel section |
items[].snippet.title STRING The channel section's title for multiple_playlists and multiple_channels |
items[].snippet.type ENUMERATION The type of the channel section |
items[].targeting OBJECT ChannelSection targeting setting |
items[].targeting.countries[] STRING |
items[].targeting.languages[] STRING |
items[].targeting.regions[] STRING |
kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#channelSectionListResponse" |
visitorId STRING The visitorId identifies the visitor |