REST Resource: accounts.locations.reviews

Resource: Review

Output only. Represents a review for a location.

JSON representation
{
  "name": string,
  "reviewId": string,
  "reviewer": {
    object(Reviewer)
  },
  "starRating": enum(StarRating),
  "comment": string,
  "createTime": string,
  "updateTime": string,
  "reviewReply": {
    object(ReviewReply)
  }
}
Fields
name

string

The resource name. For Review it is of the form accounts/{account_id}/locations/{location_id}/reviews/{reviewId}

reviewId

string

The encrypted unique identifier.

reviewer

object(Reviewer)

The author of the review.

starRating

enum(StarRating)

The star rating of the review.

comment

string

The body of the review as plain text with markups.

createTime

string (Timestamp format)

The timestamp for when the review was written.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

The timestamp for when the review was last modified.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

reviewReply

object(ReviewReply)

The owner/manager of this location's reply to this review.

Reviewer

Represents the author of the review.

JSON representation
{
  "displayName": string,
  "isAnonymous": boolean
}
Fields
displayName

string

The name of the reviewer. Only populated with the reviewer's real name if isAnonymous is false.

isAnonymous

boolean

Indicates whether the reviewer has opted to remain anonymous.

StarRating

The star rating out of five, where five is the highest rated.

Enums
STAR_RATING_UNSPECIFIED Not specified.
ONE One star out of a maximum of five.
TWO Two stars out of a maximum of five.
THREE Three stars out of a maximum of five.
FOUR Four stars out of a maximum of five.
FIVE The maximum star rating.

ReviewReply

Represents the location owner/manager's reply to a review.

JSON representation
{
  "comment": string,
  "updateTime": string
}
Fields
comment

string

The body of the reply as plain text with markups. The maximum length is 4096 bytes.

updateTime

string (Timestamp format)

Output only. The timestamp for when the reply was last modified.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

Methods

deleteReply

Deletes the response to the specified review.

get

Returns the specified review.

list

Returns the paginated list of reviews for the specified location.

updateReply

Updates the reply to the specified review.

Send feedback about...

Google My Business API
Google My Business API
Need help? Visit our support page.