com.google.api.services.youtube

Class YouTube.Channels.List

java.lang.Object

java.util.AbstractMap<String,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<ChannelListResponse>

com.google.api.services.youtube.YouTube.Channels.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

YouTube.Channels

public class YouTube.Channels.List
extends YouTubeRequest<ChannelListResponse>

Nested Class Summary

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

GenericData.Flags

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

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

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

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	List(List<String> part) Retrieves a list of resources, possibly filtered.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getCategoryId() Return the channels within the specified guide category ID.
String	getForUsername() Return the channel associated with a YouTube username.
String	getHl() Stands for "host language".
List<String>	getId() Return the channels with the specified IDs.
Boolean	getManagedByMe() Return the channels managed by the authenticated user.
Long	getMaxResults() The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
Boolean	getMine() Return the ids of channels owned by the authenticated user.
Boolean	getMySubscribers() Return the channels subscribed to the authenticated user
String	getOnBehalfOfContentOwner() Note:* This parameter is intended exclusively for YouTube content partners.
String	getPageToken() The *pageToken* parameter identifies a specific page in the result set that should be returned.
List<String>	getPart() The *part* parameter specifies a comma-separated list of one or more channel resource properties that the API response will include.
YouTube.Channels.List	set(String parameterName, Object value)
YouTube.Channels.List	set$Xgafv(String $Xgafv) V1 error format.
YouTube.Channels.List	setAccessToken(String accessToken) OAuth access token.
YouTube.Channels.List	setAlt(String alt) Data format for response.
YouTube.Channels.List	setCallback(String callback) JSONP
YouTube.Channels.List	setCategoryId(String categoryId) Return the channels within the specified guide category ID.
YouTube.Channels.List	setFields(String fields) Selector specifying which fields to include in a partial response.
YouTube.Channels.List	setForUsername(String forUsername) Return the channel associated with a YouTube username.
YouTube.Channels.List	setHl(String hl) Stands for "host language".
YouTube.Channels.List	setId(List<String> id) Return the channels with the specified IDs.
YouTube.Channels.List	setKey(String key) API key.
YouTube.Channels.List	setManagedByMe(Boolean managedByMe) Return the channels managed by the authenticated user.
YouTube.Channels.List	setMaxResults(Long maxResults) The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
YouTube.Channels.List	setMine(Boolean mine) Return the ids of channels owned by the authenticated user.
YouTube.Channels.List	setMySubscribers(Boolean mySubscribers) Return the channels subscribed to the authenticated user
YouTube.Channels.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
YouTube.Channels.List	setOnBehalfOfContentOwner(String onBehalfOfContentOwner) *Note:* This parameter is intended exclusively for YouTube content partners.
YouTube.Channels.List	setPageToken(String pageToken) The *pageToken* parameter identifies a specific page in the result set that should be returned.
YouTube.Channels.List	setPart(List<String> part) The *part* parameter specifies a comma-separated list of one or more channel resource properties that the API response will include.
YouTube.Channels.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.Channels.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
YouTube.Channels.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
YouTube.Channels.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

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

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, 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

List

protected List(List<String> part)

Retrieves a list of resources, possibly filtered. Create a request for the method "channels.list". 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:

part - The *part* parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set *part=contentDetails*, the API response will also contain all of those nested properties.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<ChannelListResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ChannelListResponse>

Throws:

IOException

set$Xgafv

public YouTube.Channels.List set$Xgafv(String $Xgafv)

Description copied from class: YouTubeRequest

V1 error format.

Overrides:

set$Xgafv in class YouTubeRequest<ChannelListResponse>

setAccessToken

public YouTube.Channels.List setAccessToken(String accessToken)

Description copied from class: YouTubeRequest

OAuth access token.

Overrides:

setAccessToken in class YouTubeRequest<ChannelListResponse>

setAlt

public YouTube.Channels.List setAlt(String alt)

Description copied from class: YouTubeRequest

Data format for response.

Overrides:

setAlt in class YouTubeRequest<ChannelListResponse>

setCallback

public YouTube.Channels.List setCallback(String callback)

Description copied from class: YouTubeRequest

JSONP

Overrides:

setCallback in class YouTubeRequest<ChannelListResponse>

setFields

public YouTube.Channels.List setFields(String fields)

Description copied from class: YouTubeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeRequest<ChannelListResponse>

setKey

public YouTube.Channels.List setKey(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<ChannelListResponse>

setOauthToken

public YouTube.Channels.List setOauthToken(String oauthToken)

Description copied from class: YouTubeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeRequest<ChannelListResponse>

setPrettyPrint

public YouTube.Channels.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: YouTubeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeRequest<ChannelListResponse>

setQuotaUser

public YouTube.Channels.List setQuotaUser(String quotaUser)

Description copied from class: YouTubeRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class YouTubeRequest<ChannelListResponse>

setUploadType

public YouTube.Channels.List setUploadType(String uploadType)

Description copied from class: YouTubeRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class YouTubeRequest<ChannelListResponse>

setUploadProtocol

public YouTube.Channels.List setUploadProtocol(String uploadProtocol)

Description copied from class: YouTubeRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class YouTubeRequest<ChannelListResponse>

getPart

public List<String> getPart()

The *part* parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set *part=contentDetails*, the API response will also contain all of those nested properties.

setPart

public YouTube.Channels.List setPart(List<String> part)

The *part* parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set *part=contentDetails*, the API response will also contain all of those nested properties.

getCategoryId

public String getCategoryId()

Return the channels within the specified guide category ID.

setCategoryId

public YouTube.Channels.List setCategoryId(String categoryId)

Return the channels within the specified guide category ID.

getForUsername

public String getForUsername()

Return the channel associated with a YouTube username.

setForUsername

public YouTube.Channels.List setForUsername(String forUsername)

Return the channel associated with a YouTube username.

getHl

public String getHl()

Stands for "host language". Specifies the localization language of the metadata to be filled into snippet.localized. The field is filled with the default metadata if there is no localization in the specified language. The parameter value must be a language code included in the list returned by the i18nLanguages.list method (e.g. en_US, es_MX).

setHl

public YouTube.Channels.List setHl(String hl)

Stands for "host language". Specifies the localization language of the metadata to be filled into snippet.localized. The field is filled with the default metadata if there is no localization in the specified language. The parameter value must be a language code included in the list returned by the i18nLanguages.list method (e.g. en_US, es_MX).

getId

public List<String> getId()

Return the channels with the specified IDs.

setId

public YouTube.Channels.List setId(List<String> id)

Return the channels with the specified IDs.

getManagedByMe

public Boolean getManagedByMe()

Return the channels managed by the authenticated user.

setManagedByMe

public YouTube.Channels.List setManagedByMe(Boolean managedByMe)

Return the channels managed by the authenticated user.

getMaxResults

public Long getMaxResults()

The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. [default: 5] [minimum: 0] [maximum: 50]

setMaxResults

public YouTube.Channels.List setMaxResults(Long maxResults)

The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.

getMine

public Boolean getMine()

Return the ids of channels owned by the authenticated user.

setMine

public YouTube.Channels.List setMine(Boolean mine)

Return the ids of channels owned by the authenticated user.

getMySubscribers

public Boolean getMySubscribers()

Return the channels subscribed to the authenticated user

setMySubscribers

public YouTube.Channels.List setMySubscribers(Boolean mySubscribers)

Return the channels subscribed to the authenticated user

getOnBehalfOfContentOwner

public 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.Channels.List setOnBehalfOfContentOwner(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.

getPageToken

public String getPageToken()

The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

setPageToken

public YouTube.Channels.List setPageToken(String pageToken)

The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

set

public YouTube.Channels.List set(String parameterName,
                                 Object value)

Overrides:

set in class YouTubeRequest<ChannelListResponse>