View Source GoogleApi.Retail.V2.Model.GoogleCloudRetailV2Rating (google_api_retail v0.19.1)

The rating of a Product.

Attributes

  • averageRating (type: number(), default: nil) - The average rating of the Product. The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT error is returned.
  • ratingCount (type: integer(), default: nil) - 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.
  • ratingHistogram (type: list(integer()), default: nil) - 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.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Retail.V2.Model.GoogleCloudRetailV2Rating{
  averageRating: number() | nil,
  ratingCount: integer() | nil,
  ratingHistogram: [integer()] | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.