com.google.api.services.dfareporting

Class Dfareporting.Reports.Run

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

com.google.api.services.dfareporting.Dfareporting.Reports.Run

All Implemented Interfaces:

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

Enclosing class:

Dfareporting.Reports

public class Dfareporting.Reports.Run
extends DfareportingRequest<File>

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.Reports.Run(java.lang.Long profileId, java.lang.Long reportId) Runs a report.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Long	getProfileId() The DFA profile ID.
java.lang.Long	getReportId() The ID of the report.
java.lang.Boolean	getSynchronous() If set and true, tries to run the report synchronously.
boolean	isSynchronous() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Dfareporting.Reports.Run	set(java.lang.String parameterName, java.lang.Object value)
Dfareporting.Reports.Run	setAlt(java.lang.String alt) Data format for the response.
Dfareporting.Reports.Run	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Dfareporting.Reports.Run	setKey(java.lang.String key) API key.
Dfareporting.Reports.Run	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Dfareporting.Reports.Run	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Dfareporting.Reports.Run	setProfileId(java.lang.Long profileId) The DFA profile ID.
Dfareporting.Reports.Run	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Dfareporting.Reports.Run	setReportId(java.lang.Long reportId) The ID of the report.
Dfareporting.Reports.Run	setSynchronous(java.lang.Boolean synchronous) If set and true, tries to run the report synchronously.
Dfareporting.Reports.Run	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.Reports.Run

protected Dfareporting.Reports.Run(java.lang.Long profileId,
                        java.lang.Long reportId)

Runs a report. Create a request for the method "reports.run". 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 profile ID.

reportId - The ID of the report.

Since:

1.13

Method Detail

setAlt

public Dfareporting.Reports.Run setAlt(java.lang.String alt)

Description copied from class: DfareportingRequest

Data format for the response.

Overrides:

setAlt in class DfareportingRequest<File>

setFields

public Dfareporting.Reports.Run 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<File>

setKey

public Dfareporting.Reports.Run 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<File>

setOauthToken

public Dfareporting.Reports.Run setOauthToken(java.lang.String oauthToken)

Description copied from class: DfareportingRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DfareportingRequest<File>

setPrettyPrint

public Dfareporting.Reports.Run setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: DfareportingRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DfareportingRequest<File>

setQuotaUser

public Dfareporting.Reports.Run 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<File>

setUserIp

public Dfareporting.Reports.Run 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<File>

getProfileId

public java.lang.Long getProfileId()

The DFA profile ID.

setProfileId

public Dfareporting.Reports.Run setProfileId(java.lang.Long profileId)

The DFA profile ID.

getReportId

public java.lang.Long getReportId()

The ID of the report.

setReportId

public Dfareporting.Reports.Run setReportId(java.lang.Long reportId)

The ID of the report.

getSynchronous

public java.lang.Boolean getSynchronous()

If set and true, tries to run the report synchronously. [default: false]

setSynchronous

public Dfareporting.Reports.Run setSynchronous(java.lang.Boolean synchronous)

If set and true, tries to run the report synchronously.

isSynchronous

public boolean isSynchronous()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

If set and true, tries to run the report synchronously.

set

public Dfareporting.Reports.Run set(java.lang.String parameterName,
                           java.lang.Object value)

Overrides:

set in class DfareportingRequest<File>