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,114 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2016, 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 illustrates how to create a draft and access its associated
20
+ # draft campaign.
21
+ #
22
+ # See the Campaign Drafts and Experiments guide for more information:
23
+ # https://developers.google.com/adwords/api/docs/guides/campaign-drafts-experiments
24
+
25
+ require 'adwords_api'
26
+ require 'date'
27
+
28
+ def add_draft(base_campaign_id)
29
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
30
+ # when called without parameters.
31
+ adwords = AdwordsApi::Api.new
32
+
33
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
34
+ # the configuration file or provide your own logger:
35
+ # adwords.logger = Logger.new('adwords_xml.log')
36
+
37
+ draft_srv = adwords.service(:DraftService, API_VERSION)
38
+
39
+ draft = {
40
+ :base_campaign_id => base_campaign_id,
41
+ :draft_name => 'Test Draft #%d' % (Time.new.to_f * 1000).to_i
42
+ }
43
+ draft_operation = {:operator => 'ADD', :operand => draft}
44
+
45
+ draft_result = draft_srv.mutate([draft_operation])
46
+
47
+ draft = draft_result[:value].first
48
+ draft_id = draft[:draft_id]
49
+ draft_campaign_id = draft[:draft_campaign_id]
50
+
51
+ puts "Draft with id %d and base campaign %d and draft campaign %d created" %
52
+ [draft_id, draft[:base_campaign_id], draft_campaign_id]
53
+
54
+ # Once the draft is created, you can modify the draft campaign as if it
55
+ # were a real campaign. For example, you may add criteria, adjust bids,
56
+ # or even include additional ads. Adding a criterion is shown here.
57
+ campaign_criterion_srv =
58
+ adwords.service(:CampaignCriterionService, API_VERSION)
59
+
60
+ criterion = {
61
+ :xsi_type => 'Language',
62
+ :id => 1003 # Spanish
63
+ }
64
+
65
+ criterion_operation = {
66
+ # Make sure to use the draft_campaign_id when modifying the virtual draft
67
+ # campaign.
68
+ :operator => 'ADD',
69
+ :operand => {
70
+ :campaign_id => draft_campaign_id,
71
+ :criterion => criterion
72
+ }
73
+ }
74
+
75
+ criterion_result = campaign_criterion_srv.mutate([criterion_operation])
76
+
77
+ criterion = criterion_result[:value].first
78
+
79
+ puts "Draft updated to include criteria in campaign %d" % draft_campaign_id
80
+ end
81
+
82
+ if __FILE__ == $0
83
+ API_VERSION = :v201607
84
+
85
+ begin
86
+ base_campaign_id = 'INSERT_BASE_CAMPAIGN_ID_HERE'.to_i
87
+
88
+ add_draft(base_campaign_id)
89
+
90
+ # Authorization error.
91
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
92
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
93
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
94
+ "to retrieve and store OAuth2 tokens."
95
+ puts "See this wiki page for more details:\n\n " +
96
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
97
+
98
+ # HTTP errors.
99
+ rescue AdsCommon::Errors::HttpError => e
100
+ puts "HTTP Error: %s" % e
101
+
102
+ # API errors.
103
+ rescue AdwordsApi::Errors::ApiException => e
104
+ puts "Message: %s" % e.message
105
+ puts 'Errors:'
106
+ e.errors.each_with_index do |error, index|
107
+ puts "\tError [%d]:" % (index + 1)
108
+ error.each do |field, value|
109
+ puts "\t\t%s: %s" % [field, value]
110
+ end
111
+ end
112
+ end
113
+ end
114
+
@@ -0,0 +1,162 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2011, 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 creates an experiment using a query percentage of 10, which
20
+ # defines what fraction of auctions should go to the control split (90%) vs.
21
+ # the experiment split (10%), then adds experimental bid changes for criteria
22
+ # and ad groups. To get campaigns, run get_campaigns.rb. To get ad groups,
23
+ # run get_ad_groups.rb. To get keywords, run get_keywords.rb.
24
+
25
+ require 'adwords_api'
26
+ require 'date'
27
+
28
+ def add_experiment(campaign_id, ad_group_id, criterion_id)
29
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
30
+ # when called without parameters.
31
+ adwords = AdwordsApi::Api.new
32
+
33
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
34
+ # the configuration file or provide your own logger:
35
+ # adwords.logger = Logger.new('adwords_xml.log')
36
+
37
+ experiment_srv = adwords.service(:ExperimentService, API_VERSION)
38
+ ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
39
+ ad_group_criterion_srv =
40
+ adwords.service(:AdGroupCriterionService, API_VERSION)
41
+
42
+ # Prepare for adding experiment.
43
+ operation = {
44
+ :operator => 'ADD',
45
+ :operand => {
46
+ :campaign_id => campaign_id,
47
+ :name => "Interplanetary Experiment #%d" % (Time.new.to_f * 1000).to_i,
48
+ :query_percentage => 10,
49
+ :start_date_time => Time.now.strftime('%Y%m%d %H%M%S'),
50
+ # Optional fields:
51
+ :status => 'ENABLED',
52
+ :end_date_time =>
53
+ DateTime.parse((Date.today + 30).to_s).strftime('%Y%m%d %H%M%S')
54
+ }
55
+ }
56
+
57
+ # Add experiment.
58
+ response = experiment_srv.mutate([operation])
59
+ experiment = response[:value].first
60
+ puts "Experiment with name '%s' and ID %d was added." %
61
+ [experiment[:name], experiment[:id]]
62
+
63
+ experiment_id = experiment[:id]
64
+
65
+ # Setup ad group for the experiment.
66
+ ad_group = {
67
+ :id => ad_group_id,
68
+ # Set experiment data for the ad group.
69
+ :experiment_data => {
70
+ :experiment_id => experiment_id,
71
+ :experiment_delta_status => 'MODIFIED',
72
+ # Bid multiplier rule that will modify ad group bid for the experiment.
73
+ :experiment_bid_multipliers => {
74
+ :xsi_type => 'ManualCPCAdGroupExperimentBidMultipliers',
75
+ :max_cpc_multiplier => {
76
+ :multiplier => 1.5
77
+ }
78
+ }
79
+ }
80
+ }
81
+
82
+ # Prepare for updating ad group.
83
+ operation = {
84
+ :operator => 'SET',
85
+ :operand => ad_group
86
+ }
87
+
88
+ # Update ad group.
89
+ response = ad_group_srv.mutate([operation])
90
+ ad_group = response[:value].first
91
+ puts "Ad group ID %d was updated for the experiment." % ad_group[:id]
92
+
93
+ # Setup ad group criterion for the experiment.
94
+ ad_group_criterion = {
95
+ :xsi_type => 'BiddableAdGroupCriterion',
96
+ :ad_group_id => ad_group_id,
97
+ :criterion => {
98
+ :id => criterion_id
99
+ },
100
+ # Set experiment data for the criterion.
101
+ :experiment_data => {
102
+ :xsi_type => 'BiddableAdGroupCriterionExperimentData',
103
+ :experiment_id => experiment_id,
104
+ :experiment_delta_status => 'MODIFIED',
105
+ # Bid multiplier rule that will modify criterion bid for the experiment.
106
+ :experiment_bid_multiplier => {
107
+ :xsi_type => 'ManualCPCAdGroupCriterionExperimentBidMultiplier',
108
+ :max_cpc_multiplier => {
109
+ :multiplier => 1.5
110
+ }
111
+ }
112
+ }
113
+ }
114
+
115
+ # Prepare for updating ad group criterion.
116
+ operation = {
117
+ :operator => 'SET',
118
+ :operand => ad_group_criterion
119
+ }
120
+
121
+ # Update criterion.
122
+ response = ad_group_criterion_srv.mutate([operation])
123
+ criterion = response[:value].first
124
+ puts "Criterion ID %d was successfully updated for the experiment." %
125
+ [criterion[:criterion][:id]]
126
+
127
+ end
128
+
129
+ if __FILE__ == $0
130
+ API_VERSION = :v201607
131
+
132
+ begin
133
+ # IDs of the required objects.
134
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
135
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
136
+ criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
137
+ add_experiment(campaign_id, ad_group_id, criterion_id)
138
+
139
+ # Authorization error.
140
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
141
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
142
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
143
+ "to retrieve and store OAuth2 tokens."
144
+ puts "See this wiki page for more details:\n\n " +
145
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
146
+
147
+ # HTTP errors.
148
+ rescue AdsCommon::Errors::HttpError => e
149
+ puts "HTTP Error: %s" % e
150
+
151
+ # API errors.
152
+ rescue AdwordsApi::Errors::ApiException => e
153
+ puts "Message: %s" % e.message
154
+ puts 'Errors:'
155
+ e.errors.each_with_index do |error, index|
156
+ puts "\tError [%d]:" % (index + 1)
157
+ error.each do |field, value|
158
+ puts "\t\t%s: %s" % [field, value]
159
+ end
160
+ end
161
+ end
162
+ end
@@ -0,0 +1,210 @@
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 illustrates how to perform multiple requests using the
20
+ # BatchJobService using incremental uploads.
21
+
22
+ require 'adwords_api'
23
+
24
+ def add_keywords_using_incremental_batch_job(ad_group_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
+ batch_job_srv = adwords.service(:BatchJobService, API_VERSION)
34
+ batch_job_utils = adwords.batch_job_utils(API_VERSION)
35
+
36
+ # Create a BatchJob.
37
+ add_op = {
38
+ :operator => 'ADD',
39
+ :operand => {}
40
+ }
41
+
42
+ response = batch_job_srv.mutate([add_op])
43
+ batch_job = response[:value].first
44
+
45
+ # Get the upload URL from the new job.
46
+ upload_url = batch_job[:upload_url][:url]
47
+ puts "Created BatchJob with ID %d, status '%s', and upload URL %s." %
48
+ [batch_job[:id], batch_job[:status], upload_url]
49
+
50
+ # Upload #1
51
+ incremental_helper = batch_job_utils.start_incremental_upload(upload_url)
52
+ operations = create_keyword_operations(ad_group_id)
53
+ incremental_helper.upload(operations)
54
+
55
+ # Upload #2
56
+ operations = create_keyword_operations(ad_group_id)
57
+ incremental_helper.upload(operations)
58
+
59
+ # Upload #3
60
+ operations = create_keyword_operations(ad_group_id)
61
+ incremental_helper.upload(operations, true)
62
+
63
+ # Poll for completion of the batch job using an exponential back off.
64
+ poll_attempts = 0
65
+ is_pending = true
66
+ cancel_requested = false
67
+ selector = {
68
+ :fields =>
69
+ ['Id', 'Status', 'DownloadUrl', 'ProcessingErrors', 'ProgressStats'],
70
+ :predicates => [{
71
+ :field => 'Id',
72
+ :operator => 'IN',
73
+ :values => [batch_job[:id]]
74
+ }]
75
+ }
76
+
77
+ begin
78
+ sleep_seconds = 30 * (2 ** poll_attempts)
79
+ puts "Sleeping for %d seconds" % sleep_seconds
80
+ sleep(sleep_seconds)
81
+
82
+ batch_job = batch_job_srv.get(selector)[:entries].first
83
+
84
+ puts "Batch job ID %d has status '%s'." %
85
+ [batch_job[:id], batch_job[:status]]
86
+
87
+ poll_attempts += 1
88
+ is_pending = PENDING_STATUSES.include?(batch_job[:status])
89
+
90
+ if is_pending && !cancel_requested && poll_attempts == MAX_POLL_ATTEMPTS
91
+ batch_job[:status] = 'CANCELING'
92
+
93
+ set_op = {
94
+ :operator => 'SET',
95
+ :operand => batch_job
96
+ }
97
+
98
+ # Only request cancellation once per job.
99
+ cancel_requested = true
100
+
101
+ begin
102
+ batch_job = batch_job_srv.mutate([set_op])[:value].first
103
+ puts "Requested cancellation of batch job with ID %d" % batch_job[:id]
104
+ rescue AdwordsApi::Errors::ApiException => e
105
+ if !e.message.nil? && e.message.include?('INVALID_STATE_CHANGE')
106
+ puts ("Attempt to cancel batch job with ID %d was rejected " +
107
+ "because the job already completed or was canceled.") %
108
+ batch_job[:id]
109
+ next
110
+ end
111
+ raise e
112
+ end
113
+ end
114
+ end while is_pending and poll_attempts < MAX_POLL_ATTEMPTS
115
+
116
+ if is_pending
117
+ raise StandardError,
118
+ "Job is still in pending state after polling %d times." %
119
+ MAX_POLL_ATTEMPTS
120
+ end
121
+
122
+ if batch_job[:status] == 'CANCELED'
123
+ puts "Job was canceled before completion."
124
+ return
125
+ end
126
+
127
+ unless batch_job[:processing_errors].nil?
128
+ batch_job[:processing_errors].each_with_index do |processing_error, i|
129
+ puts ("Processing error [%d]: errorType=%s, trigger=%s, errorString=%s" +
130
+ "fieldPath=%s, reason=%s") % [i, processing_error[:api_error_type],
131
+ processing_error[:trigger], processing_error[:error_string],
132
+ processing_error[:field_path], processing_error[:reason]]
133
+ end
134
+ end
135
+
136
+ unless batch_job[:download_url].nil? or batch_job[:download_url][:url].nil?
137
+ mutate_response = batch_job_utils.get_job_results(
138
+ batch_job[:download_url][:url])
139
+ puts "Downloaded results from '%s':" % batch_job[:download_url][:url]
140
+ mutate_response.each do |mutate_result|
141
+ outcome = "FAILURE"
142
+ outcome = "SUCCESS" if mutate_result[:error_list].nil?
143
+ puts " Operation [%d] - %s" % [mutate_result[:index], outcome]
144
+ end
145
+ end
146
+ end
147
+
148
+ def create_keyword_operations(ad_group_id)
149
+ operations = []
150
+ KEYWORD_COUNT.times do |i|
151
+ text = "keyword %d" % i
152
+
153
+ # Make 10% of keywords invalid to demonstrate error handling.
154
+ text = text + "!!!" if i % 10 == 0
155
+ keyword = {
156
+ :xsi_type => 'Keyword',
157
+ :text => text,
158
+ :match_type => 'BROAD'
159
+ }
160
+ biddable_criterion = {
161
+ :xsi_type => 'BiddableAdGroupCriterion',
162
+ :ad_group_id => ad_group_id,
163
+ :criterion => keyword
164
+ }
165
+ operation = {
166
+ :xsi_type => 'AdGroupCriterionOperation',
167
+ :operator => 'ADD',
168
+ :operand => biddable_criterion
169
+ }
170
+ operations << operation
171
+ end
172
+
173
+ return operations
174
+ end
175
+
176
+ if __FILE__ == $0
177
+ API_VERSION = :v201607
178
+ KEYWORD_COUNT = 100
179
+ MAX_POLL_ATTEMPTS = 5
180
+ PENDING_STATUSES = ['ACTIVE', 'AWAITING_FILE', 'CANCELING']
181
+
182
+ begin
183
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
184
+
185
+ add_keywords_using_incremental_batch_job(ad_group_id)
186
+
187
+ # Authorization error.
188
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
189
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
190
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
191
+ "to retrieve and store OAuth2 tokens."
192
+ puts "See this wiki page for more details:\n\n " +
193
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
194
+
195
+ # HTTP errors.
196
+ rescue AdsCommon::Errors::HttpError => e
197
+ puts "HTTP Error: %s" % e
198
+
199
+ # API errors.
200
+ rescue AdwordsApi::Errors::ApiException => e
201
+ puts "Message: %s" % e.message
202
+ puts 'Errors:'
203
+ e.errors.each_with_index do |error, index|
204
+ puts "\tError [%d]:" % (index + 1)
205
+ error.each do |field, value|
206
+ puts "\t\t%s: %s" % [field, value]
207
+ end
208
+ end
209
+ end
210
+ end