-
Notifications
You must be signed in to change notification settings - Fork 66
/
add_hotel_ad.rb
257 lines (216 loc) · 8.59 KB
/
add_hotel_ad.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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
#!/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 creates a hotel campaign, a hotel ad group, and a hotel ad group
# ad.
#
# Prerequisite: You need to have access to the Hotel Ads Center, which can be
# granted during integration with Google Hotels. The integration instructions
# can be found at:
# https://support.google.com/hotelprices/answer/6101897
require 'optparse'
require 'google/ads/google_ads'
require 'date'
def add_hotel_ads(customer_id, hotel_center_account_id,
cpc_bid_ceiling_micro_amount)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client = Google::Ads::GoogleAds::GoogleAdsClient.new
# Create a budget to be used by the campaign that will be created below.
budget_resource = add_campaign_budget(client, customer_id)
# Create a hotel campaign.
campaign_resource = add_hotel_campaign(client, customer_id, budget_resource,
hotel_center_account_id, cpc_bid_ceiling_micro_amount)
# Create a hotel ad group.
ad_group_resource = add_hotel_ad_group(client, customer_id, campaign_resource)
# Create a hotel ad group ad.
add_hotel_ad_group_ad(client, customer_id, ad_group_resource)
end
# Creates a new campaign budget in the specified client account.
def add_campaign_budget(client, customer_id)
# Create the budget and set relevant fields.
campaign_budget_operation = client.operation.create_resource.campaign_budget do |cb|
cb.name = generate_random_name_field("Interplanetary Cruise Budget")
cb.delivery_method = :STANDARD
cb.amount_micros = 50_000_000
end
# Issue a mutate request.
campaign_budget_service = client.service.campaign_budget
response = campaign_budget_service.mutate_campaign_budgets(
customer_id: customer_id,
operations: [campaign_budget_operation],
)
# Fetch the new budget's resource name.
budget_resource = response.results.first.resource_name
puts "Added budget with resource name '#{budget_resource}'."
budget_resource
end
# Creates a new campaign in the specified client account.
# [START add_hotel_ad]
def add_hotel_campaign(client, customer_id, budget_resource,
hotel_center_account_id, cpc_bid_ceiling_micro_amount)
# [START add_hotel_ad_1]
# Create a campaign.
campaign_operation = client.operation.create_resource.campaign do |c|
c.name = generate_random_name_field("Interplanetary Cruise Campaign")
# Configure settings related to hotel campaigns.
c.advertising_channel_type = :HOTEL
c.hotel_setting = client.resource.hotel_setting_info do |hsi|
hsi.hotel_center_id = hotel_center_account_id
end
# Recommendation: Set the campaign to PAUSED when creating it to prevent the
# ads from immediately serving. Set to ENABLED once you've added targeting and
# the ads are ready to serve.
c.status = :PAUSED
# Set the bidding strategy to PercentCpc. Only Manual CPC and Percent CPC can
# be used for hotel campaigns.
c.percent_cpc = client.resource.percent_cpc do |pcpc|
pcpc.cpc_bid_ceiling_micros = cpc_bid_ceiling_micro_amount
end
# Set the budget.
c.campaign_budget = budget_resource
# Configures the campaign network options. Only Google Search is allowed for
# hotel campaigns.
c.network_settings = client.resource.network_settings do |ns|
ns.target_google_search = true
end
end
# [END add_hotel_ad_1]
# Issue a mutate request to add the campaign.
campaign_service = client.service.campaign
response = campaign_service.mutate_campaigns(
customer_id: customer_id,
operations: [campaign_operation],
)
# Fetch the new campaign's resource name.
campaign_resource = response.results.first.resource_name
puts "Added hotel campaign with resource name '#{campaign_resource}'."
campaign_resource
end
# [END add_hotel_ad]
# Creates a new hotel ad group in the specified campaign.
# [START add_hotel_ad_2]
def add_hotel_ad_group(client, customer_id, campaign_resource)
# Create an ad group.
ad_group_operation = client.operation.create_resource.ad_group do |ag|
ag.name = generate_random_name_field("Earth to Mars Cruise")
# Set the campaign.
ag.campaign = campaign_resource
# Optional: Set the ad group type to HOTEL_ADS.
# This cannot be set to other types.
ag.type = :HOTEL_ADS
ag.cpc_bid_micros = 10_000_000
ag.status = :ENABLED
end
# Issue a mutate request to add the ad group.
ad_group_service = client.service.ad_group
response = ad_group_service.mutate_ad_groups(
customer_id: customer_id,
operations: [ad_group_operation]
)
# Fetch the new ad group's resource name.
ad_group_resource = response.results.first.resource_name
puts "Added hotel ad group with resource name '#{ad_group_resource}'."
ad_group_resource
end
# [END add_hotel_ad_2]
# Creates a new hotel ad group ad in the specified ad group.
# [START add_hotel_ad_3]
def add_hotel_ad_group_ad(client, customer_id, ad_group_resource)
# Create a new hotel ad.
ad_group_ad_operation = client.operation.create_resource.ad_group_ad do |aga|
# Create a new ad group ad and sets the hotel ad to it.
aga.ad = client.resource.ad do |ad|
ad.hotel_ad = client.resource.hotel_ad_info
end
# Set the ad group ad to enabled. Setting this to paused will cause an error
# for hotel campaigns. For hotels pausing should happen at either the ad group or
# campaign level.
aga.status = :ENABLED
# Set the ad group.
aga.ad_group = ad_group_resource
end
# Issue a mutate request to add the ad group ad.
ad_group_ad_service = client.service.ad_group_ad
response = ad_group_ad_service.mutate_ad_group_ads(
customer_id: customer_id,
operations: [ad_group_ad_operation],
)
# Fetch the new ad group ad's resource name.
ad_group_ad_resource = response.results.first.resource_name
puts "Added hotel ad group ad with resource name '#{ad_group_ad_resource}'."
end
# [END add_hotel_ad_3]
# Appends a random number to the provided description text and returns it as a
# string-wrapped value
def generate_random_name_field(text)
"#{text} ##{(Time.new.to_f * 100).to_i}"
end
if __FILE__ == $0
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[:hotel_center_account_id] = 'INSERT_HOTEL_CENTER_ACCOUNT_ID_HERE'
options[:cpc_bid_ceiling_micro_amount] = 20_000_000
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('-H', '--hotel-center-account-id HOTEL-CENTER-ACCOUNT-ID', Integer,
'Hotel Center Account ID') do |v|
options[:hotel_center_account_id] = v
end
opts.on('-B', '--cpc-bid-ceiling-micro-amount CPC-BID-CEILING-MICRO_AMOUNT',
Integer, 'CPC Bid Ceiling Micro Amount') do |v|
options[:cpc_bid_ceiling_micro_amount] = v
end
opts.separator ''
opts.separator 'Help:'
opts.on_tail('-h', '--help', 'Show this message') do
puts opts
exit
end
end.parse!
begin
add_hotel_ads(options.fetch(:customer_id).tr("-", ""), options[:hotel_center_account_id],
options[:cpc_bid_ceiling_micro_amount])
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