ShoppingContent.Orders.List (Content API for Shopping v2.1-rev20240325-2.0.0)

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<OrdersListResponse>
        
        com.google.api.services.content.ShoppingContent.Orders.List

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: ShoppingContent.Orders

public class ShoppingContent.Orders.List
extends ShoppingContentRequest<OrdersListResponse>

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 the orders in your Merchant Center account.

Constructors
Modifier	Constructor and Description
`protected`	`List(BigInteger merchantId)` Lists the orders in your Merchant Center account.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`Boolean`	`getAcknowledged()` Obtains orders that match the acknowledgement status.
`Long`	`getMaxResults()` The maximum number of orders to return in the response, used for paging.
`BigInteger`	`getMerchantId()` The ID of the account that manages the order.
`String`	`getOrderBy()` Order results by placement date in descending or ascending order.
`String`	`getPageToken()` The token returned by the previous request.
`String`	`getPlacedDateEnd()` Obtains orders placed before this date (exclusively), in ISO 8601 format.
`String`	`getPlacedDateStart()` Obtains orders placed after this date (inclusively), in ISO 8601 format.
`List<String>`	`getStatuses()` Obtains orders that match any of the specified statuses.
`ShoppingContent.Orders.List`	`set(String parameterName, Object value)`
`ShoppingContent.Orders.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`ShoppingContent.Orders.List`	`setAccessToken(String accessToken)` OAuth access token.
`ShoppingContent.Orders.List`	`setAcknowledged(Boolean acknowledged)` Obtains orders that match the acknowledgement status.
`ShoppingContent.Orders.List`	`setAlt(String alt)` Data format for response.
`ShoppingContent.Orders.List`	`setCallback(String callback)` JSONP
`ShoppingContent.Orders.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`ShoppingContent.Orders.List`	`setKey(String key)` API key.
`ShoppingContent.Orders.List`	`setMaxResults(Long maxResults)` The maximum number of orders to return in the response, used for paging.
`ShoppingContent.Orders.List`	`setMerchantId(BigInteger merchantId)` The ID of the account that manages the order.
`ShoppingContent.Orders.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`ShoppingContent.Orders.List`	`setOrderBy(String orderBy)` Order results by placement date in descending or ascending order.
`ShoppingContent.Orders.List`	`setPageToken(String pageToken)` The token returned by the previous request.
`ShoppingContent.Orders.List`	`setPlacedDateEnd(String placedDateEnd)` Obtains orders placed before this date (exclusively), in ISO 8601 format.
`ShoppingContent.Orders.List`	`setPlacedDateStart(String placedDateStart)` Obtains orders placed after this date (inclusively), in ISO 8601 format.
`ShoppingContent.Orders.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`ShoppingContent.Orders.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`ShoppingContent.Orders.List`	`setStatuses(List<String> statuses)` Obtains orders that match any of the specified statuses.
`ShoppingContent.Orders.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`ShoppingContent.Orders.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 the orders in your Merchant Center account. Create a request for the method "orders.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<OrdersListResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<OrdersListResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public ShoppingContent.Orders.List set$Xgafv(String $Xgafv)
```
    Description copied from class: ShoppingContentRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ShoppingContentRequest<OrdersListResponse>
  - setAccessToken
```
public ShoppingContent.Orders.List setAccessToken(String accessToken)
```
    Description copied from class: ShoppingContentRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ShoppingContentRequest<OrdersListResponse>
  - setAlt
```
public ShoppingContent.Orders.List setAlt(String alt)
```
    Description copied from class: ShoppingContentRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ShoppingContentRequest<OrdersListResponse>
  - setCallback
```
public ShoppingContent.Orders.List setCallback(String callback)
```
    Description copied from class: ShoppingContentRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ShoppingContentRequest<OrdersListResponse>
  - setFields
```
public ShoppingContent.Orders.List setFields(String fields)
```
    Description copied from class: ShoppingContentRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ShoppingContentRequest<OrdersListResponse>
  - setKey
```
public ShoppingContent.Orders.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<OrdersListResponse>
  - setOauthToken
```
public ShoppingContent.Orders.List setOauthToken(String oauthToken)
```
    Description copied from class: ShoppingContentRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ShoppingContentRequest<OrdersListResponse>
  - setPrettyPrint
```
public ShoppingContent.Orders.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: ShoppingContentRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ShoppingContentRequest<OrdersListResponse>
  - setQuotaUser
```
public ShoppingContent.Orders.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<OrdersListResponse>
  - setUploadType
```
public ShoppingContent.Orders.List setUploadType(String uploadType)
```
    Description copied from class: ShoppingContentRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ShoppingContentRequest<OrdersListResponse>
  - setUploadProtocol
```
public ShoppingContent.Orders.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: ShoppingContentRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ShoppingContentRequest<OrdersListResponse>
  - getMerchantId
```
public BigInteger getMerchantId()
```
    The ID of the account that manages the order. This cannot be a multi-client account.
  - setMerchantId
```
public ShoppingContent.Orders.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 orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un- acknowledged orders are returned.
  - setAcknowledged
```
public ShoppingContent.Orders.List setAcknowledged(Boolean acknowledged)
```
    Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged orders are returned.
  - getMaxResults
```
public Long getMaxResults()
```
    The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.
  - setMaxResults
```
public ShoppingContent.Orders.List setMaxResults(Long maxResults)
```
    The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.
  - getOrderBy
```
public String getOrderBy()
```
    Order results by placement date in descending or ascending order. Acceptable values are: - placedDateAsc - placedDateDesc
  - setOrderBy
```
public ShoppingContent.Orders.List setOrderBy(String orderBy)
```
    Order results by placement date in descending or ascending order. Acceptable values are: - placedDateAsc - placedDateDesc
  - getPageToken
```
public String getPageToken()
```
    The token returned by the previous request.
  - setPageToken
```
public ShoppingContent.Orders.List setPageToken(String pageToken)
```
    The token returned by the previous request.
  - getPlacedDateEnd
```
public String getPlacedDateEnd()
```
    Obtains orders placed before this date (exclusively), in ISO 8601 format.
  - setPlacedDateEnd
```
public ShoppingContent.Orders.List setPlacedDateEnd(String placedDateEnd)
```
    Obtains orders placed before this date (exclusively), in ISO 8601 format.
  - getPlacedDateStart
```
public String getPlacedDateStart()
```
    Obtains orders placed after this date (inclusively), in ISO 8601 format.
  - setPlacedDateStart
```
public ShoppingContent.Orders.List setPlacedDateStart(String placedDateStart)
```
    Obtains orders placed after this date (inclusively), in ISO 8601 format.
  - getStatuses
```
public List<String> getStatuses()
```
    Obtains orders that match any of the specified statuses. Note that `active` is a shortcut for `pendingShipment` and `partiallyShipped`, and `completed` is a shortcut for `shipped`, `partiallyDelivered`, `delivered`, `partiallyReturned`, `returned`, and `canceled`.
  - setStatuses
```
public ShoppingContent.Orders.List setStatuses(List<String> statuses)
```
    Obtains orders that match any of the specified statuses. Note that `active` is a shortcut for `pendingShipment` and `partiallyShipped`, and `completed` is a shortcut for `shipped`, `partiallyDelivered`, `delivered`, `partiallyReturned`, `returned`, and `canceled`.
  - set
```
public ShoppingContent.Orders.List set(String parameterName,
                                       Object value)
```
    Overrides:
    
    set in class ShoppingContentRequest<OrdersListResponse>

Class ShoppingContent.Orders.List

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

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

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getMerchantId

setMerchantId

getAcknowledged

setAcknowledged

getMaxResults

setMaxResults

getOrderBy

setOrderBy

getPageToken

setPageToken

getPlacedDateEnd

setPlacedDateEnd

getPlacedDateStart

setPlacedDateStart

getStatuses

setStatuses

set