Class: Google::Cloud::Retail::V2::Rating

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/retail/v2/common.rb

Overview

The rating of a Product.

Instance Attribute Summary collapse

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.

Returns:

  • (::Float) —

    The average rating of the Product.

    The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT error is returned.



741
742
743
744
 
# File 'proto_docs/google/cloud/retail/v2/common.rb', line 741

class Rating
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#rating_count ⇒ ::Integer

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.

Returns:

  • (::Integer) —

    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.



741
742
743
744
 
# File 'proto_docs/google/cloud/retail/v2/common.rb', line 741

class Rating
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#rating_histogram ⇒ ::Array<::Integer>

Returns 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.

Returns:

  • (::Array<::Integer>) —

    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.



741
742
743
744
 
# File 'proto_docs/google/cloud/retail/v2/common.rb', line 741

class Rating
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end