com.google.api.services.youtube

Class YouTube.ChannelBanners.Insert

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.youtube.YouTubeRequest<ChannelBannerResource>

com.google.api.services.youtube.YouTube.ChannelBanners.Insert

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

YouTube.ChannelBanners

public class YouTube.ChannelBanners.Insert
extends YouTubeRequest<ChannelBannerResource>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Insert(ChannelBannerResource content) Uploads a channel banner image to YouTube.
protected	Insert(ChannelBannerResource content, com.google.api.client.http.AbstractInputStreamContent mediaContent) Uploads a channel banner image to YouTube.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getChannelId() The channelId parameter identifies the YouTube channel to which the banner is uploaded.
java.lang.String	getOnBehalfOfContentOwner() Note: This parameter is intended exclusively for YouTube content partners.
YouTube.ChannelBanners.Insert	set(java.lang.String parameterName, java.lang.Object value)
YouTube.ChannelBanners.Insert	setAlt(java.lang.String alt) Data format for the response.
YouTube.ChannelBanners.Insert	setChannelId(java.lang.String channelId) The channelId parameter identifies the YouTube channel to which the banner is uploaded.
YouTube.ChannelBanners.Insert	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
YouTube.ChannelBanners.Insert	setKey(java.lang.String key) API key.
YouTube.ChannelBanners.Insert	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
YouTube.ChannelBanners.Insert	setOnBehalfOfContentOwner(java.lang.String onBehalfOfContentOwner) Note: This parameter is intended exclusively for YouTube content partners.
YouTube.ChannelBanners.Insert	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.ChannelBanners.Insert	setQuotaUser(java.lang.String quotaUser) An opaque string that represents a user for quota purposes.
YouTube.ChannelBanners.Insert	setUserIp(java.lang.String userIp) Deprecated.

Methods inherited from class com.google.api.services.youtube.YouTubeRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Insert

protected Insert(ChannelBannerResource content)

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. Create a request for the method "channelBanners.insert". This request holds the parameters needed by the the youtube server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

YouTube.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

content - the ChannelBannerResource

Since:

1.13

Insert

protected Insert(ChannelBannerResource content,
                 com.google.api.client.http.AbstractInputStreamContent mediaContent)

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. Create a request for the method "channelBanners.insert". This request holds the parameters needed by the the youtube server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

YouTube.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

This constructor should be used for uploading media content.

Parameters:

content - the ChannelBannerResource media metadata or null if none

mediaContent - The media HTTP content or null if none.

Since:

1.13

Method Detail

setAlt

public YouTube.ChannelBanners.Insert setAlt(java.lang.String alt)

Description copied from class: YouTubeRequest

Data format for the response.

Overrides:

setAlt in class YouTubeRequest<ChannelBannerResource>

setFields

public YouTube.ChannelBanners.Insert setFields(java.lang.String fields)

Description copied from class: YouTubeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeRequest<ChannelBannerResource>

setKey

public YouTube.ChannelBanners.Insert setKey(java.lang.String key)

Description copied from class: YouTubeRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class YouTubeRequest<ChannelBannerResource>

setOauthToken

public YouTube.ChannelBanners.Insert setOauthToken(java.lang.String oauthToken)

Description copied from class: YouTubeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeRequest<ChannelBannerResource>

setPrettyPrint

public YouTube.ChannelBanners.Insert setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: YouTubeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeRequest<ChannelBannerResource>

setQuotaUser

public YouTube.ChannelBanners.Insert setQuotaUser(java.lang.String quotaUser)

Description copied from class: YouTubeRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class YouTubeRequest<ChannelBannerResource>

setUserIp

public YouTube.ChannelBanners.Insert setUserIp(java.lang.String userIp)

Description copied from class: YouTubeRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class YouTubeRequest<ChannelBannerResource>

getChannelId

public java.lang.String getChannelId()

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.

setChannelId

public YouTube.ChannelBanners.Insert setChannelId(java.lang.String channelId)

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.

getOnBehalfOfContentOwner

public java.lang.String getOnBehalfOfContentOwner()

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.

setOnBehalfOfContentOwner

public YouTube.ChannelBanners.Insert setOnBehalfOfContentOwner(java.lang.String onBehalfOfContentOwner)

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.

set

public YouTube.ChannelBanners.Insert set(java.lang.String parameterName,
                                         java.lang.Object value)

Overrides:

set in class YouTubeRequest<ChannelBannerResource>