Reference documentation and code samples for the Google Shopping Merchant Issue Resolution V1 Client class Reason.
A single reason why the action is not available.
Generated from protobuf message google.shopping.merchant.issueresolution.v1.Action.Reason
Namespace
Google \ Shopping \ Merchant \ IssueResolution \ V1 \ ActionMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ message |
string
Messages summarizing the reason, why the action is not available. For example: "Review requested on Jan 03. Review requests can take a few days to complete." |
↳ detail |
string
Detailed explanation of the reason. Should be displayed as a hint if present. |
↳ action |
Action
Optional. An action that needs to be performed to solve the problem represented by this reason. This action will always be available. Should be rendered as a link or button next to the summarizing message. For example, the review may be available only once the business configure all required attributes. In such a situation this action can be a link to the form, where they can fill the missing attribute to unblock the main action. |
getMessage
Messages summarizing the reason, why the action is not available.
For example: "Review requested on Jan 03. Review requests can take a few days to complete."
| Returns | |
|---|---|
| Type | Description |
string |
|
setMessage
Messages summarizing the reason, why the action is not available.
For example: "Review requested on Jan 03. Review requests can take a few days to complete."
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDetail
Detailed explanation of the reason. Should be displayed as a hint if present.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDetail
clearDetail
setDetail
Detailed explanation of the reason. Should be displayed as a hint if present.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAction
Optional. An action that needs to be performed to solve the problem represented by this reason. This action will always be available. Should be rendered as a link or button next to the summarizing message.
For example, the review may be available only once the business configure all required attributes. In such a situation this action can be a link to the form, where they can fill the missing attribute to unblock the main action.
| Returns | |
|---|---|
| Type | Description |
Action|null |
|
hasAction
clearAction
setAction
Optional. An action that needs to be performed to solve the problem represented by this reason. This action will always be available. Should be rendered as a link or button next to the summarizing message.
For example, the review may be available only once the business configure all required attributes. In such a situation this action can be a link to the form, where they can fill the missing attribute to unblock the main action.
| Parameter | |
|---|---|
| Name | Description |
var |
Action
|
| Returns | |
|---|---|
| Type | Description |
$this |
|