google-adwords-api 0.20.0 → 0.20.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (201) hide show
  1. checksums.yaml +4 -4
  2. data/ChangeLog +7 -0
  3. data/examples/v201601/remarketing/add_crm_based_user_list.rb +2 -2
  4. data/examples/v201603/remarketing/add_crm_based_user_list.rb +2 -2
  5. data/examples/v201605/advanced_operations/add_click_to_download_ad.rb +2 -2
  6. data/examples/v201605/advanced_operations/add_html5_ad.rb +2 -2
  7. data/examples/v201605/remarketing/add_crm_based_user_list.rb +2 -2
  8. data/examples/v201607/account_management/create_account.rb +88 -0
  9. data/examples/v201607/account_management/get_account_changes.rb +135 -0
  10. data/examples/v201607/account_management/get_account_hierarchy.rb +132 -0
  11. data/examples/v201607/advanced_operations/add_ad_customizers.rb +184 -0
  12. data/examples/v201607/advanced_operations/add_ad_group_bid_modifier.rb +101 -0
  13. data/examples/v201607/advanced_operations/add_click_to_download_ad.rb +148 -0
  14. data/examples/v201607/advanced_operations/add_html5_ad.rb +137 -0
  15. data/examples/v201607/advanced_operations/add_responsive_display_ad.rb +130 -0
  16. data/examples/v201607/advanced_operations/add_text_ad_with_upgraded_urls.rb +134 -0
  17. data/examples/v201607/advanced_operations/create_and_attach_shared_keyword_set.rb +141 -0
  18. data/examples/v201607/advanced_operations/find_and_remove_criteria_from_shared_set.rb +174 -0
  19. data/examples/v201607/advanced_operations/get_ad_group_bid_modifiers.rb +102 -0
  20. data/examples/v201607/advanced_operations/use_portfolio_bidding_strategy.rb +146 -0
  21. data/examples/v201607/basic_operations/add_ad_groups.rb +142 -0
  22. data/examples/v201607/basic_operations/add_campaigns.rb +138 -0
  23. data/examples/v201607/basic_operations/add_expanded_text_ads.rb +108 -0
  24. data/examples/v201607/basic_operations/add_keywords.rb +114 -0
  25. data/examples/v201607/basic_operations/add_text_ads.rb +109 -0
  26. data/examples/v201607/basic_operations/get_ad_groups.rb +102 -0
  27. data/examples/v201607/basic_operations/get_campaigns.rb +97 -0
  28. data/examples/v201607/basic_operations/get_campaigns_with_awql.rb +89 -0
  29. data/examples/v201607/basic_operations/get_expanded_text_ads.rb +122 -0
  30. data/examples/v201607/basic_operations/get_keywords.rb +109 -0
  31. data/examples/v201607/basic_operations/get_text_ads.rb +110 -0
  32. data/examples/v201607/basic_operations/pause_ad.rb +88 -0
  33. data/examples/v201607/basic_operations/remove_ad.rb +89 -0
  34. data/examples/v201607/basic_operations/remove_ad_group.rb +85 -0
  35. data/examples/v201607/basic_operations/remove_campaign.rb +87 -0
  36. data/examples/v201607/basic_operations/remove_keyword.rb +94 -0
  37. data/examples/v201607/basic_operations/update_ad_group.rb +85 -0
  38. data/examples/v201607/basic_operations/update_campaign.rb +86 -0
  39. data/examples/v201607/basic_operations/update_keyword.rb +106 -0
  40. data/examples/v201607/campaign_management/add_campaign_labels.rb +82 -0
  41. data/examples/v201607/campaign_management/add_complete_campaigns_using_batch_job.rb +355 -0
  42. data/examples/v201607/campaign_management/add_draft.rb +114 -0
  43. data/examples/v201607/campaign_management/add_experiment.rb +162 -0
  44. data/examples/v201607/campaign_management/add_keywords_using_incremental_batch_job.rb +210 -0
  45. data/examples/v201607/campaign_management/add_trial.rb +142 -0
  46. data/examples/v201607/campaign_management/get_all_disapproved_ads.rb +97 -0
  47. data/examples/v201607/campaign_management/get_all_disapproved_ads_with_awql.rb +89 -0
  48. data/examples/v201607/campaign_management/get_campaigns_by_label.rb +108 -0
  49. data/examples/v201607/campaign_management/graduate_trial.rb +106 -0
  50. data/examples/v201607/campaign_management/promote_experiment.rb +81 -0
  51. data/examples/v201607/campaign_management/set_ad_parameters.rb +118 -0
  52. data/examples/v201607/campaign_management/set_criterion_bid_modifier.rb +104 -0
  53. data/examples/v201607/campaign_management/validate_text_ad.rb +110 -0
  54. data/examples/v201607/error_handling/handle_partial_failures.rb +130 -0
  55. data/examples/v201607/error_handling/handle_policy_violation_error.rb +141 -0
  56. data/examples/v201607/extensions/add_google_my_business_location_extensions.rb +193 -0
  57. data/examples/v201607/extensions/add_prices.rb +164 -0
  58. data/examples/v201607/extensions/add_site_links.rb +199 -0
  59. data/examples/v201607/extensions/add_site_links_using_feeds.rb +286 -0
  60. data/examples/v201607/migration/migrate_to_extension_settings.rb +386 -0
  61. data/examples/v201607/migration/upgrade_ad_url.rb +93 -0
  62. data/examples/v201607/misc/get_all_images_and_videos.rb +104 -0
  63. data/examples/v201607/misc/setup_oauth2.rb +84 -0
  64. data/examples/v201607/misc/upload_image.rb +93 -0
  65. data/examples/v201607/misc/upload_media_bundle.rb +90 -0
  66. data/examples/v201607/misc/use_oauth2_jwt.rb +93 -0
  67. data/examples/v201607/misc/use_runtime_config.rb +92 -0
  68. data/examples/v201607/optimization/estimate_keyword_traffic.rb +191 -0
  69. data/examples/v201607/optimization/get_campaign_criterion_bid_modifier_simulations.rb +128 -0
  70. data/examples/v201607/optimization/get_keyword_bid_simulations.rb +95 -0
  71. data/examples/v201607/optimization/get_keyword_ideas.rb +136 -0
  72. data/examples/v201607/remarketing/add_audience.rb +118 -0
  73. data/examples/v201607/remarketing/add_conversion_tracker.rb +97 -0
  74. data/examples/v201607/remarketing/add_crm_based_user_list.rb +116 -0
  75. data/examples/v201607/remarketing/add_rule_based_user_lists.rb +167 -0
  76. data/examples/v201607/remarketing/upload_offline_conversions.rb +98 -0
  77. data/examples/v201607/reporting/download_criteria_report.rb +92 -0
  78. data/examples/v201607/reporting/download_criteria_report_with_awql.rb +93 -0
  79. data/examples/v201607/reporting/get_report_fields.rb +75 -0
  80. data/examples/v201607/reporting/parallel_report_download.rb +164 -0
  81. data/examples/v201607/reporting/stream_criteria_report_results.rb +97 -0
  82. data/examples/v201607/shopping_campaigns/add_product_partition_tree.rb +267 -0
  83. data/examples/v201607/shopping_campaigns/add_product_scope.rb +129 -0
  84. data/examples/v201607/shopping_campaigns/add_shopping_campaign.rb +129 -0
  85. data/examples/v201607/shopping_campaigns/get_product_category_taxonomy.rb +115 -0
  86. data/examples/v201607/targeting/add_campaign_targeting_criteria.rb +166 -0
  87. data/examples/v201607/targeting/add_demographic_targeting_criteria.rb +112 -0
  88. data/examples/v201607/targeting/get_campaign_targeting_criteria.rb +106 -0
  89. data/examples/v201607/targeting/get_targetable_languages_and_carriers.rb +89 -0
  90. data/examples/v201607/targeting/lookup_location.rb +108 -0
  91. data/lib/adwords_api/api_config.rb +96 -4
  92. data/lib/adwords_api/batch_job_utils.rb +6 -5
  93. data/lib/adwords_api/v201607/account_label_service.rb +46 -0
  94. data/lib/adwords_api/v201607/account_label_service_registry.rb +46 -0
  95. data/lib/adwords_api/v201607/ad_customizer_feed_service.rb +46 -0
  96. data/lib/adwords_api/v201607/ad_customizer_feed_service_registry.rb +46 -0
  97. data/lib/adwords_api/v201607/ad_group_ad_service.rb +70 -0
  98. data/lib/adwords_api/v201607/ad_group_ad_service_registry.rb +46 -0
  99. data/lib/adwords_api/v201607/ad_group_bid_modifier_service.rb +54 -0
  100. data/lib/adwords_api/v201607/ad_group_bid_modifier_service_registry.rb +46 -0
  101. data/lib/adwords_api/v201607/ad_group_criterion_service.rb +62 -0
  102. data/lib/adwords_api/v201607/ad_group_criterion_service_registry.rb +46 -0
  103. data/lib/adwords_api/v201607/ad_group_extension_setting_service.rb +54 -0
  104. data/lib/adwords_api/v201607/ad_group_extension_setting_service_registry.rb +46 -0
  105. data/lib/adwords_api/v201607/ad_group_feed_service.rb +54 -0
  106. data/lib/adwords_api/v201607/ad_group_feed_service_registry.rb +46 -0
  107. data/lib/adwords_api/v201607/ad_group_service.rb +62 -0
  108. data/lib/adwords_api/v201607/ad_group_service_registry.rb +46 -0
  109. data/lib/adwords_api/v201607/ad_param_service.rb +46 -0
  110. data/lib/adwords_api/v201607/ad_param_service_registry.rb +46 -0
  111. data/lib/adwords_api/v201607/adwords_user_list_service.rb +62 -0
  112. data/lib/adwords_api/v201607/adwords_user_list_service_registry.rb +46 -0
  113. data/lib/adwords_api/v201607/batch_job_service.rb +54 -0
  114. data/lib/adwords_api/v201607/batch_job_service_registry.rb +46 -0
  115. data/lib/adwords_api/v201607/bidding_strategy_service.rb +54 -0
  116. data/lib/adwords_api/v201607/bidding_strategy_service_registry.rb +46 -0
  117. data/lib/adwords_api/v201607/budget_order_service.rb +54 -0
  118. data/lib/adwords_api/v201607/budget_order_service_registry.rb +46 -0
  119. data/lib/adwords_api/v201607/budget_service.rb +54 -0
  120. data/lib/adwords_api/v201607/budget_service_registry.rb +46 -0
  121. data/lib/adwords_api/v201607/campaign_criterion_service.rb +54 -0
  122. data/lib/adwords_api/v201607/campaign_criterion_service_registry.rb +46 -0
  123. data/lib/adwords_api/v201607/campaign_extension_setting_service.rb +54 -0
  124. data/lib/adwords_api/v201607/campaign_extension_setting_service_registry.rb +46 -0
  125. data/lib/adwords_api/v201607/campaign_feed_service.rb +54 -0
  126. data/lib/adwords_api/v201607/campaign_feed_service_registry.rb +46 -0
  127. data/lib/adwords_api/v201607/campaign_service.rb +62 -0
  128. data/lib/adwords_api/v201607/campaign_service_registry.rb +46 -0
  129. data/lib/adwords_api/v201607/campaign_shared_set_service.rb +54 -0
  130. data/lib/adwords_api/v201607/campaign_shared_set_service_registry.rb +46 -0
  131. data/lib/adwords_api/v201607/constant_data_service.rb +110 -0
  132. data/lib/adwords_api/v201607/constant_data_service_registry.rb +46 -0
  133. data/lib/adwords_api/v201607/conversion_tracker_service.rb +54 -0
  134. data/lib/adwords_api/v201607/conversion_tracker_service_registry.rb +46 -0
  135. data/lib/adwords_api/v201607/customer_extension_setting_service.rb +54 -0
  136. data/lib/adwords_api/v201607/customer_extension_setting_service_registry.rb +46 -0
  137. data/lib/adwords_api/v201607/customer_feed_service.rb +54 -0
  138. data/lib/adwords_api/v201607/customer_feed_service_registry.rb +46 -0
  139. data/lib/adwords_api/v201607/customer_service.rb +46 -0
  140. data/lib/adwords_api/v201607/customer_service_registry.rb +46 -0
  141. data/lib/adwords_api/v201607/customer_sync_service.rb +38 -0
  142. data/lib/adwords_api/v201607/customer_sync_service_registry.rb +47 -0
  143. data/lib/adwords_api/v201607/data_service.rb +94 -0
  144. data/lib/adwords_api/v201607/data_service_registry.rb +46 -0
  145. data/lib/adwords_api/v201607/draft_async_error_service.rb +46 -0
  146. data/lib/adwords_api/v201607/draft_async_error_service_registry.rb +46 -0
  147. data/lib/adwords_api/v201607/draft_service.rb +54 -0
  148. data/lib/adwords_api/v201607/draft_service_registry.rb +46 -0
  149. data/lib/adwords_api/v201607/experiment_service.rb +46 -0
  150. data/lib/adwords_api/v201607/experiment_service_registry.rb +46 -0
  151. data/lib/adwords_api/v201607/feed_item_service.rb +54 -0
  152. data/lib/adwords_api/v201607/feed_item_service_registry.rb +46 -0
  153. data/lib/adwords_api/v201607/feed_mapping_service.rb +54 -0
  154. data/lib/adwords_api/v201607/feed_mapping_service_registry.rb +46 -0
  155. data/lib/adwords_api/v201607/feed_service.rb +54 -0
  156. data/lib/adwords_api/v201607/feed_service_registry.rb +46 -0
  157. data/lib/adwords_api/v201607/label_service.rb +54 -0
  158. data/lib/adwords_api/v201607/label_service_registry.rb +46 -0
  159. data/lib/adwords_api/v201607/location_criterion_service.rb +46 -0
  160. data/lib/adwords_api/v201607/location_criterion_service_registry.rb +46 -0
  161. data/lib/adwords_api/v201607/managed_customer_service.rb +78 -0
  162. data/lib/adwords_api/v201607/managed_customer_service_registry.rb +46 -0
  163. data/lib/adwords_api/v201607/media_service.rb +54 -0
  164. data/lib/adwords_api/v201607/media_service_registry.rb +46 -0
  165. data/lib/adwords_api/v201607/offline_conversion_feed_service.rb +38 -0
  166. data/lib/adwords_api/v201607/offline_conversion_feed_service_registry.rb +46 -0
  167. data/lib/adwords_api/v201607/report_definition_service.rb +38 -0
  168. data/lib/adwords_api/v201607/report_definition_service_registry.rb +46 -0
  169. data/lib/adwords_api/v201607/shared_criterion_service.rb +54 -0
  170. data/lib/adwords_api/v201607/shared_criterion_service_registry.rb +46 -0
  171. data/lib/adwords_api/v201607/shared_set_service.rb +54 -0
  172. data/lib/adwords_api/v201607/shared_set_service_registry.rb +46 -0
  173. data/lib/adwords_api/v201607/targeting_idea_service.rb +38 -0
  174. data/lib/adwords_api/v201607/targeting_idea_service_registry.rb +46 -0
  175. data/lib/adwords_api/v201607/traffic_estimator_service.rb +38 -0
  176. data/lib/adwords_api/v201607/traffic_estimator_service_registry.rb +46 -0
  177. data/lib/adwords_api/v201607/trial_async_error_service.rb +46 -0
  178. data/lib/adwords_api/v201607/trial_async_error_service_registry.rb +46 -0
  179. data/lib/adwords_api/v201607/trial_service.rb +54 -0
  180. data/lib/adwords_api/v201607/trial_service_registry.rb +46 -0
  181. data/lib/adwords_api/version.rb +1 -1
  182. data/test/adwords_api/test_adwords_api.rb +1 -1
  183. data/test/adwords_api/test_api_config.rb +8 -8
  184. data/test/adwords_api/test_batch_job_utils.rb +5 -5
  185. data/test/adwords_api/test_choices.rb +2 -2
  186. data/test/adwords_api/test_report_stream.rb +1 -1
  187. data/test/adwords_api/test_report_utils.rb +1 -1
  188. data/test/templates/v201601/basic_operations_get_campaigns.def +116 -0
  189. data/test/templates/v201601/basic_operations_update_keyword.def +125 -0
  190. data/test/templates/v201601/misc_use_oauth2_jwt.def +131 -0
  191. data/test/templates/v201603/basic_operations_get_campaigns.def +116 -0
  192. data/test/templates/v201603/basic_operations_update_keyword.def +125 -0
  193. data/test/templates/v201603/misc_use_oauth2_jwt.def +131 -0
  194. data/test/templates/v201605/basic_operations_get_campaigns.def +1 -1
  195. data/test/templates/v201605/basic_operations_update_keyword.def +125 -0
  196. data/test/templates/v201605/misc_use_oauth2_jwt.def +1 -1
  197. data/test/templates/v201607/basic_operations_get_campaigns.def +116 -0
  198. data/test/templates/v201607/basic_operations_update_keyword.def +125 -0
  199. data/test/templates/v201607/misc_use_oauth2_jwt.def +131 -0
  200. data/test/test_utils.rb +4 -1
  201. metadata +183 -2
@@ -0,0 +1,199 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2015, Google Inc. All Rights Reserved.
5
+ #
6
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15
+ # implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ # This example adds a sitelinks feed and associates it with a campaign.
20
+
21
+ require 'adwords_api'
22
+ require 'date'
23
+
24
+ def add_site_links(campaign_id)
25
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
26
+ # when called without parameters.
27
+ adwords = AdwordsApi::Api.new
28
+
29
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
30
+ # the configuration file or provide your own logger:
31
+ # adwords.logger = Logger.new('adwords_xml.log')
32
+
33
+ customer_srv = adwords.service(:CustomerService, API_VERSION)
34
+
35
+ # Find the matching customer and its time zone. The get_customers method will
36
+ # return a single customer corresponding to the configured client_customer_id.
37
+ customer = customer_srv.get_customers().first
38
+ customer_time_zone = customer[:date_time_zone]
39
+ puts 'Found customer ID %d with time zone "%s"' %
40
+ [customer[:customer_id], customer_time_zone]
41
+
42
+ if customer_time_zone.nil?
43
+ raise StandardError, 'Customer not found for customer ID: ' + customer_id
44
+ end
45
+
46
+ campaign_extension_setting_srv =
47
+ adwords.service(:CampaignExtensionSettingService, API_VERSION)
48
+
49
+ sitelink_1 = {
50
+ :xsi_type => "SitelinkFeedItem",
51
+ :sitelink_text => "Store Hours",
52
+ :sitelink_final_urls => {
53
+ :urls => ["http://www.example.com/storehours"]
54
+ }
55
+ }
56
+
57
+ sitelink_2 = {
58
+ :xsi_type => "SitelinkFeedItem",
59
+ :sitelink_text => "Thanksgiving Specials",
60
+ :sitelink_final_urls => {
61
+ :urls => ["http://www.example.com/thanksgiving"]
62
+ },
63
+ :start_time => DateTime.new(Date.today.year, 11, 20, 0, 0, 0).
64
+ strftime("%Y%m%d %H%M%S ") + customer_time_zone,
65
+ :end_time => DateTime.new(Date.today.year, 11, 27, 23, 59, 59).
66
+ strftime("%Y%m%d %H%M%S ") + customer_time_zone,
67
+ # Target this sitelink for United States only. See
68
+ # https://developers.google.com/adwords/api/docs/appendix/geotargeting
69
+ # for valid geolocation codes.
70
+ :geo_targeting => {
71
+ :id => 2840
72
+ },
73
+ # Restrict targeting only to people physically within the United States.
74
+ # Otherwise, this could also show to people interested in the United States
75
+ # but not physically located there.
76
+ :geo_targeting_restriction => {
77
+ :geo_restriction => 'LOCATION_OF_PRESENCE'
78
+ }
79
+ }
80
+
81
+ sitelink_3 = {
82
+ :xsi_type => "SitelinkFeedItem",
83
+ :sitelink_text => "Wifi available",
84
+ :sitelink_final_urls => {
85
+ :urls => ["http://www.example.com/mobile/wifi"]
86
+ },
87
+ :device_preference => {:device_preference => 30001},
88
+ # Target this sitelink only when the ad is triggered by the keyword
89
+ # "free wifi".
90
+ :keyword_targeting => {
91
+ :text => "free wifi",
92
+ :match_type => 'BROAD'
93
+ }
94
+ }
95
+
96
+ sitelink_4 = {
97
+ :xsi_type => "SitelinkFeedItem",
98
+ :sitelink_text => "Happy hours",
99
+ :sitelink_final_urls => {
100
+ :urls => ["http://www.example.com/happyhours"]
101
+ },
102
+ :scheduling => {
103
+ :feed_item_schedules => [
104
+ {
105
+ :day_of_week => 'MONDAY',
106
+ :start_hour => 18,
107
+ :start_minute => 'ZERO',
108
+ :end_hour => 21,
109
+ :end_minute => 'ZERO'
110
+ },
111
+ {
112
+ :day_of_week => 'TUESDAY',
113
+ :start_hour => 18,
114
+ :start_minute => 'ZERO',
115
+ :end_hour => 21,
116
+ :end_minute => 'ZERO'
117
+ },
118
+ {
119
+ :day_of_week => 'WEDNESDAY',
120
+ :start_hour => 18,
121
+ :start_minute => 'ZERO',
122
+ :end_hour => 21,
123
+ :end_minute => 'ZERO'
124
+ },
125
+ {
126
+ :day_of_week => 'THURSDAY',
127
+ :start_hour => 18,
128
+ :start_minute => 'ZERO',
129
+ :end_hour => 21,
130
+ :end_minute => 'ZERO'
131
+ },
132
+ {
133
+ :day_of_week => 'FRIDAY',
134
+ :start_hour => 18,
135
+ :start_minute => 'ZERO',
136
+ :end_hour => 21,
137
+ :end_minute => 'ZERO'
138
+ }
139
+ ]
140
+ }
141
+ }
142
+
143
+ campaign_extension_setting = {
144
+ :campaign_id => campaign_id,
145
+ :extension_type => 'SITELINK',
146
+ :extension_setting => {
147
+ :extensions => [sitelink_1, sitelink_2, sitelink_3, sitelink_4]
148
+ }
149
+ }
150
+
151
+ operation = {
152
+ :operand => campaign_extension_setting,
153
+ :operator => 'ADD'
154
+ }
155
+
156
+ response = campaign_extension_setting_srv.mutate([operation])
157
+ if response and response[:value]
158
+ new_extension_setting = response[:value].first
159
+ puts "Extension setting with type = %s was added to campaign ID %d" % [
160
+ new_extension_setting[:extension_type],
161
+ new_extension_setting[:campaign_id]
162
+ ]
163
+ elsif
164
+ puts "No extension settings were created."
165
+ end
166
+ end
167
+
168
+ if __FILE__ == $0
169
+ API_VERSION = :v201607
170
+
171
+ begin
172
+ # Campaign ID to add site link to.
173
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
174
+ add_site_links(campaign_id)
175
+
176
+ # Authorization error.
177
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
178
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
179
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
180
+ "to retrieve and store OAuth2 tokens."
181
+ puts "See this wiki page for more details:\n\n " +
182
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
183
+
184
+ # HTTP errors.
185
+ rescue AdsCommon::Errors::HttpError => e
186
+ puts "HTTP Error: %s" % e
187
+
188
+ # API errors.
189
+ rescue AdwordsApi::Errors::ApiException => e
190
+ puts "Message: %s" % e.message
191
+ puts 'Errors:'
192
+ e.errors.each_with_index do |error, index|
193
+ puts "\tError [%d]:" % (index + 1)
194
+ error.each do |field, value|
195
+ puts "\t\t%s: %s" % [field, value]
196
+ end
197
+ end
198
+ end
199
+ end
@@ -0,0 +1,286 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
5
+ #
6
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15
+ # implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ # This example adds a sitelinks feed and associates it with a campaign.
20
+
21
+ require 'adwords_api'
22
+
23
+ def add_site_links(campaign_id)
24
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
25
+ # when called without parameters.
26
+ adwords = AdwordsApi::Api.new
27
+
28
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
29
+ # the configuration file or provide your own logger:
30
+ # adwords.logger = Logger.new('adwords_xml.log')
31
+
32
+ feed_srv = adwords.service(:FeedService, API_VERSION)
33
+ feed_item_srv = adwords.service(:FeedItemService, API_VERSION)
34
+ feed_mapping_srv = adwords.service(:FeedMappingService, API_VERSION)
35
+ campaign_feed_srv = adwords.service(:CampaignFeedService, API_VERSION)
36
+
37
+ sitelinks_data = {}
38
+
39
+ # Create site links feed first.
40
+ site_links_feed = {
41
+ :name => 'Feed For Site Links',
42
+ :attributes => [
43
+ {:type => 'STRING', :name => 'Link Text'},
44
+ {:type => 'URL_LIST', :name => 'Final URLs'},
45
+ {:type => 'STRING', :name => 'Line 1 Description'},
46
+ {:type => 'STRING', :name => 'Line 2 Description'}
47
+ ]
48
+ }
49
+
50
+ response = feed_srv.mutate([
51
+ {:operator => 'ADD', :operand => site_links_feed}
52
+ ])
53
+ if response and response[:value]
54
+ feed = response[:value].first
55
+ # Attribute of type STRING.
56
+ link_text_feed_attribute_id = feed[:attributes][0][:id]
57
+ # Attribute of type URL_LIST.
58
+ final_url_feed_attribute_id = feed[:attributes][1][:id]
59
+ # Attribute of type STRING.
60
+ line_1_feed_attribute_id = feed[:attributes][2][:id]
61
+ #Attribute of type STRING.
62
+ line_2_feed_attribute_id = feed[:attributes][3][:id]
63
+ puts "Feed with name '%s' and ID %d was added with" %
64
+ [feed[:name], feed[:id]]
65
+ puts "\tText attribute ID %d and Final URLs attribute ID %d " +
66
+ "and Line 1 attribute ID %d and Line 2 attribute ID %d." % [
67
+ link_text_feed_attribute_id,
68
+ final_url_feed_attribute_id,
69
+ line_1_feed_attribute_id,
70
+ line_2_feed_attribute_id
71
+ ]
72
+
73
+ sitelinks_data[:feed_id] = feed[:id]
74
+ sitelinks_data[:link_text_feed_id] = link_text_feed_attribute_id
75
+ sitelinks_data[:final_url_feed_id] = final_url_feed_attribute_id
76
+ sitelinks_data[:line_1_feed_id] = line_1_feed_attribute_id
77
+ sitelinks_data[:line_2_feed_id] = line_2_feed_attribute_id
78
+ else
79
+ raise new StandardError, 'No feeds were added.'
80
+ end
81
+
82
+ # Create site links feed items.
83
+ items_data = [
84
+ {
85
+ :text => 'Home',
86
+ :final_urls => ['http://www.example.com'],
87
+ :line_1 => 'Home line 1',
88
+ :line_2 => 'Home line 2'
89
+ },
90
+ {
91
+ :text => 'Stores',
92
+ :final_urls => ['http://www.example.com/stores'],
93
+ :line_1 => 'Stores line 1',
94
+ :line_2 => 'Stores line 2'
95
+ },
96
+ {
97
+ :text => 'On Sale',
98
+ :final_urls => ['http://www.example.com/sale'],
99
+ :line_1 => 'On Sale line 1',
100
+ :line_2 => 'On Sale line 2'
101
+ },
102
+ {
103
+ :text => 'Support',
104
+ :final_urls => ['http://www.example.com/support'],
105
+ :line_1 => 'Support line 1',
106
+ :line_2 => 'Support line 2'
107
+ },
108
+ {
109
+ :text => 'Products',
110
+ :final_urls => ['http://www.example.com/products'],
111
+ :line_1 => 'Products line 1',
112
+ :line_2 => 'Products line 2'
113
+ },
114
+ {
115
+ :text => 'About Us',
116
+ :final_urls => ['http://www.example.com/about'],
117
+ :line_1 => 'About line 1',
118
+ :line_2 => 'About line 2',
119
+ :location_id => '21137'
120
+ }
121
+ ]
122
+
123
+ feed_items = items_data.map do |item|
124
+ feed_item = {
125
+ :feed_id => sitelinks_data[:feed_id],
126
+ :attribute_values => [
127
+ {
128
+ :feed_attribute_id => sitelinks_data[:link_text_feed_id],
129
+ :string_value => item[:text]
130
+ },
131
+ {
132
+ :feed_attribute_id => sitelinks_data[:final_url_feed_id],
133
+ :string_values => item[:final_urls]
134
+ },
135
+ {
136
+ :feed_attribute_id => sitelinks_data[:line_1_feed_id],
137
+ :string_value => item[:line_1]
138
+ },
139
+ {
140
+ :feed_attribute_id => sitelinks_data[:line_2_feed_id],
141
+ :string_value => item[:line_2]
142
+ }
143
+ ]
144
+ }
145
+ # OPTIONAL: Use geographical targeting on a feed.
146
+ # The IDs can be found in the documentation or retrieved with the
147
+ # LocationCriterionService.
148
+ unless item[:location_id].nil?
149
+ feed_item[:geo_targeting] = {
150
+ :id => item[:location_id]
151
+ }
152
+ # OPTIONAL: Restrict targeting only to people physically within the
153
+ # location.
154
+ feed_item[:geo_targeting_restriction] = {
155
+ :geo_restriction => 'LOCATION_OF_PRESENCE'
156
+ }
157
+ end
158
+ next feed_item
159
+ end
160
+
161
+ feed_items_operations = feed_items.map do |item|
162
+ {:operator => 'ADD', :operand => item}
163
+ end
164
+
165
+ response = feed_item_srv.mutate(feed_items_operations)
166
+ if response and response[:value]
167
+ sitelinks_data[:feed_item_ids] = []
168
+ response[:value].each do |feed_item|
169
+ puts 'Feed item with ID %d was added.' % feed_item[:feed_item_id]
170
+ sitelinks_data[:feed_item_ids] << feed_item[:feed_item_id]
171
+ end
172
+ else
173
+ raise new StandardError, 'No feed items were added.'
174
+ end
175
+
176
+ # Create site links feed mapping.
177
+ feed_mapping = {
178
+ :placeholder_type => PLACEHOLDER_SITELINKS,
179
+ :feed_id => sitelinks_data[:feed_id],
180
+ :attribute_field_mappings => [
181
+ {
182
+ :feed_attribute_id => sitelinks_data[:link_text_feed_id],
183
+ :field_id => PLACEHOLDER_FIELD_SITELINK_LINK_TEXT
184
+ },
185
+ {
186
+ :feed_attribute_id => sitelinks_data[:final_url_feed_id],
187
+ :field_id => PLACEHOLDER_FIELD_SITELINK_FINAL_URLS
188
+ },
189
+ {
190
+ :feed_attribute_id => sitelinks_data[:line_1_feed_id],
191
+ :field_id => PLACEHOLDER_FIELD_SITELINK_LINE_1_TEXT
192
+ },
193
+ {
194
+ :feed_attribute_id => sitelinks_data[:line_2_feed_id],
195
+ :field_id => PLACEHOLDER_FIELD_SITELINK_LINE_2_TEXT
196
+ }
197
+ ]
198
+ }
199
+
200
+ response = feed_mapping_srv.mutate([
201
+ {:operator => 'ADD', :operand => feed_mapping}
202
+ ])
203
+ if response and response[:value]
204
+ feed_mapping = response[:value].first
205
+ puts ('Feed mapping with ID %d and placeholder type %d was saved for feed' +
206
+ ' with ID %d.') % [
207
+ feed_mapping[:feed_mapping_id],
208
+ feed_mapping[:placeholder_type],
209
+ feed_mapping[:feed_id]
210
+ ]
211
+ else
212
+ raise new StandardError, 'No feed mappings were added.'
213
+ end
214
+
215
+ # Construct a matching function that associates the sitelink feeditems to the
216
+ # campaign, and set the device preference to Mobile. See the matching function
217
+ # guide at:
218
+ # https://developers.google.com/adwords/api/docs/guides/feed-matching-functions
219
+ # for more details.
220
+ matching_function_string =
221
+ "AND(IN(FEED_ITEM_ID, {%s}), EQUALS(CONTEXT.DEVICE, 'Mobile'))" %
222
+ sitelinks_data[:feed_item_ids].join(',')
223
+
224
+ # Create site links campaign feed.
225
+ campaign_feed = {
226
+ :feed_id => sitelinks_data[:feed_id],
227
+ :campaign_id => campaign_id,
228
+ :matching_function => {:function_string => matching_function_string},
229
+ # Specifying placeholder types on the CampaignFeed allows the same feed
230
+ # to be used for different placeholders in different Campaigns.
231
+ :placeholder_types => [PLACEHOLDER_SITELINKS]
232
+ }
233
+
234
+ response = campaign_feed_srv.mutate([
235
+ {:operator => 'ADD', :operand => campaign_feed}
236
+ ])
237
+ if response and response[:value]
238
+ campaign_feed = response[:value].first
239
+ puts 'Campaign with ID %d was associated with feed with ID %d.' %
240
+ [campaign_feed[:campaign_id], campaign_feed[:feed_id]]
241
+ else
242
+ raise new StandardError, 'No campaign feeds were added.'
243
+ end
244
+ end
245
+
246
+ if __FILE__ == $0
247
+ API_VERSION = :v201607
248
+
249
+ # See the Placeholder reference page for a list of all the placeholder types
250
+ # and fields, see:
251
+ # https://developers.google.com/adwords/api/docs/appendix/placeholders
252
+ PLACEHOLDER_SITELINKS = 1
253
+ PLACEHOLDER_FIELD_SITELINK_LINK_TEXT = 1
254
+ PLACEHOLDER_FIELD_SITELINK_FINAL_URLS = 5
255
+ PLACEHOLDER_FIELD_SITELINK_LINE_1_TEXT = 3
256
+ PLACEHOLDER_FIELD_SITELINK_LINE_2_TEXT = 4
257
+
258
+ begin
259
+ # Campaign ID to add site link to.
260
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
261
+ add_site_links(campaign_id)
262
+
263
+ # Authorization error.
264
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
265
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
266
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
267
+ "to retrieve and store OAuth2 tokens."
268
+ puts "See this wiki page for more details:\n\n " +
269
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
270
+
271
+ # HTTP errors.
272
+ rescue AdsCommon::Errors::HttpError => e
273
+ puts "HTTP Error: %s" % e
274
+
275
+ # API errors.
276
+ rescue AdwordsApi::Errors::ApiException => e
277
+ puts "Message: %s" % e.message
278
+ puts 'Errors:'
279
+ e.errors.each_with_index do |error, index|
280
+ puts "\tError [%d]:" % (index + 1)
281
+ error.each do |field, value|
282
+ puts "\t\t%s: %s" % [field, value]
283
+ end
284
+ end
285
+ end
286
+ end