Retail V2 API - Class Google::Cloud::Retail::V2::Rating (v0.7.0)

Stay organized with collections Save and categorize content based on your preferences.

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::Rating.

The rating of a Product.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#average_rating

def average_rating() -> ::Float
Returns
  • (::Float) — The average rating of the Product.

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

#average_rating=

def average_rating=(value) -> ::Float
Parameter
  • value (::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.

#rating_count

def rating_count() -> ::Integer
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.

#rating_count=

def rating_count=(value) -> ::Integer
Parameter
  • value (::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.

#rating_histogram

def rating_histogram() -> ::Array<::Integer>
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.

#rating_histogram=

def rating_histogram=(value) -> ::Array<::Integer>
Parameter
  • value (::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.

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.