target.apidocs.com.google.api.services.content.model.BuiltInUserInputAction.html Maven / Gradle / Ivy
BuiltInUserInputAction (Content API for Shopping v2.1-rev20240609-2.0.0)
com.google.api.services.content.model
Class BuiltInUserInputAction
- 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.BuiltInUserInputAction
-
public final class BuiltInUserInputAction
extends com.google.api.client.json.GenericJson
Action that is implemented and performed in (your) third-party application. The application needs
to show an additional content and input form to the merchant. They can start the action only when
they provided all required inputs. The application will request processing of the action by
calling the [triggeraction method](https://developers.google.com/shopping-
content/reference/rest/v2.1/merchantsupport/triggeraction).
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>
-
Constructor Summary
Constructors
Constructor and Description
BuiltInUserInputAction()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
BuiltInUserInputAction
clone()
String
getActionContext()
Internal details.
List<ActionFlow>
getFlows()
Actions may provide multiple different flows.
BuiltInUserInputAction
set(String fieldName,
Object value)
BuiltInUserInputAction
setActionContext(String actionContext)
Internal details.
BuiltInUserInputAction
setFlows(List<ActionFlow> flows)
Actions may provide multiple different flows.
-
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
-
-
Method Detail
-
getActionContext
public String getActionContext()
Internal details. Not for display but need to be sent back when triggering the action.
- Returns:
- value or
null
for none
-
setActionContext
public BuiltInUserInputAction setActionContext(String actionContext)
Internal details. Not for display but need to be sent back when triggering the action.
- Parameters:
actionContext
- actionContext or null
for none
-
getFlows
public List<ActionFlow> getFlows()
Actions may provide multiple different flows. Merchant selects one that fits best to their
intent. Selecting the flow is the first step in user's interaction with the action. It affects
what input fields will be available and required and also how the request will be processed.
- Returns:
- value or
null
for none
-
setFlows
public BuiltInUserInputAction setFlows(List<ActionFlow> flows)
Actions may provide multiple different flows. Merchant selects one that fits best to their
intent. Selecting the flow is the first step in user's interaction with the action. It affects
what input fields will be available and required and also how the request will be processed.
- Parameters:
flows
- flows or null
for none
-
set
public BuiltInUserInputAction set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public BuiltInUserInputAction clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy