com.google.api.services.dfareporting

Class Dfareporting.Reports.Files.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<File>

com.google.api.services.dfareporting.Dfareporting.Reports.Files.Get

All Implemented Interfaces:

Cloneable, Map<String,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

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 reportId, Long fileId) Retrieves a report file by its report ID and file ID.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeMedia()
void	executeMediaAndDownloadTo(OutputStream outputStream)
InputStream	executeMediaAsInputStream()
HttpResponse	executeUsingHead()
Long	getFileId() The ID of the report file.
Long	getProfileId() The Campaign Manager 360 user profile ID.
Long	getReportId() The ID of the report.
Dfareporting.Reports.Files.Get	set(String parameterName, Object value)
Dfareporting.Reports.Files.Get	set$Xgafv(String $Xgafv) V1 error format.
Dfareporting.Reports.Files.Get	setAccessToken(String accessToken) OAuth access token.
Dfareporting.Reports.Files.Get	setAlt(String alt) Data format for response.
Dfareporting.Reports.Files.Get	setCallback(String callback) JSONP
Dfareporting.Reports.Files.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
Dfareporting.Reports.Files.Get	setFileId(Long fileId) The ID of the report file.
Dfareporting.Reports.Files.Get	setKey(String key) API key.
Dfareporting.Reports.Files.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Dfareporting.Reports.Files.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Dfareporting.Reports.Files.Get	setProfileId(Long profileId) The Campaign Manager 360 user profile ID.
Dfareporting.Reports.Files.Get	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Dfareporting.Reports.Files.Get	setReportId(Long reportId) The ID of the report.
Dfareporting.Reports.Files.Get	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Dfareporting.Reports.Files.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, 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 reportId,
              Long fileId)

Retrieves a report file by its report ID and file ID. 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 Campaign Manager 360 user profile ID.

reportId - The ID of the report.

fileId - The ID of the report file.

Since:

1.13

Method Detail

executeMediaAndDownloadTo

public void executeMediaAndDownloadTo(OutputStream outputStream)
                               throws IOException

Overrides:

executeMediaAndDownloadTo in class AbstractGoogleClientRequest<File>

Throws:

IOException

executeMediaAsInputStream

public InputStream executeMediaAsInputStream()
                                      throws IOException

Overrides:

executeMediaAsInputStream in class AbstractGoogleClientRequest<File>

Throws:

IOException

executeMedia

public HttpResponse executeMedia()
                          throws IOException

Overrides:

executeMedia in class AbstractGoogleClientRequest<File>

Throws:

IOException

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<File>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<File>

Throws:

IOException

set$Xgafv

public Dfareporting.Reports.Files.Get set$Xgafv(String $Xgafv)

Description copied from class: DfareportingRequest

V1 error format.

Overrides:

set$Xgafv in class DfareportingRequest<File>

setAccessToken

public Dfareporting.Reports.Files.Get setAccessToken(String accessToken)

Description copied from class: DfareportingRequest

OAuth access token.

Overrides:

setAccessToken in class DfareportingRequest<File>

setAlt

public Dfareporting.Reports.Files.Get setAlt(String alt)

Description copied from class: DfareportingRequest

Data format for response.

Overrides:

setAlt in class DfareportingRequest<File>

setCallback

public Dfareporting.Reports.Files.Get setCallback(String callback)

Description copied from class: DfareportingRequest

JSONP

Overrides:

setCallback in class DfareportingRequest<File>

setFields

public Dfareporting.Reports.Files.Get setFields(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(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(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(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(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<File>

setUploadType

public Dfareporting.Reports.Files.Get setUploadType(String uploadType)

Description copied from class: DfareportingRequest

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

Overrides:

setUploadType in class DfareportingRequest<File>

setUploadProtocol

public Dfareporting.Reports.Files.Get setUploadProtocol(String uploadProtocol)

Description copied from class: DfareportingRequest

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

Overrides:

setUploadProtocol in class DfareportingRequest<File>

getProfileId

public Long getProfileId()

The Campaign Manager 360 user profile ID.

setProfileId

public Dfareporting.Reports.Files.Get setProfileId(Long profileId)

The Campaign Manager 360 user profile ID.

getReportId

public Long getReportId()

The ID of the report.

setReportId

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

The ID of the report.

getFileId

public Long getFileId()

The ID of the report file.

setFileId

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

The ID of the report file.

set

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

Overrides:

set in class DfareportingRequest<File>