Page Summary
-
This code sample demonstrates how to list all product reviews associated with a specific account using the Google Merchant API.
-
The Java code uses the
ProductReviewsServiceClientto send aListProductReviewsRequestand retrieve product review data. -
The sample iterates through all the pages of the response to print every product review, as well as provide a count of the reviews retrieved.
-
The code uses a Google credential setup to be able to connect to the service, and it leverages a configuration setup to set the Account ID.
Merchant API code sample to list product reviews.
Java
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package
shopping.merchant.samples.reviews.v1beta
;
import
com.google.api.gax.core.FixedCredentialsProvider
;
import
com.google.auth.oauth2.GoogleCredentials
;
import
com.google.shopping.merchant.reviews.v1beta.ListProductReviewsRequest
;
import
com.google.shopping.merchant.reviews.v1beta.ProductReview
;
import
com.google.shopping.merchant.reviews.v1beta.ProductReviewsServiceClient
;
import
com.google.shopping.merchant.reviews.v1beta.ProductReviewsServiceClient.ListProductReviewsPagedResponse
;
import
com.google.shopping.merchant.reviews.v1beta.ProductReviewsServiceSettings
;
import
shopping.merchant.samples.utils.Authenticator
;
import
shopping.merchant.samples.utils.Config
;
/** This class demonstrates how to list all the product reviews in a given account. */
public
class
ListProductReviewsSample
{
public
static
void
listProductReviews
(
String
accountId
)
throws
Exception
{
GoogleCredentials
credential
=
new
Authenticator
().
authenticate
();
ProductReviewsServiceSettings
productReviewsServiceSettings
=
ProductReviewsServiceSettings
.
newBuilder
()
.
setCredentialsProvider
(
FixedCredentialsProvider
.
create
(
credential
))
.
build
();
try
(
ProductReviewsServiceClient
productReviewsServiceClient
=
ProductReviewsServiceClient
.
create
(
productReviewsServiceSettings
))
{
ListProductReviewsRequest
request
=
ListProductReviewsRequest
.
newBuilder
()
.
setParent
(
String
.
format
(
"accounts/%s"
,
accountId
))
.
build
();
System
.
out
.
println
(
"Sending list product reviews request:"
);
ListProductReviewsPagedResponse
response
=
productReviewsServiceClient
.
listProductReviews
(
request
);
int
count
=
0
;
// Iterates over all rows in all pages and prints all product reviews.
for
(
ProductReview
element
:
response
.
iterateAll
())
{
System
.
out
.
println
(
element
);
count
++
;
}
System
.
out
.
print
(
"The following count of elements were returned: "
);
System
.
out
.
println
(
count
);
}
catch
(
Exception
e
)
{
System
.
out
.
println
(
e
);
}
}
public
static
void
main
(
String
[]
args
)
throws
Exception
{
Config
config
=
Config
.
load
();
listProductReviews
(
config
.
getAccountId
().
toString
());
}
}
PHP
< ?php
/**
* Copyright 2025 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
require_once __DIR__ . '/../../../vendor/autoload.php';
require_once __DIR__ . '/../../Authentication/Authentication.php';
require_once __DIR__ . '/../../Authentication/Config.php';
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Reviews\V1beta\Client\ProductReviewsServiceClient;
use Google\Shopping\Merchant\Reviews\V1beta\ListProductReviewsRequest;
/**
* This class demonstrates how to list all the product reviews in a given account.
*/
class ListProductReviewsSample
{
/**
* Lists all product reviews for a given account.
*
* @param array $config The configuration data for authentication and account ID.
*/
public static function listProductReviewsSample(array $config): void
{
// Gets the OAuth credentials to make the request.
$credentials = Authentication::useServiceAccountOrTokenFile();
// Creates options config containing credentials for the client to use.
$options = ['credentials' => $credentials];
// Creates a client.
$productReviewsServiceClient = new ProductReviewsServiceClient($options);
// The parent account from which to retrieve reviews.
// Format: accounts/{account}
$parent = sprintf('accounts/%s', $config['accountId']);
// Creates the request message.
$request = (new ListProductReviewsRequest())
->setParent($parent);
// Calls the API and catches and prints any network failures/errors.
try {
printf("Sending list product reviews request:%s", PHP_EOL);
$response = $productReviewsServiceClient->listProductReviews($request);
$count = 0;
// Iterates over all rows in all pages and prints all product reviews.
foreach ($response->iterateAllElements() as $element) {
printf("%s%s", $element->serializeToJsonString(), PHP_EOL);
$count++;
}
printf("The following count of elements were returned: %d%s", $count, PHP_EOL);
} catch (ApiException $e) {
print $e->getMessage() . PHP_EOL;
}
}
/**
* Helper to execute the sample.
*/
public function callSample(): void
{
$config = Config::generateConfig();
self::listProductReviewsSample($config);
}
}
// Run the script.
$sample = new ListProductReviewsSample();
$sample->callSample();
