Reference documentation and code samples for the Google Shopping Merchant Issue Resolution V1 Client class ActionFlow.
Flow that can be selected for an action. When a business selects a flow, application should open a dialog with more information and input form.
Generated from protobuf message google.shopping.merchant.issueresolution.v1.ActionFlow
Namespace
Google \ Shopping \ Merchant \ IssueResolution \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ id |
string
Not for display but need to be sent back for the selected action flow. |
↳ label |
string
Text value describing the intent for the action flow. It can be used as an input label if business needs to pick one of multiple flows. For example: "I disagree with the issue" |
↳ inputs |
array<InputField>
A list of input fields. |
↳ dialog_title |
string
Title of the request dialog. For example: "Before you request a review" |
↳ dialog_message |
TextWithTooltip
Message displayed in the request dialog. For example: "Make sure you've fixed all your country-specific issues. If not, you may have to wait 7 days to request another review". There may be an more information to be shown in a tooltip. |
↳ dialog_callout |
Callout
Important message to be highlighted in the request dialog. For example: "You can only request a review for disagreeing with this issue once. If it's not approved, you'll need to fix the issue and wait a few days before you can request another review." |
↳ dialog_button_label |
string
Label for the button to trigger the action from the action dialog. For example: "Request review" |
getId
Not for display but need to be sent back for the selected action flow.
| Returns | |
|---|---|
| Type | Description |
string |
|
setId
Not for display but need to be sent back for the selected action flow.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabel
Text value describing the intent for the action flow. It can be used as an input label if business needs to pick one of multiple flows. For example: "I disagree with the issue"
| Returns | |
|---|---|
| Type | Description |
string |
|
setLabel
Text value describing the intent for the action flow. It can be used as an input label if business needs to pick one of multiple flows. For example: "I disagree with the issue"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInputs
A list of input fields.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setInputs
A list of input fields.
| Parameter | |
|---|---|
| Name | Description |
var |
array<InputField>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDialogTitle
Title of the request dialog. For example: "Before you request a review"
| Returns | |
|---|---|
| Type | Description |
string |
|
setDialogTitle
Title of the request dialog. For example: "Before you request a review"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDialogMessage
Message displayed in the request dialog. For example: "Make sure you've fixed all your country-specific issues. If not, you may have to wait 7 days to request another review". There may be an more information to be shown in a tooltip.
| Returns | |
|---|---|
| Type | Description |
TextWithTooltip|null |
|
hasDialogMessage
clearDialogMessage
setDialogMessage
Message displayed in the request dialog. For example: "Make sure you've fixed all your country-specific issues. If not, you may have to wait 7 days to request another review". There may be an more information to be shown in a tooltip.
| Parameter | |
|---|---|
| Name | Description |
var |
TextWithTooltip
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDialogCallout
Important message to be highlighted in the request dialog. For example: "You can only request a review for disagreeing with this issue once. If it's not approved, you'll need to fix the issue and wait a few days before you can request another review."
| Returns | |
|---|---|
| Type | Description |
Callout|null |
|
hasDialogCallout
clearDialogCallout
setDialogCallout
Important message to be highlighted in the request dialog. For example: "You can only request a review for disagreeing with this issue once. If it's not approved, you'll need to fix the issue and wait a few days before you can request another review."
| Parameter | |
|---|---|
| Name | Description |
var |
Callout
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDialogButtonLabel
Label for the button to trigger the action from the action dialog. For example: "Request review"
| Returns | |
|---|---|
| Type | Description |
string |
|
setDialogButtonLabel
Label for the button to trigger the action from the action dialog. For example: "Request review"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|