Stay organized with collectionsSave and categorize content based on your preferences.
Merchant API code sample to get a product review.
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.packageshopping.merchant.samples.reviews.v1beta;importcom.google.api.gax.core.FixedCredentialsProvider;importcom.google.auth.oauth2.GoogleCredentials;importcom.google.shopping.merchant.reviews.v1beta.GetProductReviewRequest;importcom.google.shopping.merchant.reviews.v1beta.ProductReview;importcom.google.shopping.merchant.reviews.v1beta.ProductReviewsServiceClient;importcom.google.shopping.merchant.reviews.v1beta.ProductReviewsServiceSettings;importshopping.merchant.samples.utils.Authenticator;importshopping.merchant.samples.utils.Config;/** This class demonstrates how to get a product review. */publicclassGetProductReviewSample{publicstaticvoidgetProductReview(StringaccountId,StringproductReviewId)throwsException{GoogleCredentialscredential=newAuthenticator().authenticate();ProductReviewsServiceSettingsproductReviewsServiceSettings=ProductReviewsServiceSettings.newBuilder().setCredentialsProvider(FixedCredentialsProvider.create(credential)).build();try(ProductReviewsServiceClientproductReviewsServiceClient=ProductReviewsServiceClient.create(productReviewsServiceSettings)){GetProductReviewRequestrequest=GetProductReviewRequest.newBuilder().setName(String.format("accounts/%s/productReviews/%s",accountId,productReviewId)).build();System.out.println("Sending get product review request:");ProductReviewresponse=productReviewsServiceClient.getProductReview(request);System.out.println("Product review retrieved successfully:");System.out.println(response.getName());}catch(Exceptione){System.out.println(e);}}publicstaticvoidmain(String[]args)throwsException{Configconfig=Config.load();StringproductReviewId="YOUR_PRODUCT_REVIEW_ID";getProductReview(config.getAccountId().toString(),productReviewId);}}
<?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\GetProductReviewRequest;/*** This class demonstrates how to get a product review.*/class GetProductReviewSample{private const PRODUCT_REVIEW_ID = 'YOUR_PRODUCT_REVIEW_ID';/*** Retrieves a product review from your Merchant Center account.** @param array $config The configuration data for authentication and account ID.* @param string $productReviewId The ID of the product review to retrieve.*/public static function getProductReviewSample(array $config, string $productReviewId): 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 name of the product review to retrieve.// Format: accounts/{account}/productReviews/{product_review}$name = sprintf('accounts/%s/productReviews/%s',$config['accountId'],$productReviewId);// Creates the request message.$request = (new GetProductReviewRequest())->setName($name);// Calls the API and catches and prints any network failures/errors.try {printf("Sending get product review request:%s", PHP_EOL);$response = $productReviewsServiceClient->getProductReview($request);printf("Product review retrieved successfully:%s", PHP_EOL);printf("%s%s", $response->getName(), PHP_EOL);} catch (ApiException $e) {print $e->getMessage() . PHP_EOL;}}/*** Helper to execute the sample.*/public function callSample(): void{$config = Config::generateConfig();self::getProductReviewSample($config, self::PRODUCT_REVIEW_ID);}}// Run the script.$sample = new GetProductReviewSample();$sample->callSample();
# -*- 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 get a product review."""fromexamples.authenticationimportconfigurationfromexamples.authenticationimportgenerate_user_credentialsfromgoogle.shopping.merchant_reviews_v1betaimportGetProductReviewRequestfromgoogle.shopping.merchant_reviews_v1betaimportProductReviewsServiceClientdefget_product_review(account_id:str,product_review_id:str)->None:"""Gets a product review from the given account.Args:account_id: The ID of the Merchant Center account.product_review_id: The ID of the product review to retrieve."""# Gets OAuth credentials.credentials=generate_user_credentials.main()# Creates a client.client=ProductReviewsServiceClient(credentials=credentials)# The name of the review to retrieve.# Format: accounts/{account}/productReviews/{product_review}name=f"accounts/{account_id}/productReviews/{product_review_id}"# Creates the request.request=GetProductReviewRequest(name=name)# Makes the request and catches and prints any error messages.try:print("Sending get product review request:")response=client.get_product_review(request=request)print("Product review retrieved successfully:")print(response)exceptRuntimeErrorase:print(e)if__name__=="__main__":# Gets the merchant account ID from the user.merchant_account_id=configuration.Configuration().read_merchant_info()# The review ID is the last segment of the `name` field of the `ProductReview`# resource. For example, if the `name` is# `accounts/12345/productReviews/67890`, the review ID is `67890`.review_id="YOUR_PRODUCT_REVIEW_ID"get_product_review(merchant_account_id,review_id)
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-13 UTC."],[[["\u003cp\u003eThis code sample demonstrates how to retrieve a product review using the Merchant API in Java.\u003c/p\u003e\n"],["\u003cp\u003eIt utilizes the \u003ccode\u003eProductReviewsServiceClient\u003c/code\u003e to send a \u003ccode\u003eGetProductReviewRequest\u003c/code\u003e to the API.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egetProductReview\u003c/code\u003e method takes an account ID and product review ID as input to build the request.\u003c/p\u003e\n"],["\u003cp\u003eThe sample code uses \u003ccode\u003eAuthenticator\u003c/code\u003e and \u003ccode\u003eConfig\u003c/code\u003e to load the necessary credentials and configuration data.\u003c/p\u003e\n"],["\u003cp\u003eThe response, containing the retrieved product review, is printed to the console.\u003c/p\u003e\n"]]],["This Java code demonstrates how to retrieve a product review using the Merchant API. It authenticates using Google Credentials, sets up the `ProductReviewsServiceClient`, and constructs a `GetProductReviewRequest`. The request specifies the account ID and product review ID. It then sends the request to get the review from `ProductReviewsServiceClient` and prints the response. The main method loads the configuration and initiates the process, passing in the account ID and the given product review ID.\n"],null,["# Get a product review\n\nMerchant API code sample to get a product review. \n\n### Java\n\n // Copyright 2023 Google LLC\n //\n // Licensed under the Apache License, Version 2.0 (the \"License\");\n // you may not use this file except in compliance with the License.\n // You may obtain a copy of the License at\n //\n // https://www.apache.org/licenses/LICENSE-2.0\n //\n // Unless required by applicable law or agreed to in writing, software\n // distributed under the License is distributed on an \"AS IS\" BASIS,\n // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n // See the License for the specific language governing permissions and\n // limitations under the License.\n\n package shopping.merchant.samples.reviews.v1beta;\n\n import com.google.api.gax.core.FixedCredentialsProvider;\n import com.google.auth.oauth2.GoogleCredentials;\n import com.google.shopping.merchant.reviews.v1beta.GetProductReviewRequest;\n import com.google.shopping.merchant.reviews.v1beta.ProductReview;\n import com.google.shopping.merchant.reviews.v1beta.ProductReviewsServiceClient;\n import com.google.shopping.merchant.reviews.v1beta.ProductReviewsServiceSettings;\n import shopping.merchant.samples.utils.Authenticator;\n import shopping.merchant.samples.utils.Config;\n\n /** This class demonstrates how to get a product review. */\n public class GetProductReviewSample {\n\n public static void getProductReview(String accountId, String productReviewId) throws Exception {\n GoogleCredentials credential = new Authenticator().authenticate();\n\n ProductReviewsServiceSettings productReviewsServiceSettings =\n ProductReviewsServiceSettings.newBuilder()\n .setCredentialsProvider(FixedCredentialsProvider.create(credential))\n .build();\n\n try (ProductReviewsServiceClient productReviewsServiceClient =\n ProductReviewsServiceClient.create(productReviewsServiceSettings)) {\n\n GetProductReviewRequest request =\n GetProductReviewRequest.newBuilder()\n .setName(String.format(\"accounts/%s/productReviews/%s\", accountId, productReviewId))\n .build();\n\n System.out.println(\"Sending get product review request:\");\n ProductReview response = productReviewsServiceClient.getProductReview(request);\n System.out.println(\"Product review retrieved successfully:\");\n System.out.println(response.getName());\n } catch (Exception e) {\n System.out.println(e);\n }\n }\n\n public static void main(String[] args) throws Exception {\n Config config = Config.load();\n String productReviewId = \"YOUR_PRODUCT_REVIEW_ID\";\n getProductReview(config.getAccountId().toString(), productReviewId);\n }\n } \n https://github.com/google/merchant-api-samples/blob/c6de994268c785ce22af0065932518a9ac5b3c03/java/src/main/java/shopping/merchant/samples/reviews/v1beta/GetProductReviewSample.java\n\n### PHP\n\n \u003c?php\n /**\n * Copyright 2025 Google LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n require_once __DIR__ . '/../../../vendor/autoload.php';\n require_once __DIR__ . '/../../Authentication/Authentication.php';\n require_once __DIR__ . '/../../Authentication/Config.php';\n use Google\\ApiCore\\ApiException;\n use Google\\Shopping\\Merchant\\Reviews\\V1beta\\Client\\ProductReviewsServiceClient;\n use Google\\Shopping\\Merchant\\Reviews\\V1beta\\GetProductReviewRequest;\n\n /**\n * This class demonstrates how to get a product review.\n */\n class GetProductReviewSample\n {\n private const PRODUCT_REVIEW_ID = 'YOUR_PRODUCT_REVIEW_ID';\n\n /**\n * Retrieves a product review from your Merchant Center account.\n *\n * @param array $config The configuration data for authentication and account ID.\n * @param string $productReviewId The ID of the product review to retrieve.\n */\n public static function getProductReviewSample(array $config, string $productReviewId): void\n {\n // Gets the OAuth credentials to make the request.\n $credentials = Authentication::useServiceAccountOrTokenFile();\n\n // Creates options config containing credentials for the client to use.\n $options = ['credentials' =\u003e $credentials];\n\n // Creates a client.\n $productReviewsServiceClient = new ProductReviewsServiceClient($options);\n\n // The name of the product review to retrieve.\n // Format: accounts/{account}/productReviews/{product_review}\n $name = sprintf(\n 'accounts/%s/productReviews/%s',\n $config['accountId'],\n $productReviewId\n );\n\n // Creates the request message.\n $request = (new GetProductReviewRequest())\n -\u003esetName($name);\n\n // Calls the API and catches and prints any network failures/errors.\n try {\n printf(\"Sending get product review request:%s\", PHP_EOL);\n $response = $productReviewsServiceClient-\u003egetProductReview($request);\n printf(\"Product review retrieved successfully:%s\", PHP_EOL);\n printf(\"%s%s\", $response-\u003egetName(), PHP_EOL);\n } catch (ApiException $e) {\n print $e-\u003egetMessage() . PHP_EOL;\n }\n }\n\n /**\n * Helper to execute the sample.\n */\n public function callSample(): void\n {\n $config = Config::generateConfig();\n self::getProductReviewSample($config, self::PRODUCT_REVIEW_ID);\n }\n }\n\n // Run the script.\n $sample = new GetProductReviewSample();\n $sample-\u003ecallSample(); \n https://github.com/google/merchant-api-samples/blob/c6de994268c785ce22af0065932518a9ac5b3c03/php/examples/reviews/v1beta/GetProductReviewSample.php\n\n### Python\n\n # -*- coding: utf-8 -*-\n # Copyright 2025 Google LLC\n #\n # Licensed under the Apache License, Version 2.0 (the \"License\");\n # you may not use this file except in compliance with the License.\n # You may obtain a copy of the License at\n #\n # http://www.apache.org/licenses/LICENSE-2.0\n #\n # Unless required by applicable law or agreed to in writing, software\n # distributed under the License is distributed on an \"AS IS\" BASIS,\n # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n # See the License for the specific language governing permissions and\n # limitations under the License.\n \"\"\"This class demonstrates how to get a product review.\"\"\"\n\n from examples.authentication import configuration\n from examples.authentication import generate_user_credentials\n from google.shopping.merchant_reviews_v1beta import GetProductReviewRequest\n from google.shopping.merchant_reviews_v1beta import ProductReviewsServiceClient\n\n\n def get_product_review(account_id: str, product_review_id: str) -\u003e None:\n \"\"\"Gets a product review from the given account.\n\n Args:\n account_id: The ID of the Merchant Center account.\n product_review_id: The ID of the product review to retrieve.\n \"\"\"\n # Gets OAuth credentials.\n credentials = generate_user_credentials.main()\n\n # Creates a client.\n client = ProductReviewsServiceClient(credentials=credentials)\n\n # The name of the review to retrieve.\n # Format: accounts/{account}/productReviews/{product_review}\n name = f\"accounts/{account_id}/productReviews/{product_review_id}\"\n\n # Creates the request.\n request = GetProductReviewRequest(name=name)\n\n # Makes the request and catches and prints any error messages.\n try:\n print(\"Sending get product review request:\")\n response = client.get_product_review(request=request)\n print(\"Product review retrieved successfully:\")\n print(response)\n except RuntimeError as e:\n print(e)\n\n\n if __name__ == \"__main__\":\n # Gets the merchant account ID from the user.\n merchant_account_id = configuration.Configuration().read_merchant_info()\n\n # The review ID is the last segment of the `name` field of the `ProductReview`\n # resource. For example, if the `name` is\n # `accounts/12345/productReviews/67890`, the review ID is `67890`.\n review_id = \"YOUR_PRODUCT_REVIEW_ID\"\n\n get_product_review(merchant_account_id, review_id)\n\n https://github.com/google/merchant-api-samples/blob/c6de994268c785ce22af0065932518a9ac5b3c03/python/examples/reviews/v1beta/get_product_review_sample.py"]]