com.google.api.services.youtube

Class YouTube.Videos.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<VideoListResponse>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

YouTube.Videos

public class YouTube.Videos.List
extends YouTubeRequest<VideoListResponse>

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

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(String part) Returns a list of videos that match the API request parameters.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getChart() The chart parameter identifies the chart that you want to retrieve.
String	getHl() The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports.
String	getId() The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved.
String	getLocale() DEPRECATED
Long	getMaxHeight() The maxHeight parameter specifies a maximum height of the embedded player.
Long	getMaxResults() The maxResults parameter specifies the maximum number of items that should be returned in the result set.
Long	getMaxWidth() The maxWidth parameter specifies a maximum width of the embedded player.
String	getMyRating() Set this parameter's value to like or dislike to instruct the API to only return videos liked or disliked by 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.
String	getPart() The part parameter specifies a comma-separated list of one or more video resource properties that the API response will include.
String	getRegionCode() The regionCode parameter instructs the API to select a video chart available in the specified region.
String	getVideoCategoryId() The videoCategoryId parameter identifies the video category for which the chart should be retrieved.
YouTube.Videos.List	set(String parameterName, Object value)
YouTube.Videos.List	setAlt(String alt) Data format for the response.
YouTube.Videos.List	setChart(String chart) The chart parameter identifies the chart that you want to retrieve.
YouTube.Videos.List	setFields(String fields) Selector specifying which fields to include in a partial response.
YouTube.Videos.List	setHl(String hl) The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports.
YouTube.Videos.List	setId(String id) The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved.
YouTube.Videos.List	setKey(String key) API key.
YouTube.Videos.List	setLocale(String locale) DEPRECATED
YouTube.Videos.List	setMaxHeight(Long maxHeight) The maxHeight parameter specifies a maximum height of the embedded player.
YouTube.Videos.List	setMaxResults(Long maxResults) The maxResults parameter specifies the maximum number of items that should be returned in the result set.
YouTube.Videos.List	setMaxWidth(Long maxWidth) The maxWidth parameter specifies a maximum width of the embedded player.
YouTube.Videos.List	setMyRating(String myRating) Set this parameter's value to like or dislike to instruct the API to only return videos liked or disliked by the authenticated user.
YouTube.Videos.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
YouTube.Videos.List	setOnBehalfOfContentOwner(String onBehalfOfContentOwner) Note: This parameter is intended exclusively for YouTube content partners.
YouTube.Videos.List	setPageToken(String pageToken) The pageToken parameter identifies a specific page in the result set that should be returned.
YouTube.Videos.List	setPart(String part) The part parameter specifies a comma-separated list of one or more video resource properties that the API response will include.
YouTube.Videos.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.Videos.List	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
YouTube.Videos.List	setRegionCode(String regionCode) The regionCode parameter instructs the API to select a video chart available in the specified region.
YouTube.Videos.List	setUserIp(String userIp) Deprecated.
YouTube.Videos.List	setVideoCategoryId(String videoCategoryId) The videoCategoryId parameter identifies the video category for which the chart should be retrieved.

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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, 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

List

protected List(String part)

Returns a list of videos that match the API request parameters. Create a request for the method "videos.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 video 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 video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. As such, if you set part=snippet, the API response will contain all of those properties.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<VideoListResponse>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<VideoListResponse>

Throws:

IOException

setAlt

public YouTube.Videos.List setAlt(String alt)

Description copied from class: YouTubeRequest

Data format for the response.

Overrides:

setAlt in class YouTubeRequest<VideoListResponse>

setFields

public YouTube.Videos.List setFields(String fields)

Description copied from class: YouTubeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeRequest<VideoListResponse>

setKey

public YouTube.Videos.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<VideoListResponse>

setOauthToken

public YouTube.Videos.List setOauthToken(String oauthToken)

Description copied from class: YouTubeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeRequest<VideoListResponse>

setPrettyPrint

public YouTube.Videos.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: YouTubeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeRequest<VideoListResponse>

setQuotaUser

public YouTube.Videos.List setQuotaUser(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<VideoListResponse>

setUserIp

public YouTube.Videos.List setUserIp(String userIp)

Description copied from class: YouTubeRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class YouTubeRequest<VideoListResponse>

getPart

public String getPart()

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

setPart

public YouTube.Videos.List setPart(String part)

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

getChart

public String getChart()

The chart parameter identifies the chart that you want to retrieve.

setChart

public YouTube.Videos.List setChart(String chart)

The chart parameter identifies the chart that you want to retrieve.

getHl

public String getHl()

The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method. If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language.

setHl

public YouTube.Videos.List setHl(String hl)

The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method. If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language.

getId

public String getId()

The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video's ID.

setId

public YouTube.Videos.List setId(String id)

The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video's ID.

getLocale

public String getLocale()

DEPRECATED

setLocale

public YouTube.Videos.List setLocale(String locale)

DEPRECATED

getMaxHeight

public Long getMaxHeight()

The maxHeight parameter specifies a maximum height of the embedded player. If maxWidth is provided, maxHeight may not be reached in order to not violate the width request. [minimum: 72] [maximum: 8192]

setMaxHeight

public YouTube.Videos.List setMaxHeight(Long maxHeight)

The maxHeight parameter specifies a maximum height of the embedded player. If maxWidth is provided, maxHeight may not be reached in order to not violate the width request.

getMaxResults

public Long getMaxResults()

The maxResults parameter specifies the maximum number of items that should be returned in the result set. Note: This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter. [default: 5] [minimum: 1] [maximum: 50]

setMaxResults

public YouTube.Videos.List setMaxResults(Long maxResults)

The maxResults parameter specifies the maximum number of items that should be returned in the result set. Note: This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter.

getMaxWidth

public Long getMaxWidth()

The maxWidth parameter specifies a maximum width of the embedded player. If maxHeight is provided, maxWidth may not be reached in order to not violate the height request. [minimum: 72] [maximum: 8192]

setMaxWidth

public YouTube.Videos.List setMaxWidth(Long maxWidth)

The maxWidth parameter specifies a maximum width of the embedded player. If maxHeight is provided, maxWidth may not be reached in order to not violate the height request.

getMyRating

public String getMyRating()

Set this parameter's value to like or dislike to instruct the API to only return videos liked or disliked by the authenticated user.

setMyRating

public YouTube.Videos.List setMyRating(String myRating)

Set this parameter's value to like or dislike to instruct the API to only return videos liked or disliked 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.Videos.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. Note: This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter.

setPageToken

public YouTube.Videos.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. Note: This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter.

getRegionCode

public String getRegionCode()

The regionCode parameter instructs the API to select a video chart available in the specified region. This parameter can only be used in conjunction with the chart parameter. The parameter value is an ISO 3166-1 alpha-2 country code.

setRegionCode

public YouTube.Videos.List setRegionCode(String regionCode)

The regionCode parameter instructs the API to select a video chart available in the specified region. This parameter can only be used in conjunction with the chart parameter. The parameter value is an ISO 3166-1 alpha-2 country code.

getVideoCategoryId

public String getVideoCategoryId()

The videoCategoryId parameter identifies the video category for which the chart should be retrieved. This parameter can only be used in conjunction with the chart parameter. By default, charts are not restricted to a particular category. [default: 0]

setVideoCategoryId

public YouTube.Videos.List setVideoCategoryId(String videoCategoryId)

The videoCategoryId parameter identifies the video category for which the chart should be retrieved. This parameter can only be used in conjunction with the chart parameter. By default, charts are not restricted to a particular category.

set

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

Overrides:

set in class YouTubeRequest<VideoListResponse>