#!/usr/bin/perl -w
#
# Copyright 2022, 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
#
#
# 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 historical metrics for a keyword plan. To create a
# keyword plan, run add_keyword_plan.pl.
use strict;
use utf8;
use FindBin qw($Bin);
use lib "$Bin/../../lib";
use Getopt::Long qw(:config auto_help);
use Cwd qw(abs_path);
# [START generate_historical_metrics]
sub generate_historical_metrics {
my ($api_client, $customer_id, $keyword_plan_id) = @_;
my $historical_metrics_response =
$api_client->KeywordPlanService()->generate_historical_metrics({
keywordPlan =>
Google::Ads::GoogleAds::V12::Utils::ResourceNames::keyword_plan(
$customer_id, $keyword_plan_id
)});
foreach my $metric (@{$historical_metrics_response->{metrics}}) {
# These metrics include those for both the search query and any
# variants included in the response.
# If the metric is undefined, print (undef) as a placeholder.
printf
"The search query, %s, (and the following variants: %s), generated the following historical metrics:\n",
$metric->{searchQuery},
$metric->{closeVariants}
? join(', ', $metric->{closeVariants})
: "(undef)";
# Approximate number of monthly searches on this query averaged for
# the past 12 months.
printf "\tApproximate monthly searches: %s.\n",
value_or_undef($metric->{keywordMetrics}{avgMonthlySearches});
# The competition level for this search query.
printf "\tCompetition level: %s.\n",
value_or_undef($metric->{keywordMetrics}{competition});
# The competition index for the query in the range [0, 100]. This shows how
# competitive ad placement is for a keyword. The level of competition from
# 0-100 is determined by the number of ad slots filled divided by the total
# number of ad slots available. If not enough data is available, undef will
# be returned.
printf "\tCompetition index: %s.\n",
value_or_undef($metric->{keywordMetrics}{competitionIndex});
# Top of page bid low range (20th percentile) in micros for the keyword.
printf "\tTop of page bid low range: %s.\n",
value_or_undef($metric->{keywordMetrics}{lowTopOfPageBidMicros});
# Top of page bid high range (80th percentile) in micros for the keyword.
printf "\tTop of page bid high range: %s.\n",
value_or_undef($metric->{keywordMetrics}{highTopOfPageBidMicros});
# Approximate number of searches on this query for the past twelve months.
foreach my $month (@{$metric->{keywordMetrics}{monthlySearchVolumes}}) {
printf "\tApproximately %d searches in %s, %s.\n",
$month->{monthlySearches}, $month->{month}, $month->{year};
}
}
return 1;
}
# [END generate_historical_metrics]
# Returns the input value as a string if it's defined, otherwise returns "(undef)".
sub value_or_undef {
my ($value) = @_;
return $value ? "$value" : "(undef)";
}
# 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);
my $customer_id = undef;
my $keyword_plan_id = undef;
# 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_historical_metrics($api_client, $customer_id =~ s/-//gr,
$keyword_plan_id);
=pod
=head1 NAME
generate_historical_metrics
=head1 DESCRIPTION
This example generates historical metrics for a keyword plan. To create a keyword plan,
run add_keyword_plan.pl
=head1 SYNOPSIS
generate_historical_metrics.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
-keyword_plan_id The keyword plan ID.
=cut