Reference documentation and code samples for the Google Shopping Merchant Issue Resolution V1 Client class BuiltInUserInputAction.
Action that is implemented and performed in (your) third-party application.
The application needs to show an additional content and input form to the business. 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.
Generated from protobuf message google.shopping.merchant.issueresolution.v1.BuiltInUserInputAction
Namespace
Google \ Shopping \ Merchant \ IssueResolution \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ action_context |
string
Contains the action's context that must be included as part of the TriggerActionPayload.action_context in TriggerActionRequest.payload to call the |
↳ flows |
array<ActionFlow>
Actions may provide multiple different flows. Business 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. |
getActionContext
Contains the action's context that must be included as part of the
TriggerActionPayload.action_context
in
TriggerActionRequest.payload
to call the triggeraction method. The content should be treated as opaque
and must not be modified.
| Returns | |
|---|---|
| Type | Description |
string |
|
setActionContext
Contains the action's context that must be included as part of the
TriggerActionPayload.action_context
in
TriggerActionRequest.payload
to call the triggeraction method. The content should be treated as opaque
and must not be modified.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFlows
Actions may provide multiple different flows. Business 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 | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setFlows
Actions may provide multiple different flows. Business 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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ActionFlow>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|