google-adwords-api 0.11.1 → 0.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (152) hide show
  1. data/ChangeLog +3 -0
  2. data/{README → README.md} +0 -0
  3. data/lib/adwords_api/api_config.rb +0 -76
  4. data/lib/adwords_api/version.rb +1 -1
  5. data/test/templates/v201309/basic_operations_get_campaigns.def +1 -1
  6. data/test/templates/v201309/misc_use_oauth2_jwt.def +1 -1
  7. metadata +3 -148
  8. data/examples/v201306/account_management/create_account.rb +0 -95
  9. data/examples/v201306/account_management/get_account_alerts.rb +0 -122
  10. data/examples/v201306/account_management/get_account_changes.rb +0 -145
  11. data/examples/v201306/account_management/get_account_hierarchy.rb +0 -103
  12. data/examples/v201306/advanced_operations/add_ad_group_bid_modifier.rb +0 -105
  13. data/examples/v201306/advanced_operations/add_click_to_download_ad.rb +0 -137
  14. data/examples/v201306/advanced_operations/add_site_links.rb +0 -244
  15. data/examples/v201306/advanced_operations/create_and_attach_shared_keyword_set.rb +0 -147
  16. data/examples/v201306/advanced_operations/find_and_remove_criteria_from_shared_set.rb +0 -181
  17. data/examples/v201306/advanced_operations/get_ad_group_bid_modifiers.rb +0 -106
  18. data/examples/v201306/basic_operations/add_ad_groups.rb +0 -143
  19. data/examples/v201306/basic_operations/add_campaigns.rb +0 -162
  20. data/examples/v201306/basic_operations/add_keywords.rb +0 -116
  21. data/examples/v201306/basic_operations/add_text_ads.rb +0 -113
  22. data/examples/v201306/basic_operations/delete_ad.rb +0 -93
  23. data/examples/v201306/basic_operations/delete_ad_group.rb +0 -110
  24. data/examples/v201306/basic_operations/delete_campaign.rb +0 -111
  25. data/examples/v201306/basic_operations/delete_keyword.rb +0 -98
  26. data/examples/v201306/basic_operations/get_ad_groups.rb +0 -106
  27. data/examples/v201306/basic_operations/get_campaigns.rb +0 -101
  28. data/examples/v201306/basic_operations/get_campaigns_with_awql.rb +0 -93
  29. data/examples/v201306/basic_operations/get_keywords.rb +0 -112
  30. data/examples/v201306/basic_operations/get_text_ads.rb +0 -114
  31. data/examples/v201306/basic_operations/pause_ad.rb +0 -92
  32. data/examples/v201306/basic_operations/update_ad_group.rb +0 -89
  33. data/examples/v201306/basic_operations/update_campaign.rb +0 -90
  34. data/examples/v201306/basic_operations/update_keyword.rb +0 -110
  35. data/examples/v201306/campaign_management/add_experiment.rb +0 -166
  36. data/examples/v201306/campaign_management/add_keywords_in_bulk.rb +0 -158
  37. data/examples/v201306/campaign_management/add_location_extension.rb +0 -125
  38. data/examples/v201306/campaign_management/add_location_extension_override.rb +0 -91
  39. data/examples/v201306/campaign_management/get_all_disapproved_ads.rb +0 -101
  40. data/examples/v201306/campaign_management/get_all_disapproved_ads_with_awql.rb +0 -92
  41. data/examples/v201306/campaign_management/promote_experiment.rb +0 -85
  42. data/examples/v201306/campaign_management/set_ad_parameters.rb +0 -122
  43. data/examples/v201306/campaign_management/set_criterion_bid_modifier.rb +0 -110
  44. data/examples/v201306/campaign_management/validate_text_ad.rb +0 -114
  45. data/examples/v201306/error_handling/handle_captcha_challenge.rb +0 -93
  46. data/examples/v201306/error_handling/handle_partial_failures.rb +0 -134
  47. data/examples/v201306/error_handling/handle_policy_violation_error.rb +0 -145
  48. data/examples/v201306/error_handling/handle_two_factor_authorization_error.rb +0 -88
  49. data/examples/v201306/migration/upgrade_legacy_sitelinks.rb +0 -313
  50. data/examples/v201306/misc/get_all_images_and_videos.rb +0 -108
  51. data/examples/v201306/misc/setup_oauth2.rb +0 -88
  52. data/examples/v201306/misc/upload_image.rb +0 -97
  53. data/examples/v201306/misc/use_oauth2_jwt.rb +0 -97
  54. data/examples/v201306/optimization/estimate_keyword_traffic.rb +0 -137
  55. data/examples/v201306/optimization/get_keyword_bid_simulations.rb +0 -100
  56. data/examples/v201306/optimization/get_keyword_ideas.rb +0 -130
  57. data/examples/v201306/optimization/get_placement_ideas.rb +0 -112
  58. data/examples/v201306/remarketing/add_audience.rb +0 -123
  59. data/examples/v201306/remarketing/add_conversion_tracker.rb +0 -104
  60. data/examples/v201306/reporting/download_criteria_report.rb +0 -87
  61. data/examples/v201306/reporting/download_criteria_report_with_awql.rb +0 -86
  62. data/examples/v201306/reporting/get_campaign_stats.rb +0 -113
  63. data/examples/v201306/reporting/get_report_fields.rb +0 -79
  64. data/examples/v201306/reporting/parallel_report_download.rb +0 -171
  65. data/examples/v201306/targeting/add_campaign_targeting_criteria.rb +0 -123
  66. data/examples/v201306/targeting/add_demographic_targeting_criteria.rb +0 -116
  67. data/examples/v201306/targeting/get_campaign_targeting_criteria.rb +0 -110
  68. data/examples/v201306/targeting/get_targetable_languages_and_carriers.rb +0 -94
  69. data/examples/v201306/targeting/lookup_location.rb +0 -112
  70. data/examples/v201402/advanced_operations/add_places_location_extensions.rb~ +0 -159
  71. data/examples/v201402/basic_operations/add_ad_groups.rb~ +0 -147
  72. data/examples/v201402/misc/create_ad_words_session_without_properties_file.rb~ +0 -94
  73. data/examples/v201402/remarketing/add_conversion_tracker.rb~ +0 -109
  74. data/examples/v201402/shopping_campaigns/add_product_partition_tree.rb~ +0 -269
  75. data/examples/v201402/shopping_campaigns/add_shopping_campaign.rb~ +0 -136
  76. data/examples/v201402/shopping_campaigns/get_product_category_taxonomy.rb~ +0 -128
  77. data/examples/v201402/shopping_campaigns/set_product_sales_channel.rb~ +0 -98
  78. data/lib/adwords_api/v201306/ad_extension_override_service.rb +0 -38
  79. data/lib/adwords_api/v201306/ad_extension_override_service_registry.rb +0 -46
  80. data/lib/adwords_api/v201306/ad_group_ad_service.rb +0 -42
  81. data/lib/adwords_api/v201306/ad_group_ad_service_registry.rb +0 -46
  82. data/lib/adwords_api/v201306/ad_group_bid_modifier_service.rb +0 -38
  83. data/lib/adwords_api/v201306/ad_group_bid_modifier_service_registry.rb +0 -46
  84. data/lib/adwords_api/v201306/ad_group_criterion_service.rb +0 -42
  85. data/lib/adwords_api/v201306/ad_group_criterion_service_registry.rb +0 -46
  86. data/lib/adwords_api/v201306/ad_group_feed_service.rb +0 -38
  87. data/lib/adwords_api/v201306/ad_group_feed_service_registry.rb +0 -46
  88. data/lib/adwords_api/v201306/ad_group_service.rb +0 -42
  89. data/lib/adwords_api/v201306/ad_group_service_registry.rb +0 -46
  90. data/lib/adwords_api/v201306/ad_param_service.rb +0 -38
  91. data/lib/adwords_api/v201306/ad_param_service_registry.rb +0 -46
  92. data/lib/adwords_api/v201306/adwords_user_list_service.rb +0 -38
  93. data/lib/adwords_api/v201306/adwords_user_list_service_registry.rb +0 -46
  94. data/lib/adwords_api/v201306/alert_service.rb +0 -34
  95. data/lib/adwords_api/v201306/alert_service_registry.rb +0 -46
  96. data/lib/adwords_api/v201306/bidding_strategy_service.rb +0 -38
  97. data/lib/adwords_api/v201306/bidding_strategy_service_registry.rb +0 -46
  98. data/lib/adwords_api/v201306/budget_order_service.rb +0 -42
  99. data/lib/adwords_api/v201306/budget_order_service_registry.rb +0 -46
  100. data/lib/adwords_api/v201306/budget_service.rb +0 -38
  101. data/lib/adwords_api/v201306/budget_service_registry.rb +0 -46
  102. data/lib/adwords_api/v201306/campaign_ad_extension_service.rb +0 -38
  103. data/lib/adwords_api/v201306/campaign_ad_extension_service_registry.rb +0 -46
  104. data/lib/adwords_api/v201306/campaign_criterion_service.rb +0 -42
  105. data/lib/adwords_api/v201306/campaign_criterion_service_registry.rb +0 -46
  106. data/lib/adwords_api/v201306/campaign_feed_service.rb +0 -38
  107. data/lib/adwords_api/v201306/campaign_feed_service_registry.rb +0 -46
  108. data/lib/adwords_api/v201306/campaign_service.rb +0 -42
  109. data/lib/adwords_api/v201306/campaign_service_registry.rb +0 -46
  110. data/lib/adwords_api/v201306/campaign_shared_set_service.rb +0 -38
  111. data/lib/adwords_api/v201306/campaign_shared_set_service_registry.rb +0 -47
  112. data/lib/adwords_api/v201306/constant_data_service.rb +0 -62
  113. data/lib/adwords_api/v201306/constant_data_service_registry.rb +0 -46
  114. data/lib/adwords_api/v201306/conversion_tracker_service.rb +0 -38
  115. data/lib/adwords_api/v201306/conversion_tracker_service_registry.rb +0 -46
  116. data/lib/adwords_api/v201306/customer_service.rb +0 -34
  117. data/lib/adwords_api/v201306/customer_service_registry.rb +0 -46
  118. data/lib/adwords_api/v201306/customer_sync_service.rb +0 -34
  119. data/lib/adwords_api/v201306/customer_sync_service_registry.rb +0 -47
  120. data/lib/adwords_api/v201306/data_service.rb +0 -38
  121. data/lib/adwords_api/v201306/data_service_registry.rb +0 -46
  122. data/lib/adwords_api/v201306/experiment_service.rb +0 -38
  123. data/lib/adwords_api/v201306/experiment_service_registry.rb +0 -46
  124. data/lib/adwords_api/v201306/feed_item_service.rb +0 -38
  125. data/lib/adwords_api/v201306/feed_item_service_registry.rb +0 -46
  126. data/lib/adwords_api/v201306/feed_mapping_service.rb +0 -38
  127. data/lib/adwords_api/v201306/feed_mapping_service_registry.rb +0 -46
  128. data/lib/adwords_api/v201306/feed_service.rb +0 -38
  129. data/lib/adwords_api/v201306/feed_service_registry.rb +0 -46
  130. data/lib/adwords_api/v201306/geo_location_service.rb +0 -34
  131. data/lib/adwords_api/v201306/geo_location_service_registry.rb +0 -46
  132. data/lib/adwords_api/v201306/location_criterion_service.rb +0 -34
  133. data/lib/adwords_api/v201306/location_criterion_service_registry.rb +0 -46
  134. data/lib/adwords_api/v201306/managed_customer_service.rb +0 -50
  135. data/lib/adwords_api/v201306/managed_customer_service_registry.rb +0 -46
  136. data/lib/adwords_api/v201306/media_service.rb +0 -38
  137. data/lib/adwords_api/v201306/media_service_registry.rb +0 -46
  138. data/lib/adwords_api/v201306/mutate_job_service.rb +0 -42
  139. data/lib/adwords_api/v201306/mutate_job_service_registry.rb +0 -46
  140. data/lib/adwords_api/v201306/report_definition_service.rb +0 -34
  141. data/lib/adwords_api/v201306/report_definition_service_registry.rb +0 -46
  142. data/lib/adwords_api/v201306/shared_criterion_service.rb +0 -38
  143. data/lib/adwords_api/v201306/shared_criterion_service_registry.rb +0 -47
  144. data/lib/adwords_api/v201306/shared_set_service.rb +0 -38
  145. data/lib/adwords_api/v201306/shared_set_service_registry.rb +0 -47
  146. data/lib/adwords_api/v201306/targeting_idea_service.rb +0 -38
  147. data/lib/adwords_api/v201306/targeting_idea_service_registry.rb +0 -46
  148. data/lib/adwords_api/v201306/traffic_estimator_service.rb +0 -34
  149. data/lib/adwords_api/v201306/traffic_estimator_service_registry.rb +0 -46
  150. data/test/adwords_api/test_adwords_api.rb~ +0 -127
  151. data/test/templates/v201306/basic_operations_get_campaigns.def +0 -114
  152. data/test/templates/v201306/misc_use_oauth2_jwt.def +0 -131
@@ -1,113 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
- #
6
- # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
7
- #
8
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
- # you may not use this file except in compliance with the License.
10
- # You may obtain a copy of the License at
11
- #
12
- # http://www.apache.org/licenses/LICENSE-2.0
13
- #
14
- # Unless required by applicable law or agreed to in writing, software
15
- # distributed under the License is distributed on an "AS IS" BASIS,
16
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
- # implied.
18
- # See the License for the specific language governing permissions and
19
- # limitations under the License.
20
- #
21
- # This example gets various statistics for campaigns that received at least one
22
- # impression during the last week. To get campaigns, run get_campaigns.rb.
23
- #
24
- # Tags: CampaignService.get
25
-
26
- require 'adwords_api'
27
- require 'date'
28
-
29
- def get_campaign_stats()
30
- # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
31
- # when called without parameters.
32
- adwords = AdwordsApi::Api.new
33
-
34
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
35
- # the configuration file or provide your own logger:
36
- # adwords.logger = Logger.new('adwords_xml.log')
37
-
38
- campaign_srv = adwords.service(:CampaignService, API_VERSION)
39
-
40
- # Prepare start and end date for the last week.
41
- start_date = DateTime.parse((Date.today - 7).to_s).strftime("%Y%m%d")
42
- end_date = DateTime.parse((Date.today - 1).to_s).strftime("%Y%m%d")
43
-
44
- # Get all the campaigns for this account.
45
- selector = {
46
- :fields => ['Id', 'Name', 'Impressions', 'Clicks', 'Cost', 'Ctr'],
47
- :predicates => [
48
- {:field => 'Impressions', :operator => 'GREATER_THAN', :values => [0]}
49
- ],
50
- :date_range => {:min => start_date, :max => end_date},
51
- :paging => {
52
- :start_index => 0,
53
- :number_results => PAGE_SIZE
54
- }
55
- }
56
-
57
- # Set initial values.
58
- offset, page = 0, {}
59
-
60
- begin
61
- page = campaign_srv.get(selector)
62
- if page[:entries]
63
- page[:entries].each do |campaign|
64
- puts ("Campaign with ID %d, name '%s' had the following stats during" +
65
- " the last week: ") % [campaign[:id], campaign[:name]]
66
- stats = campaign[:campaign_stats]
67
- puts "\tImpressions: %d" % stats[:impressions]
68
- puts "\tClicks: %d" % stats[:clicks]
69
- puts "\tCost: %.2f" % (stats[:cost][:micro_amount] / 1000000)
70
- puts "\tCTR: %.2f%%" % (stats[:ctr] * 100)
71
- end
72
- # Increment values to request the next page.
73
- offset += PAGE_SIZE
74
- selector[:paging][:start_index] = offset
75
- end
76
- end while page[:total_num_entries] > offset
77
-
78
- if page.include?(:total_num_entries)
79
- puts "Total number of campaigns found: %d." % [page[:total_num_entries]]
80
- end
81
- end
82
-
83
- if __FILE__ == $0
84
- API_VERSION = :v201306
85
- PAGE_SIZE = 500
86
-
87
- begin
88
- get_campaign_stats()
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
- 'http://code.google.com/p/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
@@ -1,79 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Author:: api.sgomes@gmail.com (Sérgio Gomes)
5
- #
6
- # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
- #
8
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
- # you may not use this file except in compliance with the License.
10
- # You may obtain a copy of the License at
11
- #
12
- # http://www.apache.org/licenses/LICENSE-2.0
13
- #
14
- # Unless required by applicable law or agreed to in writing, software
15
- # distributed under the License is distributed on an "AS IS" BASIS,
16
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
- # implied.
18
- # See the License for the specific language governing permissions and
19
- # limitations under the License.
20
- #
21
- # This example gets the list of possible report fields for a report type.
22
- #
23
- # Tags: ReportDefinitionService.getReportFields
24
-
25
- require 'adwords_api'
26
-
27
- def get_report_fields(report_type)
28
- # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
29
- # when called without parameters.
30
- adwords = AdwordsApi::Api.new
31
-
32
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
33
- # the configuration file or provide your own logger:
34
- # adwords.logger = Logger.new('adwords_xml.log')
35
-
36
- report_def_srv = adwords.service(:ReportDefinitionService, API_VERSION)
37
-
38
- # Get report fields.
39
- fields = report_def_srv.get_report_fields(report_type)
40
- if fields
41
- puts "Report type '%s' contains the following fields:" % report_type
42
- fields.each do |field|
43
- puts ' - %s (%s)' % [field[:field_name], field[:field_type]]
44
- puts ' := [%s]' % field[:enum_values].join(', ') if field[:enum_values]
45
- end
46
- end
47
- end
48
-
49
- if __FILE__ == $0
50
- API_VERSION = :v201306
51
-
52
- begin
53
- report_type = 'INSERT_REPORT_TYPE_HERE'
54
- get_report_fields(report_type)
55
-
56
- # Authorization error.
57
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
58
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
59
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
60
- "to retrieve and store OAuth2 tokens."
61
- puts "See this wiki page for more details:\n\n " +
62
- 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
63
-
64
- # HTTP errors.
65
- rescue AdsCommon::Errors::HttpError => e
66
- puts "HTTP Error: %s" % e
67
-
68
- # API errors.
69
- rescue AdwordsApi::Errors::ApiException => e
70
- puts "Message: %s" % e.message
71
- puts 'Errors:'
72
- e.errors.each_with_index do |error, index|
73
- puts "\tError [%d]:" % (index + 1)
74
- error.each do |field, value|
75
- puts "\t\t%s: %s" % [field, value]
76
- end
77
- end
78
- end
79
- end
@@ -1,171 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
- #
6
- # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
- #
8
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
- # you may not use this file except in compliance with the License.
10
- # You may obtain a copy of the License at
11
- #
12
- # http://www.apache.org/licenses/LICENSE-2.0
13
- #
14
- # Unless required by applicable law or agreed to in writing, software
15
- # distributed under the License is distributed on an "AS IS" BASIS,
16
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
- # implied.
18
- # See the License for the specific language governing permissions and
19
- # limitations under the License.
20
- #
21
- # This example gets and downloads an Ad Hoc report from a XML report definition
22
- # for all accounts in hierarchy in multiple parallel threads.
23
- #
24
- # Note: This code example uses MCC-level calls and won't work with Test
25
- # Accounts, see: https://developers.google.com/adwords/api/docs/test-accounts
26
-
27
- require 'thread'
28
-
29
- require 'adwords_api'
30
- require 'adwords_api/utils'
31
-
32
- def parallel_report_download()
33
- # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
34
- # when called without parameters.
35
- adwords = AdwordsApi::Api.new
36
-
37
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
38
- # the configuration file or provide your own logger:
39
- # adwords.logger = Logger.new('adwords_xml.log')
40
-
41
- # Determine list of customer IDs to retrieve report for. For this example we
42
- # will use ManagedCustomerService to get all IDs in hierarchy.
43
-
44
- managed_customer_srv = adwords.service(:ManagedCustomerService, API_VERSION)
45
-
46
- # Get the account hierarchy for this account.
47
- selector = {:fields => ['CustomerId']}
48
-
49
- # Run the request at the MCC level.
50
- graph = adwords.use_mcc() {managed_customer_srv.get(selector)}
51
-
52
- # Using queue to balance load between threads.
53
- queue = Queue.new()
54
-
55
- if graph and graph[:entries] and !graph[:entries].empty?
56
- graph[:entries].each {|account| queue << account[:customer_id]}
57
- else
58
- raise StandardError, 'Can not retrieve any customer ID'
59
- end
60
-
61
- # Get report utilities for the version.
62
- report_utils = adwords.report_utils(API_VERSION)
63
-
64
- # Define report definition. You can also pass your own XML text as a string.
65
- report_definition = {
66
- :selector => {
67
- :fields => ['CampaignId', 'Id', 'Impressions', 'Clicks', 'Cost'],
68
- # Predicates are optional.
69
- :predicates => {
70
- :field => 'Status',
71
- :operator => 'IN',
72
- :values => ['ENABLED', 'PAUSED']
73
- }
74
- },
75
- :report_name => 'Custom ADGROUP_PERFORMANCE_REPORT',
76
- :report_type => 'ADGROUP_PERFORMANCE_REPORT',
77
- :download_format => 'CSV',
78
- :date_range_type => 'LAST_7_DAYS',
79
- # Enable to get rows with zero impressions.
80
- :include_zero_impressions => false
81
- }
82
-
83
- puts 'Retrieving %d reports with %d threads:' % [queue.size, THREADS]
84
-
85
- reports_succeeded = Queue.new()
86
- reports_failed = Queue.new()
87
-
88
- # Creating a mutex to control access to the queue.
89
- queue_mutex = Mutex.new
90
-
91
- # Start all the threads.
92
- threads = (1..THREADS).map do |thread_id|
93
- Thread.new(report_definition) do |local_def|
94
- cid = nil
95
- begin
96
- cid = queue_mutex.synchronize {(queue.empty?) ? nil : queue.pop(true)}
97
- if cid
98
- retry_count = 0
99
- file_name = 'adgroup_%010d.csv' % cid
100
- puts "[%2d/%d] Loading report for customer ID %s into '%s'..." %
101
- [thread_id, retry_count,
102
- AdwordsApi::Utils.format_id(cid), file_name]
103
- begin
104
- report_utils.download_report_as_file(local_def, file_name, cid)
105
- reports_succeeded << {:cid => cid, :file_name => file_name}
106
- rescue AdwordsApi::Errors::ReportError => e
107
- if e.http_code == 500 && retry_count < MAX_RETRIES
108
- retry_count += 1
109
- sleep(retry_count * BACKOFF_FACTOR)
110
- retry
111
- else
112
- puts(('Report failed for customer ID %s with code %d after %d ' +
113
- 'retries.') % [cid, e.http_code, retry_count + 1])
114
- reports_failed <<
115
- {:cid => cid, :http_code => e.http_code, :message => e.message}
116
- end
117
- end
118
- end
119
- end while (cid != nil)
120
- end
121
- end
122
-
123
- # Wait for all threads to finish.
124
- threads.each { |aThread| aThread.join }
125
-
126
- puts 'Download completed, results:'
127
- puts 'Successful reports:'
128
- while !reports_succeeded.empty? do
129
- result = reports_succeeded.pop()
130
- puts "\tClient ID %s => '%s'" %
131
- [AdwordsApi::Utils.format_id(result[:cid]), result[:file_name]]
132
- end
133
- puts 'Failed reports:'
134
- while !reports_failed.empty? do
135
- result = reports_failed.pop()
136
- puts "\tClient ID %s => Code: %d, Message: '%s'" %
137
- [AdwordsApi::Utils.format_id(result[:cid]),
138
- result[:http_code], result[:message]]
139
- end
140
- puts 'End of results.'
141
- end
142
-
143
- if __FILE__ == $0
144
- API_VERSION = :v201306
145
- # Number of parallel threads to spawn.
146
- THREADS = 10
147
- # Maximum number of retries for 500 errors.
148
- MAX_RETRIES = 5
149
- # Timeout between retries in seconds.
150
- BACKOFF_FACTOR = 5
151
-
152
- begin
153
- parallel_report_download()
154
-
155
- # Authorization error.
156
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
157
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
158
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
159
- "to retrieve and store OAuth2 tokens."
160
- puts "See this wiki page for more details:\n\n " +
161
- 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
162
-
163
- # HTTP errors.
164
- rescue AdsCommon::Errors::HttpError => e
165
- puts 'HTTP Error: %s' % e
166
-
167
- # API errors.
168
- rescue AdwordsApi::Errors::ReportError => e
169
- puts 'Reporting Error: %s' % e.message
170
- end
171
- end
@@ -1,123 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
- #
6
- # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
- #
8
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
- # you may not use this file except in compliance with the License.
10
- # You may obtain a copy of the License at
11
- #
12
- # http://www.apache.org/licenses/LICENSE-2.0
13
- #
14
- # Unless required by applicable law or agreed to in writing, software
15
- # distributed under the License is distributed on an "AS IS" BASIS,
16
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
- # implied.
18
- # See the License for the specific language governing permissions and
19
- # limitations under the License.
20
- #
21
- # This example adds various types of targeting criteria to a campaign. To get
22
- # campaigns list, run get_campaigns.rb.
23
- #
24
- # Tags: CampaignCriterionService.mutate
25
-
26
- require 'adwords_api'
27
-
28
- def add_campaign_targeting_criteria(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
- campaign_criterion_srv =
38
- adwords.service(:CampaignCriterionService, API_VERSION)
39
-
40
- # Create campaign criteria.
41
- campaign_criteria = [
42
- # Location criteria. The IDs can be found in the documentation or retrieved
43
- # with the LocationCriterionService.
44
- {:xsi_type => 'Location', :id => 21137}, # California, USA
45
- {:xsi_type => 'Location', :id => 2484}, # Mexico
46
- # Language criteria. The IDs can be found in the documentation or retrieved
47
- # with the ConstantDataService.
48
- {:xsi_type => 'Language', :id => 1000}, # English
49
- {:xsi_type => 'Language', :id => 1003} # Spanish
50
- ]
51
-
52
- # Create operations.
53
- operations = campaign_criteria.map do |criterion|
54
- {:operator => 'ADD',
55
- :operand => {
56
- :campaign_id => campaign_id,
57
- :criterion => criterion}
58
- }
59
- end
60
-
61
- # Add negative campaign criterion.
62
- operations << {
63
- :operator => 'ADD',
64
- :operand => {
65
- # The 'xsi_type' field allows you to specify the xsi:type of the object
66
- # being created. It's only necessary when you must provide an explicit
67
- # type that the client library can't infer.
68
- :xsi_type => 'NegativeCampaignCriterion',
69
- :campaign_id => campaign_id,
70
- :criterion => {
71
- :xsi_type => 'Keyword',
72
- :text => 'jupiter cruise',
73
- :match_type => 'BROAD'
74
- }
75
- }
76
- }
77
-
78
- response = campaign_criterion_srv.mutate(operations)
79
-
80
- if response and response[:value]
81
- criteria = response[:value]
82
- criteria.each do |campaign_criterion|
83
- criterion = campaign_criterion[:criterion]
84
- puts ("Campaign criterion with campaign ID %d, criterion ID %d and " +
85
- "type '%s' was added.") % [campaign_criterion[:campaign_id],
86
- criterion[:id], criterion[:criterion_type]]
87
- end
88
- else
89
- puts 'No criteria were returned.'
90
- end
91
- end
92
-
93
- if __FILE__ == $0
94
- API_VERSION = :v201306
95
-
96
- begin
97
- campaign_id = 'INSERT_CAMPAIGN_ID_HERE'
98
- add_campaign_targeting_criteria(campaign_id)
99
-
100
- # Authorization error.
101
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
102
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
103
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
104
- "to retrieve and store OAuth2 tokens."
105
- puts "See this wiki page for more details:\n\n " +
106
- 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
107
-
108
- # HTTP errors.
109
- rescue AdsCommon::Errors::HttpError => e
110
- puts "HTTP Error: %s" % e
111
-
112
- # API errors.
113
- rescue AdwordsApi::Errors::ApiException => e
114
- puts "Message: %s" % e.message
115
- puts 'Errors:'
116
- e.errors.each_with_index do |error, index|
117
- puts "\tError [%d]:" % (index + 1)
118
- error.each do |field, value|
119
- puts "\t\t%s: %s" % [field, value]
120
- end
121
- end
122
- end
123
- end