google-adwords-api 0.7.0 → 0.7.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (130) hide show
  1. data/ChangeLog +3 -0
  2. data/README +3 -3
  3. data/examples/v201206/basic_operations/add_campaigns.rb +7 -2
  4. data/examples/v201209/account_management/create_account.rb +84 -0
  5. data/examples/v201209/account_management/get_account_alerts.rb +111 -0
  6. data/examples/v201209/account_management/get_account_changes.rb +137 -0
  7. data/examples/v201209/account_management/get_account_hierarchy.rb +92 -0
  8. data/examples/v201209/account_management/get_client_customer_id.rb +85 -0
  9. data/examples/v201209/account_management/get_client_unit_usage.rb +87 -0
  10. data/examples/v201209/basic_operations/add_ad_groups.rb +136 -0
  11. data/examples/v201209/basic_operations/add_campaigns.rb +159 -0
  12. data/examples/v201209/basic_operations/add_keywords.rb +108 -0
  13. data/examples/v201209/basic_operations/add_text_ads.rb +105 -0
  14. data/examples/v201209/basic_operations/delete_ad.rb +85 -0
  15. data/examples/v201209/basic_operations/delete_ad_group.rb +102 -0
  16. data/examples/v201209/basic_operations/delete_campaign.rb +103 -0
  17. data/examples/v201209/basic_operations/delete_keyword.rb +90 -0
  18. data/examples/v201209/basic_operations/get_ad_groups.rb +98 -0
  19. data/examples/v201209/basic_operations/get_campaigns.rb +93 -0
  20. data/examples/v201209/basic_operations/get_campaigns_with_awql.rb +85 -0
  21. data/examples/v201209/basic_operations/get_keywords.rb +104 -0
  22. data/examples/v201209/basic_operations/get_text_ads.rb +106 -0
  23. data/examples/v201209/basic_operations/pause_ad.rb +84 -0
  24. data/examples/v201209/basic_operations/update_ad_group.rb +81 -0
  25. data/examples/v201209/basic_operations/update_campaign.rb +82 -0
  26. data/examples/v201209/basic_operations/update_keyword.rb +99 -0
  27. data/examples/v201209/campaign_management/add_experiment.rb +158 -0
  28. data/examples/v201209/campaign_management/add_keywords_in_bulk.rb +150 -0
  29. data/examples/v201209/campaign_management/add_location_extension.rb +117 -0
  30. data/examples/v201209/campaign_management/add_location_extension_override.rb +83 -0
  31. data/examples/v201209/campaign_management/get_all_disapproved_ads.rb +93 -0
  32. data/examples/v201209/campaign_management/get_all_disapproved_ads_with_awql.rb +84 -0
  33. data/examples/v201209/campaign_management/promote_experiment.rb +77 -0
  34. data/examples/v201209/campaign_management/set_ad_parameters.rb +114 -0
  35. data/examples/v201209/campaign_management/validate_text_ad.rb +106 -0
  36. data/examples/v201209/error_handling/handle_captcha_challenge.rb +93 -0
  37. data/examples/v201209/error_handling/handle_partial_failures.rb +126 -0
  38. data/examples/v201209/error_handling/handle_policy_violation_error.rb +137 -0
  39. data/examples/v201209/error_handling/handle_two_factor_authorization_error.rb +87 -0
  40. data/examples/v201209/misc/get_all_images_and_videos.rb +100 -0
  41. data/examples/v201209/misc/upload_image.rb +89 -0
  42. data/examples/v201209/misc/use_oauth.rb +100 -0
  43. data/examples/v201209/misc/use_oauth2.rb +97 -0
  44. data/examples/v201209/optimization/estimate_keyword_traffic.rb +129 -0
  45. data/examples/v201209/optimization/get_keyword_bid_simulations.rb +92 -0
  46. data/examples/v201209/optimization/get_keyword_ideas.rb +114 -0
  47. data/examples/v201209/optimization/get_placement_ideas.rb +104 -0
  48. data/examples/v201209/remarketing/add_audience.rb +115 -0
  49. data/examples/v201209/remarketing/add_conversion_tracker.rb +97 -0
  50. data/examples/v201209/reporting/download_criteria_report.rb +79 -0
  51. data/examples/v201209/reporting/download_criteria_report_with_awql.rb +78 -0
  52. data/examples/v201209/reporting/get_campaign_stats.rb +105 -0
  53. data/examples/v201209/reporting/get_report_fields.rb +71 -0
  54. data/examples/v201209/reporting/parallel_report_download.rb +160 -0
  55. data/examples/v201209/targeting/add_campaign_targeting_criteria.rb +118 -0
  56. data/examples/v201209/targeting/add_demographic_targeting_criteria.rb +108 -0
  57. data/examples/v201209/targeting/get_campaign_targeting_criteria.rb +102 -0
  58. data/examples/v201209/targeting/get_targetable_languages_and_carriers.rb +86 -0
  59. data/examples/v201209/targeting/lookup_location.rb +104 -0
  60. data/lib/adwords_api/api_config.rb +64 -5
  61. data/lib/adwords_api/errors.rb +15 -0
  62. data/lib/adwords_api/report_utils.rb +30 -11
  63. data/lib/adwords_api/v201209/ad_extension_override_service.rb +38 -0
  64. data/lib/adwords_api/v201209/ad_extension_override_service_registry.rb +46 -0
  65. data/lib/adwords_api/v201209/ad_group_ad_service.rb +42 -0
  66. data/lib/adwords_api/v201209/ad_group_ad_service_registry.rb +46 -0
  67. data/lib/adwords_api/v201209/ad_group_criterion_service.rb +42 -0
  68. data/lib/adwords_api/v201209/ad_group_criterion_service_registry.rb +46 -0
  69. data/lib/adwords_api/v201209/ad_group_service.rb +42 -0
  70. data/lib/adwords_api/v201209/ad_group_service_registry.rb +46 -0
  71. data/lib/adwords_api/v201209/ad_param_service.rb +38 -0
  72. data/lib/adwords_api/v201209/ad_param_service_registry.rb +46 -0
  73. data/lib/adwords_api/v201209/alert_service.rb +34 -0
  74. data/lib/adwords_api/v201209/alert_service_registry.rb +46 -0
  75. data/lib/adwords_api/v201209/budget_order_service.rb +42 -0
  76. data/lib/adwords_api/v201209/budget_order_service_registry.rb +46 -0
  77. data/lib/adwords_api/v201209/budget_service.rb +38 -0
  78. data/lib/adwords_api/v201209/budget_service_registry.rb +46 -0
  79. data/lib/adwords_api/v201209/campaign_ad_extension_service.rb +38 -0
  80. data/lib/adwords_api/v201209/campaign_ad_extension_service_registry.rb +46 -0
  81. data/lib/adwords_api/v201209/campaign_criterion_service.rb +42 -0
  82. data/lib/adwords_api/v201209/campaign_criterion_service_registry.rb +46 -0
  83. data/lib/adwords_api/v201209/campaign_service.rb +42 -0
  84. data/lib/adwords_api/v201209/campaign_service_registry.rb +46 -0
  85. data/lib/adwords_api/v201209/constant_data_service.rb +62 -0
  86. data/lib/adwords_api/v201209/constant_data_service_registry.rb +46 -0
  87. data/lib/adwords_api/v201209/conversion_tracker_service.rb +38 -0
  88. data/lib/adwords_api/v201209/conversion_tracker_service_registry.rb +46 -0
  89. data/lib/adwords_api/v201209/customer_service.rb +34 -0
  90. data/lib/adwords_api/v201209/customer_service_registry.rb +46 -0
  91. data/lib/adwords_api/v201209/customer_sync_service.rb +34 -0
  92. data/lib/adwords_api/v201209/customer_sync_service_registry.rb +47 -0
  93. data/lib/adwords_api/v201209/data_service.rb +38 -0
  94. data/lib/adwords_api/v201209/data_service_registry.rb +46 -0
  95. data/lib/adwords_api/v201209/experiment_service.rb +38 -0
  96. data/lib/adwords_api/v201209/experiment_service_registry.rb +46 -0
  97. data/lib/adwords_api/v201209/geo_location_service.rb +34 -0
  98. data/lib/adwords_api/v201209/geo_location_service_registry.rb +46 -0
  99. data/lib/adwords_api/v201209/info_service.rb +34 -0
  100. data/lib/adwords_api/v201209/info_service_registry.rb +46 -0
  101. data/lib/adwords_api/v201209/location_criterion_service.rb +34 -0
  102. data/lib/adwords_api/v201209/location_criterion_service_registry.rb +46 -0
  103. data/lib/adwords_api/v201209/managed_customer_service.rb +38 -0
  104. data/lib/adwords_api/v201209/managed_customer_service_registry.rb +46 -0
  105. data/lib/adwords_api/v201209/media_service.rb +38 -0
  106. data/lib/adwords_api/v201209/media_service_registry.rb +46 -0
  107. data/lib/adwords_api/v201209/mutate_job_service.rb +42 -0
  108. data/lib/adwords_api/v201209/mutate_job_service_registry.rb +46 -0
  109. data/lib/adwords_api/v201209/report_definition_service.rb +34 -0
  110. data/lib/adwords_api/v201209/report_definition_service_registry.rb +46 -0
  111. data/lib/adwords_api/v201209/targeting_idea_service.rb +38 -0
  112. data/lib/adwords_api/v201209/targeting_idea_service_registry.rb +46 -0
  113. data/lib/adwords_api/v201209/traffic_estimator_service.rb +34 -0
  114. data/lib/adwords_api/v201209/traffic_estimator_service_registry.rb +46 -0
  115. data/lib/adwords_api/v201209/user_list_service.rb +38 -0
  116. data/lib/adwords_api/v201209/user_list_service_registry.rb +46 -0
  117. data/lib/adwords_api/version.rb +1 -1
  118. data/test/adwords_api/test_report_utils.rb +94 -6
  119. data/test/examples/v201209/test_account_management.rb +60 -0
  120. data/test/examples/v201209/test_basic_operations.rb +177 -0
  121. data/test/examples/v201209/test_campaign_management.rb +124 -0
  122. data/test/examples/v201209/test_error_handling.rb +63 -0
  123. data/test/examples/v201209/test_misc.rb +45 -0
  124. data/test/examples/v201209/test_optimization.rb +63 -0
  125. data/test/examples/v201209/test_remarketing.rb +39 -0
  126. data/test/examples/v201209/test_reporting.rb +84 -0
  127. data/test/examples/v201209/test_targeting.rb +60 -0
  128. data/test/examples/v201209/utils.rb +238 -0
  129. data/test/suite_exampletests_v201209.rb +37 -0
  130. metadata +123 -2
@@ -0,0 +1,89 @@
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 uploads an image. To get images, run get_all_images.rb.
22
+ #
23
+ # Tags: MediaService.upload
24
+
25
+ require 'adwords_api'
26
+ require 'base64'
27
+
28
+ def upload_image()
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
+ media_srv = adwords.service(:MediaService, API_VERSION)
38
+
39
+ # Create image.
40
+ image_url =
41
+ 'http://www.google.com/intl/en/adwords/select/images/samples/inline.jpg'
42
+ # This utility method retrieves the contents of a URL using all of the config
43
+ # options provided to the Api object.
44
+ image_data = AdsCommon::Http.get(image_url, adwords.config)
45
+ base64_image_data = Base64.encode64(image_data)
46
+ image = {
47
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
48
+ # being created. It's only necessary when you must provide an explicit
49
+ # type that the client library can't infer.
50
+ :xsi_type => 'Image',
51
+ :data => base64_image_data,
52
+ :type => 'IMAGE'
53
+ }
54
+
55
+ # Upload image.
56
+ response = media_srv.upload([image])
57
+ if response and !response.empty?
58
+ ret_image = response.first
59
+ full_dimensions = ret_image[:dimensions]['FULL']
60
+ puts ("Image with ID %d, dimensions %dx%d and MIME type '%s' uploaded " +
61
+ "successfully.") % [ret_image[:media_id], full_dimensions[:height],
62
+ full_dimensions[:width], ret_image[:mime_type]]
63
+ else
64
+ puts 'No images uploaded.'
65
+ end
66
+ end
67
+
68
+ if __FILE__ == $0
69
+ API_VERSION = :v201209
70
+
71
+ begin
72
+ upload_image()
73
+
74
+ # HTTP errors.
75
+ rescue AdsCommon::Errors::HttpError => e
76
+ puts "HTTP Error: %s" % e
77
+
78
+ # API errors.
79
+ rescue AdwordsApi::Errors::ApiException => e
80
+ puts "Message: %s" % e.message
81
+ puts 'Errors:'
82
+ e.errors.each_with_index do |error, index|
83
+ puts "\tError [%d]:" % (index + 1)
84
+ error.each do |field, value|
85
+ puts "\t\t%s: %s" % [field, value]
86
+ end
87
+ end
88
+ end
89
+ end
@@ -0,0 +1,100 @@
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 OAuth1.0a authentication method.
22
+ #
23
+ # NOTE: OAuth1.0a authorization method is deprecated, use OAuth2.0 instead.
24
+ # See use_oauth2.rb for an example.
25
+ #
26
+ # Tags: CampaignService.get
27
+
28
+ require 'adwords_api'
29
+
30
+ def use_oauth()
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
+ campaign_srv = adwords.service(:CampaignService, API_VERSION)
40
+
41
+ # Get all the campaigns for this account; empty selector.
42
+ selector = {
43
+ :fields => ['Id', 'Name', 'Status'],
44
+ :ordering => [
45
+ {:field => 'Name', :sort_order => 'ASCENDING'}
46
+ ]
47
+ }
48
+
49
+ retry_count = 0
50
+
51
+ begin
52
+ response = campaign_srv.get(selector)
53
+ rescue AdsCommon::Errors::OAuthVerificationRequired => e
54
+ if retry_count < MAX_RETRIES
55
+ puts "Hit Auth error, please navigate to URL:\n\t%s" % e.oauth_url
56
+ print 'log in and type the verification code: '
57
+ verification_code = gets.chomp
58
+ adwords.credential_handler.set_credential(
59
+ :oauth_verification_code, verification_code)
60
+ retry_count += 1
61
+ retry
62
+ else
63
+ raise AdsCommon::Errors::AuthError, 'Failed to authenticate.'
64
+ end
65
+ end
66
+
67
+ if response and response[:entries]
68
+ campaigns = response[:entries]
69
+ campaigns.each do |campaign|
70
+ puts "Campaign ID %d, name '%s' and status '%s'" %
71
+ [campaign[:id], campaign[:name], campaign[:status]]
72
+ end
73
+ else
74
+ puts 'No campaigns were found.'
75
+ end
76
+ end
77
+
78
+ if __FILE__ == $0
79
+ API_VERSION = :v201209
80
+ MAX_RETRIES = 3
81
+
82
+ begin
83
+ use_oauth()
84
+
85
+ # HTTP errors.
86
+ rescue AdsCommon::Errors::HttpError => e
87
+ puts "HTTP Error: %s" % e
88
+
89
+ # API errors.
90
+ rescue AdwordsApi::Errors::ApiException => e
91
+ puts "Message: %s" % e.message
92
+ puts 'Errors:'
93
+ e.errors.each_with_index do |error, index|
94
+ puts "\tError [%d]:" % (index + 1)
95
+ error.each do |field, value|
96
+ puts "\t\t%s: %s" % [field, value]
97
+ end
98
+ end
99
+ end
100
+ 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 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 illustrates how to use OAuth2.0 authentication method.
22
+ #
23
+ # Tags: CampaignService.get
24
+
25
+ require 'adwords_api'
26
+
27
+ def use_oauth2()
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::OAuth2VerificationRequired => 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
+ :oauth2_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 = :v201209
77
+ MAX_RETRIES = 3
78
+
79
+ begin
80
+ use_oauth2()
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 = :v201209
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
@@ -0,0 +1,92 @@
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 bid landscapes for a keyword. To get keywords, run
22
+ # get_keywords.rb.
23
+ #
24
+ # Tags: DataService.getCriterionBidLandscape
25
+
26
+ require 'adwords_api'
27
+
28
+ def get_criterion_bid_landscapes(ad_group_id, keyword_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
+ data_srv = adwords.service(:DataService, API_VERSION)
38
+
39
+ # Get keyword bid landscape.
40
+ selector = {
41
+ :fields => ['AdGroupId', 'CriterionId', 'StartDate', 'EndDate', 'Bid',
42
+ 'LocalClicks', 'LocalCost', 'MarginalCpc', 'LocalImpressions'],
43
+ :predicates => [
44
+ {:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]},
45
+ {:field => 'CriterionId', :operator => 'IN', :values => [keyword_id]},
46
+ ]
47
+ }
48
+ page = data_srv.get_criterion_bid_landscape(selector)
49
+ if page and page[:entries]
50
+ puts "Bid landscape(s) retrieved: %d." % [page[:entries].length]
51
+ page[:entries].each do |bid_landscape|
52
+ puts ("Retrieved keyword bid landscape with ad group ID %d" +
53
+ ", keyword ID %d, start date '%s', end date '%s'" +
54
+ ", with landscape points:") %
55
+ [bid_landscape[:ad_group_id], bid_landscape[:criterion_id],
56
+ bid_landscape[:start_date], bid_landscape[:end_date]]
57
+ bid_landscape[:landscape_points].each do |point|
58
+ puts "\t%d => clicks: %d, cost: %d, marginalCpc: %d, impressions: %d" %
59
+ [point[:bid][:micro_amount], point.clicks,
60
+ point[:cost][:micro_amount], point[:marginal_cpc][:micro_amount],
61
+ point[:impressions]]
62
+ end
63
+ end
64
+ else
65
+ puts 'No bid landscapes retrieved.'
66
+ end
67
+ end
68
+
69
+ if __FILE__ == $0
70
+ API_VERSION = :v201209
71
+
72
+ begin
73
+ ad_group_id = 'INSERT_ADGROUP_ID_HERE'.to_i
74
+ keyword_id = 'INSERT_KEYWORD_ID_HERE'.to_i
75
+ get_criterion_bid_landscapes(ad_group_id, keyword_id)
76
+
77
+ # HTTP errors.
78
+ rescue AdsCommon::Errors::HttpError => e
79
+ puts "HTTP Error: %s" % e
80
+
81
+ # API errors.
82
+ rescue AdwordsApi::Errors::ApiException => e
83
+ puts "Message: %s" % e.message
84
+ puts 'Errors:'
85
+ e.errors.each_with_index do |error, index|
86
+ puts "\tError [%d]:" % (index + 1)
87
+ error.each do |field, value|
88
+ puts "\t\t%s: %s" % [field, value]
89
+ end
90
+ end
91
+ end
92
+ end