com.google.api.services.youtube

Class YouTube.Playlists.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<PlaylistListResponse>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

YouTube.Playlists

public class YouTube.Playlists.List
extends YouTubeRequest<PlaylistListResponse>

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	getChannelId() Return the playlists owned by the specified channel ID.
String	getHl() Returen content in specified language
List<String>	getId() Return the playlists with the given IDs for Stubby or Apiary.
Long	getMaxResults() The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
Boolean	getMine() Return the playlists owned by the authenticated user.
String	getOnBehalfOfContentOwner() Note:* This parameter is intended exclusively for YouTube content partners.
String	getOnBehalfOfContentOwnerChannel() This parameter can only be used in a properly authorized request.
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 playlist resource properties that the API response will include.
YouTube.Playlists.List	set(String parameterName, Object value)
YouTube.Playlists.List	set$Xgafv(String $Xgafv) V1 error format.
YouTube.Playlists.List	setAccessToken(String accessToken) OAuth access token.
YouTube.Playlists.List	setAlt(String alt) Data format for response.
YouTube.Playlists.List	setCallback(String callback) JSONP
YouTube.Playlists.List	setChannelId(String channelId) Return the playlists owned by the specified channel ID.
YouTube.Playlists.List	setFields(String fields) Selector specifying which fields to include in a partial response.
YouTube.Playlists.List	setHl(String hl) Returen content in specified language
YouTube.Playlists.List	setId(List<String> id) Return the playlists with the given IDs for Stubby or Apiary.
YouTube.Playlists.List	setKey(String key) API key.
YouTube.Playlists.List	setMaxResults(Long maxResults) The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
YouTube.Playlists.List	setMine(Boolean mine) Return the playlists owned by the authenticated user.
YouTube.Playlists.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
YouTube.Playlists.List	setOnBehalfOfContentOwner(String onBehalfOfContentOwner) *Note:* This parameter is intended exclusively for YouTube content partners.
YouTube.Playlists.List	setOnBehalfOfContentOwnerChannel(String onBehalfOfContentOwnerChannel) This parameter can only be used in a properly authorized request.
YouTube.Playlists.List	setPageToken(String pageToken) The *pageToken* parameter identifies a specific page in the result set that should be returned.
YouTube.Playlists.List	setPart(List<String> part) The *part* parameter specifies a comma-separated list of one or more playlist resource properties that the API response will include.
YouTube.Playlists.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.Playlists.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
YouTube.Playlists.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
YouTube.Playlists.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 "playlists.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 playlist 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 playlist resource, the snippet property contains properties like author, title, description, tags, and timeCreated. As such, if you set *part=snippet*, the API response will contain all of those properties.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<PlaylistListResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<PlaylistListResponse>

Throws:

IOException

set$Xgafv

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

Description copied from class: YouTubeRequest

V1 error format.

Overrides:

set$Xgafv in class YouTubeRequest<PlaylistListResponse>

setAccessToken

public YouTube.Playlists.List setAccessToken(String accessToken)

Description copied from class: YouTubeRequest

OAuth access token.

Overrides:

setAccessToken in class YouTubeRequest<PlaylistListResponse>

setAlt

public YouTube.Playlists.List setAlt(String alt)

Description copied from class: YouTubeRequest

Data format for response.

Overrides:

setAlt in class YouTubeRequest<PlaylistListResponse>

setCallback

public YouTube.Playlists.List setCallback(String callback)

Description copied from class: YouTubeRequest

JSONP

Overrides:

setCallback in class YouTubeRequest<PlaylistListResponse>

setFields

public YouTube.Playlists.List setFields(String fields)

Description copied from class: YouTubeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeRequest<PlaylistListResponse>

setKey

public YouTube.Playlists.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<PlaylistListResponse>

setOauthToken

public YouTube.Playlists.List setOauthToken(String oauthToken)

Description copied from class: YouTubeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeRequest<PlaylistListResponse>

setPrettyPrint

public YouTube.Playlists.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: YouTubeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeRequest<PlaylistListResponse>

setQuotaUser

public YouTube.Playlists.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<PlaylistListResponse>

setUploadType

public YouTube.Playlists.List setUploadType(String uploadType)

Description copied from class: YouTubeRequest

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

Overrides:

setUploadType in class YouTubeRequest<PlaylistListResponse>

setUploadProtocol

public YouTube.Playlists.List setUploadProtocol(String uploadProtocol)

Description copied from class: YouTubeRequest

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

Overrides:

setUploadProtocol in class YouTubeRequest<PlaylistListResponse>

getPart

public List<String> getPart()

The *part* parameter specifies a comma-separated list of one or more playlist 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 playlist resource, the snippet property contains properties like author, title, description, tags, and timeCreated. As such, if you set *part=snippet*, the API response will contain all of those properties.

setPart

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

The *part* parameter specifies a comma-separated list of one or more playlist 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 playlist resource, the snippet property contains properties like author, title, description, tags, and timeCreated. As such, if you set *part=snippet*, the API response will contain all of those properties.

getChannelId

public String getChannelId()

Return the playlists owned by the specified channel ID.

setChannelId

public YouTube.Playlists.List setChannelId(String channelId)

Return the playlists owned by the specified channel ID.

getHl

public String getHl()

Returen content in specified language

setHl

public YouTube.Playlists.List setHl(String hl)

Returen content in specified language

getId

public List<String> getId()

Return the playlists with the given IDs for Stubby or Apiary.

setId

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

Return the playlists with the given IDs for Stubby or Apiary.

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.Playlists.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 playlists owned by the authenticated user.

setMine

public YouTube.Playlists.List setMine(Boolean mine)

Return the playlists owned by 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.Playlists.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.

getOnBehalfOfContentOwnerChannel

public String getOnBehalfOfContentOwnerChannel()

This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

setOnBehalfOfContentOwnerChannel

public YouTube.Playlists.List setOnBehalfOfContentOwnerChannel(String onBehalfOfContentOwnerChannel)

This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

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.Playlists.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.Playlists.List set(String parameterName,
                                  Object value)

Overrides:

set in class YouTubeRequest<PlaylistListResponse>