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,75 @@
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 gets the list of possible report fields for a report type.
20
+
21
+ require 'adwords_api'
22
+
23
+ def get_report_fields(report_type)
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
+ report_def_srv = adwords.service(:ReportDefinitionService, API_VERSION)
33
+
34
+ # Get report fields.
35
+ fields = report_def_srv.get_report_fields(report_type)
36
+ if fields
37
+ puts "Report type '%s' contains the following fields:" % report_type
38
+ fields.each do |field|
39
+ puts ' - %s (%s)' % [field[:field_name], field[:field_type]]
40
+ puts ' := [%s]' % field[:enum_values].join(', ') if field[:enum_values]
41
+ end
42
+ end
43
+ end
44
+
45
+ if __FILE__ == $0
46
+ API_VERSION = :v201607
47
+
48
+ begin
49
+ report_type = 'INSERT_REPORT_TYPE_HERE'
50
+ get_report_fields(report_type)
51
+
52
+ # Authorization error.
53
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
54
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
55
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
56
+ "to retrieve and store OAuth2 tokens."
57
+ puts "See this wiki page for more details:\n\n " +
58
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
59
+
60
+ # HTTP errors.
61
+ rescue AdsCommon::Errors::HttpError => e
62
+ puts "HTTP Error: %s" % e
63
+
64
+ # API errors.
65
+ rescue AdwordsApi::Errors::ApiException => e
66
+ puts "Message: %s" % e.message
67
+ puts 'Errors:'
68
+ e.errors.each_with_index do |error, index|
69
+ puts "\tError [%d]:" % (index + 1)
70
+ error.each do |field, value|
71
+ puts "\t\t%s: %s" % [field, value]
72
+ end
73
+ end
74
+ end
75
+ end
@@ -0,0 +1,164 @@
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 gets and downloads an Ad Hoc report from a XML report definition
20
+ # for all accounts in hierarchy in multiple parallel threads. This example
21
+ # needs to be run against an AdWords manager account.
22
+
23
+ require 'thread'
24
+
25
+ require 'adwords_api'
26
+ require 'adwords_api/utils'
27
+
28
+ def parallel_report_download()
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
+ # Determine list of customer IDs to retrieve report for. For this example we
38
+ # will use ManagedCustomerService to get all IDs in hierarchy.
39
+
40
+ managed_customer_srv = adwords.service(:ManagedCustomerService, API_VERSION)
41
+
42
+ # Get the account hierarchy for this account.
43
+ selector = {:fields => ['CustomerId']}
44
+
45
+ graph = managed_customer_srv.get(selector)
46
+
47
+ # Using queue to balance load between threads.
48
+ queue = Queue.new()
49
+
50
+ if graph and graph[:entries] and !graph[:entries].empty?
51
+ graph[:entries].each {|account| queue << account[:customer_id]}
52
+ else
53
+ raise StandardError, 'Can not retrieve any customer ID'
54
+ end
55
+
56
+ # Get report utilities for the version.
57
+ report_utils = adwords.report_utils(API_VERSION)
58
+
59
+ # Define report definition. You can also pass your own XML text as a string.
60
+ report_definition = {
61
+ :selector => {
62
+ :fields => ['CampaignId', 'AdGroupId', 'Impressions', 'Clicks', 'Cost'],
63
+ # Predicates are optional.
64
+ :predicates => {
65
+ :field => 'AdGroupStatus',
66
+ :operator => 'IN',
67
+ :values => ['ENABLED', 'PAUSED']
68
+ }
69
+ },
70
+ :report_name => 'Custom ADGROUP_PERFORMANCE_REPORT',
71
+ :report_type => 'ADGROUP_PERFORMANCE_REPORT',
72
+ :download_format => 'CSV',
73
+ :date_range_type => 'LAST_7_DAYS'
74
+ }
75
+
76
+ puts 'Retrieving %d reports with %d threads:' % [queue.size, THREADS]
77
+
78
+ reports_succeeded = Queue.new()
79
+ reports_failed = Queue.new()
80
+
81
+ # Creating a mutex to control access to the queue.
82
+ queue_mutex = Mutex.new
83
+
84
+ # Start all the threads.
85
+ threads = (1..THREADS).map do |thread_id|
86
+ Thread.new(report_definition) do |local_def|
87
+ cid = nil
88
+ begin
89
+ cid = queue_mutex.synchronize {(queue.empty?) ? nil : queue.pop(true)}
90
+ if cid
91
+ retry_count = 0
92
+ file_name = 'adgroup_%010d.csv' % cid
93
+ puts "[%2d/%d] Loading report for customer ID %s into '%s'..." %
94
+ [thread_id, retry_count,
95
+ AdwordsApi::Utils.format_id(cid), file_name]
96
+ begin
97
+ report_utils.download_report_as_file(local_def, file_name, cid)
98
+ reports_succeeded << {:cid => cid, :file_name => file_name}
99
+ rescue AdwordsApi::Errors::ReportError => e
100
+ if e.http_code == 500 && retry_count < MAX_RETRIES
101
+ retry_count += 1
102
+ sleep(retry_count * BACKOFF_FACTOR)
103
+ retry
104
+ else
105
+ puts(('Report failed for customer ID %s with code %d after %d ' +
106
+ 'retries.') % [cid, e.http_code, retry_count + 1])
107
+ reports_failed <<
108
+ {:cid => cid, :http_code => e.http_code, :message => e.message}
109
+ end
110
+ end
111
+ end
112
+ end while (cid != nil)
113
+ end
114
+ end
115
+
116
+ # Wait for all threads to finish.
117
+ threads.each { |aThread| aThread.join }
118
+
119
+ puts 'Download completed, results:'
120
+ puts 'Successful reports:'
121
+ while !reports_succeeded.empty? do
122
+ result = reports_succeeded.pop()
123
+ puts "\tClient ID %s => '%s'" %
124
+ [AdwordsApi::Utils.format_id(result[:cid]), result[:file_name]]
125
+ end
126
+ puts 'Failed reports:'
127
+ while !reports_failed.empty? do
128
+ result = reports_failed.pop()
129
+ puts "\tClient ID %s => Code: %d, Message: '%s'" %
130
+ [AdwordsApi::Utils.format_id(result[:cid]),
131
+ result[:http_code], result[:message]]
132
+ end
133
+ puts 'End of results.'
134
+ end
135
+
136
+ if __FILE__ == $0
137
+ API_VERSION = :v201607
138
+ # Number of parallel threads to spawn.
139
+ THREADS = 10
140
+ # Maximum number of retries for 500 errors.
141
+ MAX_RETRIES = 5
142
+ # Timeout between retries in seconds.
143
+ BACKOFF_FACTOR = 5
144
+
145
+ begin
146
+ parallel_report_download()
147
+
148
+ # Authorization error.
149
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
150
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
151
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
152
+ "to retrieve and store OAuth2 tokens."
153
+ puts "See this wiki page for more details:\n\n " +
154
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
155
+
156
+ # HTTP errors.
157
+ rescue AdsCommon::Errors::HttpError => e
158
+ puts 'HTTP Error: %s' % e
159
+
160
+ # API errors.
161
+ rescue AdwordsApi::Errors::ReportError => e
162
+ puts 'Reporting Error: %s' % e.message
163
+ end
164
+ end
@@ -0,0 +1,97 @@
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 streams the results of an Ad Hoc report to a file.
20
+
21
+ require 'adwords_api'
22
+
23
+ def stream_criteria_report_results()
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
+ # Get report utilities for the version.
33
+ report_utils = adwords.report_utils(API_VERSION)
34
+
35
+ # Define report query.
36
+ report_query = 'SELECT Id, AdNetworkType1, Impressions ' +
37
+ 'FROM CRITERIA_PERFORMANCE_REPORT ' +
38
+ 'WHERE Status IN [ENABLED, PAUSED] ' +
39
+ 'DURING LAST_7_DAYS'
40
+
41
+ # Optional: Set the configuration of the API instance to suppress header,
42
+ # column name, or summary rows in the report output. You can also configure
43
+ # this in your adwords_api.yml configuration file.
44
+ adwords.skip_report_header = true
45
+ adwords.skip_column_header = true
46
+ adwords.skip_report_summary = true
47
+ # Enable to allow rows with zero impressions to show.
48
+ adwords.include_zero_impressions = false
49
+
50
+ # Set the default value of the hash to 0 to allow easy totaling.
51
+ ad_network_map = Hash.new(0)
52
+
53
+ # We use get_stream_helper_with_awql.each_line here, which uses the
54
+ # ReportStream utility to handle breaking the streamed results into lines
55
+ # for easy processing. If you'd rather handle processing yourself, you can
56
+ # use download_report_as_stream_with_awql, which just passes data to the
57
+ # block as it's downloaded, without breaking it up into meaningful chunks.
58
+ report_utils.get_stream_helper_with_awql(
59
+ report_query, 'CSV').each_line do |line|
60
+ process_line(line, ad_network_map)
61
+ end
62
+
63
+ puts 'Total impressions by ad network type 1:'
64
+ ad_network_map.each do |ad_network_type, total_impressions|
65
+ puts ' %s: %s' % [ad_network_type, total_impressions]
66
+ end
67
+ end
68
+
69
+ def process_line(line, ad_network_map)
70
+ id, ad_network_type_1, impressions = line.split(',')
71
+ ad_network_map[ad_network_type_1] += impressions.to_i
72
+ end
73
+
74
+ if __FILE__ == $0
75
+ API_VERSION = :v201607
76
+
77
+ begin
78
+ # File name to write report to.
79
+ stream_criteria_report_results()
80
+
81
+ # Authorization error.
82
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
83
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
84
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
85
+ "to retrieve and store OAuth2 tokens."
86
+ puts "See this wiki page for more details:\n\n " +
87
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
88
+
89
+ # HTTP errors.
90
+ rescue AdsCommon::Errors::HttpError => e
91
+ puts "HTTP Error: %s" % e
92
+
93
+ # API errors.
94
+ rescue AdwordsApi::Errors::ReportError => e
95
+ puts "Reporting Error: %s" % e.message
96
+ end
97
+ end
@@ -0,0 +1,267 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2014, 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 a ProductPartition tree.
20
+
21
+ require 'adwords_api'
22
+
23
+ class ProductPartitionHelper
24
+ attr_reader :operations
25
+
26
+ def initialize(ad_group_id)
27
+ # The next temporary criterion ID to be used.
28
+ #
29
+ # When creating our tree we need to specify the parent-child relationships
30
+ # between nodes. However, until a criterion has been created on the server
31
+ # we do not have a criterionId with which to refer to it.
32
+ #
33
+ # Instead we can specify temporary IDs that are specific to a single mutate
34
+ # request. Once the criteria have been created they are assigned an ID as
35
+ # normal and the temporary ID will no longer refer to it.
36
+ #
37
+ # A valid temporary ID is any negative integer.
38
+ @next_id = -1
39
+
40
+ # The set of mutate operations needed to create the current tree.
41
+ @operations = []
42
+
43
+ # The ID of the AdGroup that we wish to attach the partition tree to.
44
+ @ad_group_id = ad_group_id
45
+ end
46
+
47
+ def create_subdivision(parent = nil, value = nil)
48
+ division = {
49
+ :xsi_type => 'ProductPartition',
50
+ :partition_type => 'SUBDIVISION',
51
+ :id => @next_id
52
+ }
53
+
54
+ @next_id -= 1
55
+
56
+ unless parent.nil? || value.nil?
57
+ division[:parent_criterion_id] = parent[:id]
58
+ division[:case_value] = value
59
+ end
60
+
61
+ ad_group_criterion = {
62
+ :xsi_type => 'BiddableAdGroupCriterion',
63
+ :ad_group_id => @ad_group_id,
64
+ :criterion => division
65
+ }
66
+
67
+ create_add_operation(ad_group_criterion)
68
+
69
+ return division
70
+ end
71
+
72
+ def create_unit(parent = nil, value = nil, bid_amount = nil)
73
+ unit = {
74
+ :xsi_type => 'ProductPartition',
75
+ :partition_type => 'UNIT'
76
+ }
77
+
78
+ unless parent.nil? || value.nil?
79
+ unit[:parent_criterion_id] = parent[:id]
80
+ unit[:case_value] = value
81
+ end
82
+
83
+ ad_group_criterion = {}
84
+ if bid_amount && bid_amount > 0
85
+ bidding_strategy_configuration = {
86
+ :bids => [{
87
+ :xsi_type => 'CpcBid',
88
+ :bid => {
89
+ :xsi_type => 'Money',
90
+ :micro_amount => bid_amount
91
+ }
92
+ }]
93
+ }
94
+ ad_group_criterion[:xsi_type] = 'BiddableAdGroupCriterion'
95
+ ad_group_criterion[:bidding_strategy_configuration] =
96
+ bidding_strategy_configuration
97
+ else
98
+ ad_group_criterion[:xsi_type] = 'NegativeAdGroupCriterion'
99
+ end
100
+ ad_group_criterion[:ad_group_id] = @ad_group_id
101
+ ad_group_criterion[:criterion] = unit
102
+
103
+ create_add_operation(ad_group_criterion)
104
+
105
+ return unit
106
+ end
107
+
108
+ private
109
+
110
+ def create_add_operation(ad_group_criterion)
111
+ operation = {
112
+ :operator => 'ADD',
113
+ :operand => ad_group_criterion
114
+ }
115
+
116
+ @operations << operation
117
+ end
118
+ end
119
+
120
+ def display_tree(node, children, level = 0)
121
+ value = ''
122
+ type = ''
123
+
124
+ if node[:case_value]
125
+ type = node[:case_value][:product_dimension_type]
126
+
127
+ value = case type
128
+ when 'ProductCanonicalCondition'
129
+ node[:case_value][:condition]
130
+ when 'ProductBiddingCategory'
131
+ "%s(%s)" % [node[:case_value][:type], node[:case_value][:value]]
132
+ else
133
+ node[:case_value][:value]
134
+ end
135
+ end
136
+
137
+ puts "%sid: %s, type: %s, value: %s" %
138
+ [' ' * level, node[:id], type, value]
139
+
140
+ children[node[:id]].each do |child_node|
141
+ display_tree(child_node, children, level + 1)
142
+ end
143
+ end
144
+
145
+ def add_product_partition_tree(ad_group_id)
146
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
147
+ # when called without parameters.
148
+ adwords = AdwordsApi::Api.new
149
+
150
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
151
+ # the configuration file or provide your own logger:
152
+ # adwords.logger = Logger.new('adwords_xml.log')
153
+
154
+ ad_group_criterion_srv =
155
+ adwords.service(:AdGroupCriterionService, API_VERSION)
156
+
157
+ helper = ProductPartitionHelper.new(ad_group_id)
158
+
159
+ root = helper.create_subdivision()
160
+
161
+ new_product_canonical_condition = {
162
+ :xsi_type => 'ProductCanonicalCondition',
163
+ :condition => 'NEW'
164
+ }
165
+
166
+ used_product_canonical_condition = {
167
+ :xsi_type => 'ProductCanonicalCondition',
168
+ :condition => 'USED'
169
+ }
170
+
171
+ other_product_canonical_condition = {
172
+ :xsi_type => 'ProductCanonicalCondition'
173
+ }
174
+
175
+ helper.create_unit(root, new_product_canonical_condition, 200000)
176
+ helper.create_unit(root, used_product_canonical_condition, 100000)
177
+ other_condition =
178
+ helper.create_subdivision(root, other_product_canonical_condition)
179
+
180
+ cool_product_brand = {
181
+ :xsi_type => 'ProductBrand',
182
+ :value => 'CoolBrand'
183
+ }
184
+
185
+ cheap_product_brand = {
186
+ :xsi_type => 'ProductBrand',
187
+ :value => 'CheapBrand'
188
+ }
189
+
190
+ other_product_brand = {
191
+ :xsi_type => 'ProductBrand'
192
+ }
193
+
194
+ helper.create_unit(other_condition, cool_product_brand, 900000)
195
+ helper.create_unit(other_condition, cheap_product_brand, 10000)
196
+ other_brand = helper.create_subdivision(other_condition, other_product_brand)
197
+
198
+ # The value for the bidding category is a fixed ID for the 'Luggage & Bags'
199
+ # category. You can retrieve IDs for categories from the ConstantDataService.
200
+ # See the get_product_taxonomy example for more details.
201
+ luggage_category = {
202
+ :xsi_type => 'ProductBiddingCategory',
203
+ :type => 'BIDDING_CATEGORY_L1',
204
+ :value => '-5914235892932915235'
205
+ }
206
+
207
+ generic_category = {
208
+ :xsi_type => 'ProductBiddingCategory',
209
+ :type => 'BIDDING_CATEGORY_L1'
210
+ }
211
+
212
+ helper.create_unit(other_brand, luggage_category, 750000)
213
+ helper.create_unit(other_brand, generic_category, 110000)
214
+
215
+ # Make the mutate request.
216
+ result = ad_group_criterion_srv.mutate(helper.operations)
217
+
218
+ children = {}
219
+ root_node = nil
220
+ # For each criterion, make an array containing each of its children.
221
+ # We always create the parent before the child, so we can rely on that here.
222
+ result[:value].each do |criterion|
223
+ children[criterion[:criterion][:id]] = []
224
+
225
+ if criterion[:criterion][:parent_criterion_id]
226
+ children[criterion[:criterion][:parent_criterion_id]] <<
227
+ criterion[:criterion]
228
+ else
229
+ root_node = criterion[:criterion]
230
+ end
231
+ end
232
+
233
+ display_tree(root_node, children)
234
+ end
235
+
236
+ if __FILE__ == $0
237
+ API_VERSION = :v201607
238
+
239
+ begin
240
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
241
+
242
+ add_product_partition_tree(ad_group_id)
243
+
244
+ # Authorization error.
245
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
246
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
247
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
248
+ "to retrieve and store OAuth2 tokens."
249
+ puts "See this wiki page for more details:\n\n " +
250
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
251
+
252
+ # HTTP errors.
253
+ rescue AdsCommon::Errors::HttpError => e
254
+ puts "HTTP Error: %s" % e
255
+
256
+ # API errors.
257
+ rescue AdwordsApi::Errors::ApiException => e
258
+ puts "Message: %s" % e.message
259
+ puts 'Errors:'
260
+ e.errors.each_with_index do |error, index|
261
+ puts "\tError [%d]:" % (index + 1)
262
+ error.each do |field, value|
263
+ puts "\t\t%s: %s" % [field, value]
264
+ end
265
+ end
266
+ end
267
+ end