Skip to content

Commit 526e18b

Browse files
feat(content): update the api
#### content:v2.1 The following keys were added: - schemas.BuiltInSimpleAction.properties.additionalContent.$ref (Total Keys: 1) - schemas.BuiltInSimpleActionAdditionalContent (Total Keys: 4)
1 parent 93e4d9b commit 526e18b

File tree

2 files changed

+49
-9
lines changed

2 files changed

+49
-9
lines changed

docs/dyn/content_v2_1.merchantsupport.html

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,12 @@ <h3>Method Details</h3>
122122
&quot;actions&quot;: [ # 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.
123123
{ # An actionable step that can be executed to solve the issue.
124124
&quot;builtinSimpleAction&quot;: { # 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. # 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.
125+
&quot;additionalContent&quot;: { # Long text from external source. # Long text from an external source that should be available to the merchant. Present when the type is `SHOW_ADDITIONAL_CONTENT`.
126+
&quot;paragraphs&quot;: [ # Long text organized into paragraphs.
127+
&quot;A String&quot;,
128+
],
129+
&quot;title&quot;: &quot;A String&quot;, # Title of the additional content;
130+
},
125131
&quot;attributeCode&quot;: &quot;A String&quot;, # 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&#x27;s attributes, with their codes [here](https://support.google.com/merchants/answer/7052112).
126132
&quot;type&quot;: &quot;A String&quot;, # The type of action that represents a functionality that is expected to be available in third-party application.
127133
},
@@ -157,7 +163,7 @@ <h3>Method Details</h3>
157163
&quot;message&quot;: &quot;A String&quot;, # Optional. Message summarizing the overall impact of the issue. If present, it should be rendered to the merchant. For example: &quot;Disapproves 90k offers in 25 countries&quot;
158164
&quot;severity&quot;: &quot;A String&quot;, # The severity of the issue.
159165
},
160-
&quot;prerenderedContent&quot;: &quot;A String&quot;, # 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: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example &#x27;image\_link&#x27; * `segment-literal` - section of the text that contains a special value, for example &#x27;0-1000 kg&#x27; * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example &#x27;?&#x27; or &#x27;i&#x27;. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the &#x27;?&#x27; as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the &#x27;i&#x27; as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `overlay` - wrapper for the `popup` dialog. It should be set to hidden by default. When the dialog is opened, the overlay should switch to be visible and cover the rest of the screen to highlight the dialog. * `popup` - dialog for showing a long block of content * `popup-close` - a button to close the `popup` dialog * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class.
166+
&quot;prerenderedContent&quot;: &quot;A String&quot;, # 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: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example &#x27;image\_link&#x27; * `segment-literal` - section of the text that contains a special value, for example &#x27;0-1000 kg&#x27; * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example &#x27;?&#x27; or &#x27;i&#x27;. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the &#x27;?&#x27; as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the &#x27;i&#x27; as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class.
161167
&quot;title&quot;: &quot;A String&quot;, # Title of the issue.
162168
},
163169
],
@@ -198,6 +204,12 @@ <h3>Method Details</h3>
198204
&quot;actions&quot;: [ # 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.
199205
{ # An actionable step that can be executed to solve the issue.
200206
&quot;builtinSimpleAction&quot;: { # 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. # 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.
207+
&quot;additionalContent&quot;: { # Long text from external source. # Long text from an external source that should be available to the merchant. Present when the type is `SHOW_ADDITIONAL_CONTENT`.
208+
&quot;paragraphs&quot;: [ # Long text organized into paragraphs.
209+
&quot;A String&quot;,
210+
],
211+
&quot;title&quot;: &quot;A String&quot;, # Title of the additional content;
212+
},
201213
&quot;attributeCode&quot;: &quot;A String&quot;, # 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&#x27;s attributes, with their codes [here](https://support.google.com/merchants/answer/7052112).
202214
&quot;type&quot;: &quot;A String&quot;, # The type of action that represents a functionality that is expected to be available in third-party application.
203215
},
@@ -233,7 +245,7 @@ <h3>Method Details</h3>
233245
&quot;message&quot;: &quot;A String&quot;, # Optional. Message summarizing the overall impact of the issue. If present, it should be rendered to the merchant. For example: &quot;Limits visibility in France&quot;
234246
&quot;severity&quot;: &quot;A String&quot;, # The severity of the issue.
235247
},
236-
&quot;prerenderedContent&quot;: &quot;A String&quot;, # 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: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example &#x27;image\_link&#x27; * `segment-literal` - section of the text that contains a special value, for example &#x27;0-1000 kg&#x27; * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example &#x27;?&#x27; or &#x27;i&#x27;. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the &#x27;?&#x27; as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the &#x27;i&#x27; as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `overlay` - wrapper for the `popup` dialog. It should be set to hidden by default. When the dialog is opened, the overlay should switch to be visible and cover the rest of the screen to highlight the dialog. * `popup` - dialog for showing a long block of content * `popup-close` - a button to close the `popup` dialog * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class.
248+
&quot;prerenderedContent&quot;: &quot;A String&quot;, # 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: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example &#x27;image\_link&#x27; * `segment-literal` - section of the text that contains a special value, for example &#x27;0-1000 kg&#x27; * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example &#x27;?&#x27; or &#x27;i&#x27;. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the &#x27;?&#x27; as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the &#x27;i&#x27; as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class.
237249
&quot;title&quot;: &quot;A String&quot;, # Title of the issue.
238250
},
239251
],

0 commit comments

Comments
 (0)