Delete checkout settings

Merchant API code sample to delete checkout settings.

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.accounts.checkoutsettings.v1 
 ; 
 import 
  
 com.google.api.gax.core.FixedCredentialsProvider 
 ; 
 import 
  
 com.google.auth.oauth2.GoogleCredentials 
 ; 
 import 
  
 com.google.shopping.merchant.accounts.v1.CheckoutSettingsName 
 ; 
 import 
  
 com.google.shopping.merchant.accounts.v1.CheckoutSettingsServiceClient 
 ; 
 import 
  
 com.google.shopping.merchant.accounts.v1.CheckoutSettingsServiceSettings 
 ; 
 import 
  
 com.google.shopping.merchant.accounts.v1.DeleteCheckoutSettingsRequest 
 ; 
 import 
  
 shopping.merchant.samples.utils.Authenticator 
 ; 
 import 
  
 shopping.merchant.samples.utils.Config 
 ; 
 /** This class demonstrates how to delete checkoutSettings fora given Merchant Center account. */ 
 public 
  
 class 
 DeleteCheckoutSettingsSample 
  
 { 
  
 public 
  
 static 
  
 void 
  
 deleteCheckoutSettings 
 ( 
 Config 
  
 config 
 ) 
  
 throws 
  
 Exception 
  
 { 
  
 // Obtains OAuth token based on the user's configuration. 
  
 GoogleCredentials 
  
 credential 
  
 = 
  
 new 
  
 Authenticator 
 (). 
 authenticate 
 (); 
  
 // Creates service settings using the credentials retrieved above. 
  
 CheckoutSettingsServiceSettings 
  
 checkoutSettingsServiceSettings 
  
 = 
  
 CheckoutSettingsServiceSettings 
 . 
 newBuilder 
 () 
  
 . 
 setCredentialsProvider 
 ( 
 FixedCredentialsProvider 
 . 
 create 
 ( 
 credential 
 )) 
  
 . 
 build 
 (); 
  
 // Gets the account ID from the config file. 
  
 String 
  
 accountId 
  
 = 
  
 config 
 . 
 getAccountId 
 (). 
 toString 
 (); 
  
 // The only valid programId for checkout settings is "checkout" 
  
 String 
  
 programId 
  
 = 
  
 "checkout" 
 ; 
  
 // Creates account name to identify the account. 
  
 String 
  
 name 
  
 = 
  
 CheckoutSettingsName 
 . 
 newBuilder 
 (). 
 setAccount 
 ( 
 accountId 
 ). 
 setProgram 
 ( 
 programId 
 ). 
 build 
 (). 
 toString 
 (); 
  
 // Calls the API and catches and prints any network failures/errors. 
  
 try 
  
 ( 
 CheckoutSettingsServiceClient 
  
 checkoutSettingsServiceClient 
  
 = 
  
 CheckoutSettingsServiceClient 
 . 
 create 
 ( 
 checkoutSettingsServiceSettings 
 )) 
  
 { 
  
 DeleteCheckoutSettingsRequest 
  
 request 
  
 = 
  
 DeleteCheckoutSettingsRequest 
 . 
 newBuilder 
 (). 
 setName 
 ( 
 name 
 ). 
 build 
 (); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Sending Delete Checkout Settings request" 
 ); 
  
 checkoutSettingsServiceClient 
 . 
 deleteCheckoutSettings 
 ( 
  
 request 
 ); 
  
 // No response returned on success. 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Delete successful." 
 ); 
  
 } 
  
 catch 
  
 ( 
 Exception 
  
 e 
 ) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "An error has occurred: " 
 ); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 e 
 ); 
  
 } 
  
 } 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 Exception 
  
 { 
  
 Config 
  
 config 
  
 = 
  
 Config 
 . 
 load 
 (); 
  
 deleteCheckoutSettings 
 ( 
 config 
 ); 
  
 } 
 } 
  
 

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\Accounts\V1\Client\CheckoutSettingsServiceClient; 
 use Google\Shopping\Merchant\Accounts\V1\DeleteCheckoutSettingsRequest; 
 /** 
 * This class demonstrates how to delete checkoutSettings for a given Merchant 
 * Center account. 
 */ 
 class DeleteCheckoutSettingsSample 
 { 
 /** 
 * Deletes the checkout settings for a given Merchant Center account. 
 * 
 * @param array $config The configuration file for the Merchant Center account. 
 * 
 * @return void 
 */ 
 public static function deleteCheckoutSettings(array $config): void 
 { 
 // Obtains OAuth credentials from the configuration file. 
 $credentials = Authentication::useServiceAccountOrTokenFile(); 
 // Creates a client. 
 $checkoutSettingsServiceClient = new CheckoutSettingsServiceClient([ 
 'credentials' => $credentials 
 ]); 
 // The only valid programId for checkout settings is "checkout". 
 $programId = 'checkout'; 
 // Constructs the resource name format: 
 // `accounts/{account}/programs/{program}/checkoutSettings`. 
 $name = sprintf( 
 'accounts/%s/programs/%s/checkoutSettings', 
 $config['accountId'], 
 $programId 
 ); 
 // Creates the request object. 
 $request = (new DeleteCheckoutSettingsRequest()) 
 ->setName($name); 
 // Calls the API and catches and prints any network failures/errors. 
 try { 
 printf("Sending Delete Checkout Settings request%s", PHP_EOL); 
 // No response returned on success. 
 $checkoutSettingsServiceClient->deleteCheckoutSettings($request); 
 printf("Delete successful.%s", PHP_EOL); 
 } catch (ApiException $e) { 
 printf("An error has occurred: %s", PHP_EOL); 
 print $e->getMessage(); 
 } 
 } 
 /** 
 * Executes the sample. 
 * 
 * @return void 
 */ 
 public function callSample(): void 
 { 
 $config = Config::generateConfig(); 
 self::deleteCheckoutSettings($config); 
 } 
 } 
 // Runs the sample. 
 $sample = new DeleteCheckoutSettingsSample(); 
 $sample->callSample(); 
  
 
Design a Mobile Site
View Site in Mobile | Classic
Share by: