target.apidocs.com.google.api.services.content.model.RecommendationCallToAction.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-content Show documentation

There is a newer version: v2.1-rev20241217-2.0.0

Show newest version







RecommendationCallToAction (Content API for Shopping v2.1-rev20240609-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.content.model
Class RecommendationCallToAction



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.RecommendationCallToAction













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




public final class RecommendationCallToAction
extends com.google.api.client.json.GenericJson
Call to action (CTA) that explains how a merchant can implement this recommendation

  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


RecommendationCallToAction() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


RecommendationCallToAction
clone() 


String
getIntent()
Output only.



String
getLocalizedText()
Output only.



String
getUri()
Optional.



RecommendationCallToAction
set(String fieldName,
   Object value) 


RecommendationCallToAction
setIntent(String intent)
Output only.



RecommendationCallToAction
setLocalizedText(String localizedText)
Output only.



RecommendationCallToAction
setUri(String uri)
Optional.







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





RecommendationCallToAction
public RecommendationCallToAction()









Method Detail





getIntent
public String getIntent()
Output only. Intent of the action. This value describes the intent (for example,
 `OPEN_CREATE_EMAIL_CAMPAIGN_FLOW`) and can vary from recommendation to recommendation. This
 value can change over time for the same recommendation. Currently available intent values: -
 OPEN_CREATE_EMAIL_CAMPAIGN_FLOW: Opens a user journey where they can create a marketing email
 campaign. (No default URL) - OPEN_CREATE_COLLECTION_TAB: Opens a user journey where they can
 [create a collection](https://support.google.com/merchants/answer/9703228) for their Merchant
 account. (No default URL)

Returns:
value or null for none








setIntent
public RecommendationCallToAction setIntent(String intent)
Output only. Intent of the action. This value describes the intent (for example,
 `OPEN_CREATE_EMAIL_CAMPAIGN_FLOW`) and can vary from recommendation to recommendation. This
 value can change over time for the same recommendation. Currently available intent values: -
 OPEN_CREATE_EMAIL_CAMPAIGN_FLOW: Opens a user journey where they can create a marketing email
 campaign. (No default URL) - OPEN_CREATE_COLLECTION_TAB: Opens a user journey where they can
 [create a collection](https://support.google.com/merchants/answer/9703228) for their Merchant
 account. (No default URL)

Parameters:
intent - intent or null for none








getLocalizedText
public String getLocalizedText()
Output only. Localized text of the CTA. Optional.

Returns:
value or null for none








setLocalizedText
public RecommendationCallToAction setLocalizedText(String localizedText)
Output only. Localized text of the CTA. Optional.

Parameters:
localizedText - localizedText or null for none








getUri
public String getUri()
Optional. URL of the CTA. This field will only be set for some recommendations where there is a
 suggested landing URL. Otherwise it will be set to an empty string. We recommend developers to
 use their own custom landing page according to the description of the intent field above when
 this uri field is empty.

Returns:
value or null for none








setUri
public RecommendationCallToAction setUri(String uri)
Optional. URL of the CTA. This field will only be set for some recommendations where there is a
 suggested landing URL. Otherwise it will be set to an empty string. We recommend developers to
 use their own custom landing page according to the description of the intent field above when
 this uri field is empty.

Parameters:
uri - uri or null for none








set
public RecommendationCallToAction set(String fieldName,
                                      Object value)

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








clone
public RecommendationCallToAction clone()

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














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`RecommendationCallToAction`	`clone()`
`String`	`getIntent()` Output only.
`String`	`getLocalizedText()` Output only.
`String`	`getUri()` Optional.
`RecommendationCallToAction`	`set(String fieldName, Object value)`
`RecommendationCallToAction`	`setIntent(String intent)` Output only.
`RecommendationCallToAction`	`setLocalizedText(String localizedText)` Output only.
`RecommendationCallToAction`	`setUri(String uri)` Optional.