google-adwords-api 0.15.1 → 0.15.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (166) hide show
  1. checksums.yaml +8 -8
  2. data/ChangeLog +4 -0
  3. data/examples/v201502/extensions/add_google_my_business_location_extensions.rb +4 -4
  4. data/examples/v201506/account_management/create_account.rb +92 -0
  5. data/examples/v201506/account_management/get_account_changes.rb +143 -0
  6. data/examples/v201506/account_management/get_account_hierarchy.rb +98 -0
  7. data/examples/v201506/advanced_operations/add_ad_customizers.rb +189 -0
  8. data/examples/v201506/advanced_operations/add_ad_group_bid_modifier.rb +105 -0
  9. data/examples/v201506/advanced_operations/add_click_to_download_ad.rb +137 -0
  10. data/examples/v201506/advanced_operations/add_text_ad_with_upgraded_urls.rb +138 -0
  11. data/examples/v201506/advanced_operations/create_and_attach_shared_keyword_set.rb +137 -0
  12. data/examples/v201506/advanced_operations/find_and_remove_criteria_from_shared_set.rb +171 -0
  13. data/examples/v201506/advanced_operations/get_ad_group_bid_modifiers.rb +106 -0
  14. data/examples/v201506/advanced_operations/upload_offline_conversions.rb +117 -0
  15. data/examples/v201506/advanced_operations/use_shared_bidding_strategy.rb +152 -0
  16. data/examples/v201506/basic_operations/add_ad_groups.rb +144 -0
  17. data/examples/v201506/basic_operations/add_campaigns.rb +143 -0
  18. data/examples/v201506/basic_operations/add_keywords.rb +118 -0
  19. data/examples/v201506/basic_operations/add_text_ads.rb +113 -0
  20. data/examples/v201506/basic_operations/get_ad_groups.rb +106 -0
  21. data/examples/v201506/basic_operations/get_campaigns.rb +101 -0
  22. data/examples/v201506/basic_operations/get_campaigns_with_awql.rb +93 -0
  23. data/examples/v201506/basic_operations/get_keywords.rb +112 -0
  24. data/examples/v201506/basic_operations/get_text_ads.rb +114 -0
  25. data/examples/v201506/basic_operations/pause_ad.rb +92 -0
  26. data/examples/v201506/basic_operations/remove_ad.rb +93 -0
  27. data/examples/v201506/basic_operations/remove_ad_group.rb +89 -0
  28. data/examples/v201506/basic_operations/remove_campaign.rb +91 -0
  29. data/examples/v201506/basic_operations/remove_keyword.rb +98 -0
  30. data/examples/v201506/basic_operations/update_ad_group.rb +89 -0
  31. data/examples/v201506/basic_operations/update_campaign.rb +90 -0
  32. data/examples/v201506/basic_operations/update_keyword.rb +110 -0
  33. data/examples/v201506/campaign_management/add_campaign_labels.rb +86 -0
  34. data/examples/v201506/campaign_management/add_experiment.rb +166 -0
  35. data/examples/v201506/campaign_management/add_keywords_in_bulk.rb +158 -0
  36. data/examples/v201506/campaign_management/get_all_disapproved_ads.rb +101 -0
  37. data/examples/v201506/campaign_management/get_all_disapproved_ads_with_awql.rb +93 -0
  38. data/examples/v201506/campaign_management/get_campaigns_by_label.rb +112 -0
  39. data/examples/v201506/campaign_management/promote_experiment.rb +85 -0
  40. data/examples/v201506/campaign_management/set_ad_parameters.rb +122 -0
  41. data/examples/v201506/campaign_management/set_criterion_bid_modifier.rb +108 -0
  42. data/examples/v201506/campaign_management/validate_text_ad.rb +114 -0
  43. data/examples/v201506/error_handling/handle_partial_failures.rb +134 -0
  44. data/examples/v201506/error_handling/handle_policy_violation_error.rb +145 -0
  45. data/examples/v201506/extensions/add_google_my_business_location_extensions.rb +190 -0
  46. data/examples/v201506/extensions/add_site_links.rb +168 -0
  47. data/examples/v201506/extensions/add_site_links_using_feeds.rb +276 -0
  48. data/examples/v201506/migration/migrate_to_extension_settings.rb +392 -0
  49. data/examples/v201506/migration/upgrade_ad_url.rb +97 -0
  50. data/examples/v201506/misc/create_ad_words_session_without_properties_file.rb +94 -0
  51. data/examples/v201506/misc/get_all_images_and_videos.rb +108 -0
  52. data/examples/v201506/misc/setup_oauth2.rb +88 -0
  53. data/examples/v201506/misc/upload_image.rb +97 -0
  54. data/examples/v201506/misc/use_oauth2_jwt.rb +97 -0
  55. data/examples/v201506/optimization/estimate_keyword_traffic.rb +150 -0
  56. data/examples/v201506/optimization/get_keyword_bid_simulations.rb +99 -0
  57. data/examples/v201506/optimization/get_keyword_ideas.rb +130 -0
  58. data/examples/v201506/remarketing/add_audience.rb +122 -0
  59. data/examples/v201506/remarketing/add_conversion_tracker.rb +104 -0
  60. data/examples/v201506/remarketing/add_rule_based_user_lists.rb +171 -0
  61. data/examples/v201506/reporting/download_criteria_report.rb +94 -0
  62. data/examples/v201506/reporting/download_criteria_report_with_awql.rb +95 -0
  63. data/examples/v201506/reporting/get_report_fields.rb +79 -0
  64. data/examples/v201506/reporting/parallel_report_download.rb +168 -0
  65. data/examples/v201506/shopping_campaigns/add_product_partition_tree.rb +269 -0
  66. data/examples/v201506/shopping_campaigns/add_product_scope.rb +133 -0
  67. data/examples/v201506/shopping_campaigns/add_shopping_campaign.rb +133 -0
  68. data/examples/v201506/shopping_campaigns/get_product_category_taxonomy.rb +117 -0
  69. data/examples/v201506/targeting/add_campaign_targeting_criteria.rb +184 -0
  70. data/examples/v201506/targeting/add_demographic_targeting_criteria.rb +116 -0
  71. data/examples/v201506/targeting/get_campaign_targeting_criteria.rb +110 -0
  72. data/examples/v201506/targeting/get_targetable_languages_and_carriers.rb +94 -0
  73. data/examples/v201506/targeting/lookup_location.rb +112 -0
  74. data/lib/adwords_api.rb +9 -0
  75. data/lib/adwords_api/api_config.rb +90 -4
  76. data/lib/adwords_api/report_header_handler.rb +5 -0
  77. data/lib/adwords_api/v201506/account_label_service.rb +38 -0
  78. data/lib/adwords_api/v201506/account_label_service_registry.rb +46 -0
  79. data/lib/adwords_api/v201506/ad_customizer_feed_service.rb +38 -0
  80. data/lib/adwords_api/v201506/ad_customizer_feed_service_registry.rb +46 -0
  81. data/lib/adwords_api/v201506/ad_group_ad_service.rb +50 -0
  82. data/lib/adwords_api/v201506/ad_group_ad_service_registry.rb +46 -0
  83. data/lib/adwords_api/v201506/ad_group_bid_modifier_service.rb +42 -0
  84. data/lib/adwords_api/v201506/ad_group_bid_modifier_service_registry.rb +46 -0
  85. data/lib/adwords_api/v201506/ad_group_criterion_service.rb +46 -0
  86. data/lib/adwords_api/v201506/ad_group_criterion_service_registry.rb +46 -0
  87. data/lib/adwords_api/v201506/ad_group_extension_setting_service.rb +42 -0
  88. data/lib/adwords_api/v201506/ad_group_extension_setting_service_registry.rb +46 -0
  89. data/lib/adwords_api/v201506/ad_group_feed_service.rb +42 -0
  90. data/lib/adwords_api/v201506/ad_group_feed_service_registry.rb +46 -0
  91. data/lib/adwords_api/v201506/ad_group_service.rb +46 -0
  92. data/lib/adwords_api/v201506/ad_group_service_registry.rb +46 -0
  93. data/lib/adwords_api/v201506/ad_param_service.rb +38 -0
  94. data/lib/adwords_api/v201506/ad_param_service_registry.rb +46 -0
  95. data/lib/adwords_api/v201506/adwords_user_list_service.rb +38 -0
  96. data/lib/adwords_api/v201506/adwords_user_list_service_registry.rb +46 -0
  97. data/lib/adwords_api/v201506/bidding_strategy_service.rb +42 -0
  98. data/lib/adwords_api/v201506/bidding_strategy_service_registry.rb +46 -0
  99. data/lib/adwords_api/v201506/budget_order_service.rb +42 -0
  100. data/lib/adwords_api/v201506/budget_order_service_registry.rb +46 -0
  101. data/lib/adwords_api/v201506/budget_service.rb +42 -0
  102. data/lib/adwords_api/v201506/budget_service_registry.rb +46 -0
  103. data/lib/adwords_api/v201506/campaign_criterion_service.rb +42 -0
  104. data/lib/adwords_api/v201506/campaign_criterion_service_registry.rb +46 -0
  105. data/lib/adwords_api/v201506/campaign_extension_setting_service.rb +42 -0
  106. data/lib/adwords_api/v201506/campaign_extension_setting_service_registry.rb +46 -0
  107. data/lib/adwords_api/v201506/campaign_feed_service.rb +42 -0
  108. data/lib/adwords_api/v201506/campaign_feed_service_registry.rb +46 -0
  109. data/lib/adwords_api/v201506/campaign_service.rb +46 -0
  110. data/lib/adwords_api/v201506/campaign_service_registry.rb +46 -0
  111. data/lib/adwords_api/v201506/campaign_shared_set_service.rb +42 -0
  112. data/lib/adwords_api/v201506/campaign_shared_set_service_registry.rb +46 -0
  113. data/lib/adwords_api/v201506/constant_data_service.rb +66 -0
  114. data/lib/adwords_api/v201506/constant_data_service_registry.rb +46 -0
  115. data/lib/adwords_api/v201506/conversion_tracker_service.rb +42 -0
  116. data/lib/adwords_api/v201506/conversion_tracker_service_registry.rb +46 -0
  117. data/lib/adwords_api/v201506/customer_extension_setting_service.rb +42 -0
  118. data/lib/adwords_api/v201506/customer_extension_setting_service_registry.rb +46 -0
  119. data/lib/adwords_api/v201506/customer_feed_service.rb +42 -0
  120. data/lib/adwords_api/v201506/customer_feed_service_registry.rb +46 -0
  121. data/lib/adwords_api/v201506/customer_service.rb +38 -0
  122. data/lib/adwords_api/v201506/customer_service_registry.rb +46 -0
  123. data/lib/adwords_api/v201506/customer_sync_service.rb +34 -0
  124. data/lib/adwords_api/v201506/customer_sync_service_registry.rb +47 -0
  125. data/lib/adwords_api/v201506/data_service.rb +54 -0
  126. data/lib/adwords_api/v201506/data_service_registry.rb +46 -0
  127. data/lib/adwords_api/v201506/experiment_service.rb +38 -0
  128. data/lib/adwords_api/v201506/experiment_service_registry.rb +46 -0
  129. data/lib/adwords_api/v201506/feed_item_service.rb +42 -0
  130. data/lib/adwords_api/v201506/feed_item_service_registry.rb +46 -0
  131. data/lib/adwords_api/v201506/feed_mapping_service.rb +42 -0
  132. data/lib/adwords_api/v201506/feed_mapping_service_registry.rb +46 -0
  133. data/lib/adwords_api/v201506/feed_service.rb +42 -0
  134. data/lib/adwords_api/v201506/feed_service_registry.rb +46 -0
  135. data/lib/adwords_api/v201506/geo_location_service.rb +34 -0
  136. data/lib/adwords_api/v201506/geo_location_service_registry.rb +46 -0
  137. data/lib/adwords_api/v201506/label_service.rb +42 -0
  138. data/lib/adwords_api/v201506/label_service_registry.rb +46 -0
  139. data/lib/adwords_api/v201506/location_criterion_service.rb +38 -0
  140. data/lib/adwords_api/v201506/location_criterion_service_registry.rb +46 -0
  141. data/lib/adwords_api/v201506/managed_customer_service.rb +54 -0
  142. data/lib/adwords_api/v201506/managed_customer_service_registry.rb +46 -0
  143. data/lib/adwords_api/v201506/media_service.rb +42 -0
  144. data/lib/adwords_api/v201506/media_service_registry.rb +46 -0
  145. data/lib/adwords_api/v201506/mutate_job_service.rb +42 -0
  146. data/lib/adwords_api/v201506/mutate_job_service_registry.rb +46 -0
  147. data/lib/adwords_api/v201506/offline_conversion_feed_service.rb +34 -0
  148. data/lib/adwords_api/v201506/offline_conversion_feed_service_registry.rb +46 -0
  149. data/lib/adwords_api/v201506/report_definition_service.rb +34 -0
  150. data/lib/adwords_api/v201506/report_definition_service_registry.rb +46 -0
  151. data/lib/adwords_api/v201506/shared_criterion_service.rb +42 -0
  152. data/lib/adwords_api/v201506/shared_criterion_service_registry.rb +46 -0
  153. data/lib/adwords_api/v201506/shared_set_service.rb +42 -0
  154. data/lib/adwords_api/v201506/shared_set_service_registry.rb +46 -0
  155. data/lib/adwords_api/v201506/targeting_idea_service.rb +34 -0
  156. data/lib/adwords_api/v201506/targeting_idea_service_registry.rb +46 -0
  157. data/lib/adwords_api/v201506/traffic_estimator_service.rb +34 -0
  158. data/lib/adwords_api/v201506/traffic_estimator_service_registry.rb +46 -0
  159. data/lib/adwords_api/version.rb +1 -1
  160. data/test/adwords_api/test_adwords_api.rb +1 -1
  161. data/test/adwords_api/test_api_config.rb +8 -8
  162. data/test/adwords_api/test_choices.rb +2 -2
  163. data/test/adwords_api/test_report_utils.rb +1 -1
  164. data/test/templates/v201506/basic_operations_get_campaigns.def +116 -0
  165. data/test/templates/v201506/misc_use_oauth2_jwt.def +131 -0
  166. metadata +156 -2
@@ -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 with
22
+ # Service Account (JWT). For this example to work, your Service Account must be
23
+ # a Google Apps for Business Account.
24
+ #
25
+ # See https://developers.google.com/adwords/api/docs/guides/service-accounts
26
+ # for more information.
27
+ #
28
+ # Tags: CampaignService.get
29
+
30
+ require 'adwords_api'
31
+
32
+ def use_oauth2_jwt()
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
+ # Option 1: provide key filename as authentication -> oauth2_keyfile in the
42
+ # configuration file. No additional code is necessary.
43
+ # To provide a file name at runtime, use authorize:
44
+ # adwords.authorize({:oauth2_keyfile => key_filename})
45
+
46
+ # Option 2: retrieve key manually and create OpenSSL::PKCS12 object.
47
+ # key_filename = 'INSERT_FILENAME_HERE'
48
+ # key_secret = 'INSERT_SECRET_HERE'
49
+ # key_file_data = File.read(key_filename)
50
+ # key = OpenSSL::PKCS12.new(key_file_data, key_secret).key
51
+ # adwords.authorize({:oauth2_key => key})
52
+
53
+ # Now you can make API calls.
54
+ campaign_srv = adwords.service(:CampaignService, API_VERSION)
55
+
56
+ # Get all the campaigns for this account; empty selector.
57
+ selector = {
58
+ :fields => ['Id', 'Name', 'Status'],
59
+ :ordering => [
60
+ {:field => 'Name', :sort_order => 'ASCENDING'}
61
+ ]
62
+ }
63
+
64
+ response = campaign_srv.get(selector)
65
+ if response and response[:entries]
66
+ campaigns = response[:entries]
67
+ campaigns.each do |campaign|
68
+ puts "Campaign ID %d, name '%s' and status '%s'" %
69
+ [campaign[:id], campaign[:name], campaign[:status]]
70
+ end
71
+ else
72
+ puts 'No campaigns were found.'
73
+ end
74
+ end
75
+
76
+ if __FILE__ == $0
77
+ API_VERSION = :v201506
78
+
79
+ begin
80
+ use_oauth2_jwt()
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,150 @@
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_position = calculate_mean(
88
+ estimate[:min][:average_position],
89
+ estimate[:max][:average_position]
90
+ )
91
+ mean_clicks = calculate_mean(
92
+ estimate[:min][:clicks_per_day],
93
+ estimate[:max][:clicks_per_day]
94
+ )
95
+ mean_total_cost = calculate_mean(
96
+ estimate[:min][:total_cost][:micro_amount],
97
+ estimate[:max][:total_cost][:micro_amount]
98
+ )
99
+
100
+ puts "Results for the keyword with text '%s' and match type %s:" %
101
+ [keyword[:text], keyword[:match_type]]
102
+ puts "\tEstimated ad position: %s" % format_mean(mean_avg_position)
103
+ puts "\tEstimated daily clicks: %s" % format_mean(mean_clicks)
104
+ puts "\tEstimated daily cost: %s" % format_mean(mean_total_cost)
105
+ end
106
+ else
107
+ puts 'No traffic estimates were returned.'
108
+ end
109
+ end
110
+
111
+ def format_mean(mean)
112
+ return "nil" if mean.nil?
113
+ return "%.2f" % mean
114
+ end
115
+
116
+ def calculate_mean(min_money, max_money)
117
+ return nil if min_money.nil? || max_money.nil?
118
+ return (min_money.to_f + max_money.to_f) / 2.0
119
+ end
120
+
121
+ if __FILE__ == $0
122
+ API_VERSION = :v201506
123
+
124
+ begin
125
+ estimate_keyword_traffic()
126
+
127
+ # Authorization error.
128
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
129
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
130
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
131
+ "to retrieve and store OAuth2 tokens."
132
+ puts "See this wiki page for more details:\n\n " +
133
+ 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
134
+
135
+ # HTTP errors.
136
+ rescue AdsCommon::Errors::HttpError => e
137
+ puts "HTTP Error: %s" % e
138
+
139
+ # API errors.
140
+ rescue AdwordsApi::Errors::ApiException => e
141
+ puts "Message: %s" % e.message
142
+ puts 'Errors:'
143
+ e.errors.each_with_index do |error, index|
144
+ puts "\tError [%d]:" % (index + 1)
145
+ error.each do |field, value|
146
+ puts "\t\t%s: %s" % [field, value]
147
+ end
148
+ end
149
+ end
150
+ end
@@ -0,0 +1,99 @@
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', '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, impressions: %d" %
59
+ [point[:bid][:micro_amount], point.clicks,
60
+ point[:cost][:micro_amount], point[:impressions]]
61
+ end
62
+ end
63
+ else
64
+ puts 'No bid landscapes retrieved.'
65
+ end
66
+ end
67
+
68
+ if __FILE__ == $0
69
+ API_VERSION = :v201506
70
+
71
+ begin
72
+ ad_group_id = 'INSERT_ADGROUP_ID_HERE'.to_i
73
+ keyword_id = 'INSERT_KEYWORD_ID_HERE'.to_i
74
+ get_criterion_bid_landscapes(ad_group_id, keyword_id)
75
+
76
+ # Authorization error.
77
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
78
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
79
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
80
+ "to retrieve and store OAuth2 tokens."
81
+ puts "See this wiki page for more details:\n\n " +
82
+ 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
83
+
84
+ # HTTP errors.
85
+ rescue AdsCommon::Errors::HttpError => e
86
+ puts "HTTP Error: %s" % e
87
+
88
+ # API errors.
89
+ rescue AdwordsApi::Errors::ApiException => e
90
+ puts "Message: %s" % e.message
91
+ puts 'Errors:'
92
+ e.errors.each_with_index do |error, index|
93
+ puts "\tError [%d]:" % (index + 1)
94
+ error.each do |field, value|
95
+ puts "\t\t%s: %s" % [field, value]
96
+ end
97
+ end
98
+ end
99
+ end
@@ -0,0 +1,130 @@
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 retrieves keywords that are related to a given keyword.
22
+ #
23
+ # Tags: TargetingIdeaService.get
24
+
25
+ require 'adwords_api'
26
+
27
+ def get_keyword_ideas(keyword_text)
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
+ targeting_idea_srv = adwords.service(:TargetingIdeaService, API_VERSION)
37
+
38
+ # Construct selector object.
39
+ selector = {
40
+ :idea_type => 'KEYWORD',
41
+ :request_type => 'IDEAS',
42
+ :requested_attribute_types =>
43
+ ['KEYWORD_TEXT', 'SEARCH_VOLUME', 'CATEGORY_PRODUCTS_AND_SERVICES'],
44
+ :search_parameters => [
45
+ {
46
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
47
+ # being created. It's only necessary when you must provide an explicit
48
+ # type that the client library can't infer.
49
+ :xsi_type => 'RelatedToQuerySearchParameter',
50
+ :queries => [keyword_text]
51
+ },
52
+ {
53
+ # Language setting (optional).
54
+ # The ID can be found in the documentation:
55
+ # https://developers.google.com/adwords/api/docs/appendix/languagecodes
56
+ # Only one LanguageSearchParameter is allowed per request.
57
+ :xsi_type => 'LanguageSearchParameter',
58
+ :languages => [{:id => 1000}]
59
+ }
60
+ ],
61
+ :paging => {
62
+ :start_index => 0,
63
+ :number_results => PAGE_SIZE
64
+ }
65
+ }
66
+
67
+ # Define initial values.
68
+ offset = 0
69
+ results = []
70
+
71
+ begin
72
+ # Perform request.
73
+ page = targeting_idea_srv.get(selector)
74
+ results += page[:entries] if page and page[:entries]
75
+
76
+ # Prepare next page request.
77
+ offset += PAGE_SIZE
78
+ selector[:paging][:start_index] = offset
79
+ end while offset < page[:total_num_entries]
80
+
81
+ # Display results.
82
+ results.each do |result|
83
+ data = result[:data]
84
+ keyword = data['KEYWORD_TEXT'][:value]
85
+ puts "Found keyword with text '%s'" % keyword
86
+ products_and_services = data['CATEGORY_PRODUCTS_AND_SERVICES'][:value]
87
+ if products_and_services
88
+ puts "\tWith Products and Services categories: [%s]" %
89
+ products_and_services.join(', ')
90
+ end
91
+ average_monthly_searches = data['SEARCH_VOLUME'][:value]
92
+ if average_monthly_searches
93
+ puts "\tand average monthly search volume: %d" % average_monthly_searches
94
+ end
95
+ end
96
+ puts "Total keywords related to '%s': %d." % [keyword_text, results.length]
97
+ end
98
+
99
+ if __FILE__ == $0
100
+ API_VERSION = :v201506
101
+ PAGE_SIZE = 100
102
+
103
+ begin
104
+ keyword_text = 'INSERT_KEYWORD_TEXT_HERE'
105
+ get_keyword_ideas(keyword_text)
106
+
107
+ # Authorization error.
108
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
109
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
110
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
111
+ "to retrieve and store OAuth2 tokens."
112
+ puts "See this wiki page for more details:\n\n " +
113
+ 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
114
+
115
+ # HTTP errors.
116
+ rescue AdsCommon::Errors::HttpError => e
117
+ puts "HTTP Error: %s" % e
118
+
119
+ # API errors.
120
+ rescue AdwordsApi::Errors::ApiException => e
121
+ puts "Message: %s" % e.message
122
+ puts 'Errors:'
123
+ e.errors.each_with_index do |error, index|
124
+ puts "\tError [%d]:" % (index + 1)
125
+ error.each do |field, value|
126
+ puts "\t\t%s: %s" % [field, value]
127
+ end
128
+ end
129
+ end
130
+ end