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.planning;
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.v11.errors.GoogleAdsError;
import com.google.ads.googleads.v11.errors.GoogleAdsException;
import com.google.ads.googleads.v11.services.ForecastMetrics;
import com.google.ads.googleads.v11.services.GenerateForecastMetricsResponse;
import com.google.ads.googleads.v11.services.KeywordPlanKeywordForecast;
import com.google.ads.googleads.v11.services.KeywordPlanServiceClient;
import com.google.ads.googleads.v11.utils.ResourceNames;
import java.io.FileNotFoundException;
import java.io.IOException;
/**
* Creates a keyword plan, which can be reused for retrieving forecast metrics and historic metrics.
*/
public class GenerateForecastMetrics {
private static class GenerateForecastMetricParams extends CodeSampleParams {
@Parameter(
names = ArgumentNames.CUSTOMER_ID,
description = "The customer in which to create a new keyword plan.")
public Long customerId;
@Parameter(
names = ArgumentNames.KEYWORD_PLAN_ID,
description = "The keyword plan ID for which to generate metrics.")
public Long keywordPlanId;
}
public static void main(String[] args) {
GenerateForecastMetricParams params = new GenerateForecastMetricParams();
if (!params.parseArguments(args)) {
// Optional, specify the customer ID for which the call is made.
params.customerId = Long.valueOf("INSERT_CUSTOMER_ID");
params.keywordPlanId = Long.valueOf("INSERT_KEYWORD_PLAN_ID");
}
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 GenerateForecastMetrics()
.runExample(googleAdsClient, params.customerId, params.keywordPlanId);
} 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);
}
}
/**
* Runs the code example.
*
* @param googleAdsClient the Google Ads API client.
* @param customerId the client customer ID.
* @param planId the plan ID.
*/
private void runExample(GoogleAdsClient googleAdsClient, Long customerId, Long planId) {
String planResourceName = ResourceNames.keywordPlan(customerId, planId);
try (KeywordPlanServiceClient client =
googleAdsClient.getLatestVersion().createKeywordPlanServiceClient()) {
GenerateForecastMetricsResponse response = client.generateForecastMetrics(planResourceName);
int i = 0;
for (KeywordPlanKeywordForecast forecast : response.getKeywordForecastsList()) {
ForecastMetrics metrics = forecast.getKeywordForecast();
System.out.printf("%d Keyword ID: %s%n", ++i, forecast.getKeywordPlanAdGroupKeyword());
System.out.printf("Estimated daily clicks: %f%n", metrics.getClicks());
System.out.printf("Estimated daily impressions: %f%n", metrics.getImpressions());
System.out.printf("Estimated average cpc (micros): %d%n%n", metrics.getAverageCpc());
}
}
}
}
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.V11.Errors;
using Google.Ads.GoogleAds.V11.Services;
using System;
using System.Collections.Generic;
namespace Google.Ads.GoogleAds.Examples.V11
{
/// <summary>
/// This code example generates forecast metrics for a keyword plan. To create a keyword plan,
/// run AddKeywordPlan.cs.
/// </summary>
public class GenerateForecastMetrics : ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="GenerateForecastMetrics"/> example.
/// </summary>
public class Options : OptionsBase
{
/// <summary>
/// The customer ID for which the call is made.
/// </summary>
[Option("customerId", Required = true, HelpText =
"The customer ID for which the call is made.")]
public long CustomerId { get; set; }
/// <summary>
/// The keyword plan ID.
/// </summary>
[Option("keywordPlanId", Required = true, HelpText =
"The keyword plan ID.")]
public long KeywordPlanId { 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);
GenerateForecastMetrics codeExample = new GenerateForecastMetrics();
Console.WriteLine(codeExample.Description);
codeExample.Run(new GoogleAdsClient(), options.CustomerId, options.KeywordPlanId);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description =>
"This code example generates forecast metrics for a keyword plan. To create a " +
"keyword plan, run AddKeywordPlan.cs.";
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The customer ID for which the call is made.</param>
/// <param name="keywordPlanId">The keyword plan ID.</param>
public void Run(GoogleAdsClient client, long customerId, long keywordPlanId)
{
KeywordPlanServiceClient kpServiceClient =
client.GetService(Services.V11.KeywordPlanService);
string keywordPlanResource = ResourceNames.KeywordPlan(customerId, keywordPlanId);
try
{
GenerateForecastMetricsResponse response = kpServiceClient.GenerateForecastMetrics(
keywordPlanResource);
int i = 0;
foreach (KeywordPlanKeywordForecast forecast in response.KeywordForecasts)
{
ForecastMetrics metrics = forecast.KeywordForecast;
Console.WriteLine($"{++i}) Keyword ID: {forecast.KeywordPlanAdGroupKeyword}");
Console.WriteLine($"Estimated daily clicks: {metrics.Clicks}");
Console.WriteLine($"Estimated daily impressions: {metrics.Impressions}");
Console.WriteLine($"Estimated average cpc (micros): {metrics.AverageCpc}\n");
}
}
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 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.
*/
namespace Google\Ads\GoogleAds\Examples\Planning;
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\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Lib\V11\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V11\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V11\GoogleAdsException;
use Google\Ads\GoogleAds\Util\V11\ResourceNames;
use Google\Ads\GoogleAds\V11\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V11\Services\KeywordPlanKeywordForecast;
use Google\ApiCore\ApiException;
/**
* This code example generates forecast metrics for a keyword plan. To create a keyword plan,
* run AddKeywordPlan.php.
*/
class GenerateForecastMetrics
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
private const KEYWORD_PLAN_ID = 'INSERT_KEYWORD_PLAN_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::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
ArgumentNames::KEYWORD_PLAN_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,
$options[ArgumentNames::KEYWORD_PLAN_ID] ?: self::KEYWORD_PLAN_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 $customerId the customer ID
* @param int $keywordPlanId the keyword plan ID
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
int $keywordPlanId
) {
$keywordPlanServiceClient = $googleAdsClient->getKeywordPlanServiceClient();
// Issues a request to generate forecast metrics based on the specific keyword plan ID.
$generateForecastMetricsResponse = $keywordPlanServiceClient->generateForecastMetrics(
ResourceNames::forKeywordPlan($customerId, $keywordPlanId)
);
$i = 0;
foreach ($generateForecastMetricsResponse->getKeywordForecasts() as $forecast) {
/** @var KeywordPlanKeywordForecast $forecast */
$metrics = $forecast->getKeywordForecast();
printf(
"%d) Keyword ID: %s%s",
++$i,
$forecast->getKeywordPlanAdGroupKeyword(),
PHP_EOL
);
printf(
"Estimated daily clicks: %s%s",
is_null($metrics->getClicks()) ? 'null'
: sprintf("%.2f", $metrics->getClicks()),
PHP_EOL
);
printf(
"Estimated daily impressions: %s%s",
is_null($metrics->getImpressions())
? 'null' : sprintf("%.2f", $metrics->getImpressions()),
PHP_EOL
);
printf(
"Estimated average cpc (micros): %s%s",
is_null($metrics->getAverageCpc()) ? 'null' : $metrics->getAverageCpc(),
PHP_EOL
);
}
}
}
GenerateForecastMetrics::main();
Python
#!/usr/bin/env python
# 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 generates forecast metrics for a keyword plan.
To create a keyword plan, run the add_keyword_plan.py example.
"""
import argparse
import sys
from google.ads.googleads.client import GoogleAdsClient
from google.ads.googleads.errors import GoogleAdsException
def main(client, customer_id, keyword_plan_id):
keyword_plan_service = client.get_service("KeywordPlanService")
resource_name = keyword_plan_service.keyword_plan_path(
customer_id, keyword_plan_id
)
response = keyword_plan_service.generate_forecast_metrics(
keyword_plan=resource_name
)
for i, forecast in enumerate(response.keyword_forecasts):
print(f"#{i+1} Keyword ID: {forecast.keyword_plan_ad_group_keyword}")
metrics = forecast.keyword_forecast
click_val = metrics.clicks
clicks = f"{click_val:.2f}" if click_val else "unspecified"
print(f"Estimated daily clicks: {clicks}")
imp_val = metrics.impressions
impressions = f"{imp_val:.2f}" if imp_val else "unspecified"
print(f"Estimated daily impressions: {impressions}")
cpc_val = metrics.average_cpc
cpc = f"{cpc_val:.2f}" if cpc_val else "unspecified"
print(f"Estimated average cpc: {cpc}\n")
if __name__ == "__main__":
# GoogleAdsClient will read the google-ads.yaml configuration file in the
# home directory if none is specified.
googleads_client = GoogleAdsClient.load_from_storage(version="v11")
parser = argparse.ArgumentParser(
description="Generates forecast metrics for a keyword plan."
)
# 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(
"-k",
"--keyword_plan_id",
type=str,
required=True,
help="A Keyword Plan ID.",
)
args = parser.parse_args()
try:
main(googleads_client, args.customer_id, args.keyword_plan_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'\tError with message "{error.message}".')
if error.location:
for field_path_element in error.location.field_path_elements:
print(f"\t\tOn 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 generates forecast metrics for a keyword plan. To create a
# keyword plan, run add_keyword_plan.rb.
require 'optparse'
require 'google/ads/google_ads'
def generate_forecast_metrics(customer_id, keyword_plan_id)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client = Google::Ads::GoogleAds::GoogleAdsClient.new
kp_service = client.service.keyword_plan
response = kp_service.generate_forecast_metrics(
keyword_plan: client.path.keyword_plan(customer_id, keyword_plan_id),
)
response.keyword_forecasts.each_with_index do |forecast, i|
metrics = forecast.keyword_forecast
puts "#{i + 1}) Keyword ID: #{forecast.keyword_plan_ad_group_keyword}"
clicks = if metrics.clicks.nil?
"unspecified"
else
format("%.2f", metrics.clicks)
end
puts "Estimated daily clicks: #{clicks}"
impressions = if metrics.impressions.nil?
"unspecified"
else
format("%.2f", metrics.impressions)
end
puts "Estimated daily impressions: #{impressions}"
cpc = if metrics.average_cpc.nil?
"unspecified"
else
metrics.average_cpc
end
puts "Estimated average cpc (micros): #{cpc}"
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[:keyword_plan_id] = 'INSERT_KEYWORD_PLAN_ID_HERE'
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('-k', '--keyword-plan-id KEYWORD-PLAN-ID', String,
'Keyword Plan ID') do |v|
options[:keyword_plan_id] = v
end
opts.separator ''
opts.separator 'Help:'
opts.on_tail('-h', '--help', 'Show this message') do
puts opts
exit
end
end.parse!
begin
generate_forecast_metrics(
options.fetch(:customer_id).tr("-", ""),
options.fetch(:keyword_plan_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
raise
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 generates forecast metrics for a keyword plan. To create a
# keyword plan, run add_keyword_plan.pl.
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::V11::Utils::ResourceNames;
use Getopt::Long qw(:config auto_help);
use Pod::Usage;
use Cwd qw(abs_path);
# 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 $customer_id = "INSERT_CUSTOMER_ID_HERE";
my $keyword_plan_id = "INSERT_KEYWORD_PLAN_ID_HERE";
sub generate_forecast_metrics {
my ($api_client, $customer_id, $keyword_plan_id) = @_;
my $forecast_metrics_response =
$api_client->KeywordPlanService()->generate_forecast_metrics({
keywordPlan =>
Google::Ads::GoogleAds::V11::Utils::ResourceNames::keyword_plan(
$customer_id, $keyword_plan_id
)});
while (my ($index, $forecast) =
each @{$forecast_metrics_response->{keywordForecasts}})
{
my $metrics = $forecast->{keywordForecast};
printf "%d Keyword ID: %s.\n", $index + 1,
$forecast->{keywordPlanAdGroupKeyword};
printf "Estimated daily clicks: %s.\n",
defined $metrics->{clicks} ? $metrics->{clicks} : "undef";
printf "Estimated daily impressions: %s.\n",
defined $metrics->{impressions} ? $metrics->{impressions} : "undef";
printf "Estimated average cpc (micros): %s.\n\n",
defined $metrics->{averageCpc} ? $metrics->{averageCpc} : "undef";
}
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(
"customer_id=s" => \$customer_id,
"keyword_plan_id=i" => \$keyword_plan_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($customer_id, $keyword_plan_id);
# Call the example.
generate_forecast_metrics($api_client, $customer_id =~ s/-//gr,
$keyword_plan_id);
=pod
=head1 NAME
generate_forecast_metrics
=head1 DESCRIPTION
This example generates forecast metrics for a keyword plan. To create a keyword plan,
run add_keyword_plan.pl
=head1 SYNOPSIS
generate_forecast_metrics.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
-keyword_plan_id The keyword plan ID.
=cut
