-
Notifications
You must be signed in to change notification settings - Fork 17
/
get_keywords.pl
144 lines (114 loc) · 4.32 KB
/
get_keywords.pl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
#!/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 gets keywords for a customer or for a specific ad group. To add
# keywords, run add_keywords.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::Utils::SearchGoogleAdsIterator;
use
Google::Ads::GoogleAds::V6::Services::GoogleAdsService::SearchGoogleAdsRequest;
use Getopt::Long qw(:config auto_help);
use Pod::Usage;
use Cwd qw(abs_path);
use constant PAGE_SIZE => 1000;
# 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 $ad_group_id = undef;
sub get_keywords {
my ($api_client, $customer_id, $ad_group_id) = @_;
# Create the search query.
my $search_query =
"SELECT ad_group.id, ad_group_criterion.type, " .
"ad_group_criterion.criterion_id, " .
"ad_group_criterion.keyword.text, " .
"ad_group_criterion.keyword.match_type FROM ad_group_criterion " .
"WHERE ad_group_criterion.type = KEYWORD";
if ($ad_group_id) {
$search_query .= " AND ad_group.id = $ad_group_id";
}
# Create a search Google Ads request that will retrieve all keywords using pages
# of the specified page size.
my $search_request =
Google::Ads::GoogleAds::V6::Services::GoogleAdsService::SearchGoogleAdsRequest
->new({
customerId => $customer_id,
query => $search_query,
pageSize => PAGE_SIZE
});
# Get the GoogleAdsService.
my $google_ads_service = $api_client->GoogleAdsService();
my $iterator = Google::Ads::GoogleAds::Utils::SearchGoogleAdsIterator->new({
service => $google_ads_service,
request => $search_request
});
# Iterate over all rows in all pages and print the requested field values for
# the keyword in each row.
while ($iterator->has_next) {
my $google_ads_row = $iterator->next;
my $ad_group = $google_ads_row->{adGroup};
my $ad_group_criterion = $google_ads_row->{adGroupCriterion};
my $keyword_info = $ad_group_criterion->{keyword};
printf
"Keyword with text '%s', match type '%s', criteria type '%s', and ID %d "
. "was found in ad group with ID %d.\n",
$keyword_info->{text},
$keyword_info->{matchType},
$ad_group_criterion->{type},
$ad_group_criterion->{criterionId},
$ad_group->{id},;
}
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, "ad_group_id=i" => \$ad_group_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);
# Call the example.
get_keywords($api_client, $customer_id =~ s/-//gr, $ad_group_id);
=pod
=head1 NAME
get_keywords
=head1 DESCRIPTION
This example gets keywords for a customer or for a specific ad group. To add
keywords, run add_keywords.pl.
=head1 SYNOPSIS
get_keywords.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
-ad_group_id [optional] The ad group ID.
=cut