com.google.api.services.displayvideo.v4

Class DisplayVideo.Advertisers.AdAssets.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.displayvideo.v4.DisplayVideoRequest<ListAdAssetsResponse>

com.google.api.services.displayvideo.v4.DisplayVideo.Advertisers.AdAssets.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DisplayVideo.Advertisers.AdAssets

public class DisplayVideo.Advertisers.AdAssets.List
extends DisplayVideoRequest<ListAdAssetsResponse>

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	List(Long advertiserId) Lists ad assets under an advertiser ID.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Long	getAdvertiserId() Required.
String	getFilter() Optional.
String	getOrderBy() Optional.
Integer	getPageSize() Optional.
String	getPageToken() Optional.
DisplayVideo.Advertisers.AdAssets.List	set(String parameterName, Object value)
DisplayVideo.Advertisers.AdAssets.List	set$Xgafv(String $Xgafv) V1 error format.
DisplayVideo.Advertisers.AdAssets.List	setAccessToken(String accessToken) OAuth access token.
DisplayVideo.Advertisers.AdAssets.List	setAdvertiserId(Long advertiserId) Required.
DisplayVideo.Advertisers.AdAssets.List	setAlt(String alt) Data format for response.
DisplayVideo.Advertisers.AdAssets.List	setCallback(String callback) JSONP
DisplayVideo.Advertisers.AdAssets.List	setFields(String fields) Selector specifying which fields to include in a partial response.
DisplayVideo.Advertisers.AdAssets.List	setFilter(String filter) Optional.
DisplayVideo.Advertisers.AdAssets.List	setKey(String key) API key.
DisplayVideo.Advertisers.AdAssets.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DisplayVideo.Advertisers.AdAssets.List	setOrderBy(String orderBy) Optional.
DisplayVideo.Advertisers.AdAssets.List	setPageSize(Integer pageSize) Optional.
DisplayVideo.Advertisers.AdAssets.List	setPageToken(String pageToken) Optional.
DisplayVideo.Advertisers.AdAssets.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DisplayVideo.Advertisers.AdAssets.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
DisplayVideo.Advertisers.AdAssets.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
DisplayVideo.Advertisers.AdAssets.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.displayvideo.v4.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

List

protected List(Long advertiserId)

Lists ad assets under an advertiser ID. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`. Create a request for the method "adAssets.list". 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:

advertiserId - Required. The ID of the advertiser the ad assets belong to.

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public DisplayVideo.Advertisers.AdAssets.List set$Xgafv(String $Xgafv)

Description copied from class: DisplayVideoRequest

V1 error format.

Overrides:

set$Xgafv in class DisplayVideoRequest<ListAdAssetsResponse>

setAccessToken

public DisplayVideo.Advertisers.AdAssets.List setAccessToken(String accessToken)

Description copied from class: DisplayVideoRequest

OAuth access token.

Overrides:

setAccessToken in class DisplayVideoRequest<ListAdAssetsResponse>

setAlt

public DisplayVideo.Advertisers.AdAssets.List setAlt(String alt)

Description copied from class: DisplayVideoRequest

Data format for response.

Overrides:

setAlt in class DisplayVideoRequest<ListAdAssetsResponse>

setCallback

public DisplayVideo.Advertisers.AdAssets.List setCallback(String callback)

Description copied from class: DisplayVideoRequest

JSONP

Overrides:

setCallback in class DisplayVideoRequest<ListAdAssetsResponse>

setFields

public DisplayVideo.Advertisers.AdAssets.List setFields(String fields)

Description copied from class: DisplayVideoRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DisplayVideoRequest<ListAdAssetsResponse>

setKey

public DisplayVideo.Advertisers.AdAssets.List 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<ListAdAssetsResponse>

setOauthToken

public DisplayVideo.Advertisers.AdAssets.List setOauthToken(String oauthToken)

Description copied from class: DisplayVideoRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DisplayVideoRequest<ListAdAssetsResponse>

setPrettyPrint

public DisplayVideo.Advertisers.AdAssets.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: DisplayVideoRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DisplayVideoRequest<ListAdAssetsResponse>

setQuotaUser

public DisplayVideo.Advertisers.AdAssets.List 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<ListAdAssetsResponse>

setUploadType

public DisplayVideo.Advertisers.AdAssets.List setUploadType(String uploadType)

Description copied from class: DisplayVideoRequest

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

Overrides:

setUploadType in class DisplayVideoRequest<ListAdAssetsResponse>

setUploadProtocol

public DisplayVideo.Advertisers.AdAssets.List setUploadProtocol(String uploadProtocol)

Description copied from class: DisplayVideoRequest

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

Overrides:

setUploadProtocol in class DisplayVideoRequest<ListAdAssetsResponse>

getAdvertiserId

public Long getAdvertiserId()

Required. The ID of the advertiser the ad assets belong to.

setAdvertiserId

public DisplayVideo.Advertisers.AdAssets.List setAdvertiserId(Long advertiserId)

Required. The ID of the advertiser the ad assets belong to.

getFilter

public String getFilter()

Optional. Allows filtering of the results by ad asset fields. Supported syntax: * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `youtubeVideoAsset.youtubeVideoId` * `entityStatus` Examples: * All active YouTube video ad assets under an advertiser: `entityStatus=ENTITY_STATUS_ACTIVE`

setFilter

public DisplayVideo.Advertisers.AdAssets.List setFilter(String filter)

Optional. Allows filtering of the results by ad asset fields. Supported syntax: * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `youtubeVideoAsset.youtubeVideoId` * `entityStatus` Examples: * All active YouTube video ad assets under an advertiser: `entityStatus=ENTITY_STATUS_ACTIVE`

getOrderBy

public String getOrderBy()

Optional. Field by which to sort the list. Acceptable values are: * `entityStatus` * `youtubeVideoAsset.youtubeVideoId` * `adAssetId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `adAssetId desc`.

setOrderBy

public DisplayVideo.Advertisers.AdAssets.List setOrderBy(String orderBy)

Optional. Field by which to sort the list. Acceptable values are: * `entityStatus` * `youtubeVideoAsset.youtubeVideoId` * `adAssetId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `adAssetId desc`.

getPageSize

public Integer getPageSize()

Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

setPageSize

public DisplayVideo.Advertisers.AdAssets.List setPageSize(Integer pageSize)

Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

getPageToken

public String getPageToken()

Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdAssets` method. If not specified, the first page of results will be returned.

setPageToken

public DisplayVideo.Advertisers.AdAssets.List setPageToken(String pageToken)

Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdAssets` method. If not specified, the first page of results will be returned.

set

public DisplayVideo.Advertisers.AdAssets.List set(String parameterName,
                                                  Object value)

Overrides:

set in class DisplayVideoRequest<ListAdAssetsResponse>