-
Notifications
You must be signed in to change notification settings - Fork 229
/
add_audience.rb
executable file
·120 lines (108 loc) · 4.22 KB
/
add_audience.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
#!/usr/bin/env ruby
# Encoding: utf-8
#
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
#
# License:: 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 illustrates how to create a user list (a.k.a. Audience) and shows
# its associated conversion tracker code snippet.
require 'adwords_api'
def add_audience()
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
# when called without parameters.
adwords = AdwordsApi::Api.new
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
# the configuration file or provide your own logger:
# adwords.logger = Logger.new('adwords_xml.log')
user_list_srv = adwords.service(:AdwordsUserListService, API_VERSION)
conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
# Prepare for adding remarketing user list.
name = "Mars cruise customers #%d" % (Time.new.to_f * 1000).to_i
operation = {
:operator => 'ADD',
:operand => {
# The 'xsi_type' field allows you to specify the xsi:type of the object
# being created. It's only necessary when you must provide an explicit
# type that the client library can't infer.
:xsi_type => 'BasicUserList',
:name => name,
:description => 'A list of mars cruise customers in the last year',
:membership_life_span => 365,
:conversion_types => [{:name => name}],
# Optional field.
:status => 'OPEN'
}
}
# Add user list.
response = user_list_srv.mutate([operation])
if response and response[:value]
user_list = response[:value].first
# Get conversion snippets.
conversion_trackers = {}
if user_list and user_list[:conversion_types]
conversion_ids = user_list[:conversion_types][:id]
selector = {
:fields => ['Id', 'GoogleGlobalSiteTag', 'GoogleEventSnippet'],
:predicates => [
{:field => 'Id', :operator => 'IN', :values => [conversion_ids]}
]
}
conv_tracker_response = conv_tracker_srv.get(selector)
if conv_tracker_response and conv_tracker_response[:entries]
conv_tracker_response[:entries].each do |conversion_tracker|
conversion_trackers[conversion_tracker[:id]] = conversion_tracker
end
end
end
puts "User list with name '%s' and ID %d was added." %
[user_list[:name], user_list[:id]]
# Display the list of associated conversion code snippets.
user_list_conversion_type = user_list[:conversion_types]
conversion_tracker =
conversion_trackers[user_list_conversion_type[:id].to_i]
puts "Google global site tag:\n%s\n" %
conversion_tracker[:google_global_site_tag]
puts "Google event snippet:\n%s\n" %
conversion_tracker[:google_event_snippet]
else
puts 'No user lists were added.'
end
end
if __FILE__ == $0
API_VERSION = :v201809
begin
add_audience()
# Authorization error.
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
"to retrieve and store OAuth2 tokens."
puts "See this wiki page for more details:\n\n " +
'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
# HTTP errors.
rescue AdsCommon::Errors::HttpError => e
puts "HTTP Error: %s" % e
# API errors.
rescue AdwordsApi::Errors::ApiException => e
puts "Message: %s" % e.message
puts 'Errors:'
e.errors.each_with_index do |error, index|
puts "\tError [%d]:" % (index + 1)
error.each do |field, value|
puts "\t\t%s: %s" % [field, value]
end
end
end
end