List merchant reviews

Merchant API code sample to list merchant reviews.

Java

// 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.

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.ListMerchantReviewsRequest;
import com.google.shopping.merchant.reviews.v1beta.MerchantReview;
import com.google.shopping.merchant.reviews.v1beta.MerchantReviewsServiceClient;
import com.google.shopping.merchant.reviews.v1beta.MerchantReviewsServiceClient.ListMerchantReviewsPagedResponse;
import com.google.shopping.merchant.reviews.v1beta.MerchantReviewsServiceSettings;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;

/** This class demonstrates how to list all the merchant reviews in a given account. */
public class ListMerchantReviewsSample {

  public static void listMerchantReviews(String accountId) throws Exception {
    GoogleCredentials credential = new Authenticator().authenticate();

    MerchantReviewsServiceSettings merchantReviewsServiceSettings =
        MerchantReviewsServiceSettings.newBuilder()
            .setCredentialsProvider(FixedCredentialsProvider.create(credential))
            .build();

    try (MerchantReviewsServiceClient merchantReviewsServiceClient =
        MerchantReviewsServiceClient.create(merchantReviewsServiceSettings)) {

      ListMerchantReviewsRequest request =
          ListMerchantReviewsRequest.newBuilder()
              .setParent(String.format("accounts/%s", accountId))
              .build();

      System.out.println("Sending list merchant reviews request:");
      ListMerchantReviewsPagedResponse response =
          merchantReviewsServiceClient.listMerchantReviews(request);

      int count = 0;

      // Iterates over all rows in all pages and prints all merchant reviews.
      for (MerchantReview 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();
    listMerchantReviews(config.getAccountId().toString());
  }
}
ListMerchantReviewsSample.java

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\MerchantReviewsServiceClient;
use Google\Shopping\Merchant\Reviews\V1beta\ListMerchantReviewsRequest;

/**
 * This class demonstrates how to list all the merchant reviews in a given account.
 */
class ListMerchantReviewsSample
{
    /**
     * Lists all merchant reviews for a given account.
     *
     * @param array $config The configuration data for authentication and account ID.
     */
    public static function listMerchantReviewsSample(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.
        $merchantReviewsServiceClient = new MerchantReviewsServiceClient($options);

        // The parent account from which to retrieve reviews.
        // Format: accounts/{account}
        $parent = sprintf('accounts/%s', $config['accountId']);

        // Creates the request message.
        $request = (new ListMerchantReviewsRequest())
            ->setParent($parent);

        // Calls the API and catches and prints any network failures/errors.
        try {
            printf("Sending list merchant reviews request:%s", PHP_EOL);
            $response = $merchantReviewsServiceClient->listMerchantReviews($request);

            $count = 0;
            // Iterates over all rows in all pages and prints all merchant 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::listMerchantReviewsSample($config);
    }
}

// Run the script.
$sample = new ListMerchantReviewsSample();
$sample->callSample();
ListMerchantReviewsSample.php

Python

# -*- coding: utf-8 -*-
# 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
#
#     http://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.
"""This class demonstrates how to list all the merchant reviews in a given account."""

from examples.authentication import configuration
from examples.authentication import generate_user_credentials
from google.shopping.merchant_reviews_v1beta import ListMerchantReviewsRequest
from google.shopping.merchant_reviews_v1beta import MerchantReviewsServiceClient


def list_merchant_reviews(account_id: str) -> None:
  """Lists all merchant reviews for a given account.

  Args:
    account_id: The ID of the Merchant Center account.
  """
  # Gets OAuth credentials.
  credentials = generate_user_credentials.main()

  # Creates a client.
  client = MerchantReviewsServiceClient(credentials=credentials)

  # The parent account from which to retrieve reviews.
  # Format: accounts/{account}
  parent = f"accounts/{account_id}"

  # Creates the request.
  request = ListMerchantReviewsRequest(parent=parent)

  # Makes the request and catches and prints any error messages.
  try:
    print("Sending list merchant reviews request:")
    response = client.list_merchant_reviews(request=request)

    count = 0
    # Iterates over all reviews in all pages and prints them.
    for element in response:
      print(element)
      count += 1
    print(f"The following count of elements were returned: {count}")

  except RuntimeError as e:
    print(e)


if __name__ == "__main__":
  # Gets the merchant account ID from the user.
  merchant_account_id = configuration.Configuration().read_merchant_info()
  list_merchant_reviews(merchant_account_id)


list_merchant_reviews_sample.py