Class google.gdata.Rating

Object
   |
   +--google.gdata.Rating

class google.gdata.Rating

Describes a rating.
Defined in gdata.js

Field Detail

average

{string|undefined} average

Average rating. This attribute is optional.

max

{string|undefined} max

Rating scale's maximum value. This attribute is optional.

min

{string|undefined} min

Rating scale's minimum value. This attribute is optional.

numRaters

{string|undefined} numRaters

Number of ratings taken into account when computing the average value. This attribute is optional.

rel

{string|undefined} rel

Programmatic value that describes the aspect that's being rated, if not specified, the rating is an overall rating. This attribute is optional.

value

{string|undefined} value

Rating value. This attribute is optional.

REL_OVERALL

<static> <final> {string} REL_OVERALL

Overall rating, higher values mean better ratings.

REL_PRICE

<static> <final> {string} REL_PRICE

Price rating, higher values mean better ratings.

REL_QUALITY

<static> <final> {string} REL_QUALITY

Quality rating, higher values mean better ratings.

google.gdata.Rating

google.gdata.Rating(<Object> opt_params)

Constructs a rating using an object parameter whose property names match the setter method to use for each property.

Parameters:
opt_params - Optional parameters, each of which is used as the sole parameter to the associated setter method: average, max, min, numRaters, rel, and value.

getAverage

number|undefined getAverage()

Returns the average rating. This attribute is optional.

Returns:
Average rating or undefined for none.

getMax

number|undefined getMax()

Returns the rating scale's maximum value. This attribute is optional.

Returns:
Rating scale's maximum value or undefined for none.

getMin

number|undefined getMin()

Returns the rating scale's minimum value. This attribute is optional.

Returns:
Rating scale's minimum value or undefined for none.

getNumRaters

number|undefined getNumRaters()

Returns the number of ratings taken into account when computing the average value. This attribute is optional.

Returns:
Number of ratings taken into account when computing the average value or undefined for none.

getRel

string|undefined getRel()

Returns the programmatic value that describes the aspect that's being rated, if not specified, the rating is an overall rating. This attribute is optional.

Returns:
Programmatic value that describes the aspect that's being rated, if not specified, the rating is an overall rating or undefined for none.

getValue

number|undefined getValue()

Returns the rating value. This attribute is optional.

Returns:
Rating value or undefined for none.

setAverage

void setAverage(<number|undefined> average)

Sets the average rating. This attribute is optional.

Parameters:
average - Average rating or undefined for none.

setMax

void setMax(<number|undefined> max)

Sets the rating scale's maximum value. This attribute is optional.

Parameters:
max - Rating scale's maximum value or undefined for none.

setMin

void setMin(<number|undefined> min)

Sets the rating scale's minimum value. This attribute is optional.

Parameters:
min - Rating scale's minimum value or undefined for none.

setNumRaters

void setNumRaters(<number|undefined> numRaters)

Sets the number of ratings taken into account when computing the average value. This attribute is optional.

Parameters:
numRaters - Number of ratings taken into account when computing the average value or undefined for none.

setRel

void setRel(<string|undefined> rel)

Sets the programmatic value that describes the aspect that's being rated, if not specified, the rating is an overall rating. This attribute is optional.

Parameters:
rel - Programmatic value that describes the aspect that's being rated, if not specified, the rating is an overall rating or undefined for none.

setValue

void setValue(<number|undefined> value)

Sets the rating value. This attribute is optional.

Parameters:
value - Rating value or undefined for none.