com.google.api.services.content

Class ShoppingContent.Recommendations.Generate

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

com.google.api.services.content.ShoppingContent.Recommendations.Generate

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

ShoppingContent.Recommendations

public class ShoppingContent.Recommendations.Generate
extends ShoppingContentRequest<GenerateRecommendationsResponse>

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	Generate(Long merchantId) Generates recommendations for a merchant.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
List<String>	getAllowedTag() Optional.
String	getLanguageCode() Optional.
Long	getMerchantId() Required.
ShoppingContent.Recommendations.Generate	set(String parameterName, Object value)
ShoppingContent.Recommendations.Generate	set$Xgafv(String $Xgafv) V1 error format.
ShoppingContent.Recommendations.Generate	setAccessToken(String accessToken) OAuth access token.
ShoppingContent.Recommendations.Generate	setAllowedTag(List<String> allowedTag) Optional.
ShoppingContent.Recommendations.Generate	setAlt(String alt) Data format for response.
ShoppingContent.Recommendations.Generate	setCallback(String callback) JSONP
ShoppingContent.Recommendations.Generate	setFields(String fields) Selector specifying which fields to include in a partial response.
ShoppingContent.Recommendations.Generate	setKey(String key) API key.
ShoppingContent.Recommendations.Generate	setLanguageCode(String languageCode) Optional.
ShoppingContent.Recommendations.Generate	setMerchantId(Long merchantId) Required.
ShoppingContent.Recommendations.Generate	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
ShoppingContent.Recommendations.Generate	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
ShoppingContent.Recommendations.Generate	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
ShoppingContent.Recommendations.Generate	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
ShoppingContent.Recommendations.Generate	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

Generate

protected Generate(Long merchantId)

Generates recommendations for a merchant. Create a request for the method "recommendations.generate". 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 to fetch recommendations for.

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public ShoppingContent.Recommendations.Generate set$Xgafv(String $Xgafv)

Description copied from class: ShoppingContentRequest

V1 error format.

Overrides:

set$Xgafv in class ShoppingContentRequest<GenerateRecommendationsResponse>

setAccessToken

public ShoppingContent.Recommendations.Generate setAccessToken(String accessToken)

Description copied from class: ShoppingContentRequest

OAuth access token.

Overrides:

setAccessToken in class ShoppingContentRequest<GenerateRecommendationsResponse>

setAlt

public ShoppingContent.Recommendations.Generate setAlt(String alt)

Description copied from class: ShoppingContentRequest

Data format for response.

Overrides:

setAlt in class ShoppingContentRequest<GenerateRecommendationsResponse>

setCallback

public ShoppingContent.Recommendations.Generate setCallback(String callback)

Description copied from class: ShoppingContentRequest

JSONP

Overrides:

setCallback in class ShoppingContentRequest<GenerateRecommendationsResponse>

setFields

public ShoppingContent.Recommendations.Generate setFields(String fields)

Description copied from class: ShoppingContentRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ShoppingContentRequest<GenerateRecommendationsResponse>

setKey

public ShoppingContent.Recommendations.Generate 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<GenerateRecommendationsResponse>

setOauthToken

public ShoppingContent.Recommendations.Generate setOauthToken(String oauthToken)

Description copied from class: ShoppingContentRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ShoppingContentRequest<GenerateRecommendationsResponse>

setPrettyPrint

public ShoppingContent.Recommendations.Generate setPrettyPrint(Boolean prettyPrint)

Description copied from class: ShoppingContentRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ShoppingContentRequest<GenerateRecommendationsResponse>

setQuotaUser

public ShoppingContent.Recommendations.Generate 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<GenerateRecommendationsResponse>

setUploadType

public ShoppingContent.Recommendations.Generate setUploadType(String uploadType)

Description copied from class: ShoppingContentRequest

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

Overrides:

setUploadType in class ShoppingContentRequest<GenerateRecommendationsResponse>

setUploadProtocol

public ShoppingContent.Recommendations.Generate setUploadProtocol(String uploadProtocol)

Description copied from class: ShoppingContentRequest

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

Overrides:

setUploadProtocol in class ShoppingContentRequest<GenerateRecommendationsResponse>

getMerchantId

public Long getMerchantId()

Required. The ID of the account to fetch recommendations for.

setMerchantId

public ShoppingContent.Recommendations.Generate setMerchantId(Long merchantId)

Required. The ID of the account to fetch recommendations for.

getAllowedTag

public List<String> getAllowedTag()

Optional. List of allowed tags. Tags are a set of predefined strings that describe the category that individual recommendation types belong to. User can specify zero or more tags in this field to indicate what categories of recommendations they want to receive. Current list of supported tags: - TREND

setAllowedTag

public ShoppingContent.Recommendations.Generate setAllowedTag(List<String> allowedTag)

Optional. List of allowed tags. Tags are a set of predefined strings that describe the category that individual recommendation types belong to. User can specify zero or more tags in this field to indicate what categories of recommendations they want to receive. Current list of supported tags: - TREND

getLanguageCode

public String getLanguageCode()

Optional. Language code of the client. If not set, the result will be in default language (English). This language code affects all fields prefixed with "localized". This should be set to ISO 639-1 country code. List of currently verified supported language code: en, fr, cs, da, de, es, it, nl, no, pl, pt, pt, fi, sv, vi, tr, th, ko, zh-CN, zh-TW, ja, id, hi

setLanguageCode

public ShoppingContent.Recommendations.Generate setLanguageCode(String languageCode)

Optional. Language code of the client. If not set, the result will be in default language (English). This language code affects all fields prefixed with "localized". This should be set to ISO 639-1 country code. List of currently verified supported language code: en, fr, cs, da, de, es, it, nl, no, pl, pt, pt, fi, sv, vi, tr, th, ko, zh-CN, zh-TW, ja, id, hi

set

public ShoppingContent.Recommendations.Generate set(String parameterName,
                                                    Object value)

Overrides:

set in class ShoppingContentRequest<GenerateRecommendationsResponse>