Google Business Performance API has a
NEW API method that allows fetching multiple `DailyMetrics` in a single API request. Review the
deprecation schedule and instructions to migrate over from v4 reportInsights API method to Google Business Profile Performance API.
REST Resource: accounts.locations.reviews
Stay organized with collections
Save and categorize content based on your preferences.
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.
|
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 |
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 |
|
|
Deletes the response to the specified review. |
|
|
Returns the specified review. |
|
|
Returns the paginated list of reviews for the specified location. |
|
|
Updates the reply to the specified review. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eThis document outlines the structure and properties of a Google My Business review, including details about the reviewer, star rating, and any replies.\u003c/p\u003e\n"],["\u003cp\u003eReviews can be retrieved, listed, and have their replies updated or deleted using the provided methods.\u003c/p\u003e\n"],["\u003cp\u003eReview data includes timestamps for creation and updates, as well as the review text and star rating.\u003c/p\u003e\n"],["\u003cp\u003eReviewers can choose to remain anonymous, impacting the visibility of their profile information.\u003c/p\u003e\n"],["\u003cp\u003eLocation owners/managers can reply to reviews, and these replies also have timestamps for tracking modifications.\u003c/p\u003e\n"]]],["This document details the structure of location reviews, including the review itself, the reviewer, and any replies. A review includes a `reviewId`, `starRating`, textual `comment`, and timestamps for creation and updates. The reviewer has a `displayName`, `profilePhotoUrl`, and anonymity status. The reply includes a `comment` and its last update time. The document also outlines methods to delete, get, list, and update replies to reviews.\n"],null,["# REST Resource: accounts.locations.reviews\n\n- [Resource: Review](#Review)\n - [JSON representation](#Review.SCHEMA_REPRESENTATION)\n- [Reviewer](#Reviewer)\n - [JSON representation](#Reviewer.SCHEMA_REPRESENTATION)\n- [StarRating](#StarRating)\n- [ReviewReply](#ReviewReply)\n - [JSON representation](#ReviewReply.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Review\n----------------\n\nOutput only. Represents a review for a location.\n\n| JSON representation ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"name\": string, \"reviewId\": string, \"reviewer\": { object (/my-business/reference/rest/v4/accounts.locations.reviews#Reviewer) }, \"starRating\": enum (/my-business/reference/rest/v4/accounts.locations.reviews#StarRating), \"comment\": string, \"createTime\": string, \"updateTime\": string, \"reviewReply\": { object (/my-business/reference/rest/v4/accounts.locations.reviews#ReviewReply) } } ``` |\n\n| Fields ||\n|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The resource name. For Review it is of the form `accounts/{accountId}/locations/{locationId}/reviews/{reviewId}` |\n| `reviewId` | `string` The encrypted unique identifier. |\n| `reviewer` | `object (`[Reviewer](/my-business/reference/rest/v4/accounts.locations.reviews#Reviewer)`)` The author of the review. |\n| `starRating` | `enum (`[StarRating](/my-business/reference/rest/v4/accounts.locations.reviews#StarRating)`)` The star rating of the review. |\n| `comment` | `string` The body of the review as plain text with markups. |\n| `createTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.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\"`. |\n| `updateTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.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\"`. |\n| `reviewReply` | `object (`[ReviewReply](/my-business/reference/rest/v4/accounts.locations.reviews#ReviewReply)`)` The owner/manager of this location's reply to this review. |\n\nReviewer\n--------\n\nRepresents the author of the review.\n\n| JSON representation ||\n|--------------------------------------------------------------------------------------|---|\n| ``` { \"profilePhotoUrl\": string, \"displayName\": string, \"isAnonymous\": boolean } ``` |\n\n| Fields ||\n|-------------------|------------------------------------------------------------------------------------------------------------|\n| `profilePhotoUrl` | `string` The profile photo link of the reviewer. Only populated if `isAnonymous` is false. |\n| `displayName` | `string` The name of the reviewer. Only populated with the reviewer's real name if `isAnonymous` is false. |\n| `isAnonymous` | `boolean` Indicates whether the reviewer has opted to remain anonymous. |\n\nStarRating\n----------\n\nThe star rating out of five, where five is the highest rated.\n\n| Enums ||\n|---------------------------|---------------------------------------|\n| `STAR_RATING_UNSPECIFIED` | Not specified. |\n| `ONE` | One star out of a maximum of five. |\n| `TWO` | Two stars out of a maximum of five. |\n| `THREE` | Three stars out of a maximum of five. |\n| `FOUR` | Four stars out of a maximum of five. |\n| `FIVE` | The maximum star rating. |\n\nReviewReply\n-----------\n\nRepresents the location owner/manager's reply to a review.\n\n| JSON representation ||\n|-----------------------------------------------------|---|\n| ``` { \"comment\": string, \"updateTime\": string } ``` |\n\n| Fields ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `comment` | `string` The body of the reply as plain text with markups. The maximum length is 4096 bytes. |\n| `updateTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.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\"`. |\n\n| Methods ------- ||\n|------------------------------------------------------------------------------------------|-------------------------------------------------------------------|\n| ### [deleteReply](/my-business/reference/rest/v4/accounts.locations.reviews/deleteReply) | Deletes the response to the specified review. |\n| ### [get](/my-business/reference/rest/v4/accounts.locations.reviews/get) | Returns the specified review. |\n| ### [list](/my-business/reference/rest/v4/accounts.locations.reviews/list) | Returns the paginated list of reviews for the specified location. |\n| ### [updateReply](/my-business/reference/rest/v4/accounts.locations.reviews/updateReply) | Updates the reply to the specified review. |"]]