REST Resource: accounts.locations.reviews

    • This document outlines the structure and properties of a Google My Business review, including details about the reviewer, star rating, and any replies.

    • Reviews can be retrieved, listed, and have their replies updated or deleted using the provided methods.

    • Review data includes timestamps for creation and updates, as well as the review text and star rating.

    • Reviewers can choose to remain anonymous, impacting the visibility of their profile information.

    • Location owners/managers can reply to reviews, and these replies also have timestamps for tracking modifications.

    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/{accountId}/locations/{locationId}/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, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "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, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "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 
     { 
 "profilePhotoUrl" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "isAnonymous" 
 : 
 boolean 
 }
    Fields
    profilePhotoUrl

    string

    The profile photo link of the reviewer. Only populated if isAnonymous is false.
    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, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "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.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: