com.google.api.services.displayvideo.v4

Class DisplayVideo.Advertisers.Campaigns.Delete

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

com.google.api.services.displayvideo.v4.DisplayVideo.Advertisers.Campaigns.Delete

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DisplayVideo.Advertisers.Campaigns

public class DisplayVideo.Advertisers.Campaigns.Delete
extends DisplayVideoRequest<Empty>

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	Delete(Long advertiserId, Long campaignId) Permanently deletes a campaign.

Method Summary

Modifier and Type	Method and Description
Long	getAdvertiserId() The ID of the advertiser this campaign belongs to.
Long	getCampaignId() The ID of the campaign we need to delete.
DisplayVideo.Advertisers.Campaigns.Delete	set(String parameterName, Object value)
DisplayVideo.Advertisers.Campaigns.Delete	set$Xgafv(String $Xgafv) V1 error format.
DisplayVideo.Advertisers.Campaigns.Delete	setAccessToken(String accessToken) OAuth access token.
DisplayVideo.Advertisers.Campaigns.Delete	setAdvertiserId(Long advertiserId) The ID of the advertiser this campaign belongs to.
DisplayVideo.Advertisers.Campaigns.Delete	setAlt(String alt) Data format for response.
DisplayVideo.Advertisers.Campaigns.Delete	setCallback(String callback) JSONP
DisplayVideo.Advertisers.Campaigns.Delete	setCampaignId(Long campaignId) The ID of the campaign we need to delete.
DisplayVideo.Advertisers.Campaigns.Delete	setFields(String fields) Selector specifying which fields to include in a partial response.
DisplayVideo.Advertisers.Campaigns.Delete	setKey(String key) API key.
DisplayVideo.Advertisers.Campaigns.Delete	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DisplayVideo.Advertisers.Campaigns.Delete	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DisplayVideo.Advertisers.Campaigns.Delete	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
DisplayVideo.Advertisers.Campaigns.Delete	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
DisplayVideo.Advertisers.Campaigns.Delete	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, 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

Delete

protected Delete(Long advertiserId,
                 Long campaignId)

Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors. Create a request for the method "campaigns.delete". 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 - The ID of the advertiser this campaign belongs to.

campaignId - The ID of the campaign we need to delete.

Since:

1.13

Method Detail

set$Xgafv

public DisplayVideo.Advertisers.Campaigns.Delete set$Xgafv(String $Xgafv)

Description copied from class: DisplayVideoRequest

V1 error format.

Overrides:

set$Xgafv in class DisplayVideoRequest<Empty>

setAccessToken

public DisplayVideo.Advertisers.Campaigns.Delete setAccessToken(String accessToken)

Description copied from class: DisplayVideoRequest

OAuth access token.

Overrides:

setAccessToken in class DisplayVideoRequest<Empty>

setAlt

public DisplayVideo.Advertisers.Campaigns.Delete setAlt(String alt)

Description copied from class: DisplayVideoRequest

Data format for response.

Overrides:

setAlt in class DisplayVideoRequest<Empty>

setCallback

public DisplayVideo.Advertisers.Campaigns.Delete setCallback(String callback)

Description copied from class: DisplayVideoRequest

JSONP

Overrides:

setCallback in class DisplayVideoRequest<Empty>

setFields

public DisplayVideo.Advertisers.Campaigns.Delete setFields(String fields)

Description copied from class: DisplayVideoRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DisplayVideoRequest<Empty>

setKey

public DisplayVideo.Advertisers.Campaigns.Delete 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<Empty>

setOauthToken

public DisplayVideo.Advertisers.Campaigns.Delete setOauthToken(String oauthToken)

Description copied from class: DisplayVideoRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DisplayVideoRequest<Empty>

setPrettyPrint

public DisplayVideo.Advertisers.Campaigns.Delete setPrettyPrint(Boolean prettyPrint)

Description copied from class: DisplayVideoRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DisplayVideoRequest<Empty>

setQuotaUser

public DisplayVideo.Advertisers.Campaigns.Delete 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<Empty>

setUploadType

public DisplayVideo.Advertisers.Campaigns.Delete setUploadType(String uploadType)

Description copied from class: DisplayVideoRequest

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

Overrides:

setUploadType in class DisplayVideoRequest<Empty>

setUploadProtocol

public DisplayVideo.Advertisers.Campaigns.Delete setUploadProtocol(String uploadProtocol)

Description copied from class: DisplayVideoRequest

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

Overrides:

setUploadProtocol in class DisplayVideoRequest<Empty>

getAdvertiserId

public Long getAdvertiserId()

The ID of the advertiser this campaign belongs to.

setAdvertiserId

public DisplayVideo.Advertisers.Campaigns.Delete setAdvertiserId(Long advertiserId)

The ID of the advertiser this campaign belongs to.

getCampaignId

public Long getCampaignId()

The ID of the campaign we need to delete.

setCampaignId

public DisplayVideo.Advertisers.Campaigns.Delete setCampaignId(Long campaignId)

The ID of the campaign we need to delete.

set

public DisplayVideo.Advertisers.Campaigns.Delete set(String parameterName,
                                                     Object value)

Overrides:

set in class DisplayVideoRequest<Empty>