google-adwords-api 0.20.0 → 0.20.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (201) hide show
  1. checksums.yaml +4 -4
  2. data/ChangeLog +7 -0
  3. data/examples/v201601/remarketing/add_crm_based_user_list.rb +2 -2
  4. data/examples/v201603/remarketing/add_crm_based_user_list.rb +2 -2
  5. data/examples/v201605/advanced_operations/add_click_to_download_ad.rb +2 -2
  6. data/examples/v201605/advanced_operations/add_html5_ad.rb +2 -2
  7. data/examples/v201605/remarketing/add_crm_based_user_list.rb +2 -2
  8. data/examples/v201607/account_management/create_account.rb +88 -0
  9. data/examples/v201607/account_management/get_account_changes.rb +135 -0
  10. data/examples/v201607/account_management/get_account_hierarchy.rb +132 -0
  11. data/examples/v201607/advanced_operations/add_ad_customizers.rb +184 -0
  12. data/examples/v201607/advanced_operations/add_ad_group_bid_modifier.rb +101 -0
  13. data/examples/v201607/advanced_operations/add_click_to_download_ad.rb +148 -0
  14. data/examples/v201607/advanced_operations/add_html5_ad.rb +137 -0
  15. data/examples/v201607/advanced_operations/add_responsive_display_ad.rb +130 -0
  16. data/examples/v201607/advanced_operations/add_text_ad_with_upgraded_urls.rb +134 -0
  17. data/examples/v201607/advanced_operations/create_and_attach_shared_keyword_set.rb +141 -0
  18. data/examples/v201607/advanced_operations/find_and_remove_criteria_from_shared_set.rb +174 -0
  19. data/examples/v201607/advanced_operations/get_ad_group_bid_modifiers.rb +102 -0
  20. data/examples/v201607/advanced_operations/use_portfolio_bidding_strategy.rb +146 -0
  21. data/examples/v201607/basic_operations/add_ad_groups.rb +142 -0
  22. data/examples/v201607/basic_operations/add_campaigns.rb +138 -0
  23. data/examples/v201607/basic_operations/add_expanded_text_ads.rb +108 -0
  24. data/examples/v201607/basic_operations/add_keywords.rb +114 -0
  25. data/examples/v201607/basic_operations/add_text_ads.rb +109 -0
  26. data/examples/v201607/basic_operations/get_ad_groups.rb +102 -0
  27. data/examples/v201607/basic_operations/get_campaigns.rb +97 -0
  28. data/examples/v201607/basic_operations/get_campaigns_with_awql.rb +89 -0
  29. data/examples/v201607/basic_operations/get_expanded_text_ads.rb +122 -0
  30. data/examples/v201607/basic_operations/get_keywords.rb +109 -0
  31. data/examples/v201607/basic_operations/get_text_ads.rb +110 -0
  32. data/examples/v201607/basic_operations/pause_ad.rb +88 -0
  33. data/examples/v201607/basic_operations/remove_ad.rb +89 -0
  34. data/examples/v201607/basic_operations/remove_ad_group.rb +85 -0
  35. data/examples/v201607/basic_operations/remove_campaign.rb +87 -0
  36. data/examples/v201607/basic_operations/remove_keyword.rb +94 -0
  37. data/examples/v201607/basic_operations/update_ad_group.rb +85 -0
  38. data/examples/v201607/basic_operations/update_campaign.rb +86 -0
  39. data/examples/v201607/basic_operations/update_keyword.rb +106 -0
  40. data/examples/v201607/campaign_management/add_campaign_labels.rb +82 -0
  41. data/examples/v201607/campaign_management/add_complete_campaigns_using_batch_job.rb +355 -0
  42. data/examples/v201607/campaign_management/add_draft.rb +114 -0
  43. data/examples/v201607/campaign_management/add_experiment.rb +162 -0
  44. data/examples/v201607/campaign_management/add_keywords_using_incremental_batch_job.rb +210 -0
  45. data/examples/v201607/campaign_management/add_trial.rb +142 -0
  46. data/examples/v201607/campaign_management/get_all_disapproved_ads.rb +97 -0
  47. data/examples/v201607/campaign_management/get_all_disapproved_ads_with_awql.rb +89 -0
  48. data/examples/v201607/campaign_management/get_campaigns_by_label.rb +108 -0
  49. data/examples/v201607/campaign_management/graduate_trial.rb +106 -0
  50. data/examples/v201607/campaign_management/promote_experiment.rb +81 -0
  51. data/examples/v201607/campaign_management/set_ad_parameters.rb +118 -0
  52. data/examples/v201607/campaign_management/set_criterion_bid_modifier.rb +104 -0
  53. data/examples/v201607/campaign_management/validate_text_ad.rb +110 -0
  54. data/examples/v201607/error_handling/handle_partial_failures.rb +130 -0
  55. data/examples/v201607/error_handling/handle_policy_violation_error.rb +141 -0
  56. data/examples/v201607/extensions/add_google_my_business_location_extensions.rb +193 -0
  57. data/examples/v201607/extensions/add_prices.rb +164 -0
  58. data/examples/v201607/extensions/add_site_links.rb +199 -0
  59. data/examples/v201607/extensions/add_site_links_using_feeds.rb +286 -0
  60. data/examples/v201607/migration/migrate_to_extension_settings.rb +386 -0
  61. data/examples/v201607/migration/upgrade_ad_url.rb +93 -0
  62. data/examples/v201607/misc/get_all_images_and_videos.rb +104 -0
  63. data/examples/v201607/misc/setup_oauth2.rb +84 -0
  64. data/examples/v201607/misc/upload_image.rb +93 -0
  65. data/examples/v201607/misc/upload_media_bundle.rb +90 -0
  66. data/examples/v201607/misc/use_oauth2_jwt.rb +93 -0
  67. data/examples/v201607/misc/use_runtime_config.rb +92 -0
  68. data/examples/v201607/optimization/estimate_keyword_traffic.rb +191 -0
  69. data/examples/v201607/optimization/get_campaign_criterion_bid_modifier_simulations.rb +128 -0
  70. data/examples/v201607/optimization/get_keyword_bid_simulations.rb +95 -0
  71. data/examples/v201607/optimization/get_keyword_ideas.rb +136 -0
  72. data/examples/v201607/remarketing/add_audience.rb +118 -0
  73. data/examples/v201607/remarketing/add_conversion_tracker.rb +97 -0
  74. data/examples/v201607/remarketing/add_crm_based_user_list.rb +116 -0
  75. data/examples/v201607/remarketing/add_rule_based_user_lists.rb +167 -0
  76. data/examples/v201607/remarketing/upload_offline_conversions.rb +98 -0
  77. data/examples/v201607/reporting/download_criteria_report.rb +92 -0
  78. data/examples/v201607/reporting/download_criteria_report_with_awql.rb +93 -0
  79. data/examples/v201607/reporting/get_report_fields.rb +75 -0
  80. data/examples/v201607/reporting/parallel_report_download.rb +164 -0
  81. data/examples/v201607/reporting/stream_criteria_report_results.rb +97 -0
  82. data/examples/v201607/shopping_campaigns/add_product_partition_tree.rb +267 -0
  83. data/examples/v201607/shopping_campaigns/add_product_scope.rb +129 -0
  84. data/examples/v201607/shopping_campaigns/add_shopping_campaign.rb +129 -0
  85. data/examples/v201607/shopping_campaigns/get_product_category_taxonomy.rb +115 -0
  86. data/examples/v201607/targeting/add_campaign_targeting_criteria.rb +166 -0
  87. data/examples/v201607/targeting/add_demographic_targeting_criteria.rb +112 -0
  88. data/examples/v201607/targeting/get_campaign_targeting_criteria.rb +106 -0
  89. data/examples/v201607/targeting/get_targetable_languages_and_carriers.rb +89 -0
  90. data/examples/v201607/targeting/lookup_location.rb +108 -0
  91. data/lib/adwords_api/api_config.rb +96 -4
  92. data/lib/adwords_api/batch_job_utils.rb +6 -5
  93. data/lib/adwords_api/v201607/account_label_service.rb +46 -0
  94. data/lib/adwords_api/v201607/account_label_service_registry.rb +46 -0
  95. data/lib/adwords_api/v201607/ad_customizer_feed_service.rb +46 -0
  96. data/lib/adwords_api/v201607/ad_customizer_feed_service_registry.rb +46 -0
  97. data/lib/adwords_api/v201607/ad_group_ad_service.rb +70 -0
  98. data/lib/adwords_api/v201607/ad_group_ad_service_registry.rb +46 -0
  99. data/lib/adwords_api/v201607/ad_group_bid_modifier_service.rb +54 -0
  100. data/lib/adwords_api/v201607/ad_group_bid_modifier_service_registry.rb +46 -0
  101. data/lib/adwords_api/v201607/ad_group_criterion_service.rb +62 -0
  102. data/lib/adwords_api/v201607/ad_group_criterion_service_registry.rb +46 -0
  103. data/lib/adwords_api/v201607/ad_group_extension_setting_service.rb +54 -0
  104. data/lib/adwords_api/v201607/ad_group_extension_setting_service_registry.rb +46 -0
  105. data/lib/adwords_api/v201607/ad_group_feed_service.rb +54 -0
  106. data/lib/adwords_api/v201607/ad_group_feed_service_registry.rb +46 -0
  107. data/lib/adwords_api/v201607/ad_group_service.rb +62 -0
  108. data/lib/adwords_api/v201607/ad_group_service_registry.rb +46 -0
  109. data/lib/adwords_api/v201607/ad_param_service.rb +46 -0
  110. data/lib/adwords_api/v201607/ad_param_service_registry.rb +46 -0
  111. data/lib/adwords_api/v201607/adwords_user_list_service.rb +62 -0
  112. data/lib/adwords_api/v201607/adwords_user_list_service_registry.rb +46 -0
  113. data/lib/adwords_api/v201607/batch_job_service.rb +54 -0
  114. data/lib/adwords_api/v201607/batch_job_service_registry.rb +46 -0
  115. data/lib/adwords_api/v201607/bidding_strategy_service.rb +54 -0
  116. data/lib/adwords_api/v201607/bidding_strategy_service_registry.rb +46 -0
  117. data/lib/adwords_api/v201607/budget_order_service.rb +54 -0
  118. data/lib/adwords_api/v201607/budget_order_service_registry.rb +46 -0
  119. data/lib/adwords_api/v201607/budget_service.rb +54 -0
  120. data/lib/adwords_api/v201607/budget_service_registry.rb +46 -0
  121. data/lib/adwords_api/v201607/campaign_criterion_service.rb +54 -0
  122. data/lib/adwords_api/v201607/campaign_criterion_service_registry.rb +46 -0
  123. data/lib/adwords_api/v201607/campaign_extension_setting_service.rb +54 -0
  124. data/lib/adwords_api/v201607/campaign_extension_setting_service_registry.rb +46 -0
  125. data/lib/adwords_api/v201607/campaign_feed_service.rb +54 -0
  126. data/lib/adwords_api/v201607/campaign_feed_service_registry.rb +46 -0
  127. data/lib/adwords_api/v201607/campaign_service.rb +62 -0
  128. data/lib/adwords_api/v201607/campaign_service_registry.rb +46 -0
  129. data/lib/adwords_api/v201607/campaign_shared_set_service.rb +54 -0
  130. data/lib/adwords_api/v201607/campaign_shared_set_service_registry.rb +46 -0
  131. data/lib/adwords_api/v201607/constant_data_service.rb +110 -0
  132. data/lib/adwords_api/v201607/constant_data_service_registry.rb +46 -0
  133. data/lib/adwords_api/v201607/conversion_tracker_service.rb +54 -0
  134. data/lib/adwords_api/v201607/conversion_tracker_service_registry.rb +46 -0
  135. data/lib/adwords_api/v201607/customer_extension_setting_service.rb +54 -0
  136. data/lib/adwords_api/v201607/customer_extension_setting_service_registry.rb +46 -0
  137. data/lib/adwords_api/v201607/customer_feed_service.rb +54 -0
  138. data/lib/adwords_api/v201607/customer_feed_service_registry.rb +46 -0
  139. data/lib/adwords_api/v201607/customer_service.rb +46 -0
  140. data/lib/adwords_api/v201607/customer_service_registry.rb +46 -0
  141. data/lib/adwords_api/v201607/customer_sync_service.rb +38 -0
  142. data/lib/adwords_api/v201607/customer_sync_service_registry.rb +47 -0
  143. data/lib/adwords_api/v201607/data_service.rb +94 -0
  144. data/lib/adwords_api/v201607/data_service_registry.rb +46 -0
  145. data/lib/adwords_api/v201607/draft_async_error_service.rb +46 -0
  146. data/lib/adwords_api/v201607/draft_async_error_service_registry.rb +46 -0
  147. data/lib/adwords_api/v201607/draft_service.rb +54 -0
  148. data/lib/adwords_api/v201607/draft_service_registry.rb +46 -0
  149. data/lib/adwords_api/v201607/experiment_service.rb +46 -0
  150. data/lib/adwords_api/v201607/experiment_service_registry.rb +46 -0
  151. data/lib/adwords_api/v201607/feed_item_service.rb +54 -0
  152. data/lib/adwords_api/v201607/feed_item_service_registry.rb +46 -0
  153. data/lib/adwords_api/v201607/feed_mapping_service.rb +54 -0
  154. data/lib/adwords_api/v201607/feed_mapping_service_registry.rb +46 -0
  155. data/lib/adwords_api/v201607/feed_service.rb +54 -0
  156. data/lib/adwords_api/v201607/feed_service_registry.rb +46 -0
  157. data/lib/adwords_api/v201607/label_service.rb +54 -0
  158. data/lib/adwords_api/v201607/label_service_registry.rb +46 -0
  159. data/lib/adwords_api/v201607/location_criterion_service.rb +46 -0
  160. data/lib/adwords_api/v201607/location_criterion_service_registry.rb +46 -0
  161. data/lib/adwords_api/v201607/managed_customer_service.rb +78 -0
  162. data/lib/adwords_api/v201607/managed_customer_service_registry.rb +46 -0
  163. data/lib/adwords_api/v201607/media_service.rb +54 -0
  164. data/lib/adwords_api/v201607/media_service_registry.rb +46 -0
  165. data/lib/adwords_api/v201607/offline_conversion_feed_service.rb +38 -0
  166. data/lib/adwords_api/v201607/offline_conversion_feed_service_registry.rb +46 -0
  167. data/lib/adwords_api/v201607/report_definition_service.rb +38 -0
  168. data/lib/adwords_api/v201607/report_definition_service_registry.rb +46 -0
  169. data/lib/adwords_api/v201607/shared_criterion_service.rb +54 -0
  170. data/lib/adwords_api/v201607/shared_criterion_service_registry.rb +46 -0
  171. data/lib/adwords_api/v201607/shared_set_service.rb +54 -0
  172. data/lib/adwords_api/v201607/shared_set_service_registry.rb +46 -0
  173. data/lib/adwords_api/v201607/targeting_idea_service.rb +38 -0
  174. data/lib/adwords_api/v201607/targeting_idea_service_registry.rb +46 -0
  175. data/lib/adwords_api/v201607/traffic_estimator_service.rb +38 -0
  176. data/lib/adwords_api/v201607/traffic_estimator_service_registry.rb +46 -0
  177. data/lib/adwords_api/v201607/trial_async_error_service.rb +46 -0
  178. data/lib/adwords_api/v201607/trial_async_error_service_registry.rb +46 -0
  179. data/lib/adwords_api/v201607/trial_service.rb +54 -0
  180. data/lib/adwords_api/v201607/trial_service_registry.rb +46 -0
  181. data/lib/adwords_api/version.rb +1 -1
  182. data/test/adwords_api/test_adwords_api.rb +1 -1
  183. data/test/adwords_api/test_api_config.rb +8 -8
  184. data/test/adwords_api/test_batch_job_utils.rb +5 -5
  185. data/test/adwords_api/test_choices.rb +2 -2
  186. data/test/adwords_api/test_report_stream.rb +1 -1
  187. data/test/adwords_api/test_report_utils.rb +1 -1
  188. data/test/templates/v201601/basic_operations_get_campaigns.def +116 -0
  189. data/test/templates/v201601/basic_operations_update_keyword.def +125 -0
  190. data/test/templates/v201601/misc_use_oauth2_jwt.def +131 -0
  191. data/test/templates/v201603/basic_operations_get_campaigns.def +116 -0
  192. data/test/templates/v201603/basic_operations_update_keyword.def +125 -0
  193. data/test/templates/v201603/misc_use_oauth2_jwt.def +131 -0
  194. data/test/templates/v201605/basic_operations_get_campaigns.def +1 -1
  195. data/test/templates/v201605/basic_operations_update_keyword.def +125 -0
  196. data/test/templates/v201605/misc_use_oauth2_jwt.def +1 -1
  197. data/test/templates/v201607/basic_operations_get_campaigns.def +116 -0
  198. data/test/templates/v201607/basic_operations_update_keyword.def +125 -0
  199. data/test/templates/v201607/misc_use_oauth2_jwt.def +131 -0
  200. data/test/test_utils.rb +4 -1
  201. metadata +183 -2
@@ -0,0 +1,92 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2014, Google Inc. All Rights Reserved.
5
+ #
6
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15
+ # implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ # This example demonstrates how to make AdWords queries without using the
20
+ # adwords_api.yml file.
21
+
22
+ require 'adwords_api'
23
+ require 'date'
24
+
25
+ def use_runtime_config(client_id, client_secret, refresh_token,
26
+ developer_token, client_customer_id, user_agent)
27
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
28
+ # when called without parameters.
29
+ adwords = AdwordsApi::Api.new({
30
+ :authentication => {
31
+ :method => 'OAuth2',
32
+ :oauth2_client_id => client_id,
33
+ :oauth2_client_secret => client_secret,
34
+ :developer_token => developer_token,
35
+ :client_customer_id => client_customer_id,
36
+ :user_agent => user_agent,
37
+ :oauth2_token => {
38
+ :refresh_token => refresh_token
39
+ }
40
+ },
41
+ :service => {
42
+ :environment => 'PRODUCTION'
43
+ }
44
+ })
45
+
46
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
47
+ # the hash above or provide your own logger:
48
+ # adwords.logger = Logger.new('adwords_xml.log')
49
+
50
+ customer_srv = adwords.service(:CustomerService, API_VERSION)
51
+ customer = customer_srv.get()
52
+ puts "You are logged in as customer: %d" % customer[:id]
53
+ end
54
+
55
+ if __FILE__ == $0
56
+ API_VERSION = :v201607
57
+
58
+ begin
59
+ client_id = 'INSERT_CLIENT_ID_HERE'
60
+ client_secret = 'INSERT_CLIENT_SECRET_HERE'
61
+ refresh_token = 'INSERT_REFRESH_TOKEN_HERE'
62
+ developer_token = 'INSERT_DEVELOPER_TOKEN_HERE'
63
+ client_customer_id = 'INSERT_CLIENT_CUSTOMER_ID_HERE'
64
+ user_agent = 'INSERT_USER_AGENT_HERE'
65
+
66
+ use_runtime_config(client_id, client_secret, refresh_token,
67
+ developer_token, client_customer_id, user_agent)
68
+
69
+ # Authorization error.
70
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
71
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
72
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
73
+ "to retrieve and store OAuth2 tokens."
74
+ puts "See this wiki page for more details:\n\n " +
75
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
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
@@ -0,0 +1,191 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
5
+ #
6
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15
+ # implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ # This example gets keyword traffic estimates.
20
+
21
+ require 'adwords_api'
22
+
23
+ def estimate_keyword_traffic()
24
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
25
+ # when called without parameters.
26
+ adwords = AdwordsApi::Api.new
27
+
28
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
29
+ # the configuration file or provide your own logger:
30
+ # adwords.logger = Logger.new('adwords_xml.log')
31
+
32
+ traffic_estimator_srv = adwords.service(:TrafficEstimatorService, API_VERSION)
33
+
34
+ # Create keywords. Up to 2000 keywords can be passed in a single request.
35
+ keywords = [
36
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
37
+ # being created. It's only necessary when you must provide an explicit
38
+ # type that the client library can't infer.
39
+ {:xsi_type => 'Keyword', :text => 'mars cruise', :match_type => 'BROAD'},
40
+ {:xsi_type => 'Keyword', :text => 'cheap cruise', :match_type => 'PHRASE'},
41
+ {:xsi_type => 'Keyword', :text => 'cruise', :match_type => 'EXACT'},
42
+ {:xsi_type => 'Keyword', :text => 'moon walk', :match_type => 'BROAD'}
43
+ ]
44
+
45
+ # Create a keyword estimate request for each keyword.
46
+ keyword_requests = keywords.map {|keyword| {:keyword => keyword}}
47
+
48
+ # Negative keywords don't return estimates, but adjust the estimates of the
49
+ # other keywords in the hypothetical ad group. To specify a negative keyword
50
+ # set the is_negative field to true.
51
+ keyword_requests[3][:is_negative] = true
52
+
53
+ # Create ad group estimate requests.
54
+ ad_group_request = {
55
+ :keyword_estimate_requests => keyword_requests,
56
+ :max_cpc => {
57
+ :micro_amount => 1000000
58
+ }
59
+ }
60
+
61
+ # Create campaign estimate requests.
62
+ campaign_request = {
63
+ :ad_group_estimate_requests => [ad_group_request],
64
+ # Set targeting criteria. Only locations and languages are supported.
65
+ :criteria => [
66
+ {:xsi_type => 'Location', :id => 2840}, # United States
67
+ {:xsi_type => 'Language', :id => 1000} # English
68
+ ]
69
+ }
70
+
71
+ # Create a selector.
72
+ selector = {
73
+ :campaign_estimate_requests => [campaign_request],
74
+ # Optional: Request a list of campaign level estimates segmented by
75
+ # platform.
76
+ :platform_estimate_requested => true
77
+ }
78
+
79
+ # Execute the request.
80
+ response = traffic_estimator_srv.get(selector)
81
+
82
+ # Display traffic estimates.
83
+ if response and response[:campaign_estimates] and
84
+ response[:campaign_estimates].size > 0
85
+ campaign_estimate = response[:campaign_estimates].first
86
+
87
+ unless campaign_estimate[:platform_estimates].nil?
88
+ # Display the campaign level estimates segmented by platform.
89
+ campaign_estimate[:platform_estimates].each do |platform_estimate|
90
+ platform_message = ('Results for the platform with ID %d and name ' +
91
+ '"%s":') % [platform_estimate[:platform][:id],
92
+ platform_estimate[:platform][:platform_name]]
93
+ display_mean_estimates(
94
+ platform_message,
95
+ platform_estimate[:min_estimate],
96
+ platform_estimate[:max_estimate]
97
+ )
98
+ end
99
+ end
100
+
101
+ # Display the keyword estimates.
102
+ keyword_estimates =
103
+ campaign_estimate[:ad_group_estimates].first[:keyword_estimates]
104
+ keyword_estimates.each_with_index do |keyword_estimate, index|
105
+ next if keyword_requests[index][:is_negative]
106
+ keyword = keyword_requests[index][:keyword]
107
+
108
+ keyword_message = ('Results for the keyword with text "%s" and match ' +
109
+ 'type "%s":') % [keyword[:text], keyword[:match_type]]
110
+ display_mean_estimates(
111
+ keyword_message,
112
+ keyword_estimate[:min],
113
+ keyword_estimate[:max]
114
+ )
115
+ end
116
+ else
117
+ puts 'No traffic estimates were returned.'
118
+ end
119
+ end
120
+
121
+ def display_mean_estimates(message, min_estimate, max_estimate)
122
+ mean_average_cpc = nil
123
+ unless min_estimate[:average_cpc].nil? || max_estimate[:average_cpc].nil?
124
+ mean_average_cpc = calculate_mean(
125
+ min_estimate[:average_cpc][:micro_amount],
126
+ max_estimate[:average_cpc][:micro_amount]
127
+ )
128
+ end
129
+ mean_average_position = calculate_mean(
130
+ min_estimate[:average_position],
131
+ max_estimate[:average_position]
132
+ )
133
+ mean_clicks = calculate_mean(
134
+ min_estimate[:clicks_per_day],
135
+ max_estimate[:clicks_per_day]
136
+ )
137
+ mean_total_cost = nil
138
+ unless min_estimate[:total_cost].nil? || max_estimate[:total_cost].nil?
139
+ mean_total_cost = calculate_mean(
140
+ min_estimate[:total_cost][:micro_amount],
141
+ max_estimate[:total_cost][:micro_amount]
142
+ )
143
+ end
144
+
145
+ puts message
146
+ puts "\tEstimated average CPC: %s" % format_mean(mean_average_cpc)
147
+ puts "\tEstimated ad position: %s" % format_mean(mean_average_position)
148
+ puts "\tEstimated daily clicks: %s" % format_mean(mean_clicks)
149
+ puts "\tEstimated daily cost: %s" % format_mean(mean_total_cost)
150
+ end
151
+
152
+ def format_mean(mean)
153
+ return "nil" if mean.nil?
154
+ return "%.2f" % (mean / 1000000)
155
+ end
156
+
157
+ def calculate_mean(min_money, max_money)
158
+ return nil if min_money.nil? || max_money.nil?
159
+ return (min_money.to_f + max_money.to_f) / 2.0
160
+ end
161
+
162
+ if __FILE__ == $0
163
+ API_VERSION = :v201607
164
+
165
+ begin
166
+ estimate_keyword_traffic()
167
+
168
+ # Authorization error.
169
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
170
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
171
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
172
+ "to retrieve and store OAuth2 tokens."
173
+ puts "See this wiki page for more details:\n\n " +
174
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
175
+
176
+ # HTTP errors.
177
+ rescue AdsCommon::Errors::HttpError => e
178
+ puts "HTTP Error: %s" % e
179
+
180
+ # API errors.
181
+ rescue AdwordsApi::Errors::ApiException => e
182
+ puts "Message: %s" % e.message
183
+ puts 'Errors:'
184
+ e.errors.each_with_index do |error, index|
185
+ puts "\tError [%d]:" % (index + 1)
186
+ error.each do |field, value|
187
+ puts "\t\t%s: %s" % [field, value]
188
+ end
189
+ end
190
+ end
191
+ end
@@ -0,0 +1,128 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2016, Google Inc. All Rights Reserved.
5
+ #
6
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15
+ # implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ # This example gets all available campaign criterion bid modifier landscapes
20
+ # for a given campaign.
21
+ # To get campaigns, run basic_operations/get_campaigns.rb.
22
+
23
+ require 'adwords_api'
24
+
25
+ def get_campaign_criterion_bid_modifier_simulations(campaign_id)
26
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
27
+ # when called without parameters.
28
+ adwords = AdwordsApi::Api.new
29
+
30
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
31
+ # the configuration file or provide your own logger:
32
+ # adwords.logger = Logger.new('adwords_xml.log')
33
+
34
+ data_srv = adwords.service(:DataService, API_VERSION)
35
+
36
+ # Get all the campaigns for this account.
37
+ selector = {
38
+ :fields => [
39
+ 'CampaignId',
40
+ 'CriterionId',
41
+ 'StartDate',
42
+ 'EndDate',
43
+ 'BidModifier',
44
+ 'LocalClicks',
45
+ 'LocalCost',
46
+ 'LocalImpressions',
47
+ 'TotalLocalImpressions',
48
+ 'TotalLocalClicks',
49
+ 'TotalLocalCost',
50
+ 'RequiredBudget'
51
+ ],
52
+ :paging => {
53
+ :start_index => 0,
54
+ :number_results => PAGE_SIZE
55
+ }
56
+ }
57
+
58
+ # Set initial values.
59
+ offset, page = 0, {}
60
+
61
+ begin
62
+ page = data_srv.get_campaign_criterion_bid_landscape(selector)
63
+ if page[:entries]
64
+ page[:entries].each do |bid_modifier_landscape|
65
+ puts ("Found campaign-level criterion bid modifier landscapes for " +
66
+ "criterion with id '%d', start date '%s', end date '%s', and " +
67
+ "landscape points:") % [
68
+ bid_modifier_landscape[:criterion_id],
69
+ bid_modifier_landscape[:start_date],
70
+ bid_modifier_landscape[:end_date]
71
+ ]
72
+ bid_modifier_landscape[:landscape_points].each do |landscape_point|
73
+ puts (" bid modifier: %f => clicks: %d, cost: %d, impressions: %d" +
74
+ " total clicks: %d, total cost: %d, total impressions: %d" +
75
+ " and required budget: %f") % [
76
+ landscape_point[:bid_modifier],
77
+ landscape_point[:clicks],
78
+ landscape_point[:cost][:micro_amount],
79
+ landscape_point[:impressions],
80
+ landscape_point[:total_local_clicks],
81
+ landscape_point[:total_local_cost][:micro_amount],
82
+ landscape_point[:total_local_impressions],
83
+ landscape_point[:required_budget][:micro_amount]
84
+ ]
85
+ end
86
+ puts
87
+ end
88
+
89
+ # Increment values to request the next page.
90
+ offset += PAGE_SIZE
91
+ selector[:paging][:start_index] = offset
92
+ end
93
+ end while page[:total_num_entries] > offset
94
+ end
95
+
96
+ if __FILE__ == $0
97
+ API_VERSION = :v201607
98
+ PAGE_SIZE = 500
99
+
100
+ begin
101
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
102
+
103
+ get_campaign_criterion_bid_modifier_simulations(campaign_id)
104
+
105
+ # Authorization error.
106
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
107
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
108
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
109
+ "to retrieve and store OAuth2 tokens."
110
+ puts "See this wiki page for more details:\n\n " +
111
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
112
+
113
+ # HTTP errors.
114
+ rescue AdsCommon::Errors::HttpError => e
115
+ puts "HTTP Error: %s" % e
116
+
117
+ # API errors.
118
+ rescue AdwordsApi::Errors::ApiException => e
119
+ puts "Message: %s" % e.message
120
+ puts 'Errors:'
121
+ e.errors.each_with_index do |error, index|
122
+ puts "\tError [%d]:" % (index + 1)
123
+ error.each do |field, value|
124
+ puts "\t\t%s: %s" % [field, value]
125
+ end
126
+ end
127
+ end
128
+ end
@@ -0,0 +1,95 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
5
+ #
6
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15
+ # implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ # This example gets bid landscapes for a keyword. To get keywords, run
20
+ # get_keywords.rb.
21
+
22
+ require 'adwords_api'
23
+
24
+ def get_criterion_bid_landscapes(ad_group_id, keyword_id)
25
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
26
+ # when called without parameters.
27
+ adwords = AdwordsApi::Api.new
28
+
29
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
30
+ # the configuration file or provide your own logger:
31
+ # adwords.logger = Logger.new('adwords_xml.log')
32
+
33
+ data_srv = adwords.service(:DataService, API_VERSION)
34
+
35
+ # Get keyword bid landscape.
36
+ selector = {
37
+ :fields => ['AdGroupId', 'CriterionId', 'StartDate', 'EndDate', 'Bid',
38
+ 'LocalClicks', 'LocalCost', 'LocalImpressions'],
39
+ :predicates => [
40
+ {:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]},
41
+ {:field => 'CriterionId', :operator => 'IN', :values => [keyword_id]},
42
+ ]
43
+ }
44
+ page = data_srv.get_criterion_bid_landscape(selector)
45
+ if page and page[:entries]
46
+ puts "Bid landscape(s) retrieved: %d." % [page[:entries].length]
47
+ page[:entries].each do |bid_landscape|
48
+ puts ("Retrieved keyword bid landscape with ad group ID %d" +
49
+ ", keyword ID %d, start date '%s', end date '%s'" +
50
+ ", with landscape points:") %
51
+ [bid_landscape[:ad_group_id], bid_landscape[:criterion_id],
52
+ bid_landscape[:start_date], bid_landscape[:end_date]]
53
+ bid_landscape[:landscape_points].each do |point|
54
+ puts "\t%d => clicks: %d, cost: %d, impressions: %d" %
55
+ [point[:bid][:micro_amount], point.clicks,
56
+ point[:cost][:micro_amount], point[:impressions]]
57
+ end
58
+ end
59
+ else
60
+ puts 'No bid landscapes retrieved.'
61
+ end
62
+ end
63
+
64
+ if __FILE__ == $0
65
+ API_VERSION = :v201607
66
+
67
+ begin
68
+ ad_group_id = 'INSERT_ADGROUP_ID_HERE'.to_i
69
+ keyword_id = 'INSERT_KEYWORD_ID_HERE'.to_i
70
+ get_criterion_bid_landscapes(ad_group_id, keyword_id)
71
+
72
+ # Authorization error.
73
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
74
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
75
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
76
+ "to retrieve and store OAuth2 tokens."
77
+ puts "See this wiki page for more details:\n\n " +
78
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
79
+
80
+ # HTTP errors.
81
+ rescue AdsCommon::Errors::HttpError => e
82
+ puts "HTTP Error: %s" % e
83
+
84
+ # API errors.
85
+ rescue AdwordsApi::Errors::ApiException => e
86
+ puts "Message: %s" % e.message
87
+ puts 'Errors:'
88
+ e.errors.each_with_index do |error, index|
89
+ puts "\tError [%d]:" % (index + 1)
90
+ error.each do |field, value|
91
+ puts "\t\t%s: %s" % [field, value]
92
+ end
93
+ end
94
+ end
95
+ end