- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- RenderProductIssuesRequestPayload
- ProductIssue
- ProductIssueImpact
- Try it!
Provide a list of issues for merchant's product with a support content and available actions. This content and actions are meant to be rendered and shown in third-party applications.
HTTP request
POST https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/merchantsupport/renderproductissues/{productId}
Path parameters
Parameters | |
---|---|
merchant |
Required. The ID of the account that contains the product. |
product |
Required. The REST_ID of the product to fetch issues for. |
Query parameters
Parameters | |
---|---|
language |
Optional. The IETF BCP-47 language code used to localize support content. If not set, the result will be in default language |
time |
Optional. The IANA timezone used to localize times in support content. For example 'America/Los_Angeles'. If not set, results will use as a default UTC. |
Request body
The request body contains an instance of RenderProductIssuesRequestPayload
.
Response body
Response containing support content and actions for listed product issues.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "issues": [ { object ( |
Fields | |
---|---|
issues[] |
List of issues for a given product. This list can be shown with compressed, expandable items. In the compressed form, the |
alternate |
The Alternate Dispute Resolution (ADR) contains a link to a page where merchant can bring their appeal to an external body. If present, the link should be shown on the same page as the list of issues. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/content
For more information, see the OAuth 2.0 Overview.
RenderProductIssuesRequestPayload
The payload for configuring how the content should be rendered.
JSON representation |
---|
{ "contentOption": enum ( |
Fields | |
---|---|
content |
Optional. How the detailed content should be returned. Default option is to return the content as a pre-rendered HTML text. |
user |
Optional. How actions with user input form should be handled. If not provided, actions will be returned as links that points merchant to Merchant Center where they can request the action. |
ProductIssue
An issue affecting specific product.
JSON representation |
---|
{ "title": string, "impact": { object ( |
Fields | |
---|---|
title |
Title of the issue. |
impact |
Clarifies the severity of the issue. The The detailed Issues with different |
actions[] |
A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when merchant disagrees with the issue. Actions that are supported in (your) third-party application can be rendered as buttons and should be available to merchant when they expand the issue. |
Union field content . Detailed content of the issue. Should be shown to the merchant when they expand the issue. The form in which the content is returned is specified with the content option request field. content can be only one of the following: |
|
prerendered |
Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: CSS classes:
|
ProductIssueImpact
Overall impact of product issue.
JSON representation |
---|
{ "message": string, "severity": enum ( |
Fields | |
---|---|
message |
Optional. Message summarizing the overall impact of the issue. If present, it should be rendered to the merchant. For example: "Limits visibility in France" |
severity |
The severity of the issue. |
breakdowns[] |
Detailed impact breakdown. Explains the types of restriction the issue has in different shopping destinations and territory. If present, it should be rendered to the merchant. Can be shown as a mouse over dropdown or a dialog. Each breakdown item represents a group of regions with the same impact details. |