Method: accounts.productReviews.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://merchantapi.googleapis.com/reviews/v1beta/{parent=accounts/*}/productReviews
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The account to list product reviews for. Format: accounts/{account}
|
Query parameters
| Parameters |
pageSize |
integer
Optional. The maximum number of products to return. The service may return fewer than this value.
|
pageToken |
string
Optional. A page token, received from a previous productReviews.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to productReviews.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
response message for the productReviews.list method.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"productReviews": [
{
object (ProductReview)
}
],
"nextPageToken": string
} |
| Fields |
productReviews[] |
object (ProductReview)
The product review.
|
nextPageToken |
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/content
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 2025-02-25 UTC.
[null,null,["Last updated 2025-02-25 UTC."],[[["\u003cp\u003eLists product reviews for a specified Merchant Center account using the \u003ccode\u003eproductReviews.list\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eAccepts optional pagination parameters (\u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e) to control the results.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of \u003ccode\u003eProductReview\u003c/code\u003e objects and a \u003ccode\u003enextPageToken\u003c/code\u003e for accessing further pages, if available.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/content\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eUses a simple GET request with path and query parameters.\u003c/p\u003e\n"]]],["This document details how to list product reviews via an HTTP GET request to `https://merchantapi.googleapis.com/reviews/v1beta/{parent=accounts/*}/productReviews`. The `parent` path parameter specifies the account. Optional query parameters, `pageSize` and `pageToken`, control pagination. The request body must be empty. A successful response returns a JSON object containing an array of `productReviews` and a `nextPageToken` for subsequent pages. The operation requires the `https://www.googleapis.com/auth/content` OAuth scope.\n"],null,["# Method: accounts.productReviews.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.ListProductReviewsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists product reviews.\n\n### HTTP request\n\n`GET https://merchantapi.googleapis.com/reviews/v1beta/{parent=accounts/*}/productReviews`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The account to list product reviews for. Format: accounts/{account} |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. The maximum number of products to return. The service may return fewer than this value. |\n| `pageToken` | `string` Optional. A page token, received from a previous `productReviews.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `productReviews.list` must match the call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nresponse message for the productReviews.list method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"productReviews\": [ { object (/merchant/api/reference/rest/reviews_v1beta/accounts.productReviews#ProductReview) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|--------------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `productReviews[]` | `object (`[ProductReview](/merchant/api/reference/rest/reviews_v1beta/accounts.productReviews#ProductReview)`)` The product review. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/content`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
