com.google.api.services.youtube

Class YouTube.Sponsors.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<SponsorListResponse>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

YouTube.Sponsors

public class YouTube.Sponsors.List
extends YouTubeRequest<SponsorListResponse>

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(String part) Lists sponsors for a channel.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getFilter() The filter parameter specifies which channel sponsors to return.
Long	getMaxResults() The maxResults parameter specifies the maximum number of items that should be returned in the result set.
String	getPageToken() The pageToken parameter identifies a specific page in the result set that should be returned.
String	getPart() The part parameter specifies the sponsor resource parts that the API response will include.
YouTube.Sponsors.List	set(String parameterName, Object value)
YouTube.Sponsors.List	setAlt(String alt) Data format for the response.
YouTube.Sponsors.List	setFields(String fields) Selector specifying which fields to include in a partial response.
YouTube.Sponsors.List	setFilter(String filter) The filter parameter specifies which channel sponsors to return.
YouTube.Sponsors.List	setKey(String key) API key.
YouTube.Sponsors.List	setMaxResults(Long maxResults) The maxResults parameter specifies the maximum number of items that should be returned in the result set.
YouTube.Sponsors.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
YouTube.Sponsors.List	setPageToken(String pageToken) The pageToken parameter identifies a specific page in the result set that should be returned.
YouTube.Sponsors.List	setPart(String part) The part parameter specifies the sponsor resource parts that the API response will include.
YouTube.Sponsors.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.Sponsors.List	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
YouTube.Sponsors.List	setUserIp(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, 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(String part)

Lists sponsors for a channel. Create a request for the method "sponsors.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 the sponsor resource parts that the API response will include. Supported values are id and snippet.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<SponsorListResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<SponsorListResponse>

Throws:

IOException

setAlt

public YouTube.Sponsors.List setAlt(String alt)

Description copied from class: YouTubeRequest

Data format for the response.

Overrides:

setAlt in class YouTubeRequest<SponsorListResponse>

setFields

public YouTube.Sponsors.List setFields(String fields)

Description copied from class: YouTubeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeRequest<SponsorListResponse>

setKey

public YouTube.Sponsors.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<SponsorListResponse>

setOauthToken

public YouTube.Sponsors.List setOauthToken(String oauthToken)

Description copied from class: YouTubeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeRequest<SponsorListResponse>

setPrettyPrint

public YouTube.Sponsors.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: YouTubeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeRequest<SponsorListResponse>

setQuotaUser

public YouTube.Sponsors.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<SponsorListResponse>

setUserIp

public YouTube.Sponsors.List setUserIp(String userIp)

Description copied from class: YouTubeRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class YouTubeRequest<SponsorListResponse>

getPart

public String getPart()

The part parameter specifies the sponsor resource parts that the API response will include. Supported values are id and snippet.

setPart

public YouTube.Sponsors.List setPart(String part)

The part parameter specifies the sponsor resource parts that the API response will include. Supported values are id and snippet.

getFilter

public String getFilter()

The filter parameter specifies which channel sponsors to return. [default: POLL_NEWEST]

setFilter

public YouTube.Sponsors.List setFilter(String filter)

The filter parameter specifies which channel sponsors to return.

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.Sponsors.List setMaxResults(Long maxResults)

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

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

Overrides:

set in class YouTubeRequest<SponsorListResponse>