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.
Method: accounts.locations.reviews.list
Stay organized with collections
Save and categorize content based on your preferences.
Returns the paginated list of reviews for the specified location. This operation is only valid if the specified location is verified.
HTTP request
GET https://mybusiness.googleapis.com/v4/{parent=accounts/*/locations/*}/reviews
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
The name of the location to fetch reviews for.
|
Query parameters
| Parameters |
pageSize |
integer
How many reviews to fetch per page. The maximum pageSize is 50.
|
pageToken |
string
If specified, it fetches the next page of reviews.
|
orderBy |
string
Specifies the field to sort reviews by. If unspecified, the order of reviews returned will default to updateTime desc. Valid orders to sort by are rating, rating desc and updateTime desc.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Response message for Reviews.ListReviews.
| JSON representation |
{
"reviews": [
{
object (Review)
}
],
"averageRating": number,
"totalReviewCount": integer,
"nextPageToken": string
} |
| Fields |
reviews[] |
object (Review)
The reviews.
|
averageRating |
number
The average star rating of all reviews for this location on a scale of 1 to 5, where 5 is the highest rating.
|
totalReviewCount |
integer
The total number of reviews for this location.
|
nextPageToken |
string
If the number of reviews exceeded the requested page size, this field is populated with a token to fetch the next page of reviews on a subsequent call to reviews.list. If there are no more reviews, this field is not present in the response.
|
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/plus.business.managehttps://www.googleapis.com/auth/business.manage
For more information, see the OAuth 2.0 Overview.
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\u003eRetrieves a paginated list of reviews for a specified, verified Google My Business location.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by page size, page token, and sorting order (rating, rating descending, or update time descending).\u003c/p\u003e\n"],["\u003cp\u003eReturns review details, average rating, total review count, and a token for retrieving subsequent pages if available.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with specific OAuth scopes for business management.\u003c/p\u003e\n"]]],["This content outlines the process of retrieving a paginated list of reviews for a verified location using a `GET` request to a specific URL. The URL utilizes path parameters like `parent` to identify the location. Query parameters such as `pageSize`, `pageToken`, and `orderBy` are used to manage pagination and sorting. The request body is empty. A successful response returns a JSON object containing a list of `reviews`, `averageRating`, `totalReviewCount`, and optionally `nextPageToken` for pagination. Authorization requires specific OAuth scopes.\n"],null,["# Method: accounts.locations.reviews.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListReviewsResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n\nReturns the paginated list of reviews for the specified location. This operation is only valid if the specified location is verified.\n\n### HTTP request\n\n`GET https://mybusiness.googleapis.com/v4/{parent=accounts/*/locations/*}/reviews`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|---------------------------------------------------------|\n| `parent` | `string` The name of the location to fetch reviews for. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` How many reviews to fetch per page. The maximum `pageSize` is 50. |\n| `pageToken` | `string` If specified, it fetches the next page of reviews. |\n| `orderBy` | `string` Specifies the field to sort reviews by. If unspecified, the order of reviews returned will default to `updateTime desc`. Valid orders to sort by are `rating`, `rating desc` and `updateTime desc`. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse message for Reviews.ListReviews.\n\n| JSON representation ||\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"reviews\": [ { object (/my-business/reference/rest/v4/accounts.locations.reviews#Review) } ], \"averageRating\": number, \"totalReviewCount\": integer, \"nextPageToken\": string } ``` |\n\n| Fields ||\n|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `reviews[]` | `object (`[Review](/my-business/reference/rest/v4/accounts.locations.reviews#Review)`)` The reviews. |\n| `averageRating` | `number` The average star rating of all reviews for this location on a scale of 1 to 5, where 5 is the highest rating. |\n| `totalReviewCount` | `integer` The total number of reviews for this location. |\n| `nextPageToken` | `string` If the number of reviews exceeded the requested page size, this field is populated with a token to fetch the next page of reviews on a subsequent call to reviews.list. If there are no more reviews, this field is not present in the response. |\n\n### Authorization Scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/plus.business.manage`\n- `https://www.googleapis.com/auth/business.manage`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]