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.
A collection of locations to fetch reviews for, specified by their names.
pageSize
integer
How many reviews to fetch per page. The default value is 50.
pageToken
string
If specified, it fetches the next page of reviews.
orderBy
string
Optional. 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. rating will return reviews in ascending order. updateTime(i.e. ascending order) is not supported.
ignoreRatingOnlyReviews
boolean
Whether to ignore rating-only reviews.
Response body
If successful, the response body contains data with the following structure:
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.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eBatch retrieves a paginated list of reviews for up to 50 specified, verified locations.\u003c/p\u003e\n"],["\u003cp\u003eRequest body allows filtering by page size, page token, order, and whether to ignore rating-only reviews.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes location-specific reviews and a token for retrieving subsequent pages, if available.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with either 'https://www.googleapis.com/auth/plus.business.manage' or 'https://www.googleapis.com/auth/business.manage' scope.\u003c/p\u003e\n"],["\u003cp\u003eEach location review object contains the location's name and the corresponding review details.\u003c/p\u003e\n"]]],[],null,["# Method: accounts.locations.batchGetReviews\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.BatchGetReviewsResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n- [LocationReview](#LocationReview)\n - [JSON representation](#LocationReview.SCHEMA_REPRESENTATION)\n\nReturns the paginated list of reviews for all specified locations. This operation is only valid if the specified locations are verified.\n| **Note:** Reviews are limited to a batch size of 50 `locationNames` per call.\n\n\u003cbr /\u003e\n\n### HTTP request\n\n`POST https://mybusiness.googleapis.com/v4/{name=accounts/*}/locations:batchGetReviews`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|------------------------------------------------------------------------------------------------------|\n| `name` | `string` The name of the account from which to retrieve a list of reviews across multiple locations. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation ||\n|------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"locationNames\": [ string ], \"pageSize\": integer, \"pageToken\": string, \"orderBy\": string, \"ignoreRatingOnlyReviews\": boolean } ``` |\n\n| Fields ||\n|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `locationNames[]` | `string` A collection of locations to fetch reviews for, specified by their names. |\n| `pageSize` | `integer` How many reviews to fetch per page. The default value is 50. |\n| `pageToken` | `string` If specified, it fetches the next page of reviews. |\n| `orderBy` | `string` Optional. 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`. `rating` will return reviews in ascending order. `updateTime`(i.e. ascending order) is not supported. |\n| `ignoreRatingOnlyReviews` | `boolean` Whether to ignore rating-only reviews. |\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse message for Reviews.BatchGetReviews.\n\n| JSON representation ||\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"locationReviews\": [ { object (/my-business/reference/rest/v4/accounts.locations/batchGetReviews#LocationReview) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `locationReviews[]` | `object (`[LocationReview](/my-business/reference/rest/v4/accounts.locations/batchGetReviews#LocationReview)`)` Reviews with location information. |\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 calls. If there are no more reviews, this field will not be 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).\n\nLocationReview\n--------------\n\nRepresents a review with location information.\n\n| JSON representation ||\n|---------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"name\": string, \"review\": { object (/my-business/reference/rest/v4/accounts.locations.reviews#Review) } } ``` |\n\n| Fields ||\n|----------|--------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Location resource name. |\n| `review` | `object (`[Review](/my-business/reference/rest/v4/accounts.locations.reviews#Review)`)` A review for the location. |"]]