Interface RatingOrBuilder (2.47.0)

public interface RatingOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAverageRating()

public abstract float getAverageRating()

The average rating of the Product.

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

float average_rating = 2;

Returns
Type Description
float

The averageRating.

getRatingCount()

public abstract int getRatingCount()

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.

int32 rating_count = 1;

Returns
Type Description
int

The ratingCount.

getRatingHistogram(int index)

public abstract int getRatingHistogram(int index)

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.

repeated int32 rating_histogram = 3;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
int

The ratingHistogram at the given index.

getRatingHistogramCount()

public abstract int getRatingHistogramCount()

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.

repeated int32 rating_histogram = 3;

Returns
Type Description
int

The count of ratingHistogram.

getRatingHistogramList()

public abstract List<Integer> getRatingHistogramList()

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.

repeated int32 rating_histogram = 3;

Returns
Type Description
List<Integer>

A list containing the ratingHistogram.