Google Cloud Retail V2 Client - Class Rating (1.4.2)

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

Namespace

Google \ Cloud \ Retail \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
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.

Returns
TypeDescription
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.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getAverageRating

The average rating of the Product.

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

Returns
TypeDescription
float

setAverageRating

The average rating of the Product.

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

Parameter
NameDescription
var float
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var int[]
Returns
TypeDescription
$this