com.google.api.services.displayvideo.v3

Class DisplayVideo.Advertisers.AdGroups.Patch

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.v3.DisplayVideoRequest<AdGroup>

com.google.api.services.displayvideo.v3.DisplayVideo.Advertisers.AdGroups.Patch

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DisplayVideo.Advertisers.AdGroups

public class DisplayVideo.Advertisers.AdGroups.Patch
extends DisplayVideoRequest<AdGroup>

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	Patch(Long advertiserId, Long adGroupId, AdGroup content) Updates an existing ad group.

Method Summary

Modifier and Type	Method and Description
Long	getAdGroupId() Output only.
Long	getAdvertiserId() Output only.
String	getUpdateMask() Required.
DisplayVideo.Advertisers.AdGroups.Patch	set(String parameterName, Object value)
DisplayVideo.Advertisers.AdGroups.Patch	set$Xgafv(String $Xgafv) V1 error format.
DisplayVideo.Advertisers.AdGroups.Patch	setAccessToken(String accessToken) OAuth access token.
DisplayVideo.Advertisers.AdGroups.Patch	setAdGroupId(Long adGroupId) Output only.
DisplayVideo.Advertisers.AdGroups.Patch	setAdvertiserId(Long advertiserId) Output only.
DisplayVideo.Advertisers.AdGroups.Patch	setAlt(String alt) Data format for response.
DisplayVideo.Advertisers.AdGroups.Patch	setCallback(String callback) JSONP
DisplayVideo.Advertisers.AdGroups.Patch	setFields(String fields) Selector specifying which fields to include in a partial response.
DisplayVideo.Advertisers.AdGroups.Patch	setKey(String key) API key.
DisplayVideo.Advertisers.AdGroups.Patch	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DisplayVideo.Advertisers.AdGroups.Patch	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DisplayVideo.Advertisers.AdGroups.Patch	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
DisplayVideo.Advertisers.AdGroups.Patch	setUpdateMask(String updateMask) Required.
DisplayVideo.Advertisers.AdGroups.Patch	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
DisplayVideo.Advertisers.AdGroups.Patch	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.displayvideo.v3.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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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

Patch

protected Patch(Long advertiserId,
                Long adGroupId,
                AdGroup content)

Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users. Create a request for the method "adGroups.patch". 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 - Output only. The unique ID of the advertiser the ad group belongs to.

adGroupId - Output only. The unique ID of the ad group. Assigned by the system.

content - the AdGroup

Since:

1.13

Method Detail

set$Xgafv

public DisplayVideo.Advertisers.AdGroups.Patch set$Xgafv(String $Xgafv)

Description copied from class: DisplayVideoRequest

V1 error format.

Overrides:

set$Xgafv in class DisplayVideoRequest<AdGroup>

setAccessToken

public DisplayVideo.Advertisers.AdGroups.Patch setAccessToken(String accessToken)

Description copied from class: DisplayVideoRequest

OAuth access token.

Overrides:

setAccessToken in class DisplayVideoRequest<AdGroup>

setAlt

public DisplayVideo.Advertisers.AdGroups.Patch setAlt(String alt)

Description copied from class: DisplayVideoRequest

Data format for response.

Overrides:

setAlt in class DisplayVideoRequest<AdGroup>

setCallback

public DisplayVideo.Advertisers.AdGroups.Patch setCallback(String callback)

Description copied from class: DisplayVideoRequest

JSONP

Overrides:

setCallback in class DisplayVideoRequest<AdGroup>

setFields

public DisplayVideo.Advertisers.AdGroups.Patch setFields(String fields)

Description copied from class: DisplayVideoRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DisplayVideoRequest<AdGroup>

setKey

public DisplayVideo.Advertisers.AdGroups.Patch 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<AdGroup>

setOauthToken

public DisplayVideo.Advertisers.AdGroups.Patch setOauthToken(String oauthToken)

Description copied from class: DisplayVideoRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DisplayVideoRequest<AdGroup>

setPrettyPrint

public DisplayVideo.Advertisers.AdGroups.Patch setPrettyPrint(Boolean prettyPrint)

Description copied from class: DisplayVideoRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DisplayVideoRequest<AdGroup>

setQuotaUser

public DisplayVideo.Advertisers.AdGroups.Patch 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<AdGroup>

setUploadType

public DisplayVideo.Advertisers.AdGroups.Patch setUploadType(String uploadType)

Description copied from class: DisplayVideoRequest

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

Overrides:

setUploadType in class DisplayVideoRequest<AdGroup>

setUploadProtocol

public DisplayVideo.Advertisers.AdGroups.Patch setUploadProtocol(String uploadProtocol)

Description copied from class: DisplayVideoRequest

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

Overrides:

setUploadProtocol in class DisplayVideoRequest<AdGroup>

getAdvertiserId

public Long getAdvertiserId()

Output only. The unique ID of the advertiser the ad group belongs to.

setAdvertiserId

public DisplayVideo.Advertisers.AdGroups.Patch setAdvertiserId(Long advertiserId)

Output only. The unique ID of the advertiser the ad group belongs to.

getAdGroupId

public Long getAdGroupId()

Output only. The unique ID of the ad group. Assigned by the system.

setAdGroupId

public DisplayVideo.Advertisers.AdGroups.Patch setAdGroupId(Long adGroupId)

Output only. The unique ID of the ad group. Assigned by the system.

getUpdateMask

public String getUpdateMask()

Required. The mask to control which fields to update.

setUpdateMask

public DisplayVideo.Advertisers.AdGroups.Patch setUpdateMask(String updateMask)

Required. The mask to control which fields to update.

set

public DisplayVideo.Advertisers.AdGroups.Patch set(String parameterName,
                                                   Object value)

Overrides:

set in class DisplayVideoRequest<AdGroup>