com.google.api.services.content

Class ShoppingContent.Settlementtransactions.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.content.ShoppingContentRequest<SettlementtransactionsListResponse>

com.google.api.services.content.ShoppingContent.Settlementtransactions.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

ShoppingContent.Settlementtransactions

public class ShoppingContent.Settlementtransactions.List
extends ShoppingContentRequest<SettlementtransactionsListResponse>

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	List(BigInteger merchantId, String settlementId) Retrieves a list of transactions for the settlement.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
Long	getMaxResults() The maximum number of transactions to return in the response, used for paging.
BigInteger	getMerchantId() The Merchant Center account to list transactions for.
String	getPageToken() The token returned by the previous request.
String	getSettlementId() The Google-provided ID of the settlement.
List<String>	getTransactionIds() The list of transactions to return.
ShoppingContent.Settlementtransactions.List	set(String parameterName, Object value)
ShoppingContent.Settlementtransactions.List	setAlt(String alt) Data format for the response.
ShoppingContent.Settlementtransactions.List	setFields(String fields) Selector specifying which fields to include in a partial response.
ShoppingContent.Settlementtransactions.List	setKey(String key) API key.
ShoppingContent.Settlementtransactions.List	setMaxResults(Long maxResults) The maximum number of transactions to return in the response, used for paging.
ShoppingContent.Settlementtransactions.List	setMerchantId(BigInteger merchantId) The Merchant Center account to list transactions for.
ShoppingContent.Settlementtransactions.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
ShoppingContent.Settlementtransactions.List	setPageToken(String pageToken) The token returned by the previous request.
ShoppingContent.Settlementtransactions.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
ShoppingContent.Settlementtransactions.List	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
ShoppingContent.Settlementtransactions.List	setSettlementId(String settlementId) The Google-provided ID of the settlement.
ShoppingContent.Settlementtransactions.List	setTransactionIds(List<String> transactionIds) The list of transactions to return.
ShoppingContent.Settlementtransactions.List	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, 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(BigInteger merchantId,
               String settlementId)

Retrieves a list of transactions for the settlement. Create a request for the method "settlementtransactions.list". 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.

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

Parameters:

merchantId - The Merchant Center account to list transactions for.

settlementId - The Google-provided ID of the settlement.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<SettlementtransactionsListResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<SettlementtransactionsListResponse>

Throws:

IOException

setAlt

public ShoppingContent.Settlementtransactions.List setAlt(String alt)

Description copied from class: ShoppingContentRequest

Data format for the response.

Overrides:

setAlt in class ShoppingContentRequest<SettlementtransactionsListResponse>

setFields

public ShoppingContent.Settlementtransactions.List setFields(String fields)

Description copied from class: ShoppingContentRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ShoppingContentRequest<SettlementtransactionsListResponse>

setKey

public ShoppingContent.Settlementtransactions.List 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<SettlementtransactionsListResponse>

setOauthToken

public ShoppingContent.Settlementtransactions.List setOauthToken(String oauthToken)

Description copied from class: ShoppingContentRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ShoppingContentRequest<SettlementtransactionsListResponse>

setPrettyPrint

public ShoppingContent.Settlementtransactions.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: ShoppingContentRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ShoppingContentRequest<SettlementtransactionsListResponse>

setQuotaUser

public ShoppingContent.Settlementtransactions.List 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<SettlementtransactionsListResponse>

setUserIp

public ShoppingContent.Settlementtransactions.List setUserIp(String userIp)

Description copied from class: ShoppingContentRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class ShoppingContentRequest<SettlementtransactionsListResponse>

getMerchantId

public BigInteger getMerchantId()

The Merchant Center account to list transactions for.

setMerchantId

public ShoppingContent.Settlementtransactions.List setMerchantId(BigInteger merchantId)

The Merchant Center account to list transactions for.

getSettlementId

public String getSettlementId()

The Google-provided ID of the settlement.

setSettlementId

public ShoppingContent.Settlementtransactions.List setSettlementId(String settlementId)

The Google-provided ID of the settlement.

getMaxResults

public Long getMaxResults()

The maximum number of transactions to return in the response, used for paging. The default value is 200 transactions per page, and the maximum allowed value is 5000 transactions per page.

setMaxResults

public ShoppingContent.Settlementtransactions.List setMaxResults(Long maxResults)

The maximum number of transactions to return in the response, used for paging. The default value is 200 transactions per page, and the maximum allowed value is 5000 transactions per page.

getPageToken

public String getPageToken()

The token returned by the previous request.

setPageToken

public ShoppingContent.Settlementtransactions.List setPageToken(String pageToken)

The token returned by the previous request.

getTransactionIds

public List<String> getTransactionIds()

The list of transactions to return. If not set, all transactions will be returned.

setTransactionIds

public ShoppingContent.Settlementtransactions.List setTransactionIds(List<String> transactionIds)

The list of transactions to return. If not set, all transactions will be returned.

set

public ShoppingContent.Settlementtransactions.List set(String parameterName,
                                                       Object value)

Overrides:

set in class ShoppingContentRequest<SettlementtransactionsListResponse>