com.google.api.services.dfareporting

Class Dfareporting.Campaigns.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.dfareporting.DfareportingRequest<Campaign>

com.google.api.services.dfareporting.Dfareporting.Campaigns.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dfareporting.Campaigns

public class Dfareporting.Campaigns.Get
extends DfareportingRequest<Campaign>

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 profileId, Long id) Gets one campaign by ID.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Long	getId() Campaign ID.
Long	getProfileId() User profile ID associated with this request.
Dfareporting.Campaigns.Get	set(String parameterName, Object value)
Dfareporting.Campaigns.Get	set$Xgafv(String $Xgafv) V1 error format.
Dfareporting.Campaigns.Get	setAccessToken(String accessToken) OAuth access token.
Dfareporting.Campaigns.Get	setAlt(String alt) Data format for response.
Dfareporting.Campaigns.Get	setCallback(String callback) JSONP
Dfareporting.Campaigns.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
Dfareporting.Campaigns.Get	setId(Long id) Campaign ID.
Dfareporting.Campaigns.Get	setKey(String key) API key.
Dfareporting.Campaigns.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Dfareporting.Campaigns.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Dfareporting.Campaigns.Get	setProfileId(Long profileId) User profile ID associated with this request.
Dfareporting.Campaigns.Get	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Dfareporting.Campaigns.Get	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Dfareporting.Campaigns.Get	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.dfareporting.DfareportingRequest

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 profileId,
              Long id)

Gets one campaign by ID. Create a request for the method "campaigns.get". This request holds the parameters needed by the the dfareporting server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

profileId - User profile ID associated with this request.

id - Campaign ID.

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public Dfareporting.Campaigns.Get set$Xgafv(String $Xgafv)

Description copied from class: DfareportingRequest

V1 error format.

Overrides:

set$Xgafv in class DfareportingRequest<Campaign>

setAccessToken

public Dfareporting.Campaigns.Get setAccessToken(String accessToken)

Description copied from class: DfareportingRequest

OAuth access token.

Overrides:

setAccessToken in class DfareportingRequest<Campaign>

setAlt

public Dfareporting.Campaigns.Get setAlt(String alt)

Description copied from class: DfareportingRequest

Data format for response.

Overrides:

setAlt in class DfareportingRequest<Campaign>

setCallback

public Dfareporting.Campaigns.Get setCallback(String callback)

Description copied from class: DfareportingRequest

JSONP

Overrides:

setCallback in class DfareportingRequest<Campaign>

setFields

public Dfareporting.Campaigns.Get setFields(String fields)

Description copied from class: DfareportingRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DfareportingRequest<Campaign>

setKey

public Dfareporting.Campaigns.Get setKey(String key)

Description copied from class: DfareportingRequest

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 DfareportingRequest<Campaign>

setOauthToken

public Dfareporting.Campaigns.Get setOauthToken(String oauthToken)

Description copied from class: DfareportingRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DfareportingRequest<Campaign>

setPrettyPrint

public Dfareporting.Campaigns.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: DfareportingRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DfareportingRequest<Campaign>

setQuotaUser

public Dfareporting.Campaigns.Get setQuotaUser(String quotaUser)

Description copied from class: DfareportingRequest

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 DfareportingRequest<Campaign>

setUploadType

public Dfareporting.Campaigns.Get setUploadType(String uploadType)

Description copied from class: DfareportingRequest

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

Overrides:

setUploadType in class DfareportingRequest<Campaign>

setUploadProtocol

public Dfareporting.Campaigns.Get setUploadProtocol(String uploadProtocol)

Description copied from class: DfareportingRequest

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

Overrides:

setUploadProtocol in class DfareportingRequest<Campaign>

getProfileId

public Long getProfileId()

User profile ID associated with this request.

setProfileId

public Dfareporting.Campaigns.Get setProfileId(Long profileId)

User profile ID associated with this request.

getId

public Long getId()

Campaign ID.

setId

public Dfareporting.Campaigns.Get setId(Long id)

Campaign ID.

set

public Dfareporting.Campaigns.Get set(String parameterName,
                                      Object value)

Overrides:

set in class DfareportingRequest<Campaign>