com.google.api.services.dfareporting

Class Dfareporting.AdvertiserInvoices.List

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

com.google.api.services.dfareporting.Dfareporting.AdvertiserInvoices.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dfareporting.AdvertiserInvoices

public class Dfareporting.AdvertiserInvoices.List
extends DfareportingRequest<AdvertiserInvoicesListResponse>

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	List(Long profileId, Long advertiserId) Retrieves a list of invoices for a particular issue month.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Long	getAdvertiserId() Advertiser ID of this invoice.
String	getIssueMonth() Month for which invoices are needed in the format YYYYMM.
Integer	getMaxResults() Maximum number of results to return.
String	getPageToken() Value of the nextPageToken from the previous result page.
Long	getProfileId() User profile ID associated with this request.
Dfareporting.AdvertiserInvoices.List	set(String parameterName, Object value)
Dfareporting.AdvertiserInvoices.List	set$Xgafv(String $Xgafv) V1 error format.
Dfareporting.AdvertiserInvoices.List	setAccessToken(String accessToken) OAuth access token.
Dfareporting.AdvertiserInvoices.List	setAdvertiserId(Long advertiserId) Advertiser ID of this invoice.
Dfareporting.AdvertiserInvoices.List	setAlt(String alt) Data format for response.
Dfareporting.AdvertiserInvoices.List	setCallback(String callback) JSONP
Dfareporting.AdvertiserInvoices.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Dfareporting.AdvertiserInvoices.List	setIssueMonth(String issueMonth) Month for which invoices are needed in the format YYYYMM.
Dfareporting.AdvertiserInvoices.List	setKey(String key) API key.
Dfareporting.AdvertiserInvoices.List	setMaxResults(Integer maxResults) Maximum number of results to return.
Dfareporting.AdvertiserInvoices.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Dfareporting.AdvertiserInvoices.List	setPageToken(String pageToken) Value of the nextPageToken from the previous result page.
Dfareporting.AdvertiserInvoices.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Dfareporting.AdvertiserInvoices.List	setProfileId(Long profileId) User profile ID associated with this request.
Dfareporting.AdvertiserInvoices.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Dfareporting.AdvertiserInvoices.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Dfareporting.AdvertiserInvoices.List	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, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, 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

List

protected List(Long profileId,
               Long advertiserId)

Retrieves a list of invoices for a particular issue month. The api only works if the billing profile invoice level is set to either advertiser or campaign non-consolidated invoice level. Create a request for the method "advertiserInvoices.list". 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.

advertiserId - Advertiser ID of this invoice.

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public Dfareporting.AdvertiserInvoices.List set$Xgafv(String $Xgafv)

Description copied from class: DfareportingRequest

V1 error format.

Overrides:

set$Xgafv in class DfareportingRequest<AdvertiserInvoicesListResponse>

setAccessToken

public Dfareporting.AdvertiserInvoices.List setAccessToken(String accessToken)

Description copied from class: DfareportingRequest

OAuth access token.

Overrides:

setAccessToken in class DfareportingRequest<AdvertiserInvoicesListResponse>

setAlt

public Dfareporting.AdvertiserInvoices.List setAlt(String alt)

Description copied from class: DfareportingRequest

Data format for response.

Overrides:

setAlt in class DfareportingRequest<AdvertiserInvoicesListResponse>

setCallback

public Dfareporting.AdvertiserInvoices.List setCallback(String callback)

Description copied from class: DfareportingRequest

JSONP

Overrides:

setCallback in class DfareportingRequest<AdvertiserInvoicesListResponse>

setFields

public Dfareporting.AdvertiserInvoices.List setFields(String fields)

Description copied from class: DfareportingRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DfareportingRequest<AdvertiserInvoicesListResponse>

setKey

public Dfareporting.AdvertiserInvoices.List 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<AdvertiserInvoicesListResponse>

setOauthToken

public Dfareporting.AdvertiserInvoices.List setOauthToken(String oauthToken)

Description copied from class: DfareportingRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DfareportingRequest<AdvertiserInvoicesListResponse>

setPrettyPrint

public Dfareporting.AdvertiserInvoices.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: DfareportingRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DfareportingRequest<AdvertiserInvoicesListResponse>

setQuotaUser

public Dfareporting.AdvertiserInvoices.List 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<AdvertiserInvoicesListResponse>

setUploadType

public Dfareporting.AdvertiserInvoices.List setUploadType(String uploadType)

Description copied from class: DfareportingRequest

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

Overrides:

setUploadType in class DfareportingRequest<AdvertiserInvoicesListResponse>

setUploadProtocol

public Dfareporting.AdvertiserInvoices.List setUploadProtocol(String uploadProtocol)

Description copied from class: DfareportingRequest

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

Overrides:

setUploadProtocol in class DfareportingRequest<AdvertiserInvoicesListResponse>

getProfileId

public Long getProfileId()

User profile ID associated with this request.

setProfileId

public Dfareporting.AdvertiserInvoices.List setProfileId(Long profileId)

User profile ID associated with this request.

getAdvertiserId

public Long getAdvertiserId()

Advertiser ID of this invoice.

setAdvertiserId

public Dfareporting.AdvertiserInvoices.List setAdvertiserId(Long advertiserId)

Advertiser ID of this invoice.

getIssueMonth

public String getIssueMonth()

Month for which invoices are needed in the format YYYYMM. Required field

setIssueMonth

public Dfareporting.AdvertiserInvoices.List setIssueMonth(String issueMonth)

Month for which invoices are needed in the format YYYYMM. Required field

getMaxResults

public Integer getMaxResults()

Maximum number of results to return. [default: 1000]

setMaxResults

public Dfareporting.AdvertiserInvoices.List setMaxResults(Integer maxResults)

Maximum number of results to return.

getPageToken

public String getPageToken()

Value of the nextPageToken from the previous result page.

setPageToken

public Dfareporting.AdvertiserInvoices.List setPageToken(String pageToken)

Value of the nextPageToken from the previous result page.

set

public Dfareporting.AdvertiserInvoices.List set(String parameterName,
                                                Object value)

Overrides:

set in class DfareportingRequest<AdvertiserInvoicesListResponse>