AI-generated Key Takeaways
-
Batch retrieves a paginated list of reviews for up to 50 specified, verified locations.
-
Request body allows filtering by page size, page token, order, and whether to ignore rating-only reviews.
-
Response includes location-specific reviews and a token for retrieving subsequent pages, if available.
-
Requires authorization with either 'https://www.googleapis.com/auth/plus.business.manage' or 'https://www.googleapis.com/auth/business.manage' scope.
-
Each location review object contains the location's name and the corresponding review details.
Returns the paginated list of reviews for all specified locations. This operation is only valid if the specified locations are verified.
HTTP request
POST https://mybusiness.googleapis.com/v4/{name=accounts/*}/locations:batchGetReviews
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
The name of the account from which to retrieve a list of reviews across multiple locations. |
Request body
The request body contains data with the following structure:
JSON representation | |
---|---|
{ "locationNames": [ string ], "pageSize": integer, "pageToken": string, "orderBy": string, "ignoreRatingOnlyReviews": boolean } |
Fields | |
---|---|
locationNames[] |
A collection of locations to fetch reviews for, specified by their names. |
pageSize |
How many reviews to fetch per page. The default value is 50. |
pageToken |
If specified, it fetches the next page of reviews. |
orderBy |
Optional. Specifies the field to sort reviews by. If unspecified, the order of reviews returned will default to |
ignoreRatingOnlyReviews |
Whether to ignore rating-only reviews. |
Response body
If successful, the response body contains data with the following structure:
Response message for Reviews.BatchGetReviews.
JSON representation | |
---|---|
{
"locationReviews": [
{
object ( |
Fields | |
---|---|
locationReviews[] |
Reviews with location information. |
nextPageToken |
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 calls. If there are no more reviews, this field will not be present in the response. |
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/plus.business.manage
https://www.googleapis.com/auth/business.manage
For more information, see the OAuth 2.0 Overview.
LocationReview
Represents a review with location information.
JSON representation | |
---|---|
{
"name": string,
"review": {
object ( |
Fields | |
---|---|
name |
Location resource name. |
review |
A review for the location. |