Action

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

JSON representation 
{
  "buttonLabel": string,
  "isAvailable": boolean,
  "reasons": [
    {
      object (Reason)
    }
  ],

  // Union field action can be only one of the following:
  "builtinSimpleAction": {
    object (BuiltInSimpleAction)
  },
  "externalAction": {
    object (ExternalAction)
  }
  // End of list of possible types for union field action.
}
Fields
buttonLabel

string

Label of the action button.
isAvailable

boolean

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[]

object (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.

Union field action.

action can be only one of the following:
builtinSimpleAction

object (BuiltInSimpleAction)

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

object (ExternalAction)

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

BuiltInSimpleAction

Action that is implemented and performed in (your) third-party application. Represents various functionality that is expected to be available to merchant and will help them with resolving the issue. The application should point the merchant to the place, where they can access the corresponding functionality. If the functionality is not supported, it is recommended to explain the situation to merchant and provide them with instructions how to solve the issue.

JSON representation 
{
  "type": enum (BuiltInSimpleActionType),
  "attributeCode": string,
  "additionalContent": {
    object (AdditionalContent)
  }
}
Fields
type

enum (BuiltInSimpleActionType)

The type of action that represents a functionality that is expected to be available in third-party application.
attributeCode

string

The attribute that needs to be updated. Present when the type is EDIT_ITEM_ATTRIBUTE.

This field contains a code for attribute, represented in snake_case. You can find a list of product's attributes, with their codes here.
additionalContent

object (AdditionalContent)

Long text from an external source that should be available to the merchant. Present when the type is SHOW_ADDITIONAL_CONTENT.

BuiltInSimpleActionType

Enum specifying the type of action in third-party application.

Enums
BUILT_IN_SIMPLE_ACTION_TYPE_UNSPECIFIED Default value. Will never be provided by the API.
VERIFY_PHONE Redirect merchant to the part of your application where they can verify their phone.
CLAIM_WEBSITE Redirect merchant to the part of your application where they can claim their website.
ADD_PRODUCTS Redirect merchant to the part of your application where they can add products.
ADD_CONTACT_INFO Open a form where the merchant can edit their contact information.
ADD_BUSINESS_REGISTRATION_NUMBER Open a form where the merchant can add their business registration number.
EDIT_ITEM_ATTRIBUTE Open a form where the merchant can edit an attribute. The attribute that needs to be updated is specified in attributeCode field of the action.
FIX_ACCOUNT_ISSUE

Redirect merchant from the product issues to the diagnostic page with their account issues in your application.

This action will be returned only for product issues that are caused by an account issue and thus merchant should resolve the problem on the account level.
SHOW_ADDITIONAL_CONTENT

Show additional content to the merchant.

This action will be used for example to deliver a justification from national authority.

AdditionalContent

Long text from external source.

JSON representation 
{
  "title": string,
  "paragraphs": [
    string
  ]
}
Fields
title

string

Title of the additional content;
paragraphs[]

string

Long text organized into paragraphs.

ExternalAction

Action that is implemented and performed outside of the third-party application. It should redirect the merchant to the provided URL of an external system where they can perform the action. For example to request a review in the Merchant Center.

JSON representation 
{
  "type": enum (ExternalActionType),
  "uri": string
}
Fields
type

enum (ExternalActionType)

The type of external action.
uri

string

URL to external system, for example Merchant Center, where the merchant can perform the action.

ExternalActionType

Enum specifying the type of action that requires to redirect the merchant to an external location.

Enums
EXTERNAL_ACTION_TYPE_UNSPECIFIED Default value. Will never be provided by the API.
REVIEW_PRODUCT_ISSUE_IN_MERCHANT_CENTER Redirect to Merchant Center where the merchant can request a review for issue related to their product.
REVIEW_ACCOUNT_ISSUE_IN_MERCHANT_CENTER Redirect to Merchant Center where the merchant can request a review for issue related to their account.
LEGAL_APPEAL_IN_HELP_CENTER Redirect to the form in Help Center where the merchant can request a legal appeal for the issue.

Reason

A single reason why the action is not available.

JSON representation 
{
  "message": string,
  "detail": string,
  "action": {
    object (Action)
  }
}
Fields
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

object (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 merchant 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.