Insert
|
|||||
|
|
Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel:
- Call the channelBanners.insert method to upload the binary image data to YouTube. The image must have a 16:9 aspect ratio and be at least 2120x1192 pixels.
- Extract the url property's value from the response that the API returns for step 1.
- Call the channels.update method to update the channel's branding settings. Set the brandingSettings.image.bannerExternalUrl property's value to the URL obtained in step 2
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
- Manage your YouTube videos
Input
This building block consumes 5 input parameters
Name | Format | Description |
---|---|---|
channelId |
STRING |
The channelId parameter identifies the YouTube channel to which the banner is uploaded. The channelId parameter was introduced as a required parameter in May 2017. As this was a backward-incompatible change, channelBanners.insert requests that do not specify this parameter will not return an error until six months have passed from the time that the parameter was introduced. Please see the API Terms of Service for the official policy regarding backward incompatible changes and the API revision history for the exact date that the parameter was introduced |
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 |
etag |
STRING |
Etag of this resource |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#channelBannerResource" |
url |
STRING |
The URL of this banner image |
= Parameter name
= Format
channelId STRING The channelId parameter identifies the YouTube channel to which the banner is uploaded. The channelId parameter was introduced as a required parameter in May 2017. As this was a backward-incompatible change, channelBanners.insert requests that do not specify this parameter will not return an error until six months have passed from the time that the parameter was introduced. Please see the API Terms of Service for the official policy regarding backward incompatible changes and the API revision history for the exact date that the parameter was introduced |
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 |
etag STRING Etag of this resource |
kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#channelBannerResource" |
url STRING The URL of this banner image |
Output
This building block provides 3 output parameters
Name | Format | Description |
---|---|---|
etag |
STRING |
Etag of this resource |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#channelBannerResource" |
url |
STRING |
The URL of this banner image |
= Parameter name
= Format
etag STRING Etag of this resource |
kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#channelBannerResource" |
url STRING The URL of this banner image |