ShoppingContent.Merchantsupport.Triggeraction (Content API for Shopping v2.1-rev20241023-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<TriggerActionResponse>
        
        com.google.api.services.content.ShoppingContent.Merchantsupport.Triggeraction

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

Enclosing class:: ShoppingContent.Merchantsupport

public class ShoppingContent.Merchantsupport.Triggeraction
extends ShoppingContentRequest<TriggerActionResponse>

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
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected Triggeraction(Long merchantId, TriggerActionPayload content)
Start an action.

Constructors
Modifier	Constructor and Description
`protected`	`Triggeraction(Long merchantId, TriggerActionPayload content)` Start an action.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getLanguageCode()` Optional.
`Long`	`getMerchantId()` Required.
`ShoppingContent.Merchantsupport.Triggeraction`	`set(String parameterName, Object value)`
`ShoppingContent.Merchantsupport.Triggeraction`	`set$Xgafv(String $Xgafv)` V1 error format.
`ShoppingContent.Merchantsupport.Triggeraction`	`setAccessToken(String accessToken)` OAuth access token.
`ShoppingContent.Merchantsupport.Triggeraction`	`setAlt(String alt)` Data format for response.
`ShoppingContent.Merchantsupport.Triggeraction`	`setCallback(String callback)` JSONP
`ShoppingContent.Merchantsupport.Triggeraction`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`ShoppingContent.Merchantsupport.Triggeraction`	`setKey(String key)` API key.
`ShoppingContent.Merchantsupport.Triggeraction`	`setLanguageCode(String languageCode)` Optional.
`ShoppingContent.Merchantsupport.Triggeraction`	`setMerchantId(Long merchantId)` Required.
`ShoppingContent.Merchantsupport.Triggeraction`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`ShoppingContent.Merchantsupport.Triggeraction`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`ShoppingContent.Merchantsupport.Triggeraction`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`ShoppingContent.Merchantsupport.Triggeraction`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`ShoppingContent.Merchantsupport.Triggeraction`	`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
  - Triggeraction
```
protected Triggeraction(Long merchantId,
                        TriggerActionPayload content)
```
    Start an action. The action can be requested by merchants in third-party application. Before merchants can request the action, the third-party application needs to show them action specific content and display a user input form. The action can be successfully started only once all `required` inputs are provided. If any `required` input is missing, or invalid value was provided, the service will return 400 error. Validation errors will contain Ids for all problematic field together with translated, human readable error messages that can be shown to the user. Create a request for the method "merchantsupport.triggeraction". 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.
    Triggeraction#initialize(com.google.api.client.googleapis.services.AbstractGoogleClientR equest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    merchantId - Required. The ID of the merchant's account.
    
    content - the TriggerActionPayload
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public ShoppingContent.Merchantsupport.Triggeraction set$Xgafv(String $Xgafv)
```
    Description copied from class: ShoppingContentRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ShoppingContentRequest<TriggerActionResponse>
  - setAccessToken
```
public ShoppingContent.Merchantsupport.Triggeraction setAccessToken(String accessToken)
```
    Description copied from class: ShoppingContentRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ShoppingContentRequest<TriggerActionResponse>
  - setAlt
```
public ShoppingContent.Merchantsupport.Triggeraction setAlt(String alt)
```
    Description copied from class: ShoppingContentRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ShoppingContentRequest<TriggerActionResponse>
  - setCallback
```
public ShoppingContent.Merchantsupport.Triggeraction setCallback(String callback)
```
    Description copied from class: ShoppingContentRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ShoppingContentRequest<TriggerActionResponse>
  - setFields
```
public ShoppingContent.Merchantsupport.Triggeraction setFields(String fields)
```
    Description copied from class: ShoppingContentRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ShoppingContentRequest<TriggerActionResponse>
  - setKey
```
public ShoppingContent.Merchantsupport.Triggeraction 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<TriggerActionResponse>
  - setOauthToken
```
public ShoppingContent.Merchantsupport.Triggeraction setOauthToken(String oauthToken)
```
    Description copied from class: ShoppingContentRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ShoppingContentRequest<TriggerActionResponse>
  - setPrettyPrint
```
public ShoppingContent.Merchantsupport.Triggeraction setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: ShoppingContentRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ShoppingContentRequest<TriggerActionResponse>
  - setQuotaUser
```
public ShoppingContent.Merchantsupport.Triggeraction 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<TriggerActionResponse>
  - setUploadType
```
public ShoppingContent.Merchantsupport.Triggeraction setUploadType(String uploadType)
```
    Description copied from class: ShoppingContentRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ShoppingContentRequest<TriggerActionResponse>
  - setUploadProtocol
```
public ShoppingContent.Merchantsupport.Triggeraction setUploadProtocol(String uploadProtocol)
```
    Description copied from class: ShoppingContentRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ShoppingContentRequest<TriggerActionResponse>
  - getMerchantId
```
public Long getMerchantId()
```
    Required. The ID of the merchant's account.
  - setMerchantId
```
public ShoppingContent.Merchantsupport.Triggeraction setMerchantId(Long merchantId)
```
    Required. The ID of the merchant's account.
  - getLanguageCode
```
public String getLanguageCode()
```
    Optional. Language code [IETF BCP 47 syntax](https://tools.ietf.org/html/bcp47) used to localize the response. If not set, the result will be in default language `en-US`.
  - setLanguageCode
```
public ShoppingContent.Merchantsupport.Triggeraction setLanguageCode(String languageCode)
```
    Optional. Language code [IETF BCP 47 syntax](https://tools.ietf.org/html/bcp47) used to localize the response. If not set, the result will be in default language `en-US`.
  - set
```
public ShoppingContent.Merchantsupport.Triggeraction set(String parameterName,
                                                         Object value)
```
    Overrides:
    
    set in class ShoppingContentRequest<TriggerActionResponse>

Class ShoppingContent.Merchantsupport.Triggeraction

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

Triggeraction

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getMerchantId

setMerchantId

getLanguageCode

setLanguageCode

set