com.google.api.services.dfareporting

Class Dfareporting.DimensionValues.Query

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.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<DimensionValueList>

com.google.api.services.dfareporting.Dfareporting.DimensionValues.Query

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Dfareporting.DimensionValues

public class Dfareporting.DimensionValues.Query
extends DfareportingRequest<DimensionValueList>

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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.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	Dfareporting.DimensionValues.Query(java.lang.Long profileId, DimensionValueRequest content) Retrieves list of report dimension values for a list of filters.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Integer	getMaxResults() Maximum number of results to return.
java.lang.String	getPageToken() The value of the nextToken from the previous result page.
java.lang.Long	getProfileId() The DFA user profile ID.
Dfareporting.DimensionValues.Query	set(java.lang.String parameterName, java.lang.Object value)
Dfareporting.DimensionValues.Query	setAlt(java.lang.String alt) Data format for the response.
Dfareporting.DimensionValues.Query	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Dfareporting.DimensionValues.Query	setKey(java.lang.String key) API key.
Dfareporting.DimensionValues.Query	setMaxResults(java.lang.Integer maxResults) Maximum number of results to return.
Dfareporting.DimensionValues.Query	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Dfareporting.DimensionValues.Query	setPageToken(java.lang.String pageToken) The value of the nextToken from the previous result page.
Dfareporting.DimensionValues.Query	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Dfareporting.DimensionValues.Query	setProfileId(java.lang.Long profileId) The DFA user profile ID.
Dfareporting.DimensionValues.Query	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Dfareporting.DimensionValues.Query	setUserIp(java.lang.String userIp) IP address of the site where the request originates.

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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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

Constructor Detail

Dfareporting.DimensionValues.Query

protected Dfareporting.DimensionValues.Query(java.lang.Long profileId,
                                  DimensionValueRequest content)

Retrieves list of report dimension values for a list of filters. Create a request for the method "dimensionValues.query". 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 - The DFA user profile ID.

content - the DimensionValueRequest

Since:

1.13

Method Detail

setAlt

public Dfareporting.DimensionValues.Query setAlt(java.lang.String alt)

Description copied from class: DfareportingRequest

Data format for the response.

Overrides:

setAlt in class DfareportingRequest<DimensionValueList>

setFields

public Dfareporting.DimensionValues.Query setFields(java.lang.String fields)

Description copied from class: DfareportingRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DfareportingRequest<DimensionValueList>

setKey

public Dfareporting.DimensionValues.Query setKey(java.lang.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<DimensionValueList>

setOauthToken

public Dfareporting.DimensionValues.Query setOauthToken(java.lang.String oauthToken)

Description copied from class: DfareportingRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DfareportingRequest<DimensionValueList>

setPrettyPrint

public Dfareporting.DimensionValues.Query setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: DfareportingRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DfareportingRequest<DimensionValueList>

setQuotaUser

public Dfareporting.DimensionValues.Query setQuotaUser(java.lang.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 userIp if both are provided.

Overrides:

setQuotaUser in class DfareportingRequest<DimensionValueList>

setUserIp

public Dfareporting.DimensionValues.Query setUserIp(java.lang.String userIp)

Description copied from class: DfareportingRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class DfareportingRequest<DimensionValueList>

getProfileId

public java.lang.Long getProfileId()

The DFA user profile ID.

setProfileId

public Dfareporting.DimensionValues.Query setProfileId(java.lang.Long profileId)

The DFA user profile ID.

getMaxResults

public java.lang.Integer getMaxResults()

Maximum number of results to return. [default: 100] [minimum: 0] [maximum: 100]

setMaxResults

public Dfareporting.DimensionValues.Query setMaxResults(java.lang.Integer maxResults)

Maximum number of results to return.

getPageToken

public java.lang.String getPageToken()

The value of the nextToken from the previous result page.

setPageToken

public Dfareporting.DimensionValues.Query setPageToken(java.lang.String pageToken)

The value of the nextToken from the previous result page.

set

public Dfareporting.DimensionValues.Query set(java.lang.String parameterName,
                                     java.lang.Object value)

Overrides:

set in class DfareportingRequest<DimensionValueList>