com.google.api.services.content.model

Class Recommendation

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.content.model.Recommendation

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Recommendation
extends com.google.api.client.json.GenericJson

Recommendations are suggested ways to improve your merchant account's performance. For example, to engage with a feature, or start using a new Google product.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Content API for Shopping. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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>

Constructor Summary

Constructors

Constructor and Description
Recommendation()

Method Summary

Modifier and Type	Method and Description
Recommendation	clone()
List<RecommendationCallToAction>	getAdditionalCallToAction() Output only.
List<RecommendationDescription>	getAdditionalDescriptions() Output only.
List<RecommendationCreative>	getCreative() Output only.
RecommendationCallToAction	getDefaultCallToAction() Optional.
String	getDefaultDescription() Optional.
Integer	getNumericalImpact() Optional.
Boolean	getPaid() Optional.
String	getRecommendationName() Optional.
String	getSubType() Optional.
String	getTitle() Optional.
String	getType() Output only.
Recommendation	set(String fieldName, Object value)
Recommendation	setAdditionalCallToAction(List<RecommendationCallToAction> additionalCallToAction) Output only.
Recommendation	setAdditionalDescriptions(List<RecommendationDescription> additionalDescriptions) Output only.
Recommendation	setCreative(List<RecommendationCreative> creative) Output only.
Recommendation	setDefaultCallToAction(RecommendationCallToAction defaultCallToAction) Optional.
Recommendation	setDefaultDescription(String defaultDescription) Optional.
Recommendation	setNumericalImpact(Integer numericalImpact) Optional.
Recommendation	setPaid(Boolean paid) Optional.
Recommendation	setRecommendationName(String recommendationName) Optional.
Recommendation	setSubType(String subType) Optional.
Recommendation	setTitle(String title) Optional.
Recommendation	setType(String type) Output only.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

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

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

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

Recommendation

public Recommendation()

Method Detail

getAdditionalCallToAction

public List<RecommendationCallToAction> getAdditionalCallToAction()

Output only. CTAs of this recommendation. Repeated.

Returns:

value or null for none

setAdditionalCallToAction

public Recommendation setAdditionalCallToAction(List<RecommendationCallToAction> additionalCallToAction)

Output only. CTAs of this recommendation. Repeated.

Parameters:

additionalCallToAction - additionalCallToAction or null for none

getAdditionalDescriptions

public List<RecommendationDescription> getAdditionalDescriptions()

Output only. List of additional localized descriptions for a recommendation. Localication uses the `languageCode` field in `GenerateRecommendations` requests. Not all description types are guaranteed to be present and we recommend to rely on default description.

Returns:

value or null for none

setAdditionalDescriptions

public Recommendation setAdditionalDescriptions(List<RecommendationDescription> additionalDescriptions)

Output only. List of additional localized descriptions for a recommendation. Localication uses the `languageCode` field in `GenerateRecommendations` requests. Not all description types are guaranteed to be present and we recommend to rely on default description.

Parameters:

additionalDescriptions - additionalDescriptions or null for none

getCreative

public List<RecommendationCreative> getCreative()

Output only. Any creatives attached to the recommendation. Repeated.

Returns:

value or null for none

setCreative

public Recommendation setCreative(List<RecommendationCreative> creative)

Output only. Any creatives attached to the recommendation. Repeated.

Parameters:

creative - creative or null for none

getDefaultCallToAction

public RecommendationCallToAction getDefaultCallToAction()

Optional. Default CTA of the recommendation.

Returns:

value or null for none

setDefaultCallToAction

public Recommendation setDefaultCallToAction(RecommendationCallToAction defaultCallToAction)

Optional. Default CTA of the recommendation.

Parameters:

defaultCallToAction - defaultCallToAction or null for none

getDefaultDescription

public String getDefaultDescription()

Optional. Localized recommendation description. The localization the `GenerateRecommendationsRequest.language_code` field in `GenerateRecommendationsRequest` requests.

Returns:

value or null for none

setDefaultDescription

public Recommendation setDefaultDescription(String defaultDescription)

Optional. Localized recommendation description. The localization the `GenerateRecommendationsRequest.language_code` field in `GenerateRecommendationsRequest` requests.

Parameters:

defaultDescription - defaultDescription or null for none

getNumericalImpact

public Integer getNumericalImpact()

Optional. A numerical score of the impact from the recommendation's description. For example, a recommendation might suggest an upward trend in sales for a certain product. Higher number means larger impact.

Returns:

value or null for none

setNumericalImpact

public Recommendation setNumericalImpact(Integer numericalImpact)

Optional. A numerical score of the impact from the recommendation's description. For example, a recommendation might suggest an upward trend in sales for a certain product. Higher number means larger impact.

Parameters:

numericalImpact - numericalImpact or null for none

getPaid

public Boolean getPaid()

Optional. Indicates whether a user needs to pay when they complete the user journey suggested by the recommendation.

Returns:

value or null for none

setPaid

public Recommendation setPaid(Boolean paid)

Optional. Indicates whether a user needs to pay when they complete the user journey suggested by the recommendation.

Parameters:

paid - paid or null for none

getRecommendationName

public String getRecommendationName()

Optional. Localized recommendation name. The localization uses the `GenerateRecommendationsRequest.language_code` field in `GenerateRecommendationsRequest` requests.

Returns:

value or null for none

setRecommendationName

public Recommendation setRecommendationName(String recommendationName)

Optional. Localized recommendation name. The localization uses the `GenerateRecommendationsRequest.language_code` field in `GenerateRecommendationsRequest` requests.

Parameters:

recommendationName - recommendationName or null for none

getSubType

public String getSubType()

Optional. Subtype of the recommendations. Only applicable when multiple recommendations can be generated per type, and is used as an identifier of recommendation under the same recommendation type.

Returns:

value or null for none

setSubType

public Recommendation setSubType(String subType)

Optional. Subtype of the recommendations. Only applicable when multiple recommendations can be generated per type, and is used as an identifier of recommendation under the same recommendation type.

Parameters:

subType - subType or null for none

getTitle

public String getTitle()

Optional. Localized Recommendation Title. Localization uses the `GenerateRecommendationsRequest.language_code` field in `GenerateRecommendationsRequest` requests.

Returns:

value or null for none

setTitle

public Recommendation setTitle(String title)

Optional. Localized Recommendation Title. Localization uses the `GenerateRecommendationsRequest.language_code` field in `GenerateRecommendationsRequest` requests.

Parameters:

title - title or null for none

getType

public String getType()

Output only. Type of the recommendation. List of currently available recommendation types: - OPPORTUNITY_CREATE_NEW_COLLECTION - OPPORTUNITY_CREATE_EMAIL_CAMPAIGN

Returns:

value or null for none

setType

public Recommendation setType(String type)

Output only. Type of the recommendation. List of currently available recommendation types: - OPPORTUNITY_CREATE_NEW_COLLECTION - OPPORTUNITY_CREATE_EMAIL_CAMPAIGN

Parameters:

type - type or null for none

set

public Recommendation set(String fieldName,
                          Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Recommendation clone()

Overrides:

clone in class com.google.api.client.json.GenericJson