com.google.api.services.content

Class ShoppingContent.Orderreports.Listdisbursements

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.content.ShoppingContentRequest<OrderreportsListDisbursementsResponse>

com.google.api.services.content.ShoppingContent.Orderreports.Listdisbursements

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

ShoppingContent.Orderreports

public class ShoppingContent.Orderreports.Listdisbursements
extends ShoppingContentRequest<OrderreportsListDisbursementsResponse>

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Listdisbursements(BigInteger merchantId, String disbursementStartDate) Retrieves a report for disbursements from your Merchant Center account.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getDisbursementEndDate() The last date which disbursements occurred.
String	getDisbursementStartDate() The first date which disbursements occurred.
Long	getMaxResults() The maximum number of disbursements to return in the response, used for paging.
BigInteger	getMerchantId() The ID of the account that manages the order.
String	getPageToken() The token returned by the previous request.
ShoppingContent.Orderreports.Listdisbursements	set(String parameterName, Object value)
ShoppingContent.Orderreports.Listdisbursements	setAlt(String alt) Data format for the response.
ShoppingContent.Orderreports.Listdisbursements	setDisbursementEndDate(String disbursementEndDate) The last date which disbursements occurred.
ShoppingContent.Orderreports.Listdisbursements	setDisbursementStartDate(String disbursementStartDate) The first date which disbursements occurred.
ShoppingContent.Orderreports.Listdisbursements	setFields(String fields) Selector specifying which fields to include in a partial response.
ShoppingContent.Orderreports.Listdisbursements	setKey(String key) API key.
ShoppingContent.Orderreports.Listdisbursements	setMaxResults(Long maxResults) The maximum number of disbursements to return in the response, used for paging.
ShoppingContent.Orderreports.Listdisbursements	setMerchantId(BigInteger merchantId) The ID of the account that manages the order.
ShoppingContent.Orderreports.Listdisbursements	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
ShoppingContent.Orderreports.Listdisbursements	setPageToken(String pageToken) The token returned by the previous request.
ShoppingContent.Orderreports.Listdisbursements	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
ShoppingContent.Orderreports.Listdisbursements	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
ShoppingContent.Orderreports.Listdisbursements	setUserIp(String userIp) Deprecated.

Methods inherited from class com.google.api.services.content.ShoppingContentRequest

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, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, 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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Listdisbursements

protected Listdisbursements(BigInteger merchantId,
                            String disbursementStartDate)

Retrieves a report for disbursements from your Merchant Center account. Create a request for the method "orderreports.listdisbursements". This request holds the parameters needed by the the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Listdisbursements#initialize(com.google.api.client.googleapis.services.AbstractGoogl eClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

disbursementStartDate - The first date which disbursements occurred. In ISO 8601 format.

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

setAlt

public ShoppingContent.Orderreports.Listdisbursements setAlt(String alt)

Description copied from class: ShoppingContentRequest

Data format for the response.

Overrides:

setAlt in class ShoppingContentRequest<OrderreportsListDisbursementsResponse>

setFields

public ShoppingContent.Orderreports.Listdisbursements setFields(String fields)

Description copied from class: ShoppingContentRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ShoppingContentRequest<OrderreportsListDisbursementsResponse>

setKey

public ShoppingContent.Orderreports.Listdisbursements setKey(String key)

Description copied from class: ShoppingContentRequest

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 ShoppingContentRequest<OrderreportsListDisbursementsResponse>

setOauthToken

public ShoppingContent.Orderreports.Listdisbursements setOauthToken(String oauthToken)

Description copied from class: ShoppingContentRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ShoppingContentRequest<OrderreportsListDisbursementsResponse>

setPrettyPrint

public ShoppingContent.Orderreports.Listdisbursements setPrettyPrint(Boolean prettyPrint)

Description copied from class: ShoppingContentRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ShoppingContentRequest<OrderreportsListDisbursementsResponse>

setQuotaUser

public ShoppingContent.Orderreports.Listdisbursements setQuotaUser(String quotaUser)

Description copied from class: ShoppingContentRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class ShoppingContentRequest<OrderreportsListDisbursementsResponse>

setUserIp

public ShoppingContent.Orderreports.Listdisbursements setUserIp(String userIp)

Description copied from class: ShoppingContentRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class ShoppingContentRequest<OrderreportsListDisbursementsResponse>

getMerchantId

public BigInteger getMerchantId()

The ID of the account that manages the order. This cannot be a multi-client account.

setMerchantId

public ShoppingContent.Orderreports.Listdisbursements setMerchantId(BigInteger merchantId)

The ID of the account that manages the order. This cannot be a multi-client account.

getDisbursementStartDate

public String getDisbursementStartDate()

The first date which disbursements occurred. In ISO 8601 format.

setDisbursementStartDate

public ShoppingContent.Orderreports.Listdisbursements setDisbursementStartDate(String disbursementStartDate)

The first date which disbursements occurred. In ISO 8601 format.

getDisbursementEndDate

public String getDisbursementEndDate()

The last date which disbursements occurred. In ISO 8601 format. Default: current date.

setDisbursementEndDate

public ShoppingContent.Orderreports.Listdisbursements setDisbursementEndDate(String disbursementEndDate)

The last date which disbursements occurred. In ISO 8601 format. Default: current date.

getMaxResults

public Long getMaxResults()

The maximum number of disbursements to return in the response, used for paging.

setMaxResults

public ShoppingContent.Orderreports.Listdisbursements setMaxResults(Long maxResults)

The maximum number of disbursements to return in the response, used for paging.

getPageToken

public String getPageToken()

The token returned by the previous request.

setPageToken

public ShoppingContent.Orderreports.Listdisbursements setPageToken(String pageToken)

The token returned by the previous request.

set

public ShoppingContent.Orderreports.Listdisbursements set(String parameterName,
                                                          Object value)

Overrides:

set in class ShoppingContentRequest<OrderreportsListDisbursementsResponse>