google-adwords-api 0.5.3 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (192) hide show
  1. data/ChangeLog +7 -0
  2. data/README +4 -4
  3. data/examples/v201109_1/account_management/create_account.rb +80 -0
  4. data/examples/v201109_1/account_management/get_account_alerts.rb +111 -0
  5. data/examples/v201109_1/account_management/get_account_changes.rb +137 -0
  6. data/examples/v201109_1/account_management/get_account_hierarchy.rb +93 -0
  7. data/examples/v201109_1/account_management/get_client_customer_id.rb +85 -0
  8. data/examples/v201109_1/account_management/get_client_unit_usage.rb +87 -0
  9. data/examples/v201109_1/basic_operations/add_ad_groups.rb +111 -0
  10. data/examples/v201109_1/basic_operations/add_campaigns.rb +140 -0
  11. data/examples/v201109_1/basic_operations/add_keywords.rb +108 -0
  12. data/examples/v201109_1/basic_operations/add_text_ads.rb +105 -0
  13. data/examples/v201109_1/basic_operations/delete_ad.rb +85 -0
  14. data/examples/v201109_1/basic_operations/delete_ad_group.rb +102 -0
  15. data/examples/v201109_1/basic_operations/delete_campaign.rb +103 -0
  16. data/examples/v201109_1/basic_operations/delete_keyword.rb +90 -0
  17. data/examples/v201109_1/basic_operations/get_ad_groups.rb +98 -0
  18. data/examples/v201109_1/basic_operations/get_campaigns.rb +93 -0
  19. data/examples/v201109_1/basic_operations/get_keywords.rb +104 -0
  20. data/examples/v201109_1/basic_operations/get_text_ads.rb +106 -0
  21. data/examples/v201109_1/basic_operations/pause_ad.rb +84 -0
  22. data/examples/v201109_1/basic_operations/update_ad_group.rb +81 -0
  23. data/examples/v201109_1/basic_operations/update_campaign.rb +84 -0
  24. data/examples/v201109_1/basic_operations/update_keyword.rb +99 -0
  25. data/examples/v201109_1/campaign_management/add_experiment.rb +158 -0
  26. data/examples/v201109_1/campaign_management/add_keywords_in_bulk.rb +150 -0
  27. data/examples/v201109_1/campaign_management/add_location_extension.rb +117 -0
  28. data/examples/v201109_1/campaign_management/add_location_extension_override.rb +83 -0
  29. data/examples/v201109_1/campaign_management/get_all_disapproved_ads.rb +93 -0
  30. data/examples/v201109_1/campaign_management/promote_experiment.rb +77 -0
  31. data/examples/v201109_1/campaign_management/set_ad_parameters.rb +114 -0
  32. data/examples/v201109_1/campaign_management/validate_text_ad.rb +106 -0
  33. data/examples/v201109_1/error_handling/handle_captcha_challenge.rb +93 -0
  34. data/examples/v201109_1/error_handling/handle_partial_failures.rb +126 -0
  35. data/examples/v201109_1/error_handling/handle_policy_violation_error.rb +137 -0
  36. data/examples/v201109_1/error_handling/handle_two_factor_authorization_error.rb +87 -0
  37. data/examples/v201109_1/misc/get_all_images_and_videos.rb +101 -0
  38. data/examples/v201109_1/misc/upload_image.rb +90 -0
  39. data/examples/v201109_1/misc/use_oauth.rb +97 -0
  40. data/examples/v201109_1/optimization/estimate_keyword_traffic.rb +129 -0
  41. data/examples/v201109_1/optimization/get_keyword_bid_simulations.rb +92 -0
  42. data/examples/v201109_1/optimization/get_keyword_ideas.rb +113 -0
  43. data/examples/v201109_1/optimization/get_placement_ideas.rb +106 -0
  44. data/examples/v201109_1/remarketing/add_audience.rb +115 -0
  45. data/examples/v201109_1/remarketing/add_conversion_tracker.rb +97 -0
  46. data/examples/v201109_1/reporting/download_criteria_report.rb +79 -0
  47. data/examples/v201109_1/reporting/get_campaign_stats.rb +105 -0
  48. data/examples/v201109_1/reporting/get_defined_reports.rb +75 -0
  49. data/examples/{v201109/reporting/download_defined_report.rb → v201109_1/reporting/get_report_fields.rb} +15 -11
  50. data/examples/v201109_1/reporting/parallel_report_download.rb +159 -0
  51. data/examples/v201109_1/targeting/add_campaign_targeting_criteria.rb +118 -0
  52. data/examples/v201109_1/targeting/get_campaign_targeting_criteria.rb +102 -0
  53. data/examples/v201109_1/targeting/get_targetable_languages_and_carriers.rb +86 -0
  54. data/examples/v201109_1/targeting/lookup_location.rb +103 -0
  55. data/lib/adwords_api.rb +15 -88
  56. data/lib/adwords_api/api_config.rb +75 -33
  57. data/lib/adwords_api/client_login_header_handler.rb +17 -26
  58. data/lib/adwords_api/credential_handler.rb +29 -65
  59. data/lib/adwords_api/report_header_handler.rb +65 -0
  60. data/lib/adwords_api/report_utils.rb +12 -36
  61. data/lib/adwords_api/v201109/ad_extension_override_service.rb +3 -3
  62. data/lib/adwords_api/v201109/ad_extension_override_service_registry.rb +2 -2
  63. data/lib/adwords_api/v201109/ad_group_ad_service.rb +3 -3
  64. data/lib/adwords_api/v201109/ad_group_ad_service_registry.rb +1 -1
  65. data/lib/adwords_api/v201109/ad_group_criterion_service.rb +3 -3
  66. data/lib/adwords_api/v201109/ad_group_criterion_service_registry.rb +1 -1
  67. data/lib/adwords_api/v201109/ad_group_service.rb +3 -3
  68. data/lib/adwords_api/v201109/ad_group_service_registry.rb +1 -1
  69. data/lib/adwords_api/v201109/ad_param_service.rb +3 -3
  70. data/lib/adwords_api/v201109/ad_param_service_registry.rb +1 -1
  71. data/lib/adwords_api/v201109/alert_service.rb +3 -3
  72. data/lib/adwords_api/v201109/alert_service_registry.rb +1 -1
  73. data/lib/adwords_api/v201109/budget_order_service.rb +42 -0
  74. data/lib/adwords_api/v201109/budget_order_service_registry.rb +46 -0
  75. data/lib/adwords_api/v201109/bulk_mutate_job_service.rb +3 -3
  76. data/lib/adwords_api/v201109/bulk_mutate_job_service_registry.rb +1 -1
  77. data/lib/adwords_api/v201109/campaign_ad_extension_service.rb +3 -3
  78. data/lib/adwords_api/v201109/campaign_ad_extension_service_registry.rb +2 -2
  79. data/lib/adwords_api/v201109/campaign_criterion_service.rb +3 -3
  80. data/lib/adwords_api/v201109/campaign_criterion_service_registry.rb +1 -1
  81. data/lib/adwords_api/v201109/campaign_service.rb +3 -3
  82. data/lib/adwords_api/v201109/campaign_service_registry.rb +1 -1
  83. data/lib/adwords_api/v201109/campaign_target_service.rb +3 -3
  84. data/lib/adwords_api/v201109/campaign_target_service_registry.rb +1 -1
  85. data/lib/adwords_api/v201109/constant_data_service.rb +3 -3
  86. data/lib/adwords_api/v201109/constant_data_service_registry.rb +1 -1
  87. data/lib/adwords_api/v201109/conversion_tracker_service.rb +3 -3
  88. data/lib/adwords_api/v201109/conversion_tracker_service_registry.rb +1 -1
  89. data/lib/adwords_api/v201109/create_account_service.rb +3 -3
  90. data/lib/adwords_api/v201109/create_account_service_registry.rb +1 -1
  91. data/lib/adwords_api/v201109/customer_sync_service.rb +3 -3
  92. data/lib/adwords_api/v201109/customer_sync_service_registry.rb +1 -1
  93. data/lib/adwords_api/v201109/data_service.rb +3 -3
  94. data/lib/adwords_api/v201109/data_service_registry.rb +1 -1
  95. data/lib/adwords_api/v201109/experiment_service.rb +3 -3
  96. data/lib/adwords_api/v201109/experiment_service_registry.rb +1 -1
  97. data/lib/adwords_api/v201109/geo_location_service.rb +3 -3
  98. data/lib/adwords_api/v201109/geo_location_service_registry.rb +1 -1
  99. data/lib/adwords_api/v201109/info_service.rb +3 -3
  100. data/lib/adwords_api/v201109/info_service_registry.rb +1 -1
  101. data/lib/adwords_api/v201109/location_criterion_service.rb +3 -3
  102. data/lib/adwords_api/v201109/location_criterion_service_registry.rb +1 -1
  103. data/lib/adwords_api/v201109/media_service.rb +3 -3
  104. data/lib/adwords_api/v201109/media_service_registry.rb +1 -1
  105. data/lib/adwords_api/v201109/mutate_job_service.rb +3 -3
  106. data/lib/adwords_api/v201109/mutate_job_service_registry.rb +1 -1
  107. data/lib/adwords_api/v201109/report_definition_service.rb +3 -12
  108. data/lib/adwords_api/v201109/report_definition_service_registry.rb +1 -1
  109. data/lib/adwords_api/v201109/serviced_account_service.rb +3 -3
  110. data/lib/adwords_api/v201109/serviced_account_service_registry.rb +1 -1
  111. data/lib/adwords_api/v201109/targeting_idea_service.rb +3 -3
  112. data/lib/adwords_api/v201109/targeting_idea_service_registry.rb +1 -1
  113. data/lib/adwords_api/v201109/traffic_estimator_service.rb +3 -3
  114. data/lib/adwords_api/v201109/traffic_estimator_service_registry.rb +1 -1
  115. data/lib/adwords_api/v201109/user_list_service.rb +3 -3
  116. data/lib/adwords_api/v201109/user_list_service_registry.rb +1 -1
  117. data/lib/adwords_api/v201109_1/ad_extension_override_service.rb +38 -0
  118. data/lib/adwords_api/v201109_1/ad_extension_override_service_registry.rb +46 -0
  119. data/lib/adwords_api/v201109_1/ad_group_ad_service.rb +38 -0
  120. data/lib/adwords_api/v201109_1/ad_group_ad_service_registry.rb +46 -0
  121. data/lib/adwords_api/v201109_1/ad_group_criterion_service.rb +38 -0
  122. data/lib/adwords_api/v201109_1/ad_group_criterion_service_registry.rb +46 -0
  123. data/lib/adwords_api/v201109_1/ad_group_service.rb +38 -0
  124. data/lib/adwords_api/v201109_1/ad_group_service_registry.rb +46 -0
  125. data/lib/adwords_api/v201109_1/ad_param_service.rb +38 -0
  126. data/lib/adwords_api/v201109_1/ad_param_service_registry.rb +46 -0
  127. data/lib/adwords_api/v201109_1/alert_service.rb +34 -0
  128. data/lib/adwords_api/v201109_1/alert_service_registry.rb +46 -0
  129. data/lib/adwords_api/v201109_1/budget_order_service.rb +42 -0
  130. data/lib/adwords_api/v201109_1/budget_order_service_registry.rb +46 -0
  131. data/lib/adwords_api/v201109_1/bulk_mutate_job_service.rb +38 -0
  132. data/lib/adwords_api/v201109_1/bulk_mutate_job_service_registry.rb +46 -0
  133. data/lib/adwords_api/v201109_1/campaign_ad_extension_service.rb +38 -0
  134. data/lib/adwords_api/v201109_1/campaign_ad_extension_service_registry.rb +46 -0
  135. data/lib/adwords_api/v201109_1/campaign_criterion_service.rb +38 -0
  136. data/lib/adwords_api/v201109_1/campaign_criterion_service_registry.rb +46 -0
  137. data/lib/adwords_api/v201109_1/campaign_service.rb +38 -0
  138. data/lib/adwords_api/v201109_1/campaign_service_registry.rb +46 -0
  139. data/lib/adwords_api/v201109_1/campaign_target_service.rb +38 -0
  140. data/lib/adwords_api/v201109_1/campaign_target_service_registry.rb +46 -0
  141. data/lib/adwords_api/v201109_1/constant_data_service.rb +38 -0
  142. data/lib/adwords_api/v201109_1/constant_data_service_registry.rb +46 -0
  143. data/lib/adwords_api/v201109_1/conversion_tracker_service.rb +38 -0
  144. data/lib/adwords_api/v201109_1/conversion_tracker_service_registry.rb +46 -0
  145. data/lib/adwords_api/v201109_1/create_account_service.rb +34 -0
  146. data/lib/adwords_api/v201109_1/create_account_service_registry.rb +47 -0
  147. data/lib/adwords_api/v201109_1/customer_sync_service.rb +34 -0
  148. data/lib/adwords_api/v201109_1/customer_sync_service_registry.rb +47 -0
  149. data/lib/adwords_api/v201109_1/data_service.rb +38 -0
  150. data/lib/adwords_api/v201109_1/data_service_registry.rb +46 -0
  151. data/lib/adwords_api/v201109_1/experiment_service.rb +38 -0
  152. data/lib/adwords_api/v201109_1/experiment_service_registry.rb +46 -0
  153. data/lib/adwords_api/v201109_1/geo_location_service.rb +34 -0
  154. data/lib/adwords_api/v201109_1/geo_location_service_registry.rb +46 -0
  155. data/lib/adwords_api/v201109_1/info_service.rb +34 -0
  156. data/lib/adwords_api/v201109_1/info_service_registry.rb +46 -0
  157. data/lib/adwords_api/v201109_1/location_criterion_service.rb +34 -0
  158. data/lib/adwords_api/v201109_1/location_criterion_service_registry.rb +46 -0
  159. data/lib/adwords_api/v201109_1/media_service.rb +38 -0
  160. data/lib/adwords_api/v201109_1/media_service_registry.rb +46 -0
  161. data/lib/adwords_api/v201109_1/mutate_job_service.rb +42 -0
  162. data/lib/adwords_api/v201109_1/mutate_job_service_registry.rb +46 -0
  163. data/lib/adwords_api/v201109_1/report_definition_service.rb +38 -0
  164. data/lib/adwords_api/v201109_1/report_definition_service_registry.rb +46 -0
  165. data/lib/adwords_api/v201109_1/serviced_account_service.rb +34 -0
  166. data/lib/adwords_api/v201109_1/serviced_account_service_registry.rb +46 -0
  167. data/lib/adwords_api/v201109_1/targeting_idea_service.rb +38 -0
  168. data/lib/adwords_api/v201109_1/targeting_idea_service_registry.rb +46 -0
  169. data/lib/adwords_api/v201109_1/traffic_estimator_service.rb +34 -0
  170. data/lib/adwords_api/v201109_1/traffic_estimator_service_registry.rb +46 -0
  171. data/lib/adwords_api/v201109_1/user_list_service.rb +38 -0
  172. data/lib/adwords_api/v201109_1/user_list_service_registry.rb +46 -0
  173. data/lib/adwords_api/version.rb +1 -1
  174. data/test/adwords_api/test_api_config.rb +24 -8
  175. data/test/adwords_api/test_credential_handler.rb +32 -52
  176. data/test/coverage.rb +38 -0
  177. data/test/examples/v201109/test_reporting.rb +0 -12
  178. data/test/examples/v201109_1/test_account_management.rb +60 -0
  179. data/test/examples/v201109_1/test_basic_operations.rb +172 -0
  180. data/test/examples/v201109_1/test_campaign_management.rb +116 -0
  181. data/test/examples/v201109_1/test_error_handling.rb +63 -0
  182. data/{lib/adwords_api/v13_login_handler.rb → test/examples/v201109_1/test_misc.rb} +24 -10
  183. data/test/examples/v201109_1/test_optimization.rb +63 -0
  184. data/test/{suite_exampletests.rb → examples/v201109_1/test_remarketing.rb} +16 -8
  185. data/test/examples/v201109_1/test_reporting.rb +77 -0
  186. data/test/examples/v201109_1/test_targeting.rb +60 -0
  187. data/test/examples/v201109_1/utils.rb +239 -0
  188. data/test/suite_exampletests_v201109.rb +37 -0
  189. data/test/suite_exampletests_v201109_1.rb +37 -0
  190. data/test/suite_unittests.rb +7 -5
  191. metadata +136 -11
  192. data/lib/adwords_api/extensions.rb +0 -269
@@ -0,0 +1,87 @@
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 illustrates how to handle 'two factor' authorization error.
22
+
23
+ require 'adwords_api'
24
+
25
+ def handle_two_factor_authorization_error()
26
+ # Set up credentials with an account that has 2Factor enabled.
27
+ config = {
28
+ :authentication => {
29
+ :method => 'ClientLogin',
30
+ :email => '2steptester@gmail.com',
31
+ :password => 'testaccount',
32
+ :user_agent => 'Ruby 2 Factor Sample'
33
+ },
34
+ :service => {
35
+ :environment => 'PRODUCTION'
36
+ }
37
+ }
38
+ adwords = AdwordsApi::Api.new(config)
39
+
40
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
41
+ # the configuration file or provide your own logger:
42
+ # adwords.logger = Logger.new('adwords_xml.log')
43
+
44
+ begin
45
+ # Forcing library to request authorization token.
46
+ auth_token = adwords.authorize()
47
+ puts 'Successfully retrieved the token.'
48
+
49
+ # Second factor error is one of AuthErrors.
50
+ rescue AdsCommon::Errors::AuthError => e
51
+ puts "Authorization failed with message:"
52
+ puts "\t%s" % e.message
53
+ # Checking 'Info' field for particular auth error type.
54
+ if e.info and e.info.casecmp('InvalidSecondFactor') == 0
55
+ puts "The user has enabled two factor authentication in this account." +
56
+ " Please use OAuth authentication method or have the user generate an" +
57
+ " application-specific password to make calls against the AdWords" +
58
+ " API. See \n" +
59
+ " http://adwordsapi.blogspot.com/2011/02/authentication-changes-with" +
60
+ "-2-step.html\n" +
61
+ "for more details."
62
+ end
63
+ end
64
+ end
65
+
66
+ if __FILE__ == $0
67
+ API_VERSION = :v201109_1
68
+
69
+ begin
70
+ handle_two_factor_authorization_error()
71
+
72
+ # HTTP errors.
73
+ rescue AdsCommon::Errors::HttpError => e
74
+ puts "HTTP Error: %s" % e
75
+
76
+ # API errors.
77
+ rescue AdwordsApi::Errors::ApiException => e
78
+ puts "Message: %s" % e.message
79
+ puts 'Errors:'
80
+ e.errors.each_with_index do |error, index|
81
+ puts "\tError [%d]:" % (index + 1)
82
+ error.each do |field, value|
83
+ puts "\t\t%s: %s" % [field, value]
84
+ end
85
+ end
86
+ end
87
+ end
@@ -0,0 +1,101 @@
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 illustrates how to retrieve all images and videos. To upload an
22
+ # image, run upload_image.rb. To upload video, see:
23
+ # http://adwords.google.com/support/aw/bin/answer.py?hl=en&answer=39454.
24
+ #
25
+ # Tags: MediaService.get
26
+
27
+ require 'adwords_api'
28
+ require 'adwords_api/utils'
29
+
30
+ def get_all_images_and_videos()
31
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
32
+ # when called without parameters.
33
+ adwords = AdwordsApi::Api.new
34
+
35
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
36
+ # the configuration file or provide your own logger:
37
+ # adwords.logger = Logger.new('adwords_xml.log')
38
+
39
+ media_srv = adwords.service(:MediaService, API_VERSION)
40
+
41
+ # Get all the images and videos.
42
+ selector = {
43
+ :fields => ['MediaId', 'Height', 'Width', 'MimeType', 'Urls'],
44
+ :ordering => [
45
+ {:field => 'MediaId', :sort_order => 'ASCENDING'}
46
+ ],
47
+ :predicates => [
48
+ {:field => 'Type', :operator => 'IN', :values => ['IMAGE', 'VIDEO']}
49
+ ],
50
+ :paging => {
51
+ :start_index => 0,
52
+ :number_results => PAGE_SIZE
53
+ }
54
+ }
55
+
56
+ # Set initial values.
57
+ offset, page = 0, {}
58
+
59
+ begin
60
+ page = media_srv.get(selector)
61
+ if page[:entries]
62
+ page[:entries].each do |entry|
63
+ dimensions = AdwordsApi::Utils.map(entry[:dimensions])
64
+ puts "Entry ID %d with dimensions %dx%d and MIME type is '%s'" %
65
+ [entry[:media_id], dimensions['FULL'][:height],
66
+ dimensions['FULL'][:width], entry[:mime_type]]
67
+ end
68
+ # Increment values to request the next page.
69
+ offset += PAGE_SIZE
70
+ selector[:paging][:start_index] = offset
71
+ end
72
+ end while page[:total_num_entries] > offset
73
+
74
+ if page.include?(:total_num_entries)
75
+ puts "\tFound %d entries." % page[:total_num_entries]
76
+ end
77
+ end
78
+
79
+ if __FILE__ == $0
80
+ API_VERSION = :v201109_1
81
+ PAGE_SIZE = 500
82
+
83
+ begin
84
+ get_all_images_and_videos()
85
+
86
+ # HTTP errors.
87
+ rescue AdsCommon::Errors::HttpError => e
88
+ puts "HTTP Error: %s" % e
89
+
90
+ # API errors.
91
+ rescue AdwordsApi::Errors::ApiException => e
92
+ puts "Message: %s" % e.message
93
+ puts 'Errors:'
94
+ e.errors.each_with_index do |error, index|
95
+ puts "\tError [%d]:" % (index + 1)
96
+ error.each do |field, value|
97
+ puts "\t\t%s: %s" % [field, value]
98
+ end
99
+ end
100
+ end
101
+ end
@@ -0,0 +1,90 @@
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 uploads an image. To get images, run get_all_images.rb.
22
+ #
23
+ # Tags: MediaService.upload
24
+
25
+ require 'adwords_api'
26
+ require 'adwords_api/utils'
27
+ require 'base64'
28
+
29
+ def upload_image()
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
+ media_srv = adwords.service(:MediaService, API_VERSION)
39
+
40
+ # Create image.
41
+ image_url =
42
+ 'http://www.google.com/intl/en/adwords/select/images/samples/inline.jpg'
43
+ # This utility method retrieves the contents of a URL using all of the config
44
+ # options provided to the Api object.
45
+ image_data = AdsCommon::Http.get(image_url, adwords.config)
46
+ base64_image_data = Base64.encode64(image_data)
47
+ image = {
48
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
49
+ # being created. It's only necessary when you must provide an explicit
50
+ # type that the client library can't infer.
51
+ :xsi_type => 'Image',
52
+ :data => base64_image_data,
53
+ :type => 'IMAGE'
54
+ }
55
+
56
+ # Upload image.
57
+ response = media_srv.upload([image])
58
+ if response and !response.empty?
59
+ ret_image = response.first
60
+ dimensions = AdwordsApi::Utils.map(ret_image[:dimensions])
61
+ puts "Image with id #{ret_image[:media_id]}, dimensions " +
62
+ "#{dimensions['FULL'][:height]}x#{dimensions['FULL'][:width]} " +
63
+ "and MIME type \"#{ret_image[:mime_type]}\" uploaded successfully."
64
+ else
65
+ puts "No images uploaded."
66
+ end
67
+ end
68
+
69
+ if __FILE__ == $0
70
+ API_VERSION = :v201109_1
71
+
72
+ begin
73
+ upload_image()
74
+
75
+ # HTTP errors.
76
+ rescue AdsCommon::Errors::HttpError => e
77
+ puts "HTTP Error: %s" % e
78
+
79
+ # API errors.
80
+ rescue AdwordsApi::Errors::ApiException => e
81
+ puts "Message: %s" % e.message
82
+ puts 'Errors:'
83
+ e.errors.each_with_index do |error, index|
84
+ puts "\tError [%d]:" % (index + 1)
85
+ error.each do |field, value|
86
+ puts "\t\t%s: %s" % [field, value]
87
+ end
88
+ end
89
+ end
90
+ end
@@ -0,0 +1,97 @@
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 illustrates how to use OAuth authentication method.
22
+ #
23
+ # Tags: CampaignService.get
24
+
25
+ require 'adwords_api'
26
+
27
+ def use_oauth()
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
+ campaign_srv = adwords.service(:CampaignService, API_VERSION)
37
+
38
+ # Get all the campaigns for this account; empty selector.
39
+ selector = {
40
+ :fields => ['Id', 'Name', 'Status'],
41
+ :ordering => [
42
+ {:field => 'Name', :sort_order => 'ASCENDING'}
43
+ ]
44
+ }
45
+
46
+ retry_count = 0
47
+
48
+ begin
49
+ response = campaign_srv.get(selector)
50
+ rescue AdsCommon::Errors::OAuthVerificationRequired => e
51
+ if retry_count < MAX_RETRIES
52
+ puts "Hit Auth error, please navigate to URL:\n\t%s" % e.oauth_url
53
+ print 'log in and type the verification code: '
54
+ verification_code = gets.chomp
55
+ adwords.credential_handler.set_credential(
56
+ :oauth_verification_code, verification_code)
57
+ retry_count += 1
58
+ retry
59
+ else
60
+ raise AdsCommon::Errors::AuthError, 'Failed to authenticate.'
61
+ end
62
+ end
63
+
64
+ if response and response[:entries]
65
+ campaigns = response[:entries]
66
+ campaigns.each do |campaign|
67
+ puts "Campaign ID %d, name '%s' and status '%s'" %
68
+ [campaign[:id], campaign[:name], campaign[:status]]
69
+ end
70
+ else
71
+ puts 'No campaigns were found.'
72
+ end
73
+ end
74
+
75
+ if __FILE__ == $0
76
+ API_VERSION = :v201109_1
77
+ MAX_RETRIES = 3
78
+
79
+ begin
80
+ use_oauth()
81
+
82
+ # HTTP errors.
83
+ rescue AdsCommon::Errors::HttpError => e
84
+ puts "HTTP Error: %s" % e
85
+
86
+ # API errors.
87
+ rescue AdwordsApi::Errors::ApiException => e
88
+ puts "Message: %s" % e.message
89
+ puts 'Errors:'
90
+ e.errors.each_with_index do |error, index|
91
+ puts "\tError [%d]:" % (index + 1)
92
+ error.each do |field, value|
93
+ puts "\t\t%s: %s" % [field, value]
94
+ end
95
+ end
96
+ end
97
+ end
@@ -0,0 +1,129 @@
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 keyword traffic estimates.
22
+ #
23
+ # Tags: TrafficEstimatorService.get
24
+
25
+ require 'adwords_api'
26
+
27
+ def estimate_keyword_traffic()
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
+ traffic_estimator_srv = adwords.service(:TrafficEstimatorService, API_VERSION)
37
+
38
+ # Create keywords. Up to 2000 keywords can be passed in a single request.
39
+ keywords = [
40
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
41
+ # being created. It's only necessary when you must provide an explicit
42
+ # type that the client library can't infer.
43
+ {:xsi_type => 'Keyword', :text => 'mars cruise', :match_type => 'BROAD'},
44
+ {:xsi_type => 'Keyword', :text => 'cheap cruise', :match_type => 'PHRASE'},
45
+ {:xsi_type => 'Keyword', :text => 'cruise', :match_type => 'EXACT'},
46
+ {:xsi_type => 'Keyword', :text => 'moon walk', :match_type => 'BROAD'}
47
+ ]
48
+
49
+ # Create a keyword estimate request for each keyword.
50
+ keyword_requests = keywords.map {|keyword| {:keyword => keyword}}
51
+
52
+ # Negative keywords don't return estimates, but adjust the estimates of the
53
+ # other keywords in the hypothetical ad group. To specify a negative keyword
54
+ # set the is_negative field to true.
55
+ keyword_requests[3][:is_negative] = true
56
+
57
+ # Create ad group estimate requests.
58
+ ad_group_request = {
59
+ :keyword_estimate_requests => keyword_requests,
60
+ :max_cpc => {
61
+ :micro_amount => 1000000
62
+ }
63
+ }
64
+
65
+ # Create campaign estimate requests.
66
+ campaign_request = {
67
+ :ad_group_estimate_requests => [ad_group_request],
68
+ # Set targeting criteria. Only locations and languages are supported.
69
+ :criteria => [
70
+ {:xsi_type => 'Location', :id => 2840}, # United States
71
+ {:xsi_type => 'Language', :id => 1000} # English
72
+ ]
73
+ }
74
+
75
+ # Create selector and retrieve reults.
76
+ selector = {:campaign_estimate_requests => [campaign_request]}
77
+ response = traffic_estimator_srv.get(selector)
78
+
79
+ if response and response[:campaign_estimates]
80
+ campaign_estimates = response[:campaign_estimates]
81
+ keyword_estimates =
82
+ campaign_estimates.first[:ad_group_estimates].first[:keyword_estimates]
83
+ keyword_estimates.each_with_index do |estimate, index|
84
+ keyword = keyword_requests[index][:keyword]
85
+
86
+ # Find the mean of the min and max values.
87
+ mean_avg_cpc = (estimate[:min][:average_cpc][:micro_amount] +
88
+ estimate[:max][:average_cpc][:micro_amount]) / 2
89
+ mean_avg_position = (estimate[:min][:average_position] +
90
+ estimate[:max][:average_position]) / 2
91
+ mean_clicks = (estimate[:min][:clicks_per_day] +
92
+ estimate[:max][:clicks_per_day]) / 2
93
+ mean_total_cost = (estimate[:min][:total_cost][:micro_amount] +
94
+ estimate[:max][:total_cost][:micro_amount]) / 2
95
+
96
+ puts "Results for the keyword with text '%s' and match type %s:" %
97
+ [keyword[:text], keyword[:match_type]]
98
+ puts "\tEstimated average CPC: %d" % mean_avg_cpc
99
+ puts "\tEstimated ad position: %.2f" % mean_avg_position
100
+ puts "\tEstimated daily clicks: %d" % mean_clicks
101
+ puts "\tEstimated daily cost: %d" % mean_total_cost
102
+ end
103
+ else
104
+ puts 'No traffic estimates were returned.'
105
+ end
106
+ end
107
+
108
+ if __FILE__ == $0
109
+ API_VERSION = :v201109_1
110
+
111
+ begin
112
+ estimate_keyword_traffic()
113
+
114
+ # HTTP errors.
115
+ rescue AdsCommon::Errors::HttpError => e
116
+ puts "HTTP Error: %s" % e
117
+
118
+ # API errors.
119
+ rescue AdwordsApi::Errors::ApiException => e
120
+ puts "Message: %s" % e.message
121
+ puts 'Errors:'
122
+ e.errors.each_with_index do |error, index|
123
+ puts "\tError [%d]:" % (index + 1)
124
+ error.each do |field, value|
125
+ puts "\t\t%s: %s" % [field, value]
126
+ end
127
+ end
128
+ end
129
+ end