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

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>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	YouTube.Videos.List(String part) Returns a list of videos that match the API request parameters.

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getId() The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved.
Long	getMaxResults() USE_DESCRIPTION --- channels:list:maxResults [default: 5] [minimum: 1] [maximum: 50]
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() The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value.
String	getPageToken() USE_DESCRIPTION --- channels:list:pageToken
String	getPart() The part parameter specifies a comma-separated list of one or more video resource properties that the API response will include.
YouTube.Videos.List	setAlt(String alt) Data format for the response.
YouTube.Videos.List	setFields(String fields) Selector specifying which fields to include in a partial response.
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	setMaxResults(Long maxResults) USE_DESCRIPTION --- channels:list:maxResults
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) The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value.
YouTube.Videos.List	setPageToken(String pageToken) USE_DESCRIPTION --- channels:list:pageToken
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) Available to use for quota purposes for server-side applications.
YouTube.Videos.List	setUserIp(String userIp) IP address of the site where the request originates.

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, 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, set, 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

Constructor Detail

YouTube.Videos.List

protected YouTube.Videos.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(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. The part names that you can include in the parameter value are id, snippet, contentDetails, player, statistics, status, and topicDetails. 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 HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<VideoListResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class 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

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 userIp if both are provided.

Overrides:

setQuotaUser in class YouTubeRequest<VideoListResponse>

setUserIp

public YouTube.Videos.List setUserIp(String userIp)

Description copied from class: YouTubeRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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. The part names that you can include in the parameter value are id, snippet, contentDetails, player, statistics, status, and topicDetails. 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. The part names that you can include in the parameter value are id, snippet, contentDetails, player, statistics, status, and topicDetails. 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.

getOnBehalfOfContentOwner

public String getOnBehalfOfContentOwner()

The onBehalfOfContentOwner parameter indicates that the authenticated user 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 actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner.

setOnBehalfOfContentOwner

public YouTube.Videos.List setOnBehalfOfContentOwner(String onBehalfOfContentOwner)

The onBehalfOfContentOwner parameter indicates that the authenticated user 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 actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner.

getMaxResults

public Long getMaxResults()

USE_DESCRIPTION --- channels:list:maxResults [default: 5] [minimum: 1] [maximum: 50]

setMaxResults

public YouTube.Videos.List setMaxResults(Long maxResults)

USE_DESCRIPTION --- channels:list:maxResults

getPageToken

public String getPageToken()

USE_DESCRIPTION --- channels:list:pageToken

setPageToken

public YouTube.Videos.List setPageToken(String pageToken)

USE_DESCRIPTION --- channels:list:pageToken

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.

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.