Retail v2 API - Class Rating (2.5.0)

public sealed class Rating : IMessage<Rating>, IEquatable<Rating>, IDeepCloneable<Rating>, IBufferMessage, IMessage

Reference documentation and code samples for the Retail v2 API class Rating.

The rating of a [Product][google.cloud.retail.v2.Product].

Inheritance

object > Rating

Namespace

GoogleCloudGoogle.Cloud.RetailV2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

Rating()

public Rating()

Rating(Rating)

public Rating(Rating other)
Parameter
NameDescription
otherRating

Properties

AverageRating

public float AverageRating { get; set; }

The average rating of the [Product][google.cloud.retail.v2.Product].

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

Property Value
TypeDescription
float

RatingCount

public int RatingCount { get; set; }

The total number of ratings. This value is independent of the value of [rating_histogram][google.cloud.retail.v2.Rating.rating_histogram].

This value must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.

Property Value
TypeDescription
int

RatingHistogram

public RepeatedField<int> RatingHistogram { get; }

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][google.cloud.retail.v2.Product] got 41 ratings with 1 star, 14 ratings with 2 star, and so on.

Property Value
TypeDescription
RepeatedFieldint