// 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.advancedoperations; 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.errors.GoogleAdsError; import com.google.ads.googleads.v2.resources.AdGroup; import com.google.ads.googleads.v2.resources.AdGroupBidModifier; import com.google.ads.googleads.v2.resources.Campaign; import com.google.ads.googleads.v2.services.GoogleAdsRow; import com.google.ads.googleads.v2.services.GoogleAdsServiceClient; import com.google.ads.googleads.v2.services.GoogleAdsServiceClient.SearchPagedResponse; import com.google.ads.googleads.v2.services.SearchGoogleAdsRequest; import java.io.FileNotFoundException; import java.io.IOException; import javax.annotation.Nullable; /** Gets ad group bid modifiers. */ public class GetAdGroupBidModifiers { private static final int PAGE_SIZE = 1_000; private static class GetAdGroupBidModifiersParams extends CodeSampleParams { @Parameter(names = ArgumentNames.CUSTOMER_ID, required = true) private Long customerId; @Parameter(names = ArgumentNames.AD_GROUP_ID) private Long adGroupId; } public static void main(String[] args) throws IOException { GetAdGroupBidModifiersParams params = new GetAdGroupBidModifiersParams(); 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"); // Optional: Specify an ad group ID to restrict search to only a given ad group. params.adGroupId = null; } 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 GetAdGroupBidModifiers().runExample(googleAdsClient, params.customerId, params.adGroupId); } 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. * @param adGroupId the ad group ID for which ad group bid modiifers will be retrieved. If {@code * null}, returns all ad group bid modifiers. * @throws GoogleAdsException if an API request failed with one or more service errors. */ private void runExample( GoogleAdsClient googleAdsClient, long customerId, @Nullable Long adGroupId) { try (GoogleAdsServiceClient googleAdsServiceClient = googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) { String searchQuery = "SELECT ad_group.id, ad_group_bid_modifier.criterion_id, " + "ad_group_bid_modifier.bid_modifier, ad_group_bid_modifier.device.type, " + "campaign.id FROM ad_group_bid_modifier"; if (adGroupId != null) { searchQuery += String.format(" WHERE ad_group.id = %d", adGroupId); } // Creates a request that will retrieve ad group bid modifiers using pages of the specified // page size. SearchGoogleAdsRequest request = SearchGoogleAdsRequest.newBuilder() .setCustomerId(Long.toString(customerId)) .setPageSize(PAGE_SIZE) .setQuery(searchQuery) .build(); // Issues the search request. SearchPagedResponse searchPagedResponse = googleAdsServiceClient.search(request); // Iterates over all rows in all pages and prints the requested field values for the ad group // bid modifiers in each row. for (GoogleAdsRow googleAdsRow : searchPagedResponse.iterateAll()) { AdGroupBidModifier adGroupBidModifier = googleAdsRow.getAdGroupBidModifier(); AdGroup adGroup = googleAdsRow.getAdGroup(); Campaign campaign = googleAdsRow.getCampaign(); System.out.printf( "Ad group bid modifier with criterion ID %d, bid modifier value %.2f, device type %s " + "was found in an ad group with ID %d of campaign ID %d.%n", adGroupBidModifier.getCriterionId().getValue(), adGroupBidModifier.getBidModifier().getValue(), adGroupBidModifier.getDevice().getType(), adGroup.getId().getValue(), campaign.getId().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 Google.Api.Gax; using System; namespace Google.Ads.GoogleAds.Examples.V2 { /// <summary> /// This code example gets ad group bid modifiers. /// </summary> public class GetAdGroupBidModifiers : ExampleBase { /// <summary> /// The page size to be used by default. /// </summary> private const int PAGE_SIZE = 1_000; /// <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) { GetAdGroupBidModifiers codeExample = new GetAdGroupBidModifiers(); Console.WriteLine(codeExample.Description); // The Google Ads customer ID for which the call is made. long customerId = long.Parse("INSERT_CUSTOMER_ID_HERE"); // The ad group ID for which ad group bid modiifers will be retrieved. long adGroupId = long.Parse("INSERT_ADGROUP_ID_HERE"); codeExample.Run(new GoogleAdsClient(), customerId, adGroupId); } /// <summary> /// Returns a description about the code example. /// </summary> public override string Description { get { return "This code example gets ad group bid modifiers."; } } /// <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> /// <param name="adGroupId">The ad group ID for which ad group bid modiifers will /// be retrieved.</param> public void Run(GoogleAdsClient client, long customerId, long? adGroupId) { // Get the GoogleAdsService. GoogleAdsServiceClient googleAdsService = client.GetService(Services.V2.GoogleAdsService); string searchQuery = "SELECT ad_group.id, ad_group_bid_modifier.criterion_id, " + "ad_group_bid_modifier.bid_modifier, ad_group_bid_modifier.device.type, " + "campaign.id FROM ad_group_bid_modifier"; if (adGroupId != null) { searchQuery += $" WHERE ad_group.id = {adGroupId}"; } // Creates a request that will retrieve ad group bid modifiers using pages of the // specified page size. SearchGoogleAdsRequest request = new SearchGoogleAdsRequest() { CustomerId = customerId.ToString(), Query = searchQuery, PageSize = PAGE_SIZE }; try { // Issue the search request. PagedEnumerable<SearchGoogleAdsResponse, GoogleAdsRow> searchPagedResponse = googleAdsService.Search(request); // Iterates over all rows in all pages and prints the requested field values for // the ad group bid modifiers in each row. foreach (GoogleAdsRow googleAdsRow in searchPagedResponse) { AdGroupBidModifier adGroupBidModifier = googleAdsRow.AdGroupBidModifier; AdGroup adGroup = googleAdsRow.AdGroup; Campaign campaign = googleAdsRow.Campaign; Console.WriteLine("Ad group bid modifier with criterion ID {0}, bid " + "modifier value {1:0.00}, device type {2} was found in an ad group " + "with ID {3} of campaign ID {4}.", adGroupBidModifier.CriterionId, adGroupBidModifier.BidModifier, adGroupBidModifier.Device.Type, adGroup.Id, campaign.Id); } } 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\AdvancedOperations; 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\V2\Enums\DeviceEnum\Device; use Google\Ads\GoogleAds\V2\Errors\GoogleAdsError; use Google\Ads\GoogleAds\V2\Services\GoogleAdsRow; use Google\ApiCore\ApiException; /** This example gets ad group bid modifiers. */ class GetAdGroupBidModifiers { const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE'; // Optional: Specify an ad group ID below to restrict search to only a given ad group. const AD_GROUP_ID = null; 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, ArgumentNames::AD_GROUP_ID => GetOpt::OPTIONAL_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, $options[ArgumentNames::AD_GROUP_ID] ?: self::AD_GROUP_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 * @param int|null $adGroupId the ad group ID for which ad group bid modifiers will be * retrieved. If `null`, returns from all ad groups */ public static function runExample( GoogleAdsClient $googleAdsClient, int $customerId, ?int $adGroupId ) { $googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient(); // Creates a query that retrieves ad group bid modifiers. $query = 'SELECT ad_group.id, ' . 'ad_group_bid_modifier.criterion_id, ' . 'ad_group_bid_modifier.bid_modifier, ' . 'ad_group_bid_modifier.device.type, ' . 'campaign.id ' . 'FROM ad_group_bid_modifier'; if ($adGroupId !== null) { $query .= " WHERE ad_group.id = $adGroupId"; } // Issues a search request by specifying page size. $response = $googleAdsServiceClient->search($customerId, $query, ['pageSize' => self::PAGE_SIZE]); // Iterates over all rows in all pages and prints the requested field values for // the ad group bid modifier in each row. foreach ($response->iterateAllElements() as $googleAdsRow) { /** @var GoogleAdsRow $googleAdsRow */ printf( "Ad group bid modifier with criterion ID %d, bid modifier value %f, device " . "type '%s' was found in an ad group ID %d of campaign ID %d.%s", $googleAdsRow->getAdGroupBidModifier()->getCriterionIdUnwrapped(), $googleAdsRow->getAdGroupBidModifier()->getBidModifierUnwrapped(), Device::name($googleAdsRow->getAdGroupBidModifier()->getDevice()->getType()), $googleAdsRow->getAdGroup()->getIdUnwrapped(), $googleAdsRow->getCampaign()->getIdUnwrapped(), PHP_EOL ); } } } GetAdGroupBidModifiers::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 illustrates how to retrieve ad group bid modifiers.""" import argparse import sys import google.ads.google_ads.client _DEFAULT_PAGE_SIZE = 1000 def main(client, customer_id, page_size, ad_group_id=None): ga_service = client.get_service('GoogleAdsService', version='v2') query = ('SELECT campaign.id, ad_group.id, ' 'ad_group_bid_modifier.criterion_id, ' 'ad_group_bid_modifier.bid_modifier, ' 'ad_group_bid_modifier.device.type FROM ad_group_bid_modifier') if ad_group_id: query = '%s WHERE ad_group.id = %s' % (query, ad_group_id) results = ga_service.search(customer_id, query=query, page_size=page_size) # Use the enum type to determine the enum name from the value. device_enum = client.get_type('DeviceEnum', version='v2').Device try: for row in results: print('Ad group bid modifier with criterion ID "%s", bid modifier ' 'value "%s", device type "%s" was found in ad group ID "%s" ' 'of campaign with ID "%s".' % (row.ad_group_bid_modifier.criterion_id.value, row.ad_group_bid_modifier.bid_modifier.value, device_enum.Name(row.ad_group_bid_modifier.device.type), row.ad_group.id.value, row.campaign.id.value)) 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) 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='List ad group bid modifiers for specified customer.') # 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.') parser.add_argument('-a', '--ad_group_id', type=str, required=False, help=('The ad group ID. Specify this to list ad group ' 'bid modifiers solely for this ad group ID.')) args = parser.parse_args() main(google_ads_client, args.customer_id, _DEFAULT_PAGE_SIZE, ad_group_id=args.ad_group_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 gets ad group bid modifiers. require "optparse" require "google/ads/google_ads" def get_ad_group_bid_modifiers(customer_id, ad_group_id = nil) # GoogleAdsClient will read a config file from # ENV['HOME']/google_ads_config.rb when called without parameters client = Google::Ads::GoogleAds::GoogleAdsClient.new search_query = <<~QUERY SELECT ad_group.id, ad_group_bid_modifier.criterion_id, ad_group_bid_modifier.bid_modifier, ad_group_bid_modifier.device.type, campaign.id FROM ad_group_bid_modifier QUERY if ad_group_id search_query << "WHERE ad_group.id = #{ad_group_id}" end response = client.service.google_ads.search( customer_id, search_query, page_size: PAGE_SIZE ) response.each do |row| ad_group_bid_modifier = row.ad_group_bid_modifier ad_group = row.ad_group campaign = row.campaign bid_modifier = '"nil"' device_type = if ad_group_bid_modifier.device.nil? "unspecified" else ad_group_bid_modifier.device.type end if ad_group_bid_modifier.bid_modifier bid_modifier = sprintf("%.2f", ad_group_bid_modifier.bid_modifier) end puts "Ad group bid modifier with criterion ID #{ad_group_bid_modifier.criterion_id}, bid " \ "modifier value #{bid_modifier}, device type #{device_type} was " \ "found in ad group ID #{ad_group.id} of campaign ID #{campaign.id}." end end if __FILE__ == $0 PAGE_SIZE = 1000 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' options[:ad_group_id] = nil OptionParser.new do |opts| opts.banner = sprintf('Usage: %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.on('-A', '--ad-group-id AD-GROUP-ID', String, '(Optional) AdGroup ID') do |v| options[:ad_group_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_ad_group_bid_modifiers(options.fetch(:customer_id).tr("-", ""), options[:ad_group_id]) 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