com.google.api.services.displayvideo.v2

Class DisplayVideo.CustomLists.Get

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.displayvideo.v2.DisplayVideoRequest<CustomList>

com.google.api.services.displayvideo.v2.DisplayVideo.CustomLists.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DisplayVideo.CustomLists

public class DisplayVideo.CustomLists.Get
extends DisplayVideoRequest<CustomList>

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Get(Long customListId) Gets a custom list.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Long	getAdvertiserId() The ID of the DV360 advertiser that has access to the fetched custom lists.
Long	getCustomListId() Required.
DisplayVideo.CustomLists.Get	set(String parameterName, Object value)
DisplayVideo.CustomLists.Get	set$Xgafv(String $Xgafv) V1 error format.
DisplayVideo.CustomLists.Get	setAccessToken(String accessToken) OAuth access token.
DisplayVideo.CustomLists.Get	setAdvertiserId(Long advertiserId) The ID of the DV360 advertiser that has access to the fetched custom lists.
DisplayVideo.CustomLists.Get	setAlt(String alt) Data format for response.
DisplayVideo.CustomLists.Get	setCallback(String callback) JSONP
DisplayVideo.CustomLists.Get	setCustomListId(Long customListId) Required.
DisplayVideo.CustomLists.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
DisplayVideo.CustomLists.Get	setKey(String key) API key.
DisplayVideo.CustomLists.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DisplayVideo.CustomLists.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DisplayVideo.CustomLists.Get	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
DisplayVideo.CustomLists.Get	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
DisplayVideo.CustomLists.Get	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.displayvideo.v2.DisplayVideoRequest

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

Get

protected Get(Long customListId)

Gets a custom list. Create a request for the method "customLists.get". This request holds the parameters needed by the the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

DisplayVideo.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

customListId - Required. The ID of the custom list to fetch.

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<CustomList>

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public DisplayVideo.CustomLists.Get set$Xgafv(String $Xgafv)

Description copied from class: DisplayVideoRequest

V1 error format.

Overrides:

set$Xgafv in class DisplayVideoRequest<CustomList>

setAccessToken

public DisplayVideo.CustomLists.Get setAccessToken(String accessToken)

Description copied from class: DisplayVideoRequest

OAuth access token.

Overrides:

setAccessToken in class DisplayVideoRequest<CustomList>

setAlt

public DisplayVideo.CustomLists.Get setAlt(String alt)

Description copied from class: DisplayVideoRequest

Data format for response.

Overrides:

setAlt in class DisplayVideoRequest<CustomList>

setCallback

public DisplayVideo.CustomLists.Get setCallback(String callback)

Description copied from class: DisplayVideoRequest

JSONP

Overrides:

setCallback in class DisplayVideoRequest<CustomList>

setFields

public DisplayVideo.CustomLists.Get setFields(String fields)

Description copied from class: DisplayVideoRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DisplayVideoRequest<CustomList>

setKey

public DisplayVideo.CustomLists.Get setKey(String key)

Description copied from class: DisplayVideoRequest

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 DisplayVideoRequest<CustomList>

setOauthToken

public DisplayVideo.CustomLists.Get setOauthToken(String oauthToken)

Description copied from class: DisplayVideoRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DisplayVideoRequest<CustomList>

setPrettyPrint

public DisplayVideo.CustomLists.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: DisplayVideoRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DisplayVideoRequest<CustomList>

setQuotaUser

public DisplayVideo.CustomLists.Get setQuotaUser(String quotaUser)

Description copied from class: DisplayVideoRequest

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 DisplayVideoRequest<CustomList>

setUploadType

public DisplayVideo.CustomLists.Get setUploadType(String uploadType)

Description copied from class: DisplayVideoRequest

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

Overrides:

setUploadType in class DisplayVideoRequest<CustomList>

setUploadProtocol

public DisplayVideo.CustomLists.Get setUploadProtocol(String uploadProtocol)

Description copied from class: DisplayVideoRequest

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

Overrides:

setUploadProtocol in class DisplayVideoRequest<CustomList>

getCustomListId

public Long getCustomListId()

Required. The ID of the custom list to fetch.

setCustomListId

public DisplayVideo.CustomLists.Get setCustomListId(Long customListId)

Required. The ID of the custom list to fetch.

getAdvertiserId

public Long getAdvertiserId()

The ID of the DV360 advertiser that has access to the fetched custom lists.

setAdvertiserId

public DisplayVideo.CustomLists.Get setAdvertiserId(Long advertiserId)

The ID of the DV360 advertiser that has access to the fetched custom lists.

set

public DisplayVideo.CustomLists.Get set(String parameterName,
                                        Object value)

Overrides:

set in class DisplayVideoRequest<CustomList>