ShoppingContent.Orderreports.Listdisbursements (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<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)
Retrieves a report for disbursements from your Merchant Center account.

Constructors
Modifier	Constructor and Description
`protected`	`Listdisbursements(BigInteger merchantId)` Retrieves a report for disbursements from 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()`
`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`	`set$Xgafv(String $Xgafv)` V1 error format.
`ShoppingContent.Orderreports.Listdisbursements`	`setAccessToken(String accessToken)` OAuth access token.
`ShoppingContent.Orderreports.Listdisbursements`	`setAlt(String alt)` Data format for response.
`ShoppingContent.Orderreports.Listdisbursements`	`setCallback(String callback)` JSONP
`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)` Available to use for quota purposes for server-side applications.
`ShoppingContent.Orderreports.Listdisbursements`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`ShoppingContent.Orderreports.Listdisbursements`	`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
  - Listdisbursements
```
protected Listdisbursements(BigInteger merchantId)
```
    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.
    
    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
  - set$Xgafv
```
public ShoppingContent.Orderreports.Listdisbursements set$Xgafv(String $Xgafv)
```
    Description copied from class: ShoppingContentRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ShoppingContentRequest<OrderreportsListDisbursementsResponse>
  - setAccessToken
```
public ShoppingContent.Orderreports.Listdisbursements setAccessToken(String accessToken)
```
    Description copied from class: ShoppingContentRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ShoppingContentRequest<OrderreportsListDisbursementsResponse>
  - setAlt
```
public ShoppingContent.Orderreports.Listdisbursements setAlt(String alt)
```
    Description copied from class: ShoppingContentRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ShoppingContentRequest<OrderreportsListDisbursementsResponse>
  - setCallback
```
public ShoppingContent.Orderreports.Listdisbursements setCallback(String callback)
```
    Description copied from class: ShoppingContentRequest
    
    JSONP
    
    Overrides:
    
    setCallback 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
    
    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<OrderreportsListDisbursementsResponse>
  - setUploadType
```
public ShoppingContent.Orderreports.Listdisbursements setUploadType(String uploadType)
```
    Description copied from class: ShoppingContentRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ShoppingContentRequest<OrderreportsListDisbursementsResponse>
  - setUploadProtocol
```
public ShoppingContent.Orderreports.Listdisbursements setUploadProtocol(String uploadProtocol)
```
    Description copied from class: ShoppingContentRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol 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.
  - 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.
  - 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.
  - 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>

Class ShoppingContent.Orderreports.Listdisbursements

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

Listdisbursements

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getMerchantId

setMerchantId

getDisbursementEndDate

setDisbursementEndDate

getDisbursementStartDate

setDisbursementStartDate

getMaxResults

setMaxResults

getPageToken

setPageToken

set