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)
  },
  "reviewMediaItems": [
    {
      object (ReviewMediaItem)
    }
  ]
}
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.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

The timestamp for when the review was last modified.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

reviewReply

object (ReviewReply)

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

reviewMediaItems[]

object (ReviewMediaItem)

Output only. The media items associated with the 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,
  "reviewReplyState": enum (State),
  "policyViolation": enum (PolicyViolation)
}
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.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

reviewReplyState

enum (State)

Output only. The state of the review reply.

policyViolation

enum (PolicyViolation)

Optional. Output only. The policy violation that resulted in rejection. Only populated if reviewReplyState is REJECTED.

State

Represents the moderation state of a review reply.

Enums
REVIEW_REPLY_STATE_UNSPECIFIED Indicates that the state is unspecified.
PENDING Indicates that the reply is pending moderation.
REJECTED Indicates that the reply was rejected.
APPROVED Indicates that the reply was approved.

PolicyViolation

Represents standardized policy violations. New values may be added in the future. Clients should be prepared to handle unknown values.

Enums
POLICY_VIOLATION_UNSPECIFIED Represents an unspecified policy violation.
ACCOUNT_RESTRICTED_AND_SUSPENDED A Google Account associated with this Business Profile has been placed under restriction, resulting in the suspension of the Business Profile.
ACCOUNT_RESTRICTED_AND_EDIT_REJECTED A Google Account associated with this Business Profile has been placed under restriction, causing edits to be rejected. Unlike ACCOUNT_RESTRICTED_AND_SUSPENDED, the Business Profile itself remains active and is not suspended.
ASSOCIATED_ACCOUNT_SUSPENDED A Google Account associated with this Business Profile is not in good standing. Business Profiles associated with that account have been suspended.
BUSINESS_INELIGIBLE Your business is not eligible for a Business Profile.
OWNERSHIP_REVOKED Another Google Account has claimed this Business Profile. You can no longer manage this profile.
LOCATION_SUSPENDED This Business Profile has been suspended.
LOCATION_DISABLED This Business Profile has been disabled.
LOCATION_VERIFICATION_REQUIRED This Business Profile is not verified.
PO_BOX Your Business Profile has been suspended because your business address can't be a PO box.
GOOGLE_PAY_SUSPENSION Business Profiles associated with your Payments profile have been suspended.
EDITING_RESTRICTION This Business Profile is currently restricted from receiving public updates. Google has turned editing for this location to prevent policy-violating content.
ILLEGAL_BUSINESS_HOURS_EDIT Your business category can't edit business hours.
FAKE_ENGAGEMENT Content that violates our policy on fake engagement isn't allowed. Fake engagement includes incentivized content, content intended to manipulate a place's rating, and other content that doesn't represent a genuine experience.
ADULT_THEMED Content that violates our policy on adult-themed content isn't allowed. Adult themes include both non-explicit sexual content and other adult content.
SEXUALLY_EXPLICIT Content that violates our policy on sexually explicit content isn't allowed. Sexually explicit content includes genital nudity or depictions or descriptions of sexual acts.
ADVERTISING_AND_SOLICITATION Content that violates our policy on advertising or solicitation isn't allowed. Advertising and solicitation includes promotional or commercial content, or content posted in exchange for benefits.
DANGEROUS Content that violates our policy on dangerous content isn't allowed. Dangerous content promotes, facilitates, or encourages harmful acts.
GIBBERISH_AND_REPETITIVE Content that violates our policy on unclear or repetitive content isn't allowed. Unclear or repetitive content dilutes useful information others can find on Google.
REPETITIVE Content that violates our policy on repetitive content isn't allowed. Repetitive content includes identical or similar content added multiple times by one or more accounts.
UNCLEAR Content that violates our policy on unclear content isn't allowed. Unclear content includes random characters or other content that lacks meaning.
ILLEGAL Content that violates our policy on illegal content isn't allowed.
OFF_TOPIC Content that violates our policy on off-topic content isn't allowed. Off-topic content includes general, political, or social commentary, and personal rants.
OFFENSIVE Content that violates our policy on offensive content isn't allowed. Offensive content may reasonably cause another to experience extreme anger, insult, or disrespect.
VIOLENCE_AND_GORE Content that violates our policy on violence and gore isn't allowed. Violence and gore includes content involving people or animals that is extreme and depicts realistic acts of violence, blood, body parts, or viscera.
CHILD_SAFETY Content that violates our policy on child safety isn't allowed. This includes subject matter that puts children at risk, exploits or abuses children, or uses Google services to endanger children.
HARASSMENT Content that violates our policy on harassment isn't allowed. This includes content that bullies, threatens, sexualizes, or causes a person to fear for their safety.
HATE_SPEECH Content that violates our policy on hate speech isn't allowed. Hate speech includes promoting or condoning violence, discrimination, disparagement, or inciting hatred based on a protected characteristic or other characteristics associated with systemic discrimination or marginalization.
IMPERSONATION Content that violates our policy on impersonation isn't allowed. Impersonation includes assuming a false identity in order to mislead others or gain improper benefits.
MISINFORMATION Content that violates our policy on misinformation isn't allowed. Misinformation includes false or inaccurate information that may cause significant harm to individuals, businesses, or society.
MISREPRESENTATION Content that violates our policy on misrepresentation isn't allowed. Misrepresentation includes misleading representations or omissions for the purpose of gaining improper benefit.
OBSCENITY_AND_PROFANITY Content that violates our policy on obscenity or profanity isn't allowed. Obscenity and profanity includes words or gestures that are locally considered socially offensive or vulgar.
PERSONAL_INFO Content that violates our policy on personal information isn't allowed. Personal information includes private or confidential information, such as credit card details, medical records, or government-issued identification, whether yours or someone else's.
REGULATED_GOODS_AND_SERVICES Content that violates our policy on regulated goods and services isn't allowed. This includes featuring calls to action or offers for the sale of products or services that are subject to local legal regulations.
GENERIC_VANDALISM Content that violates our policies on abusive or low quality content isn't allowed.
GENERIC_FRAUD Content that violates our policies on deceptive content and behavior isn't allowed. Deceptive content intentionally misleads or deceives others.
PHOTOS_AND_VIDEOS_CRITERIA Content that doesn't follow our photo and video criteria isn't allowed.
MODERATION_ERROR An error occurred while processing your content.
PRIVACY Content that violates the Maps User Contributed Content privacy policy isn't allowed.
GENERIC_VIOLATION Your content violates our policies and isn't allowed.
GENERIC_QUALITY Content that violates our policies on low quality content isn't allowed.
IDENTITY_CHANGE The change made by you is very different from the business created. This violates our policy.
GEOGRAPHIC_LOCATION_CHANGE Indicates the physical geographic location (address or latitude/longitude) of the business has changed significantly since the profile was created.

ReviewMediaItem

Represents a media item (photo or video) associated with a review.

JSON representation
{
  "thumbnailUrl": string,
  "thumbnailLabel": string,
  "videoUrl": string
}
Fields
thumbnailUrl

string

Output only. FIFE url for the photo, or video thumbnail if videoUrl is present.

thumbnailLabel

string

Output only. Author-provided label for the thumbnailUrl.

videoUrl

string

Output only. Playable video url.

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.