google-adwords-api 0.17.0 → 0.18.0

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