Action

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

enum (BuiltInSimpleActionType)

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

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.

object (AdditionalContent)

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

{
  "title": string,
  "paragraphs": [
    string
  ]
}

string

Title of the additional content;

string

Long text organized into paragraphs.

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

enum (ExternalActionType)

The type of external action.

string

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

{
  "actionContext": string,
  "flows": [
    {
      object (ActionFlow)
    }
  ]
}

string

Internal details. Not for display but need to be sent back when triggering the action.

object (ActionFlow)

Actions may provide multiple different flows. Merchant 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.

{
  "id": string,
  "label": string,
  "inputs": [
    {
      object (InputField)
    }
  ],
  "dialogTitle": string,
  "dialogButtonLabel": string,
  "dialogMessage": {
    object (TextWithTooltip)
  },
  "dialogCallout": {
    object (Callout)
  }
}

string

Not for display but need to be sent back for the selected action flow.

string

Text value describing the intent for the action flow. It can be used as an input label if merchant needs to pick one of multiple flows. For example: "I disagree with the issue"

object (InputField)

A list of input fields.

string

Title of the request dialog. For example: "Before you request a review"

string

Label for the button to trigger the action from the action dialog. For example: "Request review"

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

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

{
  "id": string,
  "label": {
    object (TextWithTooltip)
  },
  "required": boolean,

  // Union field value_input can be only one of the following:
  "textInput": {
    object (TextInput)
  },
  "choiceInput": {
    object (ChoiceInput)
  },
  "checkboxInput": {
    object (CheckboxInput)
  }
  // End of list of possible types for union field value_input.
}

string

Not for display but need to be sent back for the given input field.

object (TextWithTooltip)

Input field label. There may be more information to be shown in a tooltip.

boolean

Whether the field is required. The action button needs to stay disabled till values for all required fields are provided.

object (TextInput)

Input field to provide text information. Corresponds to the html input type=text or html textarea.

object (ChoiceInput)

Input field to select one of the offered choices. Corresponds to the html input type=radio.

object (CheckboxInput)

Input field to provide a boolean value. Corresponds to the html input type=checkbox.

{
  "tooltipIconStyle": enum (TooltipIconStyle),

  // Union field value can be only one of the following:
  "simpleValue": string
  // End of list of possible types for union field value.

  // Union field tooltip_value can be only one of the following:
  "simpleTooltipValue": string
  // End of list of possible types for union field tooltip_value.
}

enum (TooltipIconStyle)

The suggested type of an icon for tooltip, if a tooltip is present.

string

Value of the message as a simple text.

string

Value of the tooltip as a simple text.

{
  "type": enum (TextInputType),
  "additionalInfo": {
    object (TextWithTooltip)
  },
  "formatInfo": string,
  "ariaLabel": string
}

enum (TextInputType)

Type of the text input

object (TextWithTooltip)

Additional info regarding the field to be displayed to merchant. For example, warning to not include personal identifiable information. There may be more information to be shown in a tooltip.

string

Information about the required format. If present, it should be shown close to the input field to help merchants to provide a correct value. For example: "VAT numbers should be in a format similar to SK9999999999"

string

Text to be used as the aria-label for the input.

{
  "options": [
    {
      object (ChoiceInputOption)
    }
  ]
}

object (ChoiceInputOption)

A list of choices. Only one option can be selected.

{
  "id": string,
  "label": {
    object (TextWithTooltip)
  },
  "additionalInput": {
    object (InputField)
  }
}

string

Not for display but need to be sent back for the selected choice option.

object (TextWithTooltip)

Short description of the choice option. There may be more information to be shown as a tooltip.

object (InputField)

Input that should be displayed when this option is selected. The additional input will not contain a ChoiceInput.

{
  "styleHint": enum (CalloutStyleHint),
  "fullMessage": {
    object (TextWithTooltip)
  }
}

enum (CalloutStyleHint)

Can be used to render messages with different severity in different styles. Snippets off all types contain important information that should be displayed to merchants.

object (TextWithTooltip)

A full message that needs to be shown to the merchant.

{
  "message": string,
  "detail": string,
  "action": {
    object (Action)
  }
}

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."

string

Detailed explanation of the reason. Should be displayed as a hint if present.

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.