Create Customer

Java

 // Copyright 2019 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 
  
 com.google.ads.googleads.examples.accountmanagement 
 ; 
 import 
  
 com.beust.jcommander.Parameter 
 ; 
 import 
  
 com.google.ads.googleads.examples.utils.ArgumentNames 
 ; 
 import 
  
 com.google.ads.googleads.examples.utils.CodeSampleParams 
 ; 
 import 
  
 com.google.ads.googleads.lib.GoogleAdsClient 
 ; 
 import 
  
 com.google.ads.googleads.v21.errors.GoogleAdsError 
 ; 
 import 
  
 com.google.ads.googleads.v21.errors.GoogleAdsException 
 ; 
 import 
  
 com.google.ads.googleads.v21.resources.Customer 
 ; 
 import 
  
 com.google.ads.googleads.v21.services.CreateCustomerClientResponse 
 ; 
 import 
  
 com.google.ads.googleads.v21.services.CustomerServiceClient 
 ; 
 import 
  
 java.io.FileNotFoundException 
 ; 
 import 
  
 java.io.IOException 
 ; 
 import 
  
 java.time.ZonedDateTime 
 ; 
 import 
  
 java.time.format.DateTimeFormatter 
 ; 
 /** 
 * Creates a new customer under a given manager account. 
 * 
 * <p>Note: this example must be run using the credentials of a Google Ads manager account. By 
 * default, the new account will only be accessible via the manager account. 
 */ 
 public 
  
 class 
 CreateCustomer 
  
 { 
  
 private 
  
 static 
  
 class 
 CreateCustomerParams 
  
 extends 
  
 CodeSampleParams 
  
 { 
  
 @Parameter 
 ( 
  
 names 
  
 = 
  
 ArgumentNames 
 . 
 CUSTOMER_ID 
 , 
  
 description 
  
 = 
  
 "Manager account to own the new customer." 
 ) 
  
 public 
  
 Long 
  
 managerAccountId 
 ; 
  
 } 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 { 
  
 CreateCustomerParams 
  
 params 
  
 = 
  
 new 
  
 CreateCustomerParams 
 (); 
  
 if 
  
 ( 
 ! 
 params 
 . 
 parseArguments 
 ( 
 args 
 )) 
  
 { 
  
 // Either pass the owning manager account on the command line or insert the ID here. 
  
 params 
 . 
 managerAccountId 
  
 = 
  
 Long 
 . 
 valueOf 
 ( 
 "INSERT_MANAGER_ID_HERE" 
 ); 
  
 } 
  
 GoogleAdsClient 
  
 googleAdsClient 
  
 = 
  
 null 
 ; 
  
 try 
  
 { 
  
 googleAdsClient 
  
 = 
  
 GoogleAdsClient 
 . 
 newBuilder 
 (). 
 fromPropertiesFile 
 (). 
 build 
 (); 
  
 } 
  
 catch 
  
 ( 
 FileNotFoundException 
  
 fnfe 
 ) 
  
 { 
  
 System 
 . 
 err 
 . 
 printf 
 ( 
  
 "Failed to load GoogleAdsClient configuration from file. Exception: %s%n" 
 , 
  
 fnfe 
 ); 
  
 System 
 . 
 exit 
 ( 
 1 
 ); 
  
 } 
  
 catch 
  
 ( 
 IOException 
  
 ioe 
 ) 
  
 { 
  
 System 
 . 
 err 
 . 
 printf 
 ( 
 "Failed to create GoogleAdsClient. Exception: %s%n" 
 , 
  
 ioe 
 ); 
  
 System 
 . 
 exit 
 ( 
 1 
 ); 
  
 } 
  
 try 
  
 { 
  
 new 
  
 CreateCustomer 
 (). 
 runExample 
 ( 
 googleAdsClient 
 , 
  
 params 
 . 
 managerAccountId 
 ); 
  
 } 
  
 catch 
  
 ( 
 GoogleAdsException 
  
 gae 
 ) 
  
 { 
  
 // GoogleAdsException is the base class for most exceptions thrown by an API request. 
  
 // Instances of this exception have a message and a GoogleAdsFailure that contains a 
  
 // collection of GoogleAdsErrors that indicate the underlying causes of the 
  
 // GoogleAdsException. 
  
 System 
 . 
 err 
 . 
 printf 
 ( 
  
 "Request ID %s failed due to GoogleAdsException. Underlying errors:%n" 
 , 
  
 gae 
 . 
 getRequestId 
 ()); 
  
 int 
  
 i 
  
 = 
  
 0 
 ; 
  
 for 
  
 ( 
 GoogleAdsError 
  
 googleAdsError 
  
 : 
  
 gae 
 . 
 getGoogleAdsFailure 
 (). 
 getErrorsList 
 ()) 
  
 { 
  
 System 
 . 
 err 
 . 
 printf 
 ( 
 "  Error %d: %s%n" 
 , 
  
 i 
 ++ 
 , 
  
 googleAdsError 
 ); 
  
 } 
  
 System 
 . 
 exit 
 ( 
 1 
 ); 
  
 } 
  
 } 
  
 private 
  
 void 
  
 runExample 
 ( 
 GoogleAdsClient 
  
 googleAdsClient 
 , 
  
 Long 
  
 managerId 
 ) 
  
 { 
  
 // Formats the current date/time to use as a timestamp in the new customer description. 
  
 String 
  
 dateTime 
  
 = 
  
 ZonedDateTime 
 . 
 now 
 (). 
 format 
 ( 
 DateTimeFormatter 
 . 
 RFC_1123_DATE_TIME 
 ); 
  
 // Initializes a Customer object to be created. 
  
 Customer 
  
 customer 
  
 = 
  
 Customer 
 . 
 newBuilder 
 () 
  
 . 
 setDescriptiveName 
 ( 
 "Account created with CustomerService on '" 
  
 + 
  
 dateTime 
  
 + 
  
 "'" 
 ) 
  
 . 
 setCurrencyCode 
 ( 
 "USD" 
 ) 
  
 . 
 setTimeZone 
 ( 
 "America/New_York" 
 ) 
  
 // Optional: Sets additional attributes of the customer. 
  
 . 
 setTrackingUrlTemplate 
 ( 
 "{lpurl}?device={device}" 
 ) 
  
 . 
 setFinalUrlSuffix 
 ( 
 "keyword={keyword}&matchtype={matchtype}&adgroupid={adgroupid}" 
 ) 
  
 . 
 build 
 (); 
  
 // Sends the request to create the customer. 
  
 try 
  
 ( 
 CustomerServiceClient 
  
 client 
  
 = 
  
 googleAdsClient 
 . 
 getLatestVersion 
 (). 
 createCustomerServiceClient 
 ()) 
  
 { 
  
 CreateCustomerClientResponse 
  
 response 
  
 = 
  
 client 
 . 
 createCustomerClient 
 ( 
 managerId 
 . 
 toString 
 (), 
  
 customer 
 ); 
  
 System 
 . 
 out 
 . 
 printf 
 ( 
  
 "Created a customer with resource name '%s' under the manager account with" 
  
 + 
  
 " customer ID '%d'.%n" 
 , 
  
 response 
 . 
 getResourceName 
 (), 
  
 managerId 
 ); 
  
 } 
  
 } 
 } 
  
  

C#

 // Copyright 2019 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. 
 using 
  
 CommandLine 
 ; 
 using 
  
 Google.Ads.Gax.Examples 
 ; 
 using 
  
 Google.Ads.GoogleAds.Lib 
 ; 
 using 
  
 Google.Ads.GoogleAds.V21.Errors 
 ; 
 using 
  
 Google.Ads.GoogleAds.V21.Resources 
 ; 
 using 
  
 Google.Ads.GoogleAds.V21.Services 
 ; 
 using 
  
 System 
 ; 
 using 
  
 System.Collections.Generic 
 ; 
 namespace 
  
 Google.Ads.GoogleAds.Examples.V21 
 { 
  
 /// <summary> 
  
 /// This code example illustrates how to create a new customer under a given manager account. 
  
 /// 
  
 /// Note: this example must be run using the credentials of a Google Ads manager account. 
  
 /// By default, the new account will only be accessible via the manager account. 
  
 /// </summary> 
  
 public 
  
 class 
  
 CreateCustomer 
  
 : 
  
 ExampleBase 
  
 { 
  
 /// <summary> 
  
 /// Command line options for running the <see cref="CreateCustomer"/> example. 
  
 /// </summary> 
  
 public 
  
 class 
  
 Options 
  
 : 
  
 OptionsBase 
  
 { 
  
 /// <summary> 
  
 /// The manager customer ID. 
  
 /// </summary> 
  
 [Option("managerCustomerId", Required = true, HelpText = 
 "The manager customer ID.")] 
  
 public 
  
 long 
  
 ManagerCustomerId 
  
 { 
  
 get 
 ; 
  
 set 
 ; 
  
 } 
  
 } 
  
 /// <summary> 
  
 /// Main method, to run this code example as a standalone application. 
  
 /// </summary> 
  
 /// <param name="args">The command line arguments.</param> 
  
 public 
  
 static 
  
 void 
  
 Main 
 ( 
 string 
 [] 
  
 args 
 ) 
  
 { 
  
 Options 
  
 options 
  
 = 
  
 ExampleUtilities 
 . 
 ParseCommandLine<Options> 
 ( 
 args 
 ); 
  
 CreateCustomer 
  
 codeExample 
  
 = 
  
 new 
  
 CreateCustomer 
 (); 
  
 Console 
 . 
 WriteLine 
 ( 
 codeExample 
 . 
 Description 
 ); 
  
 codeExample 
 . 
 Run 
 ( 
 new 
  
 GoogleAdsClient 
 (), 
  
 options 
 . 
 ManagerCustomerId 
 ); 
  
 } 
  
 /// <summary> 
  
 /// Returns a description about the code example. 
  
 /// </summary> 
  
 public 
  
 override 
  
 string 
  
 Description 
  
 = 
>  
 "This code example illustrates how to create a new customer under a given manager " 
  
 + 
  
 "account.\nNote: this example must be run using the credentials of a Google Ads " 
  
 + 
  
 "manager account. By default, the new account will only be accessible via the " 
  
 + 
  
 "manager account." 
 ; 
  
 /// <summary> 
  
 /// Runs the code example. 
  
 /// </summary> 
  
 /// <param name="client">The Google Ads client.</param> 
  
 /// <param name="managerCustomerId">The manager customer ID.</param> 
  
 public 
  
 void 
  
 Run 
 ( 
 GoogleAdsClient 
  
 client 
 , 
  
 long 
  
 managerCustomerId 
 ) 
  
 { 
  
 // Get the CustomerService. 
  
 CustomerServiceClient 
  
 customerService 
  
 = 
  
 client 
 . 
 GetService 
 ( 
 Services 
 . 
 V21 
 . 
 CustomerService 
 ); 
  
 Customer 
  
 customer 
  
 = 
  
 new 
  
 Customer 
 () 
  
 { 
  
 DescriptiveName 
  
 = 
  
 $"Account created with CustomerService on '{DateTime.Now}'" 
 , 
  
 // For a list of valid currency codes and time zones see this documentation: 
  
 // https://developers.google.com/google-ads/api/reference/data/codes-formats#codes_formats. 
  
 CurrencyCode 
  
 = 
  
 "USD" 
 , 
  
 TimeZone 
  
 = 
  
 "America/New_York" 
 , 
  
 // The below values are optional. For more information about URL 
  
 // options see: https://support.google.com/google-ads/answer/6305348. 
  
 TrackingUrlTemplate 
  
 = 
  
 "{lpurl}?device={device}" 
 , 
  
 FinalUrlSuffix 
  
 = 
  
 "keyword={keyword}&matchtype={matchtype}&adgroupid={adgroupid}" 
  
 }; 
  
 try 
  
 { 
  
 // Create the account. 
  
 CreateCustomerClientResponse 
  
 response 
  
 = 
  
 customerService 
 . 
 CreateCustomerClient 
 ( 
  
 managerCustomerId 
 . 
 ToString 
 (), 
  
 customer 
 ); 
  
 // Display the result. 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Created a customer with resource name " 
  
 + 
  
 $"'{response.ResourceName}' under the manager account with customer " 
  
 + 
  
 $"ID '{managerCustomerId}'" 
 ); 
  
 } 
  
 catch 
  
 ( 
 GoogleAdsException 
  
 e 
 ) 
  
 { 
  
 Console 
 . 
 WriteLine 
 ( 
 "Failure:" 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Message: {e.Message}" 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Failure: {e.Failure}" 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Request ID: {e.RequestId}" 
 ); 
  
 throw 
 ; 
  
 } 
  
 } 
  
 } 
 } 
  
  

PHP

< ?php 
 /** 
 * Copyright 2018 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. 
 */ 
 namespace Google\Ads\GoogleAds\Examples\AccountManagement; 
 require __DIR__ . '/../../vendor/autoload.php'; 
 use GetOpt\GetOpt; 
 use Google\Ads\GoogleAds\Examples\Utils\ArgumentNames; 
 use Google\Ads\GoogleAds\Examples\Utils\ArgumentParser; 
 use Google\Ads\GoogleAds\Lib\V21\GoogleAdsClient; 
 use Google\Ads\GoogleAds\Lib\V21\GoogleAdsClientBuilder; 
 use Google\Ads\GoogleAds\Lib\V21\GoogleAdsException; 
 use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder; 
 use Google\Ads\GoogleAds\V21\Errors\GoogleAdsError; 
 use Google\Ads\GoogleAds\V21\Resources\Customer; 
 use Google\Ads\GoogleAds\V21\Services\CreateCustomerClientRequest; 
 use Google\ApiCore\ApiException; 
 /** 
 * This example illustrates how to create a new customer under a given manager account. 
 * 
 * Note: this example must be run using the credentials of a Google Ads manager account. By default, 
 * the new account will only be accessible via the manager account. 
 */ 
 class CreateCustomer 
 { 
 private const MANAGER_CUSTOMER_ID = 'INSERT_MANAGER_CUSTOMER_ID_HERE'; 
 public static function main() 
 { 
 // Either pass the required parameters for this example on the command line, or insert them 
 // into the constants above. 
 $options = (new ArgumentParser())->parseCommandArguments([ 
 ArgumentNames::MANAGER_CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT 
 ]); 
 // Generate a refreshable OAuth2 credential for authentication. 
 $oAuth2Credential = (new OAuth2TokenBuilder())->fromFile()->build(); 
 // Construct a Google Ads client configured from a properties file and the 
 // OAuth2 credentials above. 
 $googleAdsClient = (new GoogleAdsClientBuilder())->fromFile() 
 ->withOAuth2Credential($oAuth2Credential) 
 ->build(); 
 try { 
 self::runExample( 
 $googleAdsClient, 
 $options[ArgumentNames::MANAGER_CUSTOMER_ID] ?: self::MANAGER_CUSTOMER_ID 
 ); 
 } catch (GoogleAdsException $googleAdsException) { 
 printf( 
 "Request with ID '%s' has failed.%sGoogle Ads failure details:%s", 
 $googleAdsException->getRequestId(), 
 PHP_EOL, 
 PHP_EOL 
 ); 
 foreach ($googleAdsException->getGoogleAdsFailure()->getErrors() as $error) { 
 /** @var GoogleAdsError $error */ 
 printf( 
 "\t%s: %s%s", 
 $error->getErrorCode()->getErrorCode(), 
 $error->getMessage(), 
 PHP_EOL 
 ); 
 } 
 exit(1); 
 } catch (ApiException $apiException) { 
 printf( 
 "ApiException was thrown with message '%s'.%s", 
 $apiException->getMessage(), 
 PHP_EOL 
 ); 
 exit(1); 
 } 
 } 
 /** 
 * Runs the example. 
 * 
 * @param GoogleAdsClient $googleAdsClient the Google Ads API client 
 * @param int $managerCustomerId the manager customer ID 
 */ 
 public static function runExample(GoogleAdsClient $googleAdsClient, int $managerCustomerId) 
 { 
 $customer = new Customer([ 
 'descriptive_name' => 'Account created with CustomerService on ' . date('Ymd h:i:s'), 
 // For a list of valid currency codes and time zones see this documentation: 
 // https://developers.google.com/google-ads/api/reference/data/codes-formats. 
 'currency_code' => 'USD', 
 'time_zone' => 'America/New_York', 
 // The below values are optional. For more information about URL 
 // options see: https://support.google.com/google-ads/answer/6305348. 
 'tracking_url_template' => '{lpurl}?device={device}', 
 'final_url_suffix' => 'keyword={keyword}&matchtype={matchtype}&adgroupid={adgroupid}' 
 ]); 
 // Issues a mutate request to create an account 
 $customerServiceClient = $googleAdsClient->getCustomerServiceClient(); 
 $response = $customerServiceClient->createCustomerClient( 
 CreateCustomerClientRequest::build($managerCustomerId, $customer) 
 ); 
 printf( 
 'Created a customer with resource name "%s" under the manager account with ' 
 . 'customer ID %d.%s', 
 $response->getResourceName(), 
 $managerCustomerId, 
 PHP_EOL 
 ); 
 } 
 } 
 CreateCustomer::main(); 
  
  

Python

 #!/usr/bin/env python 
 # Copyright 2018 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. 
 """This example illustrates how to create a new customer under a given 
 manager account. 
 Note: this example must be run using the credentials of a Google Ads manager 
 account. By default, the new account will only be accessible via the manager 
 account. 
 """ 
 import 
  
 argparse 
 import 
  
 sys 
 from 
  
 datetime 
  
 import 
 datetime 
 from 
  
 google.ads.googleads.client 
  
 import 
 GoogleAdsClient 
 from 
  
 google.ads.googleads.errors 
  
 import 
 GoogleAdsException 
 from 
  
 google.ads.googleads.v21.resources.types.customer 
  
 import 
 Customer 
 from 
  
 google.ads.googleads.v21.services.services.customer_service.client 
  
 import 
 ( 
 CustomerServiceClient 
 , 
 ) 
 from 
  
 google.ads.googleads.v21.services.types.customer_service 
  
 import 
 ( 
 CreateCustomerClientResponse 
 , 
 ) 
 def 
  
 main 
 ( 
 client 
 : 
 GoogleAdsClient 
 , 
 manager_customer_id 
 : 
 str 
 ) 
 - 
> None 
 : 
  
 """The main method that creates all necessary entities for the example. 
 Args: 
 client: an initialized GoogleAdsClient instance. 
 manager_customer_id: a manager client customer ID. 
 """ 
 customer_service 
 : 
 CustomerServiceClient 
 = 
 client 
 . 
 get_service 
 ( 
 "CustomerService" 
 ) 
 customer 
 : 
 Customer 
 = 
 client 
 . 
 get_type 
 ( 
 "Customer" 
 ) 
 now 
 : 
 str 
 = 
 datetime 
 . 
 today 
 () 
 . 
 strftime 
 ( 
 "%Y%m 
 %d 
 %H:%M:%S" 
 ) 
 customer 
 . 
 descriptive_name 
 = 
 f 
 "Account created with CustomerService on 
 { 
 now 
 } 
 " 
 # For a list of valid currency codes and time zones see this documentation: 
 # https://developers.google.com/google-ads/api/reference/data/codes-formats 
 customer 
 . 
 currency_code 
 = 
 "USD" 
 customer 
 . 
 time_zone 
 = 
 "America/New_York" 
 # The below values are optional. For more information about URL 
 # options see: https://support.google.com/google-ads/answer/6305348 
 customer 
 . 
 tracking_url_template 
 = 
 " 
 {lpurl} 
 ?device= 
 {device} 
 " 
 customer 
 . 
 final_url_suffix 
 = 
 ( 
 "keyword= 
 {keyword} 
& matchtype= 
 {matchtype} 
& adgroupid= 
 {adgroupid} 
 " 
 ) 
 response 
 : 
 CreateCustomerClientResponse 
 = 
 ( 
 customer_service 
 . 
 create_customer_client 
 ( 
 customer_id 
 = 
 manager_customer_id 
 , 
 customer_client 
 = 
 customer 
 ) 
 ) 
 print 
 ( 
 f 
 'Customer created with resource name " 
 { 
 response 
 . 
 resource_name 
 } 
 " ' 
 f 
 'under manager account with ID " 
 { 
 manager_customer_id 
 } 
 ".' 
 ) 
 if 
 __name__ 
 == 
 "__main__" 
 : 
 parser 
 = 
 argparse 
 . 
 ArgumentParser 
 ( 
 description 
 = 
 ( 
 "Creates a new client under the given manager." 
 ) 
 ) 
 # The following argument(s) should be provided to run the example. 
 parser 
 . 
 add_argument 
 ( 
 "-m" 
 , 
 "--manager_customer_id" 
 , 
 type 
 = 
 str 
 , 
 required 
 = 
 True 
 , 
 help 
 = 
 "A Google Ads customer ID for the " 
 "manager account under which the new customer will " 
 "be created." 
 , 
 ) 
 args 
 = 
 parser 
 . 
 parse_args 
 () 
 # GoogleAdsClient will read the google-ads.yaml configuration file in the 
 # home directory if none is specified. 
 googleads_client 
 = 
 GoogleAdsClient 
 . 
 load_from_storage 
 ( 
 version 
 = 
 "v21" 
 ) 
 try 
 : 
 main 
 ( 
 googleads_client 
 , 
 args 
 . 
 manager_customer_id 
 ) 
 except 
 GoogleAdsException 
 as 
 ex 
 : 
 print 
 ( 
 f 
 'Request with ID " 
 { 
 ex 
 . 
 request_id 
 } 
 " failed with status ' 
 f 
 '" 
 { 
 ex 
 . 
 error 
 . 
 code 
 () 
 . 
 name 
 } 
 " and includes the following errors:' 
 ) 
 for 
 error 
 in 
 ex 
 . 
 failure 
 . 
 errors 
 : 
 print 
 ( 
 f 
 ' 
 \t 
 Error with message " 
 { 
 error 
 . 
 message 
 } 
 ".' 
 ) 
 if 
 error 
 . 
 location 
 : 
 for 
 field_path_element 
 in 
 error 
 . 
 location 
 . 
 field_path_elements 
 : 
 print 
 ( 
 f 
 " 
 \t\t 
 On field: 
 { 
 field_path_element 
 . 
 field_name 
 } 
 " 
 ) 
 sys 
 . 
 exit 
 ( 
 1 
 ) 
  

Ruby

 #!/usr/bin/env ruby 
 # Encoding: utf-8 
 # 
 # Copyright 2019 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. 
 # 
 # This example illustrates how to create a new customer under a given manager 
 # account. 
 # 
 # Note: This example must be run using the credentials of a Google Ads manager 
 # account. By default, the new account will only be accessible via the manager 
 # account. 
 require 
  
 'optparse' 
 require 
  
 'google/ads/google_ads' 
 require 
  
 'date' 
 require_relative 
  
 '../shared/error_handler.rb' 
 def 
  
 create_customer 
 ( 
 manager_customer_id 
 ) 
  
 # GoogleAdsClient will read a config file from 
  
 # ENV['HOME']/google_ads_config.rb when called without parameters 
  
 client 
  
 = 
  
 Google 
 :: 
 Ads 
 :: 
 GoogleAds 
 :: 
 GoogleAdsClient 
 . 
 new 
  
 customer 
  
 = 
  
 client 
 . 
 resource 
 . 
 customer 
  
 do 
  
 | 
 c 
 | 
  
 c 
 . 
 descriptive_name 
  
 = 
  
 "Account created with CustomerService on 
 #{ 
 ( 
 Time 
 . 
 new 
 . 
 to_f 
  
 * 
  
 1000 
 ) 
 . 
 to_i 
 } 
 " 
  
 # For a list of valid currency codes and time zones, see this documentation: 
  
 # https://developers.google.com/google-ads/api/reference/data/codes-formats 
  
 c 
 . 
 currency_code 
  
 = 
  
 "USD" 
  
 c 
 . 
 time_zone 
  
 = 
  
 "America/New_York" 
  
 # The below values are optional. For more information about URL options, see: 
  
 # https://support.google.com/google-ads/answer/6305348 
  
 c 
 . 
 tracking_url_template 
  
 = 
  
 "{lpurl}?device={device}" 
  
 c 
 . 
 final_url_suffix 
  
 = 
  
 "keyword={keyword}&matchtype={matchtype}&adgroupid={adgroupid}" 
  
 end 
  
 response 
  
 = 
  
 client 
 . 
 service 
 . 
 customer 
 . 
 create_customer_client 
 ( 
  
 customer_id 
 : 
  
 manager_customer_id 
 , 
  
 customer_client 
 : 
  
 customer 
  
 ) 
  
 puts 
  
 "Created a customer with resource name 
 #{ 
 response 
 . 
 resource_name 
 } 
 under" 
  
 + 
  
 " the manager account with customer ID 
 #{ 
 manager_customer_id 
 } 
 ." 
 end 
 if 
  
 __FILE__ 
  
 == 
  
 $0 
  
 options 
  
 = 
  
 {} 
  
 # The following parameter(s) should be provided to run the example. You can 
  
 # either specify these by changing the INSERT_XXX_ID_HERE values below, or on 
  
 # the command line. 
  
 # 
  
 # Parameters passed on the command line will override any parameters set in 
  
 # code. 
  
 # 
  
 # Running the example with -h will print the command line usage. 
  
 options 
 [ 
 :manager_customer_id 
 ] 
  
 = 
  
 'INSERT_MANAGER_CUSTOMER_ID_HERE' 
  
 OptionParser 
 . 
 new 
  
 do 
  
 | 
 opts 
 | 
  
 opts 
 . 
 banner 
  
 = 
  
 sprintf 
 ( 
 'Usage: %s [options]' 
 , 
  
 File 
 . 
 basename 
 ( 
 __FILE__ 
 )) 
  
 opts 
 . 
 separator 
  
 '' 
  
 opts 
 . 
 separator 
  
 'Options:' 
  
 opts 
 . 
 on 
 ( 
 '-M' 
 , 
  
 '--manager-customer-id MANAGEr-CUSTOMER-ID' 
 , 
  
 String 
 , 
  
 'Customer ID' 
 ) 
  
 do 
  
 | 
 v 
 | 
  
 options 
 [ 
 :manager_customer_id 
 ] 
  
 = 
  
 v 
  
 end 
  
 opts 
 . 
 separator 
  
 '' 
  
 opts 
 . 
 separator 
  
 'Help:' 
  
 opts 
 . 
 on_tail 
 ( 
 '-h' 
 , 
  
 '--help' 
 , 
  
 'Show this message' 
 ) 
  
 do 
  
 puts 
  
 opts 
  
 exit 
  
 end 
  
 end 
 . 
 parse! 
  
 begin 
  
 create_customer 
 ( 
 options 
 . 
 fetch 
 ( 
 :manager_customer_id 
 ) 
 . 
 tr 
 ( 
 "-" 
 , 
  
 "" 
 )) 
  
 rescue 
  
 Google 
 :: 
 Ads 
 :: 
 GoogleAds 
 :: 
 Errors 
 :: 
 GoogleAdsError 
  
 = 
>  
 e 
  
 GoogleAdsErrorHandler 
 . 
 handle_google_ads_error 
 ( 
 e 
 ) 
  
 raise 
  
 # Re-raise the error to maintain original script behavior. 
  
 end 
 end 
  
  

Perl

 #!/usr/bin/perl -w 
 # 
 # Copyright 2019, 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 example illustrates how to create a new customer under a given manager 
 # account. 
 # 
 # Note: This example must be run using the credentials of a Google Ads manager 
 # account. By default, the new account will only be accessible via the manager 
 # account. 
 use 
  
 strict 
 ; 
 use 
  
 warnings 
 ; 
 use 
  
 utf8 
 ; 
 use 
  
 FindBin 
  
 qw($Bin) 
 ; 
 use 
  
 lib 
  
 "$Bin/../../lib" 
 ; 
 use 
  
 Google::Ads::GoogleAds::Client 
 ; 
 use 
  
 Google::Ads::GoogleAds::Utils::GoogleAdsHelper 
 ; 
 use 
  
 Google::Ads::GoogleAds::V21::Resources::Customer 
 ; 
 use 
  
 Getopt::Long 
  
 qw(:config auto_help) 
 ; 
 use 
  
 Pod::Usage 
 ; 
 use 
  
 Cwd 
  
 qw(abs_path) 
 ; 
 use 
  
 Data::Uniqid 
  
 qw(uniqid) 
 ; 
 # The following parameter(s) should be provided to run the example. You can 
 # either specify these by changing the INSERT_XXX_ID_HERE values below, or on 
 # the command line. 
 # 
 # Parameters passed on the command line will override any parameters set in 
 # code. 
 # 
 # Running the example with -h will print the command line usage. 
 my 
  
 $manager_customer_id 
  
 = 
  
 "INSERT_MANAGER_CUSTOMER_ID_HERE" 
 ; 
 sub 
  
 create_customer 
  
 { 
  
 my 
  
 ( 
 $api_client 
 , 
  
 $manager_customer_id 
 ) 
  
 = 
  
 @_ 
 ; 
  
 # Initialize a customer to be created. 
  
 my 
  
 $customer 
  
 = 
  
 Google::Ads::GoogleAds::V21::Resources:: 
 Customer 
 - 
> new 
 ({ 
  
 descriptiveName 
  
 = 
>  
 "Account created with CustomerService on #" 
  
 . 
  
 uniqid 
 (), 
  
 # For a list of valid currency codes and time zones, see this documentation: 
  
 # https://developers.google.com/google-ads/api/reference/data/codes-formats 
  
 currencyCode 
  
 = 
>  
 "USD" 
 , 
  
 timeZone 
  
 = 
>  
 "America/New_York" 
 , 
  
 # The below values are optional. For more information about URL options, see: 
  
 # https://support.google.com/google-ads/answer/6305348 
  
 trackingUrlTemplate 
  
 = 
>  
 "{lpurl}?device={device}" 
 , 
  
 finalUrlSuffix 
  
 = 
>  
 "keyword={keyword}&matchtype={matchtype}&adgroupid={adgroupid}" 
  
 }); 
  
 # Create the customer client. 
  
 my 
  
 $create_customer_client_response 
  
 = 
  
 $api_client 
 - 
> CustomerService 
 () 
 - 
> create_customer_client 
 ({ 
  
 customerId 
  
 = 
>  
 $manager_customer_id 
 , 
  
 customerClient 
  
 = 
>  
 $customer 
  
 }); 
  
 printf 
  
 "Created a customer with resource name '%s' under the manager account " 
  
 . 
  
 "with customer ID %d.\n" 
 , 
  
 $create_customer_client_response 
 - 
> { 
 resourceName 
 }, 
  
 $manager_customer_id 
 ; 
  
 return 
  
 1 
 ; 
 } 
 # Don't run the example if the file is being included. 
 if 
  
 ( 
 abs_path 
 ( 
 $0 
 ) 
  
 ne 
  
 abs_path 
 ( 
 __FILE__ 
 )) 
  
 { 
  
 return 
  
 1 
 ; 
 } 
 # Get Google Ads Client, credentials will be read from ~/googleads.properties. 
 my 
  
 $api_client 
  
 = 
  
 Google::Ads::GoogleAds:: 
 Client 
 - 
> new 
 (); 
 # By default examples are set to die on any server returned fault. 
 $api_client 
 - 
> set_die_on_faults 
 ( 
 1 
 ); 
 # Parameters passed on the command line will override any parameters set in code. 
 GetOptions 
 ( 
 "manager_customer_id=s" 
  
 = 
>  
 \ 
 $manager_customer_id 
 ); 
 # Print the help message if the parameters are not initialized in the code nor 
 # in the command line. 
 pod2usage 
 ( 
 2 
 ) 
  
 if 
  
 not 
  
 check_params 
 ( 
 $manager_customer_id 
 ); 
 # Call the example. 
 create_customer 
 ( 
 $api_client 
 , 
  
 $manager_customer_id 
  
 =~ 
  
 s/-//g 
 r 
 ); 
 =pod 
 =head1 NAME 
 create_customer 
 =head1 DESCRIPTION 
 This example illustrates how to create a new customer under a given manager account. 
 Note: This example must be run using the credentials of a Google Ads manager account. 
 By default, the new account will only be accessible via the manager account. 
 =head1 SYNOPSIS 
 create_customer.pl [options] 
 -help                       Show the help message. 
 -manager_customer_id        The Google Ads manager customer ID. 
 =cut 
  
  

curl

 # 
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. # 
Creates  
a  
customer  
client. # 
 # 
Variables: # 
API_VERSION, # 
DEVELOPER_TOKEN, # 
MANAGER_CUSTOMER_ID, # 
OAUTH2_ACCESS_TOKEN: # 
See  
https://developers.google.com/google-ads/api/rest/auth#request_headers # 
 for 
  
details. # 
 curl -f --request POST \ 
 "https://googleads.googleapis.com/v${API_VERSION}/customers/${MANAGER_CUSTOMER_ID}:createCustomerClient" \ 
 --header "Content-Type: application/json" \ 
 --header "developer-token: ${DEVELOPER_TOKEN}" \ 
 --header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \ 
 --header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \ 
 --data @- <<EOF 
 { 
 "customerClient": { 
 "descriptiveName": "Account created with CustomerService #${RANDOM}", 
 "currencyCode": "USD", 
 "timeZone": "America/New_York" 
 } 
 } 
 EOF  
 
Design a Mobile Site
View Site in Mobile | Classic
Share by: