com.google.api.services.dfareporting

Class Dfareporting.AccountActiveAdSummaries.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<AccountActiveAdSummary>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dfareporting.AccountActiveAdSummaries

public class Dfareporting.AccountActiveAdSummaries.Get
extends DfareportingRequest<AccountActiveAdSummary>

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Get(Long profileId, Long summaryAccountId) Gets the account's active ad summary by account ID.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Long	getProfileId() User profile ID associated with this request.
Long	getSummaryAccountId() Account ID.
Dfareporting.AccountActiveAdSummaries.Get	set(String parameterName, Object value)
Dfareporting.AccountActiveAdSummaries.Get	setAlt(String alt) Data format for the response.
Dfareporting.AccountActiveAdSummaries.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
Dfareporting.AccountActiveAdSummaries.Get	setKey(String key) API key.
Dfareporting.AccountActiveAdSummaries.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Dfareporting.AccountActiveAdSummaries.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Dfareporting.AccountActiveAdSummaries.Get	setProfileId(Long profileId) User profile ID associated with this request.
Dfareporting.AccountActiveAdSummaries.Get	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Dfareporting.AccountActiveAdSummaries.Get	setSummaryAccountId(Long summaryAccountId) Account ID.
Dfareporting.AccountActiveAdSummaries.Get	setUserIp(String userIp) Deprecated.

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

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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 summaryAccountId)

Gets the account's active ad summary by account ID. Create a request for the method "accountActiveAdSummaries.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.

summaryAccountId - Account 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<AccountActiveAdSummary>

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

setAlt

public Dfareporting.AccountActiveAdSummaries.Get setAlt(String alt)

Description copied from class: DfareportingRequest

Data format for the response.

Overrides:

setAlt in class DfareportingRequest<AccountActiveAdSummary>

setFields

public Dfareporting.AccountActiveAdSummaries.Get setFields(String fields)

Description copied from class: DfareportingRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DfareportingRequest<AccountActiveAdSummary>

setKey

public Dfareporting.AccountActiveAdSummaries.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<AccountActiveAdSummary>

setOauthToken

public Dfareporting.AccountActiveAdSummaries.Get setOauthToken(String oauthToken)

Description copied from class: DfareportingRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DfareportingRequest<AccountActiveAdSummary>

setPrettyPrint

public Dfareporting.AccountActiveAdSummaries.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: DfareportingRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DfareportingRequest<AccountActiveAdSummary>

setQuotaUser

public Dfareporting.AccountActiveAdSummaries.Get setQuotaUser(String quotaUser)

Description copied from class: DfareportingRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class DfareportingRequest<AccountActiveAdSummary>

setUserIp

public Dfareporting.AccountActiveAdSummaries.Get setUserIp(String userIp)

Description copied from class: DfareportingRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class DfareportingRequest<AccountActiveAdSummary>

getProfileId

public Long getProfileId()

User profile ID associated with this request.

setProfileId

public Dfareporting.AccountActiveAdSummaries.Get setProfileId(Long profileId)

User profile ID associated with this request.

getSummaryAccountId

public Long getSummaryAccountId()

Account ID.

setSummaryAccountId

public Dfareporting.AccountActiveAdSummaries.Get setSummaryAccountId(Long summaryAccountId)

Account ID.

set

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

Overrides:

set in class DfareportingRequest<AccountActiveAdSummary>