Google Shopping Merchant Issue Resolution V1 Client - Class Action (1.0.0)

Reference documentation and code samples for the Google Shopping Merchant Issue Resolution V1 Client class Action.

An actionable step that can be executed to solve the issue.

Generated from protobuf message google.shopping.merchant.issueresolution.v1.Action

Namespace

Google \ Shopping \ Merchant \ IssueResolution \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ builtin_simple_action BuiltInSimpleAction

Action implemented and performed in (your) third-party application. The application should point the business to the place, where they can access the corresponding functionality or provide instructions, if the specific functionality is not available.
↳ external_action ExternalAction

Action that is implemented and performed outside of (your) third-party application. The application needs to redirect the business to the external location where they can perform the action.
↳ builtin_user_input_action BuiltInUserInputAction

Action implemented and performed in (your) third-party application. The application needs to show an additional content and input form to the business as specified for given action. They can trigger the action only when they provided all required inputs.
↳ button_label string

Label of the action button.
↳ is_available bool

Controlling whether the button is active or disabled. The value is 'false' when the action was already requested or is not available. If the action is not available then a reason will be present. If (your) third-party application shows a disabled button for action that is not available, then it should also show reasons.
↳ reasons array<Action\Reason>

List of reasons why the action is not available. The list of reasons is empty if the action is available. If there is only one reason, it can be displayed next to the disabled button. If there are more reasons, all of them should be displayed, for example in a pop-up dialog.

getBuiltinSimpleAction

Action implemented and performed in (your) third-party application. The application should point the business to the place, where they can access the corresponding functionality or provide instructions, if the specific functionality is not available.

Returns
Type Description
BuiltInSimpleAction|null

hasBuiltinSimpleAction

setBuiltinSimpleAction

Action implemented and performed in (your) third-party application. The application should point the business to the place, where they can access the corresponding functionality or provide instructions, if the specific functionality is not available.

Parameter
Name Description
var BuiltInSimpleAction
Returns
Type Description
$this

getExternalAction

Action that is implemented and performed outside of (your) third-party application. The application needs to redirect the business to the external location where they can perform the action.

Returns
Type Description
ExternalAction|null

hasExternalAction

setExternalAction

Action that is implemented and performed outside of (your) third-party application. The application needs to redirect the business to the external location where they can perform the action.

Parameter
Name Description
var ExternalAction
Returns
Type Description
$this

getBuiltinUserInputAction

Action implemented and performed in (your) third-party application.

The application needs to show an additional content and input form to the business as specified for given action. They can trigger the action only when they provided all required inputs.

Returns
Type Description
BuiltInUserInputAction|null

hasBuiltinUserInputAction

setBuiltinUserInputAction

Action implemented and performed in (your) third-party application.

The application needs to show an additional content and input form to the business as specified for given action. They can trigger the action only when they provided all required inputs.

Parameter
Name Description
var BuiltInUserInputAction
Returns
Type Description
$this

getButtonLabel

Label of the action button.

Returns
Type Description
string

setButtonLabel

Label of the action button.

Parameter
Name Description
var string
Returns
Type Description
$this

getIsAvailable

Controlling whether the button is active or disabled. The value is 'false' when the action was already requested or is not available. If the action is not available then a reason will be present. If (your) third-party application shows a disabled button for action that is not available, then it should also show reasons.

Returns
Type Description
bool

setIsAvailable

Controlling whether the button is active or disabled. The value is 'false' when the action was already requested or is not available. If the action is not available then a reason will be present. If (your) third-party application shows a disabled button for action that is not available, then it should also show reasons.

Parameter
Name Description
var bool
Returns
Type Description
$this

getReasons

List of reasons why the action is not available. The list of reasons is empty if the action is available. If there is only one reason, it can be displayed next to the disabled button. If there are more reasons, all of them should be displayed, for example in a pop-up dialog.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setReasons

List of reasons why the action is not available. The list of reasons is empty if the action is available. If there is only one reason, it can be displayed next to the disabled button. If there are more reasons, all of them should be displayed, for example in a pop-up dialog.

Parameter
Name Description
var array<Action\Reason>
Returns
Type Description
$this

getAction

Returns
Type Description
string