Reference documentation and code samples for the Google Cloud Retail V2 Client class Rating.
The rating of a Product .
Generated from protobuf message google.cloud.retail.v2.Rating
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ rating_count
int
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.
↳ average_rating
float
The average rating of the Product . The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT error is returned.
↳ rating_histogram
array
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.
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.
Generated from protobuf field int32 rating_count = 1;
int
setRatingCount
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.
Generated from protobuf field int32 rating_count = 1;
var
int
$this
getAverageRating
The average rating of the Product .
The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT error is returned.
Generated from protobuf field float average_rating = 2;
float
setAverageRating
The average rating of the Product .
The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT error is returned.
Generated from protobuf field float average_rating = 2;
var
float
$this
getRatingHistogram
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.
Generated from protobuf field repeated int32 rating_histogram = 3;
Google\Protobuf\Internal\RepeatedField
setRatingHistogram
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.
Generated from protobuf field repeated int32 rating_histogram = 3;
var
int[]
$this
