com.google.api.services.content

Class ShoppingContent.Orderreturns.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<OrderreturnsListResponse>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

ShoppingContent.Orderreturns

public class ShoppingContent.Orderreturns.List
extends ShoppingContentRequest<OrderreturnsListResponse>

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	List(BigInteger merchantId) Lists order returns in 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()
Boolean	getAcknowledged() Obtains order returns that match the acknowledgement status.
String	getCreatedEndDate() Obtains order returns created before this date (inclusively), in ISO 8601 format.
String	getCreatedStartDate() Obtains order returns created after this date (inclusively), in ISO 8601 format.
List<String>	getGoogleOrderIds() Obtains order returns with the specified order ids.
Long	getMaxResults() The maximum number of order returns to return in the response, used for paging.
BigInteger	getMerchantId() The ID of the account that manages the order.
String	getOrderBy() Return the results in the specified order.
String	getPageToken() The token returned by the previous request.
List<String>	getShipmentStates() Obtains order returns that match any shipment state provided in this parameter.
List<String>	getShipmentStatus() Obtains order returns that match any shipment status provided in this parameter.
List<String>	getShipmentTrackingNumbers() Obtains order returns with the specified tracking numbers.
List<String>	getShipmentTypes() Obtains order returns that match any shipment type provided in this parameter.
ShoppingContent.Orderreturns.List	set(String parameterName, Object value)
ShoppingContent.Orderreturns.List	set$Xgafv(String $Xgafv) V1 error format.
ShoppingContent.Orderreturns.List	setAccessToken(String accessToken) OAuth access token.
ShoppingContent.Orderreturns.List	setAcknowledged(Boolean acknowledged) Obtains order returns that match the acknowledgement status.
ShoppingContent.Orderreturns.List	setAlt(String alt) Data format for response.
ShoppingContent.Orderreturns.List	setCallback(String callback) JSONP
ShoppingContent.Orderreturns.List	setCreatedEndDate(String createdEndDate) Obtains order returns created before this date (inclusively), in ISO 8601 format.
ShoppingContent.Orderreturns.List	setCreatedStartDate(String createdStartDate) Obtains order returns created after this date (inclusively), in ISO 8601 format.
ShoppingContent.Orderreturns.List	setFields(String fields) Selector specifying which fields to include in a partial response.
ShoppingContent.Orderreturns.List	setGoogleOrderIds(List<String> googleOrderIds) Obtains order returns with the specified order ids.
ShoppingContent.Orderreturns.List	setKey(String key) API key.
ShoppingContent.Orderreturns.List	setMaxResults(Long maxResults) The maximum number of order returns to return in the response, used for paging.
ShoppingContent.Orderreturns.List	setMerchantId(BigInteger merchantId) The ID of the account that manages the order.
ShoppingContent.Orderreturns.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
ShoppingContent.Orderreturns.List	setOrderBy(String orderBy) Return the results in the specified order.
ShoppingContent.Orderreturns.List	setPageToken(String pageToken) The token returned by the previous request.
ShoppingContent.Orderreturns.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
ShoppingContent.Orderreturns.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
ShoppingContent.Orderreturns.List	setShipmentStates(List<String> shipmentStates) Obtains order returns that match any shipment state provided in this parameter.
ShoppingContent.Orderreturns.List	setShipmentStatus(List<String> shipmentStatus) Obtains order returns that match any shipment status provided in this parameter.
ShoppingContent.Orderreturns.List	setShipmentTrackingNumbers(List<String> shipmentTrackingNumbers) Obtains order returns with the specified tracking numbers.
ShoppingContent.Orderreturns.List	setShipmentTypes(List<String> shipmentTypes) Obtains order returns that match any shipment type provided in this parameter.
ShoppingContent.Orderreturns.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
ShoppingContent.Orderreturns.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

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

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(BigInteger merchantId)

Lists order returns in your Merchant Center account. Create a request for the method "orderreturns.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 ID of the account that manages the order. This cannot be a multi-client account.

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public ShoppingContent.Orderreturns.List set$Xgafv(String $Xgafv)

Description copied from class: ShoppingContentRequest

V1 error format.

Overrides:

set$Xgafv in class ShoppingContentRequest<OrderreturnsListResponse>

setAccessToken

public ShoppingContent.Orderreturns.List setAccessToken(String accessToken)

Description copied from class: ShoppingContentRequest

OAuth access token.

Overrides:

setAccessToken in class ShoppingContentRequest<OrderreturnsListResponse>

setAlt

public ShoppingContent.Orderreturns.List setAlt(String alt)

Description copied from class: ShoppingContentRequest

Data format for response.

Overrides:

setAlt in class ShoppingContentRequest<OrderreturnsListResponse>

setCallback

public ShoppingContent.Orderreturns.List setCallback(String callback)

Description copied from class: ShoppingContentRequest

JSONP

Overrides:

setCallback in class ShoppingContentRequest<OrderreturnsListResponse>

setFields

public ShoppingContent.Orderreturns.List setFields(String fields)

Description copied from class: ShoppingContentRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ShoppingContentRequest<OrderreturnsListResponse>

setKey

public ShoppingContent.Orderreturns.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<OrderreturnsListResponse>

setOauthToken

public ShoppingContent.Orderreturns.List setOauthToken(String oauthToken)

Description copied from class: ShoppingContentRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ShoppingContentRequest<OrderreturnsListResponse>

setPrettyPrint

public ShoppingContent.Orderreturns.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: ShoppingContentRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ShoppingContentRequest<OrderreturnsListResponse>

setQuotaUser

public ShoppingContent.Orderreturns.List setQuotaUser(String quotaUser)

Description copied from class: ShoppingContentRequest

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

setUploadType

public ShoppingContent.Orderreturns.List setUploadType(String uploadType)

Description copied from class: ShoppingContentRequest

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

Overrides:

setUploadType in class ShoppingContentRequest<OrderreturnsListResponse>

setUploadProtocol

public ShoppingContent.Orderreturns.List setUploadProtocol(String uploadProtocol)

Description copied from class: ShoppingContentRequest

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

Overrides:

setUploadProtocol in class ShoppingContentRequest<OrderreturnsListResponse>

getMerchantId

public BigInteger getMerchantId()

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

setMerchantId

public ShoppingContent.Orderreturns.List setMerchantId(BigInteger merchantId)

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

getAcknowledged

public Boolean getAcknowledged()

Obtains order returns that match the acknowledgement status. When set to true, obtains order returns that have been acknowledged. When false, obtains order returns that have not been acknowledged. When not provided, obtains order returns regardless of their acknowledgement status. We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged order returns are returned.

setAcknowledged

public ShoppingContent.Orderreturns.List setAcknowledged(Boolean acknowledged)

Obtains order returns that match the acknowledgement status. When set to true, obtains order returns that have been acknowledged. When false, obtains order returns that have not been acknowledged. When not provided, obtains order returns regardless of their acknowledgement status. We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged order returns are returned.

getCreatedEndDate

public String getCreatedEndDate()

Obtains order returns created before this date (inclusively), in ISO 8601 format.

setCreatedEndDate

public ShoppingContent.Orderreturns.List setCreatedEndDate(String createdEndDate)

Obtains order returns created before this date (inclusively), in ISO 8601 format.

getCreatedStartDate

public String getCreatedStartDate()

Obtains order returns created after this date (inclusively), in ISO 8601 format.

setCreatedStartDate

public ShoppingContent.Orderreturns.List setCreatedStartDate(String createdStartDate)

Obtains order returns created after this date (inclusively), in ISO 8601 format.

getGoogleOrderIds

public List<String> getGoogleOrderIds()

Obtains order returns with the specified order ids. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.

setGoogleOrderIds

public ShoppingContent.Orderreturns.List setGoogleOrderIds(List<String> googleOrderIds)

Obtains order returns with the specified order ids. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.

getMaxResults

public Long getMaxResults()

The maximum number of order returns to return in the response, used for paging. The default value is 25 returns per page, and the maximum allowed value is 250 returns per page.

setMaxResults

public ShoppingContent.Orderreturns.List setMaxResults(Long maxResults)

The maximum number of order returns to return in the response, used for paging. The default value is 25 returns per page, and the maximum allowed value is 250 returns per page.

getOrderBy

public String getOrderBy()

Return the results in the specified order.

setOrderBy

public ShoppingContent.Orderreturns.List setOrderBy(String orderBy)

Return the results in the specified order.

getPageToken

public String getPageToken()

The token returned by the previous request.

setPageToken

public ShoppingContent.Orderreturns.List setPageToken(String pageToken)

The token returned by the previous request.

getShipmentStates

public List<String> getShipmentStates()

Obtains order returns that match any shipment state provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment states.

setShipmentStates

public ShoppingContent.Orderreturns.List setShipmentStates(List<String> shipmentStates)

Obtains order returns that match any shipment state provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment states.

getShipmentStatus

public List<String> getShipmentStatus()

Obtains order returns that match any shipment status provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment statuses.

setShipmentStatus

public ShoppingContent.Orderreturns.List setShipmentStatus(List<String> shipmentStatus)

Obtains order returns that match any shipment status provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment statuses.

getShipmentTrackingNumbers

public List<String> getShipmentTrackingNumbers()

Obtains order returns with the specified tracking numbers. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.

setShipmentTrackingNumbers

public ShoppingContent.Orderreturns.List setShipmentTrackingNumbers(List<String> shipmentTrackingNumbers)

Obtains order returns with the specified tracking numbers. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.

getShipmentTypes

public List<String> getShipmentTypes()

Obtains order returns that match any shipment type provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment types.

setShipmentTypes

public ShoppingContent.Orderreturns.List setShipmentTypes(List<String> shipmentTypes)

Obtains order returns that match any shipment type provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment types.

set

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

Overrides:

set in class ShoppingContentRequest<OrderreturnsListResponse>