com.google.api.services.displayvideo.v4

Class DisplayVideo.Advertisers.Invoices.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.displayvideo.v4.DisplayVideoRequest<ListInvoicesResponse>

com.google.api.services.displayvideo.v4.DisplayVideo.Advertisers.Invoices.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DisplayVideo.Advertisers.Invoices

public class DisplayVideo.Advertisers.Invoices.List
extends DisplayVideoRequest<ListInvoicesResponse>

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 advertiserId) Lists invoices posted for an advertiser in a given 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() Required.
String	getIssueMonth() The month to list the invoices for.
String	getLoiSapinInvoiceType() Select type of invoice to retrieve for Loi Sapin advertisers.
Integer	getPageSize() Requested page size.
String	getPageToken() A token identifying a page of results the server should return.
DisplayVideo.Advertisers.Invoices.List	set(String parameterName, Object value)
DisplayVideo.Advertisers.Invoices.List	set$Xgafv(String $Xgafv) V1 error format.
DisplayVideo.Advertisers.Invoices.List	setAccessToken(String accessToken) OAuth access token.
DisplayVideo.Advertisers.Invoices.List	setAdvertiserId(Long advertiserId) Required.
DisplayVideo.Advertisers.Invoices.List	setAlt(String alt) Data format for response.
DisplayVideo.Advertisers.Invoices.List	setCallback(String callback) JSONP
DisplayVideo.Advertisers.Invoices.List	setFields(String fields) Selector specifying which fields to include in a partial response.
DisplayVideo.Advertisers.Invoices.List	setIssueMonth(String issueMonth) The month to list the invoices for.
DisplayVideo.Advertisers.Invoices.List	setKey(String key) API key.
DisplayVideo.Advertisers.Invoices.List	setLoiSapinInvoiceType(String loiSapinInvoiceType) Select type of invoice to retrieve for Loi Sapin advertisers.
DisplayVideo.Advertisers.Invoices.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DisplayVideo.Advertisers.Invoices.List	setPageSize(Integer pageSize) Requested page size.
DisplayVideo.Advertisers.Invoices.List	setPageToken(String pageToken) A token identifying a page of results the server should return.
DisplayVideo.Advertisers.Invoices.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DisplayVideo.Advertisers.Invoices.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
DisplayVideo.Advertisers.Invoices.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
DisplayVideo.Advertisers.Invoices.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.displayvideo.v4.DisplayVideoRequest

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 advertiserId)

Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this method. Create a request for the method "invoices.list". This request holds the parameters needed by the the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

DisplayVideo.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

advertiserId - Required. The ID of the advertiser to list invoices for.

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public DisplayVideo.Advertisers.Invoices.List set$Xgafv(String $Xgafv)

Description copied from class: DisplayVideoRequest

V1 error format.

Overrides:

set$Xgafv in class DisplayVideoRequest<ListInvoicesResponse>

setAccessToken

public DisplayVideo.Advertisers.Invoices.List setAccessToken(String accessToken)

Description copied from class: DisplayVideoRequest

OAuth access token.

Overrides:

setAccessToken in class DisplayVideoRequest<ListInvoicesResponse>

setAlt

public DisplayVideo.Advertisers.Invoices.List setAlt(String alt)

Description copied from class: DisplayVideoRequest

Data format for response.

Overrides:

setAlt in class DisplayVideoRequest<ListInvoicesResponse>

setCallback

public DisplayVideo.Advertisers.Invoices.List setCallback(String callback)

Description copied from class: DisplayVideoRequest

JSONP

Overrides:

setCallback in class DisplayVideoRequest<ListInvoicesResponse>

setFields

public DisplayVideo.Advertisers.Invoices.List setFields(String fields)

Description copied from class: DisplayVideoRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DisplayVideoRequest<ListInvoicesResponse>

setKey

public DisplayVideo.Advertisers.Invoices.List setKey(String key)

Description copied from class: DisplayVideoRequest

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 DisplayVideoRequest<ListInvoicesResponse>

setOauthToken

public DisplayVideo.Advertisers.Invoices.List setOauthToken(String oauthToken)

Description copied from class: DisplayVideoRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DisplayVideoRequest<ListInvoicesResponse>

setPrettyPrint

public DisplayVideo.Advertisers.Invoices.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: DisplayVideoRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DisplayVideoRequest<ListInvoicesResponse>

setQuotaUser

public DisplayVideo.Advertisers.Invoices.List setQuotaUser(String quotaUser)

Description copied from class: DisplayVideoRequest

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 DisplayVideoRequest<ListInvoicesResponse>

setUploadType

public DisplayVideo.Advertisers.Invoices.List setUploadType(String uploadType)

Description copied from class: DisplayVideoRequest

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

Overrides:

setUploadType in class DisplayVideoRequest<ListInvoicesResponse>

setUploadProtocol

public DisplayVideo.Advertisers.Invoices.List setUploadProtocol(String uploadProtocol)

Description copied from class: DisplayVideoRequest

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

Overrides:

setUploadProtocol in class DisplayVideoRequest<ListInvoicesResponse>

getAdvertiserId

public Long getAdvertiserId()

Required. The ID of the advertiser to list invoices for.

setAdvertiserId

public DisplayVideo.Advertisers.Invoices.List setAdvertiserId(Long advertiserId)

Required. The ID of the advertiser to list invoices for.

getIssueMonth

public String getIssueMonth()

The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM.

setIssueMonth

public DisplayVideo.Advertisers.Invoices.List setIssueMonth(String issueMonth)

The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM.

getLoiSapinInvoiceType

public String getLoiSapinInvoiceType()

Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.

setLoiSapinInvoiceType

public DisplayVideo.Advertisers.Invoices.List setLoiSapinInvoiceType(String loiSapinInvoiceType)

Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.

getPageSize

public Integer getPageSize()

Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

setPageSize

public DisplayVideo.Advertisers.Invoices.List setPageSize(Integer pageSize)

Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

getPageToken

public String getPageToken()

A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInvoices` method. If not specified, the first page of results will be returned.

setPageToken

public DisplayVideo.Advertisers.Invoices.List setPageToken(String pageToken)

A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInvoices` method. If not specified, the first page of results will be returned.

set

public DisplayVideo.Advertisers.Invoices.List set(String parameterName,
                                                  Object value)

Overrides:

set in class DisplayVideoRequest<ListInvoicesResponse>