ShoppingContent.Orders.CaptureOrder (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<CaptureOrderResponse>
        
        com.google.api.services.content.ShoppingContent.Orders.CaptureOrder

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

Enclosing class:: ShoppingContent.Orders

public class ShoppingContent.Orders.CaptureOrder
extends ShoppingContentRequest<CaptureOrderResponse>

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`	`CaptureOrder(Long merchantId, String orderId, CaptureOrderRequest content)` Capture funds from the customer for the current order total.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`getMerchantId()` Required.
`String`	`getOrderId()` Required.
`ShoppingContent.Orders.CaptureOrder`	`set(String parameterName, Object value)`
`ShoppingContent.Orders.CaptureOrder`	`set$Xgafv(String $Xgafv)` V1 error format.
`ShoppingContent.Orders.CaptureOrder`	`setAccessToken(String accessToken)` OAuth access token.
`ShoppingContent.Orders.CaptureOrder`	`setAlt(String alt)` Data format for response.
`ShoppingContent.Orders.CaptureOrder`	`setCallback(String callback)` JSONP
`ShoppingContent.Orders.CaptureOrder`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`ShoppingContent.Orders.CaptureOrder`	`setKey(String key)` API key.
`ShoppingContent.Orders.CaptureOrder`	`setMerchantId(Long merchantId)` Required.
`ShoppingContent.Orders.CaptureOrder`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`ShoppingContent.Orders.CaptureOrder`	`setOrderId(String orderId)` Required.
`ShoppingContent.Orders.CaptureOrder`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`ShoppingContent.Orders.CaptureOrder`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`ShoppingContent.Orders.CaptureOrder`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`ShoppingContent.Orders.CaptureOrder`	`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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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
  - CaptureOrder
```
protected CaptureOrder(Long merchantId,
                       String orderId,
                       CaptureOrderRequest content)
```
    Capture funds from the customer for the current order total. This method should be called after the merchant verifies that they are able and ready to start shipping the order. This method blocks until a response is received from the payment processsor. If this method succeeds, the merchant is guaranteed to receive funds for the order after shipment. If the request fails, it can be retried or the order may be cancelled. This method cannot be called after the entire order is already shipped. A rejected error code is returned when the payment service provider has declined the charge. This indicates a problem between the PSP and either the merchant's or customer's account. Sometimes this error will be resolved by the customer. We recommend retrying these errors once per day or cancelling the order with reason `failedToCaptureFunds` if the items cannot be held. Create a request for the method "orders.captureOrder". 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 - Required. The ID of the account that manages the order. This cannot be a multi-client account.
    
    orderId - Required. The ID of the Order.
    
    content - the CaptureOrderRequest
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public ShoppingContent.Orders.CaptureOrder set$Xgafv(String $Xgafv)
```
    Description copied from class: ShoppingContentRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ShoppingContentRequest<CaptureOrderResponse>
  - setAccessToken
```
public ShoppingContent.Orders.CaptureOrder setAccessToken(String accessToken)
```
    Description copied from class: ShoppingContentRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ShoppingContentRequest<CaptureOrderResponse>
  - setAlt
```
public ShoppingContent.Orders.CaptureOrder setAlt(String alt)
```
    Description copied from class: ShoppingContentRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ShoppingContentRequest<CaptureOrderResponse>
  - setCallback
```
public ShoppingContent.Orders.CaptureOrder setCallback(String callback)
```
    Description copied from class: ShoppingContentRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ShoppingContentRequest<CaptureOrderResponse>
  - setFields
```
public ShoppingContent.Orders.CaptureOrder setFields(String fields)
```
    Description copied from class: ShoppingContentRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ShoppingContentRequest<CaptureOrderResponse>
  - setKey
```
public ShoppingContent.Orders.CaptureOrder 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<CaptureOrderResponse>
  - setOauthToken
```
public ShoppingContent.Orders.CaptureOrder setOauthToken(String oauthToken)
```
    Description copied from class: ShoppingContentRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ShoppingContentRequest<CaptureOrderResponse>
  - setPrettyPrint
```
public ShoppingContent.Orders.CaptureOrder setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: ShoppingContentRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ShoppingContentRequest<CaptureOrderResponse>
  - setQuotaUser
```
public ShoppingContent.Orders.CaptureOrder 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<CaptureOrderResponse>
  - setUploadType
```
public ShoppingContent.Orders.CaptureOrder setUploadType(String uploadType)
```
    Description copied from class: ShoppingContentRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ShoppingContentRequest<CaptureOrderResponse>
  - setUploadProtocol
```
public ShoppingContent.Orders.CaptureOrder setUploadProtocol(String uploadProtocol)
```
    Description copied from class: ShoppingContentRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ShoppingContentRequest<CaptureOrderResponse>
  - getMerchantId
```
public Long getMerchantId()
```
    Required. The ID of the account that manages the order. This cannot be a multi-client account.
  - setMerchantId
```
public ShoppingContent.Orders.CaptureOrder setMerchantId(Long merchantId)
```
    Required. The ID of the account that manages the order. This cannot be a multi-client account.
  - getOrderId
```
public String getOrderId()
```
    Required. The ID of the Order.
  - setOrderId
```
public ShoppingContent.Orders.CaptureOrder setOrderId(String orderId)
```
    Required. The ID of the Order.
  - set
```
public ShoppingContent.Orders.CaptureOrder set(String parameterName,
                                               Object value)
```
    Overrides:
    
    set in class ShoppingContentRequest<CaptureOrderResponse>

Class ShoppingContent.Orders.CaptureOrder

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

CaptureOrder

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getMerchantId

setMerchantId

getOrderId

setOrderId

set