# Retail V2 API - Class Google::Cloud::Retail::V2::Rating (v2.9.0)

2.9.0 (latest) 2.8.1 2.7.0 2.6.1 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.3.0 1.2.0 1.1.0 1.0.1 0.21.0 0.20.0 0.19.0 0.18.2 0.17.0 0.16.1 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.4 Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::Rating.

The rating of a [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)").

## 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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)").


  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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)").


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

- (::Float) --- The average rating of the [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)").


  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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Rating#Google__Cloud__Retail__V2__Rating_rating_histogram_instance_ "Google::Cloud::Retail::V2::Rating#rating_histogram (method)").


  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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Rating#Google__Cloud__Retail__V2__Rating_rating_histogram_instance_ "Google::Cloud::Retail::V2::Rating#rating_histogram (method)").


  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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Rating#Google__Cloud__Retail__V2__Rating_rating_histogram_instance_ "Google::Cloud::Retail::V2::Rating#rating_histogram (method)").


  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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)") 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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)") 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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)") got 41 ratings with 1 star, 14
  ratings with 2 star, and so on.