com.google.api.services.dfareporting

Class Dfareporting.Reports.Files.Get

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.Files.Get

All Implemented Interfaces:

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

Enclosing class:

Dfareporting.Reports.Files

public class Dfareporting.Reports.Files.Get
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.Files.Get(java.lang.Long profileId, java.lang.Long reportId, java.lang.Long fileId) Retrieves a report file.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeMedia()
void	executeMediaAndDownloadTo(java.io.OutputStream outputStream)
java.io.InputStream	executeMediaAsInputStream()
com.google.api.client.http.HttpResponse	executeUsingHead()
java.lang.Long	getFileId() The ID of the report file.
java.lang.Long	getProfileId() The DFA profile ID.
java.lang.Long	getReportId() The ID of the report.
Dfareporting.Reports.Files.Get	set(java.lang.String parameterName, java.lang.Object value)
Dfareporting.Reports.Files.Get	setAlt(java.lang.String alt) Data format for the response.
Dfareporting.Reports.Files.Get	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Dfareporting.Reports.Files.Get	setFileId(java.lang.Long fileId) The ID of the report file.
Dfareporting.Reports.Files.Get	setKey(java.lang.String key) API key.
Dfareporting.Reports.Files.Get	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Dfareporting.Reports.Files.Get	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Dfareporting.Reports.Files.Get	setProfileId(java.lang.Long profileId) The DFA profile ID.
Dfareporting.Reports.Files.Get	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Dfareporting.Reports.Files.Get	setReportId(java.lang.Long reportId) The ID of the report.
Dfareporting.Reports.Files.Get	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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, 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

Constructor Detail

Dfareporting.Reports.Files.Get

protected Dfareporting.Reports.Files.Get(java.lang.Long profileId,
                              java.lang.Long reportId,
                              java.lang.Long fileId)

Retrieves a report file. This method supports media download. Create a request for the method "files.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 - The DFA profile ID.

reportId - The ID of the report.

fileId - The ID of the report file.

Since:

1.13

Method Detail

executeMediaAndDownloadTo

public void executeMediaAndDownloadTo(java.io.OutputStream outputStream)
                               throws java.io.IOException

Overrides:

executeMediaAndDownloadTo in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<File>

Throws:

java.io.IOException

executeMediaAsInputStream

public java.io.InputStream executeMediaAsInputStream()
                                              throws java.io.IOException

Overrides:

executeMediaAsInputStream in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<File>

Throws:

java.io.IOException

executeMedia

public com.google.api.client.http.HttpResponse executeMedia()
                                                     throws java.io.IOException

Overrides:

executeMedia in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<File>

Throws:

java.io.IOException

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<File>

Throws:

java.io.IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

java.io.IOException

setAlt

public Dfareporting.Reports.Files.Get 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.Files.Get 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.Files.Get 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.Files.Get 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.Files.Get 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.Files.Get 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.Files.Get 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.Files.Get setProfileId(java.lang.Long profileId)

The DFA profile ID.

getReportId

public java.lang.Long getReportId()

The ID of the report.

setReportId

public Dfareporting.Reports.Files.Get setReportId(java.lang.Long reportId)

The ID of the report.

getFileId

public java.lang.Long getFileId()

The ID of the report file.

setFileId

public Dfareporting.Reports.Files.Get setFileId(java.lang.Long fileId)

The ID of the report file.

set

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

Overrides:

set in class DfareportingRequest<File>