Delete a account

Page Summary

This page provides code samples in Java, PHP, and Python demonstrating how to delete a Merchant Center account using the Merchant API.
The code samples can delete standalone accounts, Multi-Client Accounts (MCAs), or sub-accounts, with the deletion of an MCA also deleting all its sub-accounts.
Admin user access is required to execute the account deletion process, as demonstrated by the samples, which includes setting up OAuth credentials for authentication.
Each code sample constructs a DeleteAccountRequest that includes the account's name and a force flag, which, when set to true , ensures deletion even if the account has offers or services linked to other accounts.
After successfully sending the DeleteAccountRequest , the API does not return a response, and the code prints a "Delete successful" message to confirm the action.

Merchant API code sample to delete a account.

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. 
 package 
  
 shopping.merchant.samples.accounts.accounts.v1 
 ; 
 import 
  
 com.google.api.gax.core.FixedCredentialsProvider 
 ; 
 import 
  
 com.google.auth.oauth2.GoogleCredentials 
 ; 
 import 
  
 com.google.shopping.merchant.accounts.v1.AccountName 
 ; 
 import 
  
 com.google.shopping.merchant.accounts.v1.AccountsServiceClient 
 ; 
 import 
  
 com.google.shopping.merchant.accounts.v1.AccountsServiceSettings 
 ; 
 import 
  
 com.google.shopping.merchant.accounts.v1.DeleteAccountRequest 
 ; 
 import 
  
 shopping.merchant.samples.utils.Authenticator 
 ; 
 import 
  
 shopping.merchant.samples.utils.Config 
 ; 
 /** This class demonstrates how to delete a given Merchant Center account. */ 
 public 
  
 class 
 DeleteAccountSample 
  
 { 
  
 // This method can delete a standalone, advanced account or sub-account. If you delete an advanced 
  
 // account, 
  
 // all sub-accounts will also be deleted. 
  
 // Admin user access is required to execute this method. 
  
 public 
  
 static 
  
 void 
  
 deleteAccount 
 ( 
 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. 
  
 AccountsServiceSettings 
  
 accountsServiceSettings 
  
 = 
  
 AccountsServiceSettings 
 . 
 newBuilder 
 () 
  
 . 
 setCredentialsProvider 
 ( 
 FixedCredentialsProvider 
 . 
 create 
 ( 
 credential 
 )) 
  
 . 
 build 
 (); 
  
 // Gets the account ID from the config file. 
  
 String 
  
 accountId 
  
 = 
  
 config 
 . 
 getAccountId 
 (). 
 toString 
 (); 
  
 // Creates account name to identify the account. 
  
 String 
  
 name 
  
 = 
  
 AccountName 
 . 
 newBuilder 
 () 
  
 . 
 setAccount 
 ( 
 accountId 
 ) 
  
 . 
 build 
 () 
  
 . 
 toString 
 (); 
  
 // Calls the API and catches and prints any network failures/errors. 
  
 try 
  
 ( 
 AccountsServiceClient 
  
 accountsServiceClient 
  
 = 
  
 AccountsServiceClient 
 . 
 create 
 ( 
 accountsServiceSettings 
 )) 
  
 { 
  
 DeleteAccountRequest 
  
 request 
  
 = 
  
 DeleteAccountRequest 
 . 
 newBuilder 
 () 
  
 . 
 setName 
 ( 
 name 
 ) 
  
 // Optional. If set to true, the account will be deleted even if it has offers or 
  
 // provides services to other accounts. Defaults to 'false'. 
  
 . 
 setForce 
 ( 
 true 
 ) 
  
 . 
 build 
 (); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Sending Delete Account request" 
 ); 
  
 accountsServiceClient 
 . 
 deleteAccount 
 ( 
 request 
 ); 
  
 // No response returned on success. 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Delete successful." 
 ); 
  
 } 
  
 catch 
  
 ( 
 Exception 
  
 e 
 ) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 e 
 ); 
  
 } 
  
 } 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 Exception 
  
 { 
  
 Config 
  
 config 
  
 = 
  
 Config 
 . 
 load 
 (); 
  
 deleteAccount 
 ( 
 config 
 ); 
  
 } 
 } 
   DeleteAccountSample 
 . 
 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\Accounts\V1\Client\AccountsServiceClient; 
 use Google\Shopping\Merchant\Accounts\V1\DeleteAccountRequest; 
 /** 
 * This class demonstrates how to delete a given Merchant Center account. 
 */ 
 class DeleteAccount 
 { 
 private static function getParent(string $accountId): string 
 { 
 return sprintf("accounts/%s", $accountId); 
 } 
 // This method can delete a standalone, advanced account or sub-account. 
 // If you delete an advanced account, all sub-accounts will also be deleted. 
 // Admin user access is required to execute this method. 
 public static function deleteAccount(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. 
 $accountsServiceClient = new AccountsServiceClient($options); 
 // Gets the account ID from the config file. 
 $accountId = $config['accountId']; 
 // Creates account name to identify the account. 
 $name = self::getParent($accountId); 
 // Calls the API and catches and prints any network failures/errors. 
 try { 
 $request = new DeleteAccountRequest([ 
 'name' => $name, 
 // Optional. If set to true, the account will be deleted even if it has offers or 
 // provides services to other accounts. Defaults to 'false'. 
 'force' => true, 
 ]); 
 print "Sending Delete Account request\n"; 
 $accountsServiceClient->deleteAccount($request); // No response returned on success. 
 print "Delete successful.\n"; 
 } catch (ApiException $e) { 
 print $e->getMessage(); 
 } 
 } 
 public function callSample(): void 
 { 
 $config = Config::generateConfig(); 
 self::deleteAccount($config); 
 } 
 } 
 $sample = new DeleteAccount(); 
 $sample->callSample();  DeleteAccountSample.php

# -*- 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 delete a specific Merchant Center account.""" from examples.authentication import configuration from examples.authentication import generate_user_credentials from google.shopping.merchant_accounts_v1 import AccountsServiceClient from google.shopping.merchant_accounts_v1 import DeleteAccountRequest _ACCOUNT = configuration . Configuration () . read_merchant_info () def get_parent ( account_id ): return f "accounts/ { account_id } " def delete_account (): """Deletes a given Merchant Center account.""" # Get OAuth credentials. credentials = generate_user_credentials . main () # Create a client. client = AccountsServiceClient ( credentials = credentials ) # Create the account name. name = get_parent ( _ACCOUNT ) # Create the request. request = DeleteAccountRequest ( name = name , force = True ) # Make the request and print the response. try : print ( "Sending Delete Account request" ) client . delete_account ( request = request ) print ( "Delete successful." ) except RuntimeError as e : print ( e ) if __name__ == "__main__" : delete_account () delete_account_sample . py

Delete a account Stay organized with collections Save and categorize content based on your preferences.

Page Summary

Java

PHP

Python

Delete a account