public static final class RenderedIssue.Builder extends GeneratedMessageV3.Builder<RenderedIssue.Builder> implements RenderedIssueOrBuilder
An issue affecting specific business or their product.
Protobuf type google.shopping.merchant.issueresolution.v1beta.RenderedIssue
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RenderedIssue.BuilderImplements
RenderedIssueOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addActions(Action value)
public RenderedIssue.Builder addActions(Action value)
A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue.
Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue.
repeated .google.shopping.merchant.issueresolution.v1beta.Action actions = 4;
Parameter | |
---|---|
Name | Description |
value |
Action |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
addActions(Action.Builder builderForValue)
public RenderedIssue.Builder addActions(Action.Builder builderForValue)
A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue.
Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue.
repeated .google.shopping.merchant.issueresolution.v1beta.Action actions = 4;
Parameter | |
---|---|
Name | Description |
builderForValue |
Action.Builder |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
addActions(int index, Action value)
public RenderedIssue.Builder addActions(int index, Action value)
A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue.
Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue.
repeated .google.shopping.merchant.issueresolution.v1beta.Action actions = 4;
Parameters | |
---|---|
Name | Description |
index |
int |
value |
Action |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
addActions(int index, Action.Builder builderForValue)
public RenderedIssue.Builder addActions(int index, Action.Builder builderForValue)
A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue.
Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue.
repeated .google.shopping.merchant.issueresolution.v1beta.Action actions = 4;
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
Action.Builder |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
addActionsBuilder()
public Action.Builder addActionsBuilder()
A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue.
Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue.
repeated .google.shopping.merchant.issueresolution.v1beta.Action actions = 4;
Returns | |
---|---|
Type | Description |
Action.Builder |
addActionsBuilder(int index)
public Action.Builder addActionsBuilder(int index)
A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue.
Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue.
repeated .google.shopping.merchant.issueresolution.v1beta.Action actions = 4;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Action.Builder |
addAllActions(Iterable<? extends Action> values)
public RenderedIssue.Builder addAllActions(Iterable<? extends Action> values)
A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue.
Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue.
repeated .google.shopping.merchant.issueresolution.v1beta.Action actions = 4;
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.shopping.merchant.issueresolution.v1beta.Action> |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RenderedIssue.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
build()
public RenderedIssue build()
Returns | |
---|---|
Type | Description |
RenderedIssue |
buildPartial()
public RenderedIssue buildPartial()
Returns | |
---|---|
Type | Description |
RenderedIssue |
clear()
public RenderedIssue.Builder clear()
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
clearActions()
public RenderedIssue.Builder clearActions()
A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue.
Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue.
repeated .google.shopping.merchant.issueresolution.v1beta.Action actions = 4;
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
clearContent()
public RenderedIssue.Builder clearContent()
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
clearField(Descriptors.FieldDescriptor field)
public RenderedIssue.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
clearImpact()
public RenderedIssue.Builder clearImpact()
Clarifies the severity of the issue.
The summarizing message, if present, should be shown right under the title for each issue. It helps business to quickly understand the impact of the issue.
The detailed breakdown helps the business to fully understand the impact of the issue. It can be rendered as dialog that opens when the business mouse over the summarized impact statement.
Issues with different
severity
can be styled differently. They may use a different color or icon to signal
the difference between ERROR
, WARNING
and INFO
.
.google.shopping.merchant.issueresolution.v1beta.Impact impact = 2;
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public RenderedIssue.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
clearOutOfCourtDisputeSettlement()
public RenderedIssue.Builder clearOutOfCourtDisputeSettlement()
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
clearPrerenderedContent()
public RenderedIssue.Builder clearPrerenderedContent()
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.
CSS classes:
issue-detail
- top level container for the detail of the issuecallout-banners
- section of theissue-detail
with callout bannerscallout-banner
- single callout banner, insidecallout-banners
callout-banner-info
- callout with important information (default)callout-banner-warning
- callout with a warningcallout-banner-error
- callout informing about an error (most severe)issue-content
- section of theissue-detail
, contains multiplecontent-element
content-element
- content element such as a list, link or paragraph, insideissue-content
root-causes
- unordered list with items describing root causes of the issue, insideissue-content
root-causes-intro
- intro text before theroot-causes
list, insideissue-content
segment
- section of the text,span
inside paragraphsegment-attribute
- section of the text that represents a product attribute, for example 'image\_link'segment-literal
- section of the text that contains a special value, for example '0-1000 kg'segment-bold
- section of the text that should be rendered as boldsegment-italic
- section of the text that should be rendered as italictooltip
- used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a classtooltip-text
and is intended to be shown in a mouse over dialog. If the style is not used, thetooltip-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 atooltip
, that is intended to be shown in a mouse over dialog.tooltip-icon
- marks a section of the text within atooltip
, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains abr
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 '?' as an icon.tooltip-style-info
- the tooltip adds additional information fitting to the context, can use the 'i' 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.
string prerendered_content = 3;
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
This builder for chaining. |
clearPrerenderedOutOfCourtDisputeSettlement()
public RenderedIssue.Builder clearPrerenderedOutOfCourtDisputeSettlement()
Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet.
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.
CSS classes:
ods-section
* - wrapper around the out-of-court dispute resolution sectionods-description
* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link.ods-param
* - wrapper around the header-value pair for parameters that the business may need to provide during the ODS process.ods-routing-id
* - ods param for the Routing ID.ods-reference-id
* - ods param for the Routing ID.ods-param-header
* - header for the ODS parameterods-param-value
* - value of the ODS parameter. This value should be rendered in a way that it is easy for the user to identify and copy.segment
- section of the text,span
inside paragraphsegment-attribute
- section of the text that represents a product attribute, for example 'image\_link'segment-literal
- section of the text that contains a special value, for example '0-1000 kg'segment-bold
- section of the text that should be rendered as boldsegment-italic
- section of the text that should be rendered as italictooltip
- used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a classtooltip-text
and is intended to be shown in a mouse over dialog. If the style is not used, thetooltip-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 atooltip
, that is intended to be shown in a mouse over dialog.tooltip-icon
- marks a section of the text within atooltip
, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains abr
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 '?' as an icon.tooltip-style-info
- the tooltip adds additional information fitting to the context, can use the 'i' as an icon.
string prerendered_out_of_court_dispute_settlement = 5;
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
This builder for chaining. |
clearTitle()
public RenderedIssue.Builder clearTitle()
Title of the issue.
string title = 1;
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
This builder for chaining. |
clone()
public RenderedIssue.Builder clone()
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
getActions(int index)
public Action getActions(int index)
A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue.
Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue.
repeated .google.shopping.merchant.issueresolution.v1beta.Action actions = 4;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Action |
getActionsBuilder(int index)
public Action.Builder getActionsBuilder(int index)
A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue.
Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue.
repeated .google.shopping.merchant.issueresolution.v1beta.Action actions = 4;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Action.Builder |
getActionsBuilderList()
public List<Action.Builder> getActionsBuilderList()
A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue.
Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue.
repeated .google.shopping.merchant.issueresolution.v1beta.Action actions = 4;
Returns | |
---|---|
Type | Description |
List<Builder> |
getActionsCount()
public int getActionsCount()
A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue.
Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue.
repeated .google.shopping.merchant.issueresolution.v1beta.Action actions = 4;
Returns | |
---|---|
Type | Description |
int |
getActionsList()
public List<Action> getActionsList()
A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue.
Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue.
repeated .google.shopping.merchant.issueresolution.v1beta.Action actions = 4;
Returns | |
---|---|
Type | Description |
List<Action> |
getActionsOrBuilder(int index)
public ActionOrBuilder getActionsOrBuilder(int index)
A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue.
Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue.
repeated .google.shopping.merchant.issueresolution.v1beta.Action actions = 4;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
ActionOrBuilder |
getActionsOrBuilderList()
public List<? extends ActionOrBuilder> getActionsOrBuilderList()
A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue.
Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue.
repeated .google.shopping.merchant.issueresolution.v1beta.Action actions = 4;
Returns | |
---|---|
Type | Description |
List<? extends com.google.shopping.merchant.issueresolution.v1beta.ActionOrBuilder> |
getContentCase()
public RenderedIssue.ContentCase getContentCase()
Returns | |
---|---|
Type | Description |
RenderedIssue.ContentCase |
getDefaultInstanceForType()
public RenderedIssue getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
RenderedIssue |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getImpact()
public Impact getImpact()
Clarifies the severity of the issue.
The summarizing message, if present, should be shown right under the title for each issue. It helps business to quickly understand the impact of the issue.
The detailed breakdown helps the business to fully understand the impact of the issue. It can be rendered as dialog that opens when the business mouse over the summarized impact statement.
Issues with different
severity
can be styled differently. They may use a different color or icon to signal
the difference between ERROR
, WARNING
and INFO
.
.google.shopping.merchant.issueresolution.v1beta.Impact impact = 2;
Returns | |
---|---|
Type | Description |
Impact |
The impact. |
getImpactBuilder()
public Impact.Builder getImpactBuilder()
Clarifies the severity of the issue.
The summarizing message, if present, should be shown right under the title for each issue. It helps business to quickly understand the impact of the issue.
The detailed breakdown helps the business to fully understand the impact of the issue. It can be rendered as dialog that opens when the business mouse over the summarized impact statement.
Issues with different
severity
can be styled differently. They may use a different color or icon to signal
the difference between ERROR
, WARNING
and INFO
.
.google.shopping.merchant.issueresolution.v1beta.Impact impact = 2;
Returns | |
---|---|
Type | Description |
Impact.Builder |
getImpactOrBuilder()
public ImpactOrBuilder getImpactOrBuilder()
Clarifies the severity of the issue.
The summarizing message, if present, should be shown right under the title for each issue. It helps business to quickly understand the impact of the issue.
The detailed breakdown helps the business to fully understand the impact of the issue. It can be rendered as dialog that opens when the business mouse over the summarized impact statement.
Issues with different
severity
can be styled differently. They may use a different color or icon to signal
the difference between ERROR
, WARNING
and INFO
.
.google.shopping.merchant.issueresolution.v1beta.Impact impact = 2;
Returns | |
---|---|
Type | Description |
ImpactOrBuilder |
getOutOfCourtDisputeSettlementCase()
public RenderedIssue.OutOfCourtDisputeSettlementCase getOutOfCourtDisputeSettlementCase()
Returns | |
---|---|
Type | Description |
RenderedIssue.OutOfCourtDisputeSettlementCase |
getPrerenderedContent()
public String getPrerenderedContent()
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.
CSS classes:
issue-detail
- top level container for the detail of the issuecallout-banners
- section of theissue-detail
with callout bannerscallout-banner
- single callout banner, insidecallout-banners
callout-banner-info
- callout with important information (default)callout-banner-warning
- callout with a warningcallout-banner-error
- callout informing about an error (most severe)issue-content
- section of theissue-detail
, contains multiplecontent-element
content-element
- content element such as a list, link or paragraph, insideissue-content
root-causes
- unordered list with items describing root causes of the issue, insideissue-content
root-causes-intro
- intro text before theroot-causes
list, insideissue-content
segment
- section of the text,span
inside paragraphsegment-attribute
- section of the text that represents a product attribute, for example 'image\_link'segment-literal
- section of the text that contains a special value, for example '0-1000 kg'segment-bold
- section of the text that should be rendered as boldsegment-italic
- section of the text that should be rendered as italictooltip
- used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a classtooltip-text
and is intended to be shown in a mouse over dialog. If the style is not used, thetooltip-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 atooltip
, that is intended to be shown in a mouse over dialog.tooltip-icon
- marks a section of the text within atooltip
, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains abr
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 '?' as an icon.tooltip-style-info
- the tooltip adds additional information fitting to the context, can use the 'i' 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.
string prerendered_content = 3;
Returns | |
---|---|
Type | Description |
String |
The prerenderedContent. |
getPrerenderedContentBytes()
public ByteString getPrerenderedContentBytes()
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.
CSS classes:
issue-detail
- top level container for the detail of the issuecallout-banners
- section of theissue-detail
with callout bannerscallout-banner
- single callout banner, insidecallout-banners
callout-banner-info
- callout with important information (default)callout-banner-warning
- callout with a warningcallout-banner-error
- callout informing about an error (most severe)issue-content
- section of theissue-detail
, contains multiplecontent-element
content-element
- content element such as a list, link or paragraph, insideissue-content
root-causes
- unordered list with items describing root causes of the issue, insideissue-content
root-causes-intro
- intro text before theroot-causes
list, insideissue-content
segment
- section of the text,span
inside paragraphsegment-attribute
- section of the text that represents a product attribute, for example 'image\_link'segment-literal
- section of the text that contains a special value, for example '0-1000 kg'segment-bold
- section of the text that should be rendered as boldsegment-italic
- section of the text that should be rendered as italictooltip
- used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a classtooltip-text
and is intended to be shown in a mouse over dialog. If the style is not used, thetooltip-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 atooltip
, that is intended to be shown in a mouse over dialog.tooltip-icon
- marks a section of the text within atooltip
, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains abr
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 '?' as an icon.tooltip-style-info
- the tooltip adds additional information fitting to the context, can use the 'i' 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.
string prerendered_content = 3;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for prerenderedContent. |
getPrerenderedOutOfCourtDisputeSettlement()
public String getPrerenderedOutOfCourtDisputeSettlement()
Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet.
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.
CSS classes:
ods-section
* - wrapper around the out-of-court dispute resolution sectionods-description
* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link.ods-param
* - wrapper around the header-value pair for parameters that the business may need to provide during the ODS process.ods-routing-id
* - ods param for the Routing ID.ods-reference-id
* - ods param for the Routing ID.ods-param-header
* - header for the ODS parameterods-param-value
* - value of the ODS parameter. This value should be rendered in a way that it is easy for the user to identify and copy.segment
- section of the text,span
inside paragraphsegment-attribute
- section of the text that represents a product attribute, for example 'image\_link'segment-literal
- section of the text that contains a special value, for example '0-1000 kg'segment-bold
- section of the text that should be rendered as boldsegment-italic
- section of the text that should be rendered as italictooltip
- used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a classtooltip-text
and is intended to be shown in a mouse over dialog. If the style is not used, thetooltip-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 atooltip
, that is intended to be shown in a mouse over dialog.tooltip-icon
- marks a section of the text within atooltip
, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains abr
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 '?' as an icon.tooltip-style-info
- the tooltip adds additional information fitting to the context, can use the 'i' as an icon.
string prerendered_out_of_court_dispute_settlement = 5;
Returns | |
---|---|
Type | Description |
String |
The prerenderedOutOfCourtDisputeSettlement. |
getPrerenderedOutOfCourtDisputeSettlementBytes()
public ByteString getPrerenderedOutOfCourtDisputeSettlementBytes()
Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet.
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.
CSS classes:
ods-section
* - wrapper around the out-of-court dispute resolution sectionods-description
* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link.ods-param
* - wrapper around the header-value pair for parameters that the business may need to provide during the ODS process.ods-routing-id
* - ods param for the Routing ID.ods-reference-id
* - ods param for the Routing ID.ods-param-header
* - header for the ODS parameterods-param-value
* - value of the ODS parameter. This value should be rendered in a way that it is easy for the user to identify and copy.segment
- section of the text,span
inside paragraphsegment-attribute
- section of the text that represents a product attribute, for example 'image\_link'segment-literal
- section of the text that contains a special value, for example '0-1000 kg'segment-bold
- section of the text that should be rendered as boldsegment-italic
- section of the text that should be rendered as italictooltip
- used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a classtooltip-text
and is intended to be shown in a mouse over dialog. If the style is not used, thetooltip-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 atooltip
, that is intended to be shown in a mouse over dialog.tooltip-icon
- marks a section of the text within atooltip
, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains abr
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 '?' as an icon.tooltip-style-info
- the tooltip adds additional information fitting to the context, can use the 'i' as an icon.
string prerendered_out_of_court_dispute_settlement = 5;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for prerenderedOutOfCourtDisputeSettlement. |
getTitle()
public String getTitle()
Title of the issue.
string title = 1;
Returns | |
---|---|
Type | Description |
String |
The title. |
getTitleBytes()
public ByteString getTitleBytes()
Title of the issue.
string title = 1;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for title. |
hasImpact()
public boolean hasImpact()
Clarifies the severity of the issue.
The summarizing message, if present, should be shown right under the title for each issue. It helps business to quickly understand the impact of the issue.
The detailed breakdown helps the business to fully understand the impact of the issue. It can be rendered as dialog that opens when the business mouse over the summarized impact statement.
Issues with different
severity
can be styled differently. They may use a different color or icon to signal
the difference between ERROR
, WARNING
and INFO
.
.google.shopping.merchant.issueresolution.v1beta.Impact impact = 2;
Returns | |
---|---|
Type | Description |
boolean |
Whether the impact field is set. |
hasPrerenderedContent()
public boolean hasPrerenderedContent()
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.
CSS classes:
issue-detail
- top level container for the detail of the issuecallout-banners
- section of theissue-detail
with callout bannerscallout-banner
- single callout banner, insidecallout-banners
callout-banner-info
- callout with important information (default)callout-banner-warning
- callout with a warningcallout-banner-error
- callout informing about an error (most severe)issue-content
- section of theissue-detail
, contains multiplecontent-element
content-element
- content element such as a list, link or paragraph, insideissue-content
root-causes
- unordered list with items describing root causes of the issue, insideissue-content
root-causes-intro
- intro text before theroot-causes
list, insideissue-content
segment
- section of the text,span
inside paragraphsegment-attribute
- section of the text that represents a product attribute, for example 'image\_link'segment-literal
- section of the text that contains a special value, for example '0-1000 kg'segment-bold
- section of the text that should be rendered as boldsegment-italic
- section of the text that should be rendered as italictooltip
- used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a classtooltip-text
and is intended to be shown in a mouse over dialog. If the style is not used, thetooltip-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 atooltip
, that is intended to be shown in a mouse over dialog.tooltip-icon
- marks a section of the text within atooltip
, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains abr
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 '?' as an icon.tooltip-style-info
- the tooltip adds additional information fitting to the context, can use the 'i' 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.
string prerendered_content = 3;
Returns | |
---|---|
Type | Description |
boolean |
Whether the prerenderedContent field is set. |
hasPrerenderedOutOfCourtDisputeSettlement()
public boolean hasPrerenderedOutOfCourtDisputeSettlement()
Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet.
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.
CSS classes:
ods-section
* - wrapper around the out-of-court dispute resolution sectionods-description
* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link.ods-param
* - wrapper around the header-value pair for parameters that the business may need to provide during the ODS process.ods-routing-id
* - ods param for the Routing ID.ods-reference-id
* - ods param for the Routing ID.ods-param-header
* - header for the ODS parameterods-param-value
* - value of the ODS parameter. This value should be rendered in a way that it is easy for the user to identify and copy.segment
- section of the text,span
inside paragraphsegment-attribute
- section of the text that represents a product attribute, for example 'image\_link'segment-literal
- section of the text that contains a special value, for example '0-1000 kg'segment-bold
- section of the text that should be rendered as boldsegment-italic
- section of the text that should be rendered as italictooltip
- used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a classtooltip-text
and is intended to be shown in a mouse over dialog. If the style is not used, thetooltip-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 atooltip
, that is intended to be shown in a mouse over dialog.tooltip-icon
- marks a section of the text within atooltip
, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains abr
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 '?' as an icon.tooltip-style-info
- the tooltip adds additional information fitting to the context, can use the 'i' as an icon.
string prerendered_out_of_court_dispute_settlement = 5;
Returns | |
---|---|
Type | Description |
boolean |
Whether the prerenderedOutOfCourtDisputeSettlement field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RenderedIssue.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public RenderedIssue.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
mergeFrom(RenderedIssue other)
public RenderedIssue.Builder mergeFrom(RenderedIssue other)
Parameter | |
---|---|
Name | Description |
other |
RenderedIssue |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
mergeImpact(Impact value)
public RenderedIssue.Builder mergeImpact(Impact value)
Clarifies the severity of the issue.
The summarizing message, if present, should be shown right under the title for each issue. It helps business to quickly understand the impact of the issue.
The detailed breakdown helps the business to fully understand the impact of the issue. It can be rendered as dialog that opens when the business mouse over the summarized impact statement.
Issues with different
severity
can be styled differently. They may use a different color or icon to signal
the difference between ERROR
, WARNING
and INFO
.
.google.shopping.merchant.issueresolution.v1beta.Impact impact = 2;
Parameter | |
---|---|
Name | Description |
value |
Impact |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RenderedIssue.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
removeActions(int index)
public RenderedIssue.Builder removeActions(int index)
A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue.
Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue.
repeated .google.shopping.merchant.issueresolution.v1beta.Action actions = 4;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
setActions(int index, Action value)
public RenderedIssue.Builder setActions(int index, Action value)
A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue.
Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue.
repeated .google.shopping.merchant.issueresolution.v1beta.Action actions = 4;
Parameters | |
---|---|
Name | Description |
index |
int |
value |
Action |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
setActions(int index, Action.Builder builderForValue)
public RenderedIssue.Builder setActions(int index, Action.Builder builderForValue)
A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue.
Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue.
repeated .google.shopping.merchant.issueresolution.v1beta.Action actions = 4;
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
Action.Builder |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public RenderedIssue.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
setImpact(Impact value)
public RenderedIssue.Builder setImpact(Impact value)
Clarifies the severity of the issue.
The summarizing message, if present, should be shown right under the title for each issue. It helps business to quickly understand the impact of the issue.
The detailed breakdown helps the business to fully understand the impact of the issue. It can be rendered as dialog that opens when the business mouse over the summarized impact statement.
Issues with different
severity
can be styled differently. They may use a different color or icon to signal
the difference between ERROR
, WARNING
and INFO
.
.google.shopping.merchant.issueresolution.v1beta.Impact impact = 2;
Parameter | |
---|---|
Name | Description |
value |
Impact |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
setImpact(Impact.Builder builderForValue)
public RenderedIssue.Builder setImpact(Impact.Builder builderForValue)
Clarifies the severity of the issue.
The summarizing message, if present, should be shown right under the title for each issue. It helps business to quickly understand the impact of the issue.
The detailed breakdown helps the business to fully understand the impact of the issue. It can be rendered as dialog that opens when the business mouse over the summarized impact statement.
Issues with different
severity
can be styled differently. They may use a different color or icon to signal
the difference between ERROR
, WARNING
and INFO
.
.google.shopping.merchant.issueresolution.v1beta.Impact impact = 2;
Parameter | |
---|---|
Name | Description |
builderForValue |
Impact.Builder |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
setPrerenderedContent(String value)
public RenderedIssue.Builder setPrerenderedContent(String value)
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.
CSS classes:
issue-detail
- top level container for the detail of the issuecallout-banners
- section of theissue-detail
with callout bannerscallout-banner
- single callout banner, insidecallout-banners
callout-banner-info
- callout with important information (default)callout-banner-warning
- callout with a warningcallout-banner-error
- callout informing about an error (most severe)issue-content
- section of theissue-detail
, contains multiplecontent-element
content-element
- content element such as a list, link or paragraph, insideissue-content
root-causes
- unordered list with items describing root causes of the issue, insideissue-content
root-causes-intro
- intro text before theroot-causes
list, insideissue-content
segment
- section of the text,span
inside paragraphsegment-attribute
- section of the text that represents a product attribute, for example 'image\_link'segment-literal
- section of the text that contains a special value, for example '0-1000 kg'segment-bold
- section of the text that should be rendered as boldsegment-italic
- section of the text that should be rendered as italictooltip
- used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a classtooltip-text
and is intended to be shown in a mouse over dialog. If the style is not used, thetooltip-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 atooltip
, that is intended to be shown in a mouse over dialog.tooltip-icon
- marks a section of the text within atooltip
, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains abr
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 '?' as an icon.tooltip-style-info
- the tooltip adds additional information fitting to the context, can use the 'i' 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.
string prerendered_content = 3;
Parameter | |
---|---|
Name | Description |
value |
String The prerenderedContent to set. |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
This builder for chaining. |
setPrerenderedContentBytes(ByteString value)
public RenderedIssue.Builder setPrerenderedContentBytes(ByteString value)
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.
CSS classes:
issue-detail
- top level container for the detail of the issuecallout-banners
- section of theissue-detail
with callout bannerscallout-banner
- single callout banner, insidecallout-banners
callout-banner-info
- callout with important information (default)callout-banner-warning
- callout with a warningcallout-banner-error
- callout informing about an error (most severe)issue-content
- section of theissue-detail
, contains multiplecontent-element
content-element
- content element such as a list, link or paragraph, insideissue-content
root-causes
- unordered list with items describing root causes of the issue, insideissue-content
root-causes-intro
- intro text before theroot-causes
list, insideissue-content
segment
- section of the text,span
inside paragraphsegment-attribute
- section of the text that represents a product attribute, for example 'image\_link'segment-literal
- section of the text that contains a special value, for example '0-1000 kg'segment-bold
- section of the text that should be rendered as boldsegment-italic
- section of the text that should be rendered as italictooltip
- used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a classtooltip-text
and is intended to be shown in a mouse over dialog. If the style is not used, thetooltip-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 atooltip
, that is intended to be shown in a mouse over dialog.tooltip-icon
- marks a section of the text within atooltip
, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains abr
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 '?' as an icon.tooltip-style-info
- the tooltip adds additional information fitting to the context, can use the 'i' 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.
string prerendered_content = 3;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for prerenderedContent to set. |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
This builder for chaining. |
setPrerenderedOutOfCourtDisputeSettlement(String value)
public RenderedIssue.Builder setPrerenderedOutOfCourtDisputeSettlement(String value)
Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet.
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.
CSS classes:
ods-section
* - wrapper around the out-of-court dispute resolution sectionods-description
* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link.ods-param
* - wrapper around the header-value pair for parameters that the business may need to provide during the ODS process.ods-routing-id
* - ods param for the Routing ID.ods-reference-id
* - ods param for the Routing ID.ods-param-header
* - header for the ODS parameterods-param-value
* - value of the ODS parameter. This value should be rendered in a way that it is easy for the user to identify and copy.segment
- section of the text,span
inside paragraphsegment-attribute
- section of the text that represents a product attribute, for example 'image\_link'segment-literal
- section of the text that contains a special value, for example '0-1000 kg'segment-bold
- section of the text that should be rendered as boldsegment-italic
- section of the text that should be rendered as italictooltip
- used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a classtooltip-text
and is intended to be shown in a mouse over dialog. If the style is not used, thetooltip-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 atooltip
, that is intended to be shown in a mouse over dialog.tooltip-icon
- marks a section of the text within atooltip
, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains abr
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 '?' as an icon.tooltip-style-info
- the tooltip adds additional information fitting to the context, can use the 'i' as an icon.
string prerendered_out_of_court_dispute_settlement = 5;
Parameter | |
---|---|
Name | Description |
value |
String The prerenderedOutOfCourtDisputeSettlement to set. |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
This builder for chaining. |
setPrerenderedOutOfCourtDisputeSettlementBytes(ByteString value)
public RenderedIssue.Builder setPrerenderedOutOfCourtDisputeSettlementBytes(ByteString value)
Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet.
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.
CSS classes:
ods-section
* - wrapper around the out-of-court dispute resolution sectionods-description
* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link.ods-param
* - wrapper around the header-value pair for parameters that the business may need to provide during the ODS process.ods-routing-id
* - ods param for the Routing ID.ods-reference-id
* - ods param for the Routing ID.ods-param-header
* - header for the ODS parameterods-param-value
* - value of the ODS parameter. This value should be rendered in a way that it is easy for the user to identify and copy.segment
- section of the text,span
inside paragraphsegment-attribute
- section of the text that represents a product attribute, for example 'image\_link'segment-literal
- section of the text that contains a special value, for example '0-1000 kg'segment-bold
- section of the text that should be rendered as boldsegment-italic
- section of the text that should be rendered as italictooltip
- used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a classtooltip-text
and is intended to be shown in a mouse over dialog. If the style is not used, thetooltip-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 atooltip
, that is intended to be shown in a mouse over dialog.tooltip-icon
- marks a section of the text within atooltip
, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains abr
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 '?' as an icon.tooltip-style-info
- the tooltip adds additional information fitting to the context, can use the 'i' as an icon.
string prerendered_out_of_court_dispute_settlement = 5;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for prerenderedOutOfCourtDisputeSettlement to set. |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RenderedIssue.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
setTitle(String value)
public RenderedIssue.Builder setTitle(String value)
Title of the issue.
string title = 1;
Parameter | |
---|---|
Name | Description |
value |
String The title to set. |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
This builder for chaining. |
setTitleBytes(ByteString value)
public RenderedIssue.Builder setTitleBytes(ByteString value)
Title of the issue.
string title = 1;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for title to set. |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final RenderedIssue.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
RenderedIssue.Builder |