// 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. 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.v2.errors.GoogleAdsException; import com.google.ads.googleads.v2.utils.ResourceNames; import com.google.ads.googleads.v2.errors.GoogleAdsError; import com.google.ads.googleads.v2.resources.Customer; import com.google.ads.googleads.v2.services.CustomerServiceClient; import java.io.FileNotFoundException; import java.io.IOException; /** * Lists basic information about an advertising account. For instance, the name, * currency, time zone etc. */ public class GetAccountInformation { private static class GetAccountInformationParams extends CodeSampleParams { @Parameter(names = ArgumentNames.CUSTOMER_ID, required = true) private Long customerId; } public static void main(String[] args) { GetAccountInformationParams params = new GetAccountInformationParams(); if (!params.parseArguments(args)) { // Either pass the required parameters for this example on the command line, or insert them // into the code here. See the parameter class definition above for descriptions. params.customerId = Long.parseLong("INSERT_CUSTOMER_ID_HERE"); } GoogleAdsClient googleAdsClient; try { googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build(); } catch (FileNotFoundException fnfe) { System.err.printf( "Failed to load GoogleAdsClient configuration from file. Exception: %s%n", fnfe); return; } catch (IOException ioe) { System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe); return; } try { new GetAccountInformation().runExample(googleAdsClient, params.customerId); } 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); } } } /** * Runs the example. * * @param googleAdsClient the Google Ads API client. * @param customerId the client customer ID. * @throws GoogleAdsException if an API request failed with one or more service errors. */ private void runExample(GoogleAdsClient googleAdsClient, long customerId) { try (CustomerServiceClient customerServiceClient = googleAdsClient.getLatestVersion().createCustomerServiceClient()) { String customerResourceName = ResourceNames.customer(customerId); Customer customer = customerServiceClient.getCustomer(customerResourceName); // Prints account information. System.out.printf( "Customer with ID %d, descriptive name '%s', currency code '%s', timezone '%s', " + "tracking URL template '%s' and auto tagging enabled '%s' was retrieved.%n", customer.getId().getValue(), customer.getDescriptiveName().getValue(), customer.getCurrencyCode().getValue(), customer.getTimeZone().getValue(), customer.getTrackingUrlTemplate().getValue(), customer.getAutoTaggingEnabled().getValue()); } } }
// 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 Google.Ads.GoogleAds.Lib; using Google.Ads.GoogleAds.V2.Errors; using Google.Ads.GoogleAds.V2.Resources; using Google.Ads.GoogleAds.V2.Services; using System; namespace Google.Ads.GoogleAds.Examples.V2 { /// <summary> /// This code example lists basic information about an advertising account, like the name, /// currency and time zone. /// </summary> public class GetAccountInformation : ExampleBase { /// <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) { GetAccountInformation codeExample = new GetAccountInformation(); Console.WriteLine(codeExample.Description); // The Google Ads customer ID for which the call is made. long customerId = long.Parse("INSERT_CUSTOMER_ID_HERE"); codeExample.Run(new GoogleAdsClient(), customerId); } /// <summary> /// Returns a description about the code example. /// </summary> public override string Description { get { return " This code example lists basic information about an advertising " + "account, like the name, currency and time zone."; } } /// <summary> /// Runs the code example. /// </summary> /// <param name="client">The Google Ads client.</param> /// <param name="customerId">The Google Ads customer ID for which the call is made.</param> public void Run(GoogleAdsClient client, long customerId) { // Get the CustomerService. CustomerServiceClient customerService = client.GetService(Services.V2.CustomerService); try { string customerResourceName = ResourceNames.Customer(customerId); Customer customer = customerService.GetCustomer(customerResourceName); // Print account information. Console.WriteLine("Customer with ID {0}, descriptive name '{1}', currency " + "code '{2}', timezone '{3}', tracking URL template '{4}' and auto tagging " + "enabled '{5}' was retrieved.", customer.Id, customer.DescriptiveName, customer.CurrencyCode, customer.TimeZone, customer.TrackingUrlTemplate, customer.AutoTaggingEnabled); } catch (GoogleAdsException e) { Console.WriteLine("Failure:"); Console.WriteLine($"Message: {e.Message}"); Console.WriteLine($"Failure: {e.Failure}"); Console.WriteLine($"Request ID: {e.RequestId}"); } } } }
<?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\V2\GoogleAdsClient; use Google\Ads\GoogleAds\Lib\V2\GoogleAdsClientBuilder; use Google\Ads\GoogleAds\Lib\V2\GoogleAdsException; use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder; use Google\Ads\GoogleAds\Util\V2\ResourceNames; use Google\Ads\GoogleAds\V2\Errors\GoogleAdsError; use Google\ApiCore\ApiException; /** * This example lists basic information about an advertising account. For instance, the name, * currency, time zone, etc. */ class GetAccountInformation { const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE'; const PAGE_SIZE = 1000; 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::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::CUSTOMER_ID] ?: self::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 ); } } catch (ApiException $apiException) { printf( "ApiException was thrown with message '%s'.%s", $apiException->getMessage(), PHP_EOL ); } } /** * Runs the example. * * @param GoogleAdsClient $googleAdsClient the Google Ads API client * @param int $customerId the customer ID */ public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId) { // Issues a getCustomer() request and gets the result. $customerServiceClient = $googleAdsClient->getCustomerServiceClient(); $customer = $customerServiceClient->getCustomer(ResourceNames::forCustomer($customerId)); // Print information about the account. printf( "Customer with ID %d, descriptive name '%s', currency code '%s', timezone '%s', " . "tracking URL template '%s' and auto tagging enabled '%s' was retrieved.%s", $customer->getId()->getValue(), $customer->getDescriptiveName()->getValue(), $customer->getCurrencyCode()->getValue(), $customer->getTimeZone()->getValue(), is_null($customer->getTrackingUrlTemplate()) ? 'N/A' : $customer->getTrackingUrlTemplate()->getValue(), $customer->getAutoTaggingEnabled()->getValue() ? 'true' : 'false', PHP_EOL ); } } GetAccountInformation::main();
#!/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 lists information about an advertising account. For example, its name, currency, time zone, etc. """ import argparse import sys import google.ads.google_ads.client def main(client, customer_id): customer_service = client.get_service('CustomerService', version='v2') resource_name = customer_service.customer_path(customer_id) try: customer = customer_service.get_customer(resource_name=resource_name) except google.ads.google_ads.errors.GoogleAdsException as ex: print('Request with ID "%s" failed with status "%s" and includes the ' 'following errors:' % (ex.request_id, ex.error.code().name)) for error in ex.failure.errors: print('\tError with message "%s".' % error.message) if error.location: for field_path_element in error.location.field_path_elements: print('\t\tOn field: %s' % field_path_element.field_name) sys.exit(1) print('Customer ID: %d' % customer.id.value) print('\tDescriptive name: %s' % customer.descriptive_name.value) print('\tCurrency code: %s' % customer.currency_code.value) print('\tTime zone: %s' % customer.time_zone.value) print('\tTracking URL template: %s' % customer.tracking_url_template.value) print('\tAuto tagging enabled: %s' % customer.auto_tagging_enabled) if __name__ == '__main__': # GoogleAdsClient will read the google-ads.yaml configuration file in the # home directory if none is specified. google_ads_client = (google.ads.google_ads.client.GoogleAdsClient .load_from_storage()) parser = argparse.ArgumentParser( description=('Displays basic information about the specified ' 'customer\'s advertising account.')) # The following argument(s) should be provided to run the example. parser.add_argument('-c', '--customer_id', type=str, required=True, help='The Google Ads customer ID.') args = parser.parse_args() main(google_ads_client, args.customer_id)
#!/usr/bin/env ruby # Encoding: utf-8 # # 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 lists basic information about an advertising account. For # instance, the name, currency, time zone etc. require 'optparse' require 'google/ads/google_ads' def get_account_information(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 resource_name = client.path.customer(customer_id) customer = client.service.customer.get_customer(resource_name) puts "Customer ID #{customer.id}\n"\ "\tdescriptive_name: #{customer.descriptive_name}\n"\ "\tcurrency_code: #{customer.currency_code}\n"\ "\ttime_zone: #{customer.time_zone}\n"\ "\ttracking_url_template: #{customer.tracking_url_template}\n"\ "\tauto_tagging_enabled: #{customer.auto_tagging_enabled.value}" end if __FILE__ == $PROGRAM_NAME 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[:customer_id] = 'INSERT_CUSTOMER_ID_HERE' OptionParser.new do |opts| opts.banner = sprintf('Usage: ruby %s [options]', File.basename(__FILE__)) opts.separator '' opts.separator 'Options:' opts.on('-C', '--customer-id CUSTOMER-ID', String, 'Customer ID') do |v| options[: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 get_account_information(options.fetch(:customer_id).tr("-", "")) rescue Google::Ads::GoogleAds::Errors::GoogleAdsError => e e.failure.errors.each do |error| STDERR.printf("Error with message: %s\n", error.message) if error.location error.location.field_path_elements.each do |field_path_element| STDERR.printf("\tOn field: %s\n", field_path_element.field_name) end end error.error_code.to_h.each do |k, v| next if v == :UNSPECIFIED STDERR.printf("\tType: %s\n\tCode: %s\n", k, v) end end rescue Google::Gax::RetryError => e STDERR.printf("Error: '%s'\n\tCause: '%s'\n\tCode: %d\n\tDetails: '%s'\n" \ "\tRequest-Id: '%s'\n", e.message, e.cause.message, e.cause.code, e.cause.details, e.cause.metadata['request-id']) end end