Stay organized with collectionsSave and categorize content based on your preferences.
Merchant API code sample to get a shipping settings.
Java
// Copyright 2024 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.accounts.shippingsettings.v1;importcom.google.api.gax.core.FixedCredentialsProvider;importcom.google.auth.oauth2.GoogleCredentials;importcom.google.shopping.merchant.accounts.v1.GetShippingSettingsRequest;importcom.google.shopping.merchant.accounts.v1.ShippingSettings;importcom.google.shopping.merchant.accounts.v1.ShippingSettingsName;importcom.google.shopping.merchant.accounts.v1.ShippingSettingsServiceClient;importcom.google.shopping.merchant.accounts.v1.ShippingSettingsServiceSettings;importshopping.merchant.samples.utils.Authenticator;importshopping.merchant.samples.utils.Config;/** This class demonstrates how to get the ShippingSettings for a given Merchant Center account. */publicclassGetShippingSettingsSample{publicstaticvoidgetShippingSettings(Configconfig)throwsException{// Obtains OAuth token based on the user's configuration.GoogleCredentialscredential=newAuthenticator().authenticate();// Creates service settings using the credentials retrieved above.ShippingSettingsServiceSettingsshippingSettingsServiceSettings=ShippingSettingsServiceSettings.newBuilder().setCredentialsProvider(FixedCredentialsProvider.create(credential)).build();// Creates ShippingSettings name to identify ShippingSettings.Stringname=ShippingSettingsName.newBuilder().setAccount(config.getAccountId().toString()).build().toString();// Calls the API and catches and prints any network failures/errors.try(ShippingSettingsServiceClientshippingSettingsServiceClient=ShippingSettingsServiceClient.create(shippingSettingsServiceSettings)){// The name has the format: accounts/{account}/shippingSettingsGetShippingSettingsRequestrequest=GetShippingSettingsRequest.newBuilder().setName(name).build();System.out.println("Sending Get ShippingSettings request:");ShippingSettingsresponse=shippingSettingsServiceClient.getShippingSettings(request);System.out.println("Retrieved ShippingSettings below");System.out.println(response);}catch(Exceptione){System.out.println(e);}}publicstaticvoidmain(String[]args)throwsException{Configconfig=Config.load();getShippingSettings(config);}}
<?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\Accounts\V1\Client\ShippingSettingsServiceClient;use Google\Shopping\Merchant\Accounts\V1\GetShippingSettingsRequest;/*** This class demonstrates how to get the ShippingSettings for a given Merchant Center account.*/class GetShippingSettings{/*** Retrieves the shipping settings for the specified Merchant Center account.** @param array $config The configuration data containing the account ID.* @return void*/public static function getShippingSettings($config){// 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.$shippingSettingsServiceClient = new ShippingSettingsServiceClient($options);// Creates ShippingSettings name to identify ShippingSettings.// The name has the format: accounts/{account}/shippingSettings$name = "accounts/" . $config['accountId'] . "/shippingSettings";// Calls the API and catches and prints any network failures/errors.try {$request = (new GetShippingSettingsRequest())->setName($name);print "Sending Get ShippingSettings request:" . PHP_EOL;$response = $shippingSettingsServiceClient->getShippingSettings($request);print "Retrieved ShippingSettings below" . PHP_EOL;print_r($response);} catch (ApiException $e) {print $e->getMessage();}}/*** Helper to execute the sample.** @return void*/public function callSample(): void{$config = Config::generateConfig();// Makes the call to get shipping settings for the MC account.self::getShippingSettings($config);}}// Run the script$sample = new GetShippingSettings();$sample->callSample();
# -*- coding: utf-8 -*-# Copyright 2024 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."""A module to get the ShippingSettings for a given Merchant Center account."""fromexamples.authenticationimportconfigurationfromexamples.authenticationimportgenerate_user_credentialsfromgoogle.shopping.merchant_accounts_v1importGetShippingSettingsRequestfromgoogle.shopping.merchant_accounts_v1importShippingSettingsServiceClient_ACCOUNT=configuration.Configuration().read_merchant_info()_PARENT=f"accounts/{_ACCOUNT}"defget_shipping_settings():"""Gets the ShippingSettings for a given Merchant Center account."""# Gets OAuth Credentials.credentials=generate_user_credentials.main()# Creates a client.client=ShippingSettingsServiceClient(credentials=credentials)# Creates the Shipping Settings namename=_PARENT+"/shippingSettings"# Creates the request.request=GetShippingSettingsRequest(name=name)# Makes the request and prints the retrieved ShippingSettings.try:response=client.get_shipping_settings(request=request)print("Retrieved ShippingSettings below")print(response)exceptRuntimeErrorase:print(e)if__name__=="__main__":get_shipping_settings()
[[["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 webpage provides code samples in Java, PHP, and Python demonstrating how to retrieve shipping settings for a specific Merchant Center account using the Merchant API.\u003c/p\u003e\n"],["\u003cp\u003eThe code samples utilize the \u003ccode\u003eShippingSettingsServiceClient\u003c/code\u003e to make the request to the \u003ccode\u003egetShippingSettings\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eEach code sample generates an OAuth credential to authorize API calls and constructs a \u003ccode\u003eGetShippingSettingsRequest\u003c/code\u003e with the appropriate account name.\u003c/p\u003e\n"],["\u003cp\u003eThe samples showcase error handling to manage exceptions during API calls, like network failures and errors.\u003c/p\u003e\n"],["\u003cp\u003eThe provided code includes proper license and copyright information, and has links to the relevant section of the Github repo.\u003c/p\u003e\n"]]],["The provided code samples demonstrate retrieving shipping settings for a Merchant Center account using the Merchant API in Java, PHP, and Python. Each sample authenticates via OAuth, creates a `ShippingSettingsServiceClient`, and constructs a `GetShippingSettingsRequest` with the account's shipping settings name. It then calls the `getShippingSettings` method, sending the request and printing the retrieved `ShippingSettings` response or any encountered errors. Each script requires an account ID and credentials to operate.\n"],null,["# Get a shipping settings\n\nMerchant API code sample to get a shipping settings. \n\n### Java\n\n // Copyright 2024 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.accounts.shippingsettings.v1;\n import com.google.api.gax.core.FixedCredentialsProvider;\n import com.google.auth.oauth2.GoogleCredentials;\n import com.google.shopping.merchant.accounts.v1.GetShippingSettingsRequest;\n import com.google.shopping.merchant.accounts.v1.ShippingSettings;\n import com.google.shopping.merchant.accounts.v1.ShippingSettingsName;\n import com.google.shopping.merchant.accounts.v1.ShippingSettingsServiceClient;\n import com.google.shopping.merchant.accounts.v1.ShippingSettingsServiceSettings;\n import shopping.merchant.samples.utils.Authenticator;\n import shopping.merchant.samples.utils.Config;\n\n /** This class demonstrates how to get the ShippingSettings for a given Merchant Center account. */\n public class GetShippingSettingsSample {\n\n public static void getShippingSettings(Config config) throws Exception {\n\n // Obtains OAuth token based on the user's configuration.\n GoogleCredentials credential = new Authenticator().authenticate();\n\n // Creates service settings using the credentials retrieved above.\n ShippingSettingsServiceSettings shippingSettingsServiceSettings =\n ShippingSettingsServiceSettings.newBuilder()\n .setCredentialsProvider(FixedCredentialsProvider.create(credential))\n .build();\n\n // Creates ShippingSettings name to identify ShippingSettings.\n String name =\n ShippingSettingsName.newBuilder()\n .setAccount(config.getAccountId().toString())\n .build()\n .toString();\n\n // Calls the API and catches and prints any network failures/errors.\n try (ShippingSettingsServiceClient shippingSettingsServiceClient =\n ShippingSettingsServiceClient.create(shippingSettingsServiceSettings)) {\n\n // The name has the format: accounts/{account}/shippingSettings\n GetShippingSettingsRequest request =\n GetShippingSettingsRequest.newBuilder().setName(name).build();\n\n System.out.println(\"Sending Get ShippingSettings request:\");\n ShippingSettings response = shippingSettingsServiceClient.getShippingSettings(request);\n\n System.out.println(\"Retrieved ShippingSettings below\");\n System.out.println(response);\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\n getShippingSettings(config);\n }\n } \n https://github.com/google/merchant-api-samples/blob/c6de994268c785ce22af0065932518a9ac5b3c03/java/src/main/java/shopping/merchant/samples/accounts/shippingsettings/v1/GetShippingSettingsSample.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 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\\Accounts\\V1\\Client\\ShippingSettingsServiceClient;\n use Google\\Shopping\\Merchant\\Accounts\\V1\\GetShippingSettingsRequest;\n\n /**\n * This class demonstrates how to get the ShippingSettings for a given Merchant Center account.\n */\n class GetShippingSettings\n {\n\n /**\n * Retrieves the shipping settings for the specified Merchant Center account.\n *\n * @param array $config The configuration data containing the account ID.\n * @return void\n */\n public static function getShippingSettings($config)\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 $shippingSettingsServiceClient = new ShippingSettingsServiceClient($options);\n\n // Creates ShippingSettings name to identify ShippingSettings.\n // The name has the format: accounts/{account}/shippingSettings\n $name = \"accounts/\" . $config['accountId'] . \"/shippingSettings\";\n\n\n // Calls the API and catches and prints any network failures/errors.\n try {\n $request = (new GetShippingSettingsRequest())\n -\u003esetName($name);\n\n print \"Sending Get ShippingSettings request:\" . PHP_EOL;\n $response = $shippingSettingsServiceClient-\u003egetShippingSettings($request);\n\n print \"Retrieved ShippingSettings below\" . PHP_EOL;\n print_r($response);\n } catch (ApiException $e) {\n print $e-\u003egetMessage();\n }\n }\n\n /**\n * Helper to execute the sample.\n *\n * @return void\n */\n public function callSample(): void\n {\n $config = Config::generateConfig();\n // Makes the call to get shipping settings for the MC account.\n self::getShippingSettings($config);\n }\n }\n\n // Run the script\n $sample = new GetShippingSettings();\n $sample-\u003ecallSample(); \n https://github.com/google/merchant-api-samples/blob/c6de994268c785ce22af0065932518a9ac5b3c03/php/examples/accounts/shippingsettings/v1/GetShippingSettingsSample.php\n\n### Python\n\n # -*- coding: utf-8 -*-\n # Copyright 2024 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 \"\"\"A module to get the ShippingSettings for a given Merchant Center account.\"\"\"\n\n\n from examples.authentication import configuration\n from examples.authentication import generate_user_credentials\n from google.shopping.merchant_accounts_v1 import GetShippingSettingsRequest\n from google.shopping.merchant_accounts_v1 import ShippingSettingsServiceClient\n\n _ACCOUNT = configuration.Configuration().read_merchant_info()\n _PARENT = f\"accounts/{_ACCOUNT}\"\n\n\n def get_shipping_settings():\n \"\"\"Gets the ShippingSettings for a given Merchant Center account.\"\"\"\n\n # Gets OAuth Credentials.\n credentials = generate_user_credentials.main()\n\n # Creates a client.\n client = ShippingSettingsServiceClient(credentials=credentials)\n\n # Creates the Shipping Settings name\n name = _PARENT + \"/shippingSettings\"\n\n # Creates the request.\n request = GetShippingSettingsRequest(name=name)\n\n # Makes the request and prints the retrieved ShippingSettings.\n try:\n response = client.get_shipping_settings(request=request)\n print(\"Retrieved ShippingSettings below\")\n print(response)\n except RuntimeError as e:\n print(e)\n\n\n if __name__ == \"__main__\":\n get_shipping_settings()\n\n https://github.com/google/merchant-api-samples/blob/c6de994268c785ce22af0065932518a9ac5b3c03/python/examples/accounts/shippingsettings/v1/get_shipping_settings_sample.py"]]
