target.apidocs.com.google.api.services.content.model.AccountIssue.html Maven / Gradle / Ivy

Go to download






AccountIssue (Content API for Shopping v2.1-rev20240609-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.content.model
Class AccountIssue



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.content.model.AccountIssue













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class AccountIssue
extends com.google.api.client.json.GenericJson
An issue affecting specific merchant.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Content API for Shopping. For a detailed explanation
 see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


AccountIssue() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


AccountIssue
clone() 


List<Action>
getActions()
A list of actionable steps that can be executed to solve the issue.



AccountIssueImpact
getImpact()
Clarifies the severity of the issue.



String
getPrerenderedContent()
Details of the issue as a pre-rendered HTML.



String
getTitle()
Title of the issue.



AccountIssue
set(String fieldName,
   Object value) 


AccountIssue
setActions(List<Action> actions)
A list of actionable steps that can be executed to solve the issue.



AccountIssue
setImpact(AccountIssueImpact impact)
Clarifies the severity of the issue.



AccountIssue
setPrerenderedContent(String prerenderedContent)
Details of the issue as a pre-rendered HTML.



AccountIssue
setTitle(String title)
Title of the issue.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





AccountIssue
public AccountIssue()









Method Detail





getActions
public List<Action> getActions()
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.

Returns:
value or null for none








setActions
public AccountIssue setActions(List<Action> actions)
A list of actionable steps that can be executed to solve the issue. An example is requesting a
 re-review or providing arguments when merchant disagrees with the issue. Actions that are
 supported in (your) third-party application can be rendered as buttons and should be available
 to merchant when they expand the issue.

Parameters:
actions - actions or null for none








getImpact
public AccountIssueImpact getImpact()
Clarifies the severity of the issue. The summarizing message, if present, should be shown right
 under the title for each issue. It helps merchants to quickly understand the impact of the
 issue. The detailed breakdown helps the merchant to fully understand the impact of the issue.
 It can be rendered as dialog that opens when the merchant 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`.

Returns:
value or null for none








setImpact
public AccountIssue setImpact(AccountIssueImpact impact)
Clarifies the severity of the issue. The summarizing message, if present, should be shown right
 under the title for each issue. It helps merchants to quickly understand the impact of the
 issue. The detailed breakdown helps the merchant to fully understand the impact of the issue.
 It can be rendered as dialog that opens when the merchant 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`.

Parameters:
impact - impact or null for none








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](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 '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.

Returns:
value or null for none








setPrerenderedContent
public AccountIssue setPrerenderedContent(String prerenderedContent)
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 '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.

Parameters:
prerenderedContent - prerenderedContent or null for none








getTitle
public String getTitle()
Title of the issue.

Returns:
value or null for none








setTitle
public AccountIssue setTitle(String title)
Title of the issue.

Parameters:
title - title or null for none








set
public AccountIssue set(String fieldName,
                        Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public AccountIssue clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.
Modifier and Type	Method and Description
`AccountIssue`	`clone()`
`List<Action>`	`getActions()` A list of actionable steps that can be executed to solve the issue.
`AccountIssueImpact`	`getImpact()` Clarifies the severity of the issue.
`String`	`getPrerenderedContent()` Details of the issue as a pre-rendered HTML.
`String`	`getTitle()` Title of the issue.
`AccountIssue`	`set(String fieldName, Object value)`
`AccountIssue`	`setActions(List<Action> actions)` A list of actionable steps that can be executed to solve the issue.
`AccountIssue`	`setImpact(AccountIssueImpact impact)` Clarifies the severity of the issue.
`AccountIssue`	`setPrerenderedContent(String prerenderedContent)` Details of the issue as a pre-rendered HTML.
`AccountIssue`	`setTitle(String title)` Title of the issue.