Class: Google::Apis::RetailV2::GoogleCloudRetailV2Rating

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

Overview

The rating of a Product.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2Rating

Returns a new instance of GoogleCloudRetailV2Rating.



2162
2163
2164
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2162

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

Instance Attribute Details

#average_rating ⇒ Float

The average rating of the Product. The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property averageRating

Returns:

  • (Float) 


2144
2145
2146
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2144

def average_rating
  @average_rating
end

#rating_count ⇒ Fixnum

The total number of ratings. This value is independent of the value of rating_histogram. This value must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property ratingCount

Returns:

  • (Fixnum) 


2151
2152
2153
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2151

def rating_count
  @rating_count
end

#rating_histogram ⇒ Array<Fixnum>

List of rating counts per rating value (index = rating - 1). The list is empty if there is no rating. If the list is non-empty, its size is always 5. Otherwise, an INVALID_ARGUMENT error is returned. For example, [41, 14, 13, 47, 303]. It means that the Product got 41 ratings with 1 star, 14 ratings with 2 star, and so on. Corresponds to the JSON property ratingHistogram

Returns:

  • (Array<Fixnum>) 


2160
2161
2162
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2160

def rating_histogram
  @rating_histogram
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2167
2168
2169
2170
2171
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2167

def update!(**args)
  @average_rating = args[:average_rating] if args.key?(:average_rating)
  @rating_count = args[:rating_count] if args.key?(:rating_count)
  @rating_histogram = args[:rating_histogram] if args.key?(:rating_histogram)
end