ChannelBanners: insert
Stay organized with collections
Save and categorize content based on your preferences.
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 2048x1152 pixels. We recommend uploading a 2560px by 1440px image.
- 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.
This method supports media upload. Uploaded files must conform to these constraints:
- Maximum file size:
6MB
- Accepted Media MIME types:
image/jpeg
,
image/png
,
application/octet-stream
Quota impact:
A call to this method has a
quota cost
of 50 units.
Request
HTTP request
POST https://www.googleapis.com/upload/youtube/v3/channelBanners/insert
Authorization
This request requires authorization with at least one of the following scopes (
read more about authentication and authorization
).
Scope
|
https://www.googleapis.com/auth/youtube.upload
|
https://www.googleapis.com/auth/youtube
|
https://www.googleapis.com/auth/youtube.force-ssl
|
Parameters
The following table lists the parameters that this query supports. All of the parameters listed are query parameters.
Parameters
|
Optional parameters
|
onBehalfOfContentOwner
|
string
This parameter can only be used in a properly
authorized request
.
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.
|
Request body
Do not provide a request body when calling this method.
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
|
badRequest (400)
|
bannerAlbumFull
|
Your YouTube Channel Art album has too many images. Please go to
http://photos.google.com
, navigate to the albums page, and remove some from images from that album.
|
badRequest (400)
|
mediaBodyRequired
|
The request does not include the image content.
|
Try it!
Use the
APIs Explorer
to call this API and see the API request and response.
Except as otherwise noted, the content of this page is licensed under the
Creative Commons Attribution 4.0 License
, and code samples are licensed under the
Apache 2.0 License
. For details, see the
Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-11-04 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]