public final class RenderedIssue extends GeneratedMessageV3 implements RenderedIssueOrBuilder
An issue affecting specific business or their product.
Protobuf type google.shopping.merchant.issueresolution.v1beta.RenderedIssue
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int ACTIONS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int IMPACT_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
PRERENDERED_CONTENT_FIELD_NUMBER
public static final int PRERENDERED_CONTENT_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int PRERENDERED_OUT_OF_COURT_DISPUTE_SETTLEMENT_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int TITLE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
public static RenderedIssue getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static RenderedIssue.Builder newBuilder()
public static RenderedIssue.Builder newBuilder(RenderedIssue prototype)
public static RenderedIssue parseDelimitedFrom(InputStream input)
public static RenderedIssue parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RenderedIssue parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
public static RenderedIssue parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RenderedIssue parseFrom(ByteString data)
public static RenderedIssue parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RenderedIssue parseFrom(CodedInputStream input)
public static RenderedIssue parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RenderedIssue parseFrom(InputStream input)
public static RenderedIssue parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RenderedIssue parseFrom(ByteBuffer data)
public static RenderedIssue parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<RenderedIssue> parser()
Methods
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
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 |
|
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 |
|
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;
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
|
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()
public RenderedIssue getDefaultInstanceForType()
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.
|
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;
public RenderedIssue.OutOfCourtDisputeSettlementCase getOutOfCourtDisputeSettlementCase()
public Parser<RenderedIssue> getParserForType()
Overrides
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 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 '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 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 '?' or 'i'. 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 '?' 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 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 '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 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 '?' or 'i'. 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 '?' 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.
|
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
section
ods-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 parameter
ods-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 paragraph
segment-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 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 '?' or 'i'. 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 '?' 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.
|
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
section
ods-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 parameter
ods-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 paragraph
segment-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 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 '?' or 'i'. 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 '?' 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.
|
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
Title of the issue.
string title = 1;
Returns |
Type |
Description |
String |
The title.
|
public ByteString getTitleBytes()
Title of the issue.
string title = 1;
Returns |
Type |
Description |
ByteString |
The bytes for title.
|
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 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 '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 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 '?' or 'i'. 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 '?' 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.
|
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
section
ods-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 parameter
ods-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 paragraph
segment-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 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 '?' or 'i'. 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 '?' 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.
|
Returns |
Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public RenderedIssue.Builder newBuilderForType()
protected RenderedIssue.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
public RenderedIssue.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides