Class: Google::Apis::ContentV2_1::ProductIssue

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/content_v2_1/classes.rb,
lib/google/apis/content_v2_1/representations.rb,
lib/google/apis/content_v2_1/representations.rb

Overview

An issue affecting specific product.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ProductIssue

Returns a new instance of ProductIssue.



9766
9767
9768
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9766

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#actions ⇒ Array<Google::Apis::ContentV2_1::Action>

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. Corresponds to the JSON property actions

Returns:



9675
9676
9677
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9675

def actions
  @actions
end

#impact ⇒ Google::Apis::ContentV2_1::ProductIssueImpact

Overall impact of product issue. Corresponds to the JSON property impact

Returns:



9680
9681
9682
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9680

def impact
  @impact
end

#prerendered_content ⇒ String

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. * list-intro - marks the paragraph that contains an intro for a list. This paragraph will be always followed by a list. * 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. Corresponds to the JSON property prerenderedContent

Returns:

  • (String) 


9722
9723
9724
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9722

def prerendered_content
  @prerendered_content
end

#prerendered_out_of_court_dispute_settlement ⇒ String

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 merchant 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 merchants 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. Corresponds to the JSON property prerenderedOutOfCourtDisputeSettlement

Returns:

  • (String) 


9759
9760
9761
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9759

def prerendered_out_of_court_dispute_settlement
  @prerendered_out_of_court_dispute_settlement
end

#title ⇒ String

Title of the issue. Corresponds to the JSON property title

Returns:

  • (String) 


9764
9765
9766
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9764

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9771
9772
9773
9774
9775
9776
9777
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9771

def update!(**args)
  @actions = args[:actions] if args.key?(:actions)
  @impact = args[:impact] if args.key?(:impact)
  @prerendered_content = args[:prerendered_content] if args.key?(:prerendered_content)
  @prerendered_out_of_court_dispute_settlement = args[:prerendered_out_of_court_dispute_settlement] if args.key?(:prerendered_out_of_court_dispute_settlement)
  @title = args[:title] if args.key?(:title)
end