Index
Action(message)ActionFlow(message)ActionInput(message)AggregateProductStatus(message)Breakdown(message)BuiltInSimpleAction(message)BuiltInUserInputAction(message)Callout(message)ContentOption(enum)ExternalAction(message)Impact(message)InputField(message)InputValue(message)ListAggregateProductStatusesRequest(message)ListAggregateProductStatusesResponse(message)RenderAccountIssuesRequest(message)RenderAccountIssuesResponse(message)RenderIssuesRequestPayload(message)RenderProductIssuesRequest(message)RenderProductIssuesResponse(message)RenderedIssue(message)Severity(enum)TextWithTooltip(message)TriggerActionPayload(message)TriggerActionRequest(message)TriggerActionResponse(message)UserInputActionRenderingOption(enum)
Reason
A single reason why the action is not available.
| Fields | |
|---|---|
message |
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 |
Detailed explanation of the reason. Should be displayed as a hint if present. |
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. |
ItemLevelIssue
The ItemLevelIssue of the product status.
| Fields | |
|---|---|
code |
The error code of the issue. |
severity |
How this issue affects serving of the offer. |
resolution |
Whether the issue can be resolved by the merchant. |
attribute |
The attribute's name, if the issue is caused by a single attribute. |
description |
A short issue description in English. |
detail |
A detailed issue description in English. |
documentation_uri |
The URL of a web page to help with resolving this issue. |
product_count |
The number of products affected by this issue. |
Resolution
How the issue can be resolved.
| Enums | |
|---|---|
RESOLUTION_UNSPECIFIED |
Not specified. |
MERCHANT_ACTION |
The issue can be resolved by the merchant. |
PENDING_PROCESSING |
The issue will be resolved auomatically. |
Severity
How the issue affects the serving of the product.
| Enums | |
|---|---|
SEVERITY_UNSPECIFIED |
Not specified. |
NOT_IMPACTED |
This issue represents a warning and does not have a direct affect on the product. |
DEMOTED |
The product is demoted and most likely have limited performance in search results |
DISAPPROVED |
Issue disapproves the product. |
Stats
Products statistics.
| Fields | |
|---|---|
active_count |
The number of products that are active. |
pending_count |
The number of products that are pending. |
disapproved_count |
The number of products that are disapproved. |
expiring_count |
The number of products that are expiring. |
Region
Region with code and localized name.
| Fields | |
|---|---|
code |
|
name |
The localized name of the region. For region with code='001' the value is 'All countries' or the equivalent in other languages. |
AdditionalContent
Long text from external source.
| Fields | |
|---|---|
title |
Title of the additional content; |
paragraphs[] |
Long text organized into paragraphs. |
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 the business to the part of your application where they can verify their phone. |
CLAIM_WEBSITE |
Redirect the business to the part of your application where they can claim their website. |
ADD_PRODUCTS |
Redirect the business to the part of your application where they can add products. |
ADD_CONTACT_INFO |
Open a form where the business can edit their contact information. |
LINK_ADS_ACCOUNT |
Redirect the business to the part of your application where they can link ads account. |
ADD_BUSINESS_REGISTRATION_NUMBER |
Open a form where the business can add their business registration number. |
EDIT_ITEM_ATTRIBUTE |
Open a form where the business can edit an attribute. The attribute that needs to be updated is specified in attribute_code field of the action. |
FIX_ACCOUNT_ISSUE |
Redirect the business 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 the business should resolve the problem on the account level. |
SHOW_ADDITIONAL_CONTENT |
Show This action will be used for example to deliver a justification from national authority. |
CalloutStyleHint
Enum specifying the suggested style, how the message should be rendered.
| Enums | |
|---|---|
CALLOUT_STYLE_HINT_UNSPECIFIED |
Default value. Will never be provided by the API. |
ERROR |
The most important type of information highlighting problems, like an unsuccessful outcome of previously requested actions. |
WARNING |
Information warning about pending problems, risks or deadlines. |
INFO |
Default severity for important information like pending status of previously requested action or cooldown for re-review. |
ExternalActionType
Enum specifying the type of action that requires to redirect the business 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 business can request a review for issue related to their product. |
REVIEW_ACCOUNT_ISSUE_IN_MERCHANT_CENTER |
Redirect to Merchant Center where the business can request a review for issue related to their account. |
LEGAL_APPEAL_IN_HELP_CENTER |
Redirect to the form in Help Center where the business can request a legal appeal for the issue. |
VERIFY_IDENTITY_IN_MERCHANT_CENTER |
Redirect to Merchant Center where the business can perform identity verification. |
VERIFY_BUSINESS_VIDEO_IN_MERCHANT_CENTER |
Redirect to Merchant Center where the business can perform business video verification. |
CheckboxInput
This type has no fields.
Checkbox input allows the business to provide a boolean value. Corresponds to the html input type=checkbox.
If the business checks the box, the input value for the field is true, otherwise it is false.
This type of input is often used as a confirmation that the business completed required steps before they are allowed to start the action. In such a case, the input field is marked as required and the button to trigger the action should stay disabled until the business checks the box.
ChoiceInput
Choice input allows the business to select one of the offered choices. Some choices may be linked to additional input fields that should be displayed under or next to the choice option. The value for the additional input field needs to be provided only when the specific choice is selected by the the business. For example, additional input field can be hidden or disabled until the business selects the specific choice.
| Fields | |
|---|---|
options[] |
A list of choices. Only one option can be selected. |
ChoiceInputOption
A choice that the business can select.
| Fields | |
|---|---|
id |
Not for display but need to be sent back for the selected choice option. |
label |
Short description of the choice option. There may be more information to be shown as a tooltip. |
additional_input |
Input that should be displayed when this option is selected. The additional input will not contain a |
TextInput
Text input allows the business to provide a text value.
| Fields | |
|---|---|
type |
Type of the text input |
additional_info |
Additional info regarding the field to be displayed to the business. For example, warning to not include personal identifiable information. There may be more information to be shown in a tooltip. |
format_info |
Information about the required format. If present, it should be shown close to the input field to help the business to provide a correct value. For example: "VAT numbers should be in a format similar to SK9999999999" |
aria_label |
Text to be used as the aria-label for the input. |
TextInputType
Enum specifying the type of the text input and how it should be rendered.
| Enums | |
|---|---|
TEXT_INPUT_TYPE_UNSPECIFIED |
Default value. Will never be provided by the API. |
GENERIC_SHORT_TEXT |
Used when a short text is expected. The field can be rendered as a text field. |
GENERIC_LONG_TEXT |
Used when a longer text is expected. The field should be rendered as a textarea. |
CheckboxInputValue
Value for checkbox input field.
| Fields | |
|---|---|
value |
Required. True if the business checked the box field. False otherwise. |
ChoiceInputValue
Value for choice input field.
| Fields | |
|---|---|
choice_input_option_id |
Required. [Id][InputField.ChoiceInput.id] of the option that was selected by the business. |
TextInputValue
Value for text input field.
| Fields | |
|---|---|
value |
Required. Text provided by the business. |
TooltipIconStyle
Enum specifying the type of an icon that is being used to display a corresponding tooltip in the Merchant Center.
| Enums | |
|---|---|
TOOLTIP_ICON_STYLE_UNSPECIFIED |
Default value. Will never be provided by the API. |
INFO |
Used when the tooltip adds additional information to the context, the 'i' can be used as an icon. |
QUESTION |
Used when the tooltip shows helpful information, the '?' can be used as an icon. |