-
Notifications
You must be signed in to change notification settings - Fork 66
/
find_and_remove_criteria_from_shared_set.rb
executable file
·142 lines (119 loc) · 4.57 KB
/
find_and_remove_criteria_from_shared_set.rb
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
#!/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 demonstrates how to find shared sets, shared set criteria, and
# how to remove them.
require 'optparse'
require 'google/ads/google_ads'
def find_and_remove_criteria_from_shared_set(customer_id, campaign_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
shared_set_ids = []
criterion_ids = []
# First, retrieve all shared sets associated with the campaign.
query = <<~QUERY
SELECT shared_set.id, shared_set.name
FROM campaign_shared_set
WHERE campaign.id = #{campaign_id}
QUERY
response = ga_service.search(customer_id, query, page_size: PAGE_SIZE)
response.each do |row|
shared_set = row.shared_set
puts "Campaign shared set ID #{shared_set.id} and name '#{shared_set.name}' was found."
shared_set_ids << shared_set.id
end
# Next, retrieve shared criteria for all found shared sets.
query = <<~QUERY
SELECT shared_criterion.type, shared_criterion.keyword.text,
shared_criterion.keyword.match_type, shared_set.id
FROM shared_criterion
WHERE shared_set.id IN (#{shared_set_ids.join(',')})
QUERY
response = ga_service.search(customer_id, query, page_size: PAGE_SIZE)
response.each do |row|
sc = row.shared_criterion
if sc.type == :KEYWORD
puts "Shared criterion with resource name '#{sc.resource_name}' for negative keyword " +
"with text '#{sc.keyword.text}' and match type '#{sc.keyword.match_type}' was found."
else
puts "Shared criterion with resource name '#{sc.resource_name}' was found."
end
criterion_ids << sc.resource_name
end
# Finally, remove the criteria.
operations = criterion_ids.map do |criterion|
client.operation.remove_resource.shared_criterion(criterion)
end
response = client.service.shared_criterion.mutate_shared_criteria(customer_id, operations)
response.results.each do |result|
puts "Removed shared criterion #{result.resource_name}"
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_CUSTOMER_ID_HERE'
options[:campaign_id] = 'INSERT_CAMPAIGN_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.on('-c', '--campaign-id CAMPAIGN-ID', String, 'Campaign ID') do |v|
options[:campaign_id] = v
end
opts.separator ''
opts.separator 'Help:'
opts.on_tail('-h', '--help', 'Show this message') do
puts opts
exit
end
end.parse!
begin
find_and_remove_criteria_from_shared_set(options.fetch(:customer_id).tr("-", ""),
options[:campaign_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