// 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.reporting; 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.common.Metrics; import com.google.ads.googleads.v2.errors.GoogleAdsError; import com.google.ads.googleads.v2.resources.AdGroup; import com.google.ads.googleads.v2.resources.AdGroupCriterion; 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; /** * Gets keyword performance statistics for the 50 keywords with the most impressions * over the last 7 days. */ public class GetKeywordStats { private static final int PAGE_SIZE = 1_000; private static class GetKeywordStatsParams extends CodeSampleParams { @Parameter(names = ArgumentNames.CUSTOMER_ID, required = true) private Long customerId; } public static void main(String[] args) throws IOException { GetKeywordStatsParams params = new GetKeywordStatsParams(); 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 GetKeywordStats().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 (GoogleAdsServiceClient googleAdsServiceClient = googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) { String searchQuery = "SELECT campaign.id, " + "campaign.name, " + "ad_group.id, " + "ad_group.name, " + "ad_group_criterion.criterion_id, " + "ad_group_criterion.keyword.text, " + "ad_group_criterion.keyword.match_type, " + "metrics.impressions, " + "metrics.clicks, " + "metrics.cost_micros " + "FROM keyword_view " + "WHERE segments.date DURING LAST_7_DAYS " + "AND campaign.advertising_channel_type = 'SEARCH' " + "AND ad_group.status = 'ENABLED' " + "AND ad_group_criterion.status IN ('ENABLED', 'PAUSED') " // Limits to the 50 keywords with the most impressions in the date range. + "ORDER BY metrics.impressions DESC " + "LIMIT 50"; // Creates a request that will retrieve all keyword statistics 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 keyword // in each row. for (GoogleAdsRow googleAdsRow : searchPagedResponse.iterateAll()) { Campaign campaign = googleAdsRow.getCampaign(); AdGroup adGroup = googleAdsRow.getAdGroup(); AdGroupCriterion adGroupCriterion = googleAdsRow.getAdGroupCriterion(); Metrics metrics = googleAdsRow.getMetrics(); System.out.printf( "Keyword text '%s' with " + "match type '%s' " + "and ID %d " + "in ad group '%s' " + "with ID %d " + "in campaign '%s' " + "with ID %d " + "had %d impression(s), " + "%d click(s), " + "and %d cost (in micros) " + "during the last 7 days.%n", adGroupCriterion.getKeyword().getText().getValue(), adGroupCriterion.getKeyword().getMatchType(), adGroupCriterion.getCriterionId().getValue(), adGroup.getName().getValue(), adGroup.getId().getValue(), campaign.getName().getValue(), campaign.getId().getValue(), metrics.getImpressions().getValue(), metrics.getClicks().getValue(), metrics.getCostMicros().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.Services; using Google.Api.Gax; using System; namespace Google.Ads.GoogleAds.Examples.V2 { /// <summary> /// This code example illustrates getting campaign targeting criteria. /// </summary> public class GetKeywordStats : 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) { GetKeywordStats codeExample = new GetKeywordStats(); 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 illustrates getting keyword stats."; } } /// <summary> /// Runs the code example. /// </summary> /// <param name="client">The Google Ads client.</param> /// <param name="customerId">The Google Ads customer Id.</param> public void Run(GoogleAdsClient client, long customerId) { // Get the GoogleAdsService. GoogleAdsServiceClient googleAdsService = client.GetService( Services.V2.GoogleAdsService); // Create the query. string query = $@"SELECT campaign.id, campaign.name, ad_group.id, ad_group.name, ad_group_criterion.criterion_id, ad_group_criterion.keyword.text, ad_group_criterion.keyword.match_type, metrics.impressions, metrics.clicks, metrics.cost_micros, metrics.video_quartile_25_rate FROM keyword_view WHERE segments.date DURING LAST_7_DAYS AND campaign.advertising_channel_type = 'SEARCH' AND ad_group.status = 'ENABLED' AND ad_group_criterion.status IN ('ENABLED','PAUSED') ORDER BY metrics.impressions DESC LIMIT 50"; try { // Issue a search request. PagedEnumerable<SearchGoogleAdsResponse, GoogleAdsRow> result = googleAdsService.Search(customerId.ToString(), query); // Display the results. foreach (GoogleAdsRow criterionRow in result) { Console.WriteLine( $"Keyword with text '{criterionRow.AdGroupCriterion.Keyword.Text}', " + $" match type '{criterionRow.AdGroupCriterion.Keyword.MatchType}' and " + $"ID {criterionRow.AdGroupCriterion.CriterionId} " + $"in ad group '{criterionRow.AdGroup.Name}' with " + $"ID {criterionRow.AdGroup.Id} " + $"in campaign '{criterionRow.Campaign.Name}' " + $"with ID {criterionRow.Campaign.Id} " + $"had {criterionRow.Metrics.Impressions.ToString()} impressions, " + $"{criterionRow.Metrics.Clicks} clicks, and " + $"{criterionRow.Metrics.CostMicros} cost (in micros)" + "during the last 7 days."); } } 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\BasicOperations; 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\KeywordMatchTypeEnum\KeywordMatchType; use Google\Ads\GoogleAds\V2\Errors\GoogleAdsError; use Google\Ads\GoogleAds\V2\Services\GoogleAdsRow; use Google\ApiCore\ApiException; /** * This example gets keyword performance statistics for the 50 keywords with the most impressions * over the last 7 days. */ class GetKeywordStats { const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE'; const PAGE_SIZE = 50; 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) { $googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient(); // Creates a query that retrieves all keyword statistics. $query = "SELECT campaign.id, " . "campaign.name, " . "ad_group.id, " . "ad_group.name, " . "ad_group_criterion.criterion_id, " . "ad_group_criterion.keyword.text, " . "ad_group_criterion.keyword.match_type, " . "metrics.impressions, " . "metrics.clicks, " . "metrics.cost_micros " . "FROM keyword_view " . "WHERE segments.date DURING LAST_7_DAYS " . "AND campaign.advertising_channel_type = 'SEARCH' " . "AND ad_group.status = 'ENABLED' " . "AND ad_group_criterion.status IN ('ENABLED', 'PAUSED') " // Limits to the 50 keywords with the most impressions in the date range. . "ORDER BY metrics.impressions DESC " . "LIMIT 50"; // 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 keyword in each row. foreach ($response->iterateAllElements() as $googleAdsRow) { /** @var GoogleAdsRow $googleAdsRow */ $campaign = $googleAdsRow->getCampaign(); $adGroup = $googleAdsRow->getAdGroup(); $adGroupCriterion = $googleAdsRow->getAdGroupCriterion(); $metrics = $googleAdsRow->getMetrics(); printf( "Keyword text '%s' with " . "match type %s " . "and ID %d " . "in ad group '%s' " . "with ID %d " . "in campaign '%s' " . "with ID %d " . "had %d impression(s), " . "%d click(s), " . "and %d cost (in micros) " . "during the last 7 days.%s", $adGroupCriterion->getKeyword()->getTextUnwrapped(), KeywordMatchType::name($adGroupCriterion->getKeyword()->getMatchType()), $adGroupCriterion->getCriterionIdUnwrapped(), $adGroup->getNameUnwrapped(), $adGroup->getIdUnwrapped(), $campaign->getNameUnwrapped(), $campaign->getIdUnwrapped(), $metrics->getImpressionsUnwrapped(), $metrics->getClicksUnwrapped(), $metrics->getCostMicrosUnwrapped(), PHP_EOL ); } } } GetKeywordStats::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 get campaign criteria. Retrieves negative keywords in a campaign. """ import argparse import sys import google.ads.google_ads.client _DEFAULT_PAGE_SIZE = 1000 def main(client, customer_id, page_size): ga_service = client.get_service('GoogleAdsService', version='v2') query = ('SELECT campaign.id, campaign.name, ad_group.id, ad_group.name, ' 'ad_group_criterion.criterion_id, ' 'ad_group_criterion.keyword.text, ' 'ad_group_criterion.keyword.match_type, ' 'metrics.impressions, metrics.clicks, metrics.cost_micros ' 'FROM keyword_view WHERE segments.date DURING LAST_7_DAYS ' 'AND campaign.advertising_channel_type = \'SEARCH\' ' 'AND ad_group.status = \'ENABLED\' ' 'AND ad_group_criterion.status IN (\'ENABLED\', \'PAUSED\') ' 'ORDER BY metrics.impressions DESC ' 'LIMIT 50') response = ga_service.search(customer_id, query, page_size=page_size) try: for row in response: campaign = row.campaign ad_group = row.ad_group criterion = row.ad_group_criterion metrics = row.metrics print('Keyword text "%s" with match type "%d" and ID %d in ad ' 'group "%s" with ID "%d" in campaign "%s" with ID %d had %s ' 'impression(s), %s click(s), and %s cost (in micros) during ' 'the last 7 days.' % (criterion.keyword.text.value, criterion.keyword.match_type, criterion.criterion_id.value, ad_group.name.value, ad_group.id.value, campaign.name.value, campaign.id.value, metrics.impressions.value, metrics.clicks.value, metrics.cost_micros.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=('Retrieves a campaign\'s negative keywords.')) # 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, _DEFAULT_PAGE_SIZE)
#!/usr/bin/ruby # Encoding: utf-8 # # Copyright:: 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 code example illustrates how to get campaign criteria, which is getting # negative keywords in a campaign. require 'optparse' require 'google/ads/google_ads' def get_keyword_stats(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 ga_service = client.service.google_ads # Limits to the 50 keywords with the most impressions in the date range. # If you wish to exclude entries with zero impressions, include a # predicate in the WHERE statement like 'metrics.impressions > 0' query = <<~QUERY SELECT campaign.id, campaign.name, ad_group.id, ad_group.name, ad_group_criterion.criterion_id, ad_group_criterion.keyword.text, ad_group_criterion.keyword.match_type, metrics.impressions, metrics.clicks, metrics.cost_micros FROM keyword_view WHERE segments.date DURING LAST_7_DAYS AND campaign.advertising_channel_type = 'SEARCH' AND ad_group.status = 'ENABLED' AND ad_group_criterion.status IN ('ENABLED', 'PAUSED') ORDER BY metrics.impressions DESC LIMIT 50 QUERY response = ga_service.search(customer_id, query, page_size: PAGE_SIZE) if response.response.results.empty? puts "The given query returned no entries:\n #{query}" return end response.each do |row| campaign = row.campaign ad_group = row.ad_group criterion = row.ad_group_criterion metrics = row.metrics puts "Keyword text '#{criterion.keyword.text}' with match type "\ "'#{criterion.keyword.match_type}' and ID #{criterion.criterion_id} in "\ "ad group '#{ad_group.name}' with ID #{ad_group.id} in campaign "\ "'#{campaign.name}' with ID #{campaign.id} had #{metrics.impressions} "\ "impression(s), #{metrics.clicks} click(s), and #{metrics.cost_micros} "\ "cost (in micros) during the last 7 days." end end if __FILE__ == $PROGRAM_NAME 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_ADWORDS_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_keyword_stats(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