google-adx-buyer-api 0.4.0 → 0.4.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (185) hide show
  1. data/ChangeLog +4 -0
  2. data/README +39 -25
  3. data/examples/v201109/account_management/get_account_changes.rb +137 -0
  4. data/examples/{v201008 → v201109/basic_operations}/add_ad_group.rb +18 -28
  5. data/examples/{v201003 → v201109/basic_operations}/add_campaign.rb +28 -30
  6. data/examples/{v201008/add_ad_group_criteria.rb → v201109/basic_operations/add_placements.rb} +45 -46
  7. data/examples/v201109/basic_operations/add_thirdparty_redirect_ad.rb +105 -0
  8. data/examples/{v201008 → v201109/basic_operations}/delete_ad.rb +21 -35
  9. data/examples/{v201101 → v201109/basic_operations}/delete_ad_group.rb +18 -28
  10. data/examples/v201109/{delete_campaign.rb → basic_operations/delete_campaign.rb} +18 -28
  11. data/examples/{v201008/delete_ad_group_criterion.rb → v201109/basic_operations/delete_placement.rb} +24 -33
  12. data/examples/{v201101/get_all_ad_groups.rb → v201109/basic_operations/get_ad_groups.rb} +21 -35
  13. data/examples/{v201101/get_all_campaigns.rb → v201109/basic_operations/get_campaigns.rb} +14 -23
  14. data/examples/{v201008/get_all_ad_group_criteria.rb → v201109/basic_operations/get_placements.rb} +37 -36
  15. data/examples/v201109/{get_all_ads.rb → basic_operations/get_thirdparty_redirect_ads.rb} +37 -36
  16. data/examples/v201109/{get_client_customer_id.rb → basic_operations/pause_ad.rb} +27 -33
  17. data/examples/{v201003 → v201109/basic_operations}/update_ad_group.rb +18 -32
  18. data/examples/{v201101 → v201109/basic_operations}/update_campaign.rb +19 -33
  19. data/examples/{v201003/delete_ad_group_criterion.rb → v201109/basic_operations/update_placement.rb} +35 -36
  20. data/examples/v201109/{perform_mutate_job.rb → campaign_management/add_placements_in_bulk.rb} +11 -11
  21. data/examples/v201109/{get_all_disapproved_ads.rb → campaign_management/get_all_disapproved_ads.rb} +18 -28
  22. data/examples/v201109/error_handling/handle_captcha_challenge.rb +93 -0
  23. data/examples/v201109/error_handling/handle_partial_failures.rb +117 -0
  24. data/examples/v201109/error_handling/handle_policy_violation_error.rb +138 -0
  25. data/examples/v201109/error_handling/handle_two_factor_authorization_error.rb +87 -0
  26. data/examples/v201109/misc/get_all_images_and_videos.rb +101 -0
  27. data/examples/{v201101 → v201109/misc}/upload_image.rb +23 -33
  28. data/examples/v201109/{get_all_campaigns.rb → misc/use_oauth.rb} +42 -31
  29. data/examples/{v201003/get_related_placements.rb → v201109/optimization/get_placement_ideas.rb} +32 -37
  30. data/examples/{v201008/add_user_list.rb → v201109/remarketing/add_audience.rb} +49 -34
  31. data/examples/v201109/{add_conversion.rb → remarketing/add_conversion_tracker.rb} +31 -35
  32. data/examples/v201109/{download_adhoc_report.rb → reporting/download_criteria_report.rb} +24 -24
  33. data/examples/{v201008/download_report.rb → v201109/reporting/download_defined_report.rb} +20 -29
  34. data/examples/v201109/reporting/get_campaign_stats.rb +105 -0
  35. data/examples/{v201008/get_all_report_definitions.rb → v201109/reporting/get_defined_reports.rb} +18 -27
  36. data/examples/v201109/{get_all_carriers.rb → reporting/get_report_fields.rb} +18 -19
  37. data/examples/v201109/reporting/parallel_report_download.rb +159 -0
  38. data/examples/v201109/{add_campaign_targeting_criteria.rb → targeting/add_campaign_targeting_criteria.rb} +27 -19
  39. data/examples/v201109/targeting/get_campaign_targeting_criteria.rb +104 -0
  40. data/examples/v201109/{get_all_languages.rb → targeting/get_targetable_languages_and_carriers.rb} +18 -9
  41. data/examples/v201109/{get_location_criteria.rb → targeting/lookup_location.rb} +7 -7
  42. metadata +59 -191
  43. data/Rakefile +0 -50
  44. data/examples/v201003/add_ad_group.rb +0 -98
  45. data/examples/v201003/add_ad_group_criteria.rb +0 -100
  46. data/examples/v201003/add_ads.rb +0 -110
  47. data/examples/v201003/add_negative_campaign_criterion.rb +0 -95
  48. data/examples/v201003/add_placement_performance_report_definition.rb +0 -108
  49. data/examples/v201003/check_campaigns.rb +0 -132
  50. data/examples/v201003/delete_ad.rb +0 -94
  51. data/examples/v201003/delete_ad_group.rb +0 -86
  52. data/examples/v201003/delete_campaign.rb +0 -87
  53. data/examples/v201003/download_report.rb +0 -76
  54. data/examples/v201003/get_all_active_ad_group_criteria.rb +0 -93
  55. data/examples/v201003/get_all_ad_group_criteria.rb +0 -91
  56. data/examples/v201003/get_all_ad_groups.rb +0 -88
  57. data/examples/v201003/get_all_ads.rb +0 -91
  58. data/examples/v201003/get_all_campaign_targets.rb +0 -83
  59. data/examples/v201003/get_all_campaigns.rb +0 -83
  60. data/examples/v201003/get_all_disapproved_ads.rb +0 -94
  61. data/examples/v201003/get_all_images.rb +0 -88
  62. data/examples/v201003/get_all_paused_campaigns.rb +0 -86
  63. data/examples/v201003/get_all_report_definitions.rb +0 -84
  64. data/examples/v201003/get_criterion_bid_landscape.rb +0 -105
  65. data/examples/v201003/get_geo_location_info.rb +0 -108
  66. data/examples/v201003/get_report_fields.rb +0 -81
  67. data/examples/v201003/perform_bulk_mutate_job.rb +0 -222
  68. data/examples/v201003/set_campaign_targets.rb +0 -124
  69. data/examples/v201003/update_ad.rb +0 -95
  70. data/examples/v201003/update_ad_group_criterion.rb +0 -108
  71. data/examples/v201003/update_campaign.rb +0 -92
  72. data/examples/v201003/upload_image.rb +0 -97
  73. data/examples/v201008/add_ads.rb +0 -110
  74. data/examples/v201008/add_campaign.rb +0 -101
  75. data/examples/v201008/add_negative_campaign_criterion.rb +0 -95
  76. data/examples/v201008/add_placement_performance_report_definition.rb +0 -108
  77. data/examples/v201008/check_campaigns.rb +0 -132
  78. data/examples/v201008/delete_ad_group.rb +0 -86
  79. data/examples/v201008/delete_bulk_mutate_job.rb +0 -96
  80. data/examples/v201008/delete_campaign.rb +0 -87
  81. data/examples/v201008/delete_user_list.rb +0 -87
  82. data/examples/v201008/get_all_account_changes.rb +0 -144
  83. data/examples/v201008/get_all_active_ad_group_criteria.rb +0 -93
  84. data/examples/v201008/get_all_ad_groups.rb +0 -88
  85. data/examples/v201008/get_all_ads.rb +0 -91
  86. data/examples/v201008/get_all_campaign_targets.rb +0 -83
  87. data/examples/v201008/get_all_campaigns.rb +0 -83
  88. data/examples/v201008/get_all_disapproved_ads.rb +0 -94
  89. data/examples/v201008/get_all_images.rb +0 -88
  90. data/examples/v201008/get_all_paused_campaigns.rb +0 -86
  91. data/examples/v201008/get_all_user_lists.rb +0 -84
  92. data/examples/v201008/get_bulk_mutate_job.rb +0 -106
  93. data/examples/v201008/get_campaign_alerts.rb +0 -103
  94. data/examples/v201008/get_criterion_bid_landscape.rb +0 -105
  95. data/examples/v201008/get_geo_location_info.rb +0 -108
  96. data/examples/v201008/get_related_placements.rb +0 -114
  97. data/examples/v201008/get_report_fields.rb +0 -81
  98. data/examples/v201008/perform_bulk_mutate_job.rb +0 -222
  99. data/examples/v201008/set_campaign_targets.rb +0 -124
  100. data/examples/v201008/update_ad.rb +0 -95
  101. data/examples/v201008/update_ad_group.rb +0 -90
  102. data/examples/v201008/update_ad_group_criterion.rb +0 -108
  103. data/examples/v201008/update_campaign.rb +0 -93
  104. data/examples/v201008/update_user_list.rb +0 -91
  105. data/examples/v201008/upload_image.rb +0 -97
  106. data/examples/v201101/add_ad_group.rb +0 -98
  107. data/examples/v201101/add_ad_group_criteria.rb +0 -100
  108. data/examples/v201101/add_ads.rb +0 -110
  109. data/examples/v201101/add_campaign.rb +0 -108
  110. data/examples/v201101/add_conversion.rb +0 -97
  111. data/examples/v201101/add_negative_campaign_criterion.rb +0 -95
  112. data/examples/v201101/add_placement_performance_report_definition.rb +0 -108
  113. data/examples/v201101/add_rtb_campaign.rb +0 -113
  114. data/examples/v201101/add_user_list.rb +0 -122
  115. data/examples/v201101/check_campaigns.rb +0 -132
  116. data/examples/v201101/delete_ad.rb +0 -94
  117. data/examples/v201101/delete_ad_group_criterion.rb +0 -95
  118. data/examples/v201101/delete_bulk_mutate_job.rb +0 -96
  119. data/examples/v201101/delete_campaign.rb +0 -87
  120. data/examples/v201101/delete_user_list.rb +0 -87
  121. data/examples/v201101/download_report.rb +0 -76
  122. data/examples/v201101/get_ad_group_bid_landscape.rb +0 -103
  123. data/examples/v201101/get_all_account_changes.rb +0 -146
  124. data/examples/v201101/get_all_active_ad_group_criteria.rb +0 -106
  125. data/examples/v201101/get_all_ad_group_criteria.rb +0 -97
  126. data/examples/v201101/get_all_ads.rb +0 -99
  127. data/examples/v201101/get_all_campaign_targets.rb +0 -83
  128. data/examples/v201101/get_all_conversions.rb +0 -88
  129. data/examples/v201101/get_all_disapproved_ads.rb +0 -102
  130. data/examples/v201101/get_all_images.rb +0 -90
  131. data/examples/v201101/get_all_paused_campaigns.rb +0 -92
  132. data/examples/v201101/get_all_report_definitions.rb +0 -84
  133. data/examples/v201101/get_all_user_lists.rb +0 -87
  134. data/examples/v201101/get_bulk_mutate_job.rb +0 -106
  135. data/examples/v201101/get_campaign_alerts.rb +0 -103
  136. data/examples/v201101/get_criterion_bid_landscape.rb +0 -102
  137. data/examples/v201101/get_geo_location_info.rb +0 -108
  138. data/examples/v201101/get_related_placements.rb +0 -114
  139. data/examples/v201101/get_report_fields.rb +0 -81
  140. data/examples/v201101/perform_bulk_mutate_job.rb +0 -222
  141. data/examples/v201101/set_campaign_targets.rb +0 -111
  142. data/examples/v201101/update_ad.rb +0 -95
  143. data/examples/v201101/update_ad_group.rb +0 -90
  144. data/examples/v201101/update_ad_group_criterion.rb +0 -108
  145. data/examples/v201101/update_conversion.rb +0 -96
  146. data/examples/v201101/update_user_list.rb +0 -91
  147. data/examples/v201109/add_ad_group.rb +0 -98
  148. data/examples/v201109/add_ad_group_criteria.rb +0 -100
  149. data/examples/v201109/add_ads.rb +0 -110
  150. data/examples/v201109/add_campaign.rb +0 -108
  151. data/examples/v201109/add_negative_campaign_criterion.rb +0 -95
  152. data/examples/v201109/add_rtb_campaign.rb +0 -113
  153. data/examples/v201109/add_user_list.rb +0 -122
  154. data/examples/v201109/check_campaigns.rb +0 -132
  155. data/examples/v201109/delete_ad.rb +0 -94
  156. data/examples/v201109/delete_ad_group.rb +0 -86
  157. data/examples/v201109/delete_ad_group_criterion.rb +0 -95
  158. data/examples/v201109/delete_bulk_mutate_job.rb +0 -96
  159. data/examples/v201109/delete_user_list.rb +0 -87
  160. data/examples/v201109/download_report.rb +0 -76
  161. data/examples/v201109/get_ad_group_bid_landscape.rb +0 -103
  162. data/examples/v201109/get_all_account_changes.rb +0 -146
  163. data/examples/v201109/get_all_active_ad_group_criteria.rb +0 -106
  164. data/examples/v201109/get_all_ad_group_criteria.rb +0 -98
  165. data/examples/v201109/get_all_ad_groups.rb +0 -94
  166. data/examples/v201109/get_all_campaign_targets.rb +0 -83
  167. data/examples/v201109/get_all_conversions.rb +0 -88
  168. data/examples/v201109/get_all_images.rb +0 -90
  169. data/examples/v201109/get_all_paused_campaigns.rb +0 -92
  170. data/examples/v201109/get_all_report_definitions.rb +0 -84
  171. data/examples/v201109/get_all_user_lists.rb +0 -87
  172. data/examples/v201109/get_bulk_mutate_job.rb +0 -106
  173. data/examples/v201109/get_campaign_alerts.rb +0 -103
  174. data/examples/v201109/get_criterion_bid_landscape.rb +0 -102
  175. data/examples/v201109/get_geo_location_info.rb +0 -108
  176. data/examples/v201109/get_related_placements.rb +0 -114
  177. data/examples/v201109/get_report_fields.rb +0 -81
  178. data/examples/v201109/perform_bulk_mutate_job.rb +0 -222
  179. data/examples/v201109/update_ad.rb +0 -95
  180. data/examples/v201109/update_ad_group.rb +0 -90
  181. data/examples/v201109/update_ad_group_criterion.rb +0 -108
  182. data/examples/v201109/update_campaign.rb +0 -93
  183. data/examples/v201109/update_conversion.rb +0 -96
  184. data/examples/v201109/update_user_list.rb +0 -91
  185. data/examples/v201109/upload_image.rb +0 -97
@@ -1,103 +0,0 @@
1
- #!/usr/bin/ruby
2
- #
3
- # Author:: api.sgomes@gmail.com (Sérgio Gomes)
4
- #
5
- # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
6
- #
7
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
8
- # you may not use this file except in compliance with the License.
9
- # You may obtain a copy of the License at
10
- #
11
- # http://www.apache.org/licenses/LICENSE-2.0
12
- #
13
- # Unless required by applicable law or agreed to in writing, software
14
- # distributed under the License is distributed on an "AS IS" BASIS,
15
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
16
- # implied.
17
- # See the License for the specific language governing permissions and
18
- # limitations under the License.
19
- #
20
- # This code example illustrates how to retrieve campaign alerts for a user.
21
- # The alerts are restricted to a maximum of 10 entries.
22
- #
23
- # Tags: AlertService.get
24
-
25
- require 'rubygems'
26
- gem 'google-adwords-api'
27
- require 'adwords_api'
28
-
29
- API_VERSION = :v201109
30
-
31
- def get_campaign_alerts()
32
- # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
33
- # when called without parameters.
34
- adwords = AdwordsApi::Api.new
35
-
36
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
37
- # the configuration file or provide your own logger:
38
- # adwords.logger = Logger.new('adwords_xml.log')
39
-
40
- alert_srv = adwords.service(:AlertService, API_VERSION)
41
-
42
- # Create the selector.
43
- selector = {
44
- :query => {
45
- :filter_spec => 'ALL',
46
- :client_spec => 'ALL',
47
- :trigger_time_spec => 'ALL_TIME',
48
- :severities => ['GREEN', 'YELLOW', 'RED'],
49
- :types => ['CAMPAIGN_ENDING', 'CAMPAIGN_ENDED']
50
- },
51
- :paging => {
52
- :start_index => 0,
53
- :number_results => 10
54
- }
55
- }
56
-
57
- # Get alerts.
58
- response = alert_srv.get(selector)
59
-
60
- if response and response[:entries]
61
- alerts = response[:entries]
62
- alerts.each_with_index do |alert, index|
63
- puts "{index}) Customer Id is " +
64
- "#{AdwordsApi::Utils.format_id(alert[:client_customer_id])}, " +
65
- "alert type is '#{alert[:alert_type]}', severity is " +
66
- "#{alert[:alert_severity]}."
67
- alert[:details].each do |detail|
68
- puts " - triggered at #{detail[:trigger_time]}"
69
- end
70
- end
71
- else
72
- puts "No alerts were found."
73
- end
74
- end
75
-
76
- if __FILE__ == $0
77
- begin
78
- get_campaign_alerts()
79
-
80
- # Connection error. Likely transitory.
81
- rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
82
- puts 'Connection Error: %s' % e
83
- puts 'Source: %s' % e.backtrace.first
84
-
85
- # API Error.
86
- rescue AdwordsApi::Errors::ApiException => e
87
- puts 'API Exception caught.'
88
- puts 'Message: %s' % e.message
89
- puts 'Code: %d' % e.code if e.code
90
- puts 'Trigger: %s' % e.trigger if e.trigger
91
- puts 'Errors:'
92
- if e.errors
93
- e.errors.each_with_index do |error, index|
94
- puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
95
- error.each_pair do |field, value|
96
- if field != :xsi_type
97
- puts ' %s: %s' % [field, value]
98
- end
99
- end
100
- end
101
- end
102
- end
103
- end
@@ -1,102 +0,0 @@
1
- #!/usr/bin/ruby
2
- #
3
- # Author:: api.sgomes@gmail.com (Sérgio Gomes)
4
- #
5
- # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
6
- #
7
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
8
- # you may not use this file except in compliance with the License.
9
- # You may obtain a copy of the License at
10
- #
11
- # http://www.apache.org/licenses/LICENSE-2.0
12
- #
13
- # Unless required by applicable law or agreed to in writing, software
14
- # distributed under the License is distributed on an "AS IS" BASIS,
15
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
16
- # implied.
17
- # See the License for the specific language governing permissions and
18
- # limitations under the License.
19
- #
20
- # This example gets a bid landscapes for a criterion. To get criteria, run
21
- # get_all_ad_group_criteria.rb.
22
- #
23
- # Tags: DataService.getCriterionBidLandscape
24
-
25
- require 'rubygems'
26
- gem 'google-adwords-api'
27
- require 'adwords_api'
28
-
29
- API_VERSION = :v201109
30
-
31
- def get_criterion_bid_landscapes()
32
- # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
33
- # when called without parameters.
34
- adwords = AdwordsApi::Api.new
35
-
36
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
37
- # the configuration file or provide your own logger:
38
- # adwords.logger = Logger.new('adwords_xml.log')
39
-
40
- data_srv = adwords.service(:DataService, API_VERSION)
41
-
42
- ad_group_id = 'INSERT_ADGROUP_ID_HERE'.to_i
43
- criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
44
-
45
- # Get criterion bid landscape.
46
- selector = {
47
- :fields => ["AdGroupId", "CriterionId", "StartDate", "EndDate", "Bid",
48
- "LocalClicks", "LocalCost", "MarginalCpc", "LocalImpressions"],
49
- :predicates => [
50
- {:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]},
51
- {:field => 'CriterionId', :operator => 'IN', :values => [criterion_id]},
52
- ]
53
- }
54
- page = data_srv.get_criterion_bid_landscape(selector)
55
- if page and page[:entries]
56
- puts "#{page[:entries].length} bid landscape(s) retrieved."
57
- page[:entries].each do |bid_landscape|
58
- puts "Retrieved criterion bid landscape with ad group id " +
59
- "'#{bid_landscape[:ad_group_id]}', criterion id " +
60
- "'#{bid_landscape[:criterion_id]}', start date " +
61
- "'#{bid_landscape[:start_date]}', end date "+
62
- "'#{bid_landscape[:end_date]}', with landscape points:"
63
- bid_landscape[:landscape_points].each do |point|
64
- puts " #{point[:bid][:micro_amount]} => clicks: #{point.clicks}, " +
65
- "cost: #{point[:cost][:micro_amount]}, marginalCpc: " +
66
- "#{point[:marginal_cpc][:micro_amount]}, impressions: " +
67
- "#{point[:impressions]}"
68
- end
69
- end
70
- else
71
- puts "No bid landscapes retrieved."
72
- end
73
- end
74
-
75
- if __FILE__ == $0
76
- begin
77
- get_criterion_bid_landscapes()
78
-
79
- # Connection error. Likely transitory.
80
- rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
81
- puts 'Connection Error: %s' % e
82
- puts 'Source: %s' % e.backtrace.first
83
-
84
- # API Error.
85
- rescue AdwordsApi::Errors::ApiException => e
86
- puts 'API Exception caught.'
87
- puts 'Message: %s' % e.message
88
- puts 'Code: %d' % e.code if e.code
89
- puts 'Trigger: %s' % e.trigger if e.trigger
90
- puts 'Errors:'
91
- if e.errors
92
- e.errors.each_with_index do |error, index|
93
- puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
94
- error.each_pair do |field, value|
95
- if field != :xsi_type
96
- puts ' %s: %s' % [field, value]
97
- end
98
- end
99
- end
100
- end
101
- end
102
- end
@@ -1,108 +0,0 @@
1
- #!/usr/bin/ruby
2
- #
3
- # Author:: api.sgomes@gmail.com (Sérgio Gomes)
4
- #
5
- # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
6
- #
7
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
8
- # you may not use this file except in compliance with the License.
9
- # You may obtain a copy of the License at
10
- #
11
- # http://www.apache.org/licenses/LICENSE-2.0
12
- #
13
- # Unless required by applicable law or agreed to in writing, software
14
- # distributed under the License is distributed on an "AS IS" BASIS,
15
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
16
- # implied.
17
- # See the License for the specific language governing permissions and
18
- # limitations under the License.
19
- #
20
- # This example illustrates how to retrieve geo location information for
21
- # addresses.
22
- #
23
- # Tags: GeoLocationService.get
24
-
25
- require 'rubygems'
26
- gem 'google-adwords-api'
27
- require 'adwords_api'
28
-
29
- API_VERSION = :v201109
30
-
31
- def get_geo_location_info()
32
- # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
33
- # when called without parameters.
34
- adwords = AdwordsApi::Api.new
35
-
36
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
37
- # the configuration file or provide your own logger:
38
- # adwords.logger = Logger.new('adwords_xml.log')
39
-
40
- geo_location_srv = adwords.service(:GeoLocationService, API_VERSION)
41
-
42
- selector = {
43
- :addresses => [
44
- {
45
- :street_address => '1600 Amphitheatre Parkway',
46
- :city_name => 'Mountain View',
47
- :province_code => 'US-CA',
48
- :province_name => 'California',
49
- :postal_code => '94043',
50
- :country_code => 'US'
51
- },
52
- {
53
- :street_address => '76 Ninth Avenue',
54
- :city_name => 'New York',
55
- :province_code => 'US-NY',
56
- :province_name => 'New York',
57
- :postal_code => '10011',
58
- :country_code => 'US'
59
- },
60
- {
61
- :street_address => '五四大街1号, Beijing东城区',
62
- :country_code => 'CN'
63
- }
64
- ]
65
- }
66
-
67
- # Get the geo location info for the various addresses.
68
- locations = geo_location_srv.get(selector)
69
-
70
- if locations
71
- locations.each do |location|
72
- puts "Address \"#{location[:address][:street_address]}\" has latitude " +
73
- "#{location[:geo_point][:latitude_in_micro_degrees]} and " +
74
- "longitude #{location[:geo_point][:longitude_in_micro_degrees]}."
75
- end
76
- else
77
- puts "No geo locations were returned."
78
- end
79
- end
80
-
81
- if __FILE__ == $0
82
- begin
83
- get_geo_location_info()
84
-
85
- # Connection error. Likely transitory.
86
- rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
87
- puts 'Connection Error: %s' % e
88
- puts 'Source: %s' % e.backtrace.first
89
-
90
- # API Error.
91
- rescue AdwordsApi::Errors::ApiException => e
92
- puts 'API Exception caught.'
93
- puts 'Message: %s' % e.message
94
- puts 'Code: %d' % e.code if e.code
95
- puts 'Trigger: %s' % e.trigger if e.trigger
96
- puts 'Errors:'
97
- if e.errors
98
- e.errors.each_with_index do |error, index|
99
- puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
100
- error.each_pair do |field, value|
101
- if field != :xsi_type
102
- puts ' %s: %s' % [field, value]
103
- end
104
- end
105
- end
106
- end
107
- end
108
- end
@@ -1,114 +0,0 @@
1
- #!/usr/bin/ruby
2
- #
3
- # Author:: api.sgomes@gmail.com (Sérgio Gomes)
4
- #
5
- # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
6
- #
7
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
8
- # you may not use this file except in compliance with the License.
9
- # You may obtain a copy of the License at
10
- #
11
- # http://www.apache.org/licenses/LICENSE-2.0
12
- #
13
- # Unless required by applicable law or agreed to in writing, software
14
- # distributed under the License is distributed on an "AS IS" BASIS,
15
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
16
- # implied.
17
- # See the License for the specific language governing permissions and
18
- # limitations under the License.
19
- #
20
- # This example retrieves URLs that have content keywords related to a given
21
- # website.
22
- #
23
- # Tags: TargetingIdeaService.get
24
-
25
- require 'rubygems'
26
- gem 'google-adwords-api'
27
- require 'adwords_api'
28
-
29
- API_VERSION = :v201109
30
-
31
- def get_related_placements()
32
- # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
33
- # when called without parameters.
34
- adwords = AdwordsApi::Api.new
35
-
36
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
37
- # the configuration file or provide your own logger:
38
- # adwords.logger = Logger.new('adwords_xml.log')
39
-
40
- targeting_idea_srv = adwords.service(:TargetingIdeaService, API_VERSION)
41
-
42
- results_per_page = 10
43
- url = 'mars.google.com'
44
-
45
- # Construct selector.
46
- selector = {
47
- :idea_type => 'PLACEMENT',
48
- :request_type => 'IDEAS',
49
- :requested_attribute_types => ['CRITERION'],
50
- :search_parameters => [{
51
- # The 'xsi_type' field allows you to specify the xsi:type of the object
52
- # being created. It's only necessary when you must provide an explicit
53
- # type that the client library can't infer.
54
- :xsi_type => 'RelatedToUrlSearchParameter',
55
- :urls => [url],
56
- :include_sub_urls => false
57
- }],
58
- :paging => {
59
- :start_index => 0,
60
- :number_results => results_per_page
61
- }
62
- }
63
-
64
- # Perform request.
65
- results = []
66
- index = 0
67
- while true
68
- page = targeting_idea_srv.get(selector)
69
- if page and page[:entries]
70
- results += page[:entries]
71
- end
72
- break if page[:total_num_entries] <= index
73
- index += results_per_page
74
- selector[:paging][:start_index] = index
75
- end
76
-
77
- # Display results.
78
- results.each do |result|
79
- data = AdwordsApi::Utils.map(result[:data])
80
- placement = data['CRITERION'][:value]
81
- puts " Related content keywords found at URL \"%s\"" % placement[:url]
82
- end
83
- puts "Total urls found with content keywords related to keywords at " +
84
- " \"#{url}\": #{results.length}."
85
- end
86
-
87
- if __FILE__ == $0
88
- begin
89
- get_related_placements()
90
-
91
- # Connection error. Likely transitory.
92
- rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
93
- puts 'Connection Error: %s' % e
94
- puts 'Source: %s' % e.backtrace.first
95
-
96
- # API Error.
97
- rescue AdwordsApi::Errors::ApiException => e
98
- puts 'API Exception caught.'
99
- puts 'Message: %s' % e.message
100
- puts 'Code: %d' % e.code if e.code
101
- puts 'Trigger: %s' % e.trigger if e.trigger
102
- puts 'Errors:'
103
- if e.errors
104
- e.errors.each_with_index do |error, index|
105
- puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
106
- error.each_pair do |field, value|
107
- if field != :xsi_type
108
- puts ' %s: %s' % [field, value]
109
- end
110
- end
111
- end
112
- end
113
- end
114
- end
@@ -1,81 +0,0 @@
1
- #!/usr/bin/ruby
2
- #
3
- # Author:: api.sgomes@gmail.com (Sérgio Gomes)
4
- #
5
- # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
6
- #
7
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
8
- # you may not use this file except in compliance with the License.
9
- # You may obtain a copy of the License at
10
- #
11
- # http://www.apache.org/licenses/LICENSE-2.0
12
- #
13
- # Unless required by applicable law or agreed to in writing, software
14
- # distributed under the License is distributed on an "AS IS" BASIS,
15
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
16
- # implied.
17
- # See the License for the specific language governing permissions and
18
- # limitations under the License.
19
- #
20
- # This example gets the list of possible report fields for a report type.
21
- #
22
- # Tags: ReportDefinitionService.getReportFields
23
-
24
- require 'rubygems'
25
- gem 'google-adwords-api'
26
- require 'adwords_api'
27
-
28
- API_VERSION = :v201109
29
-
30
- def get_report_fields()
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
- report_def_srv = adwords.service(:ReportDefinitionService, API_VERSION)
40
-
41
- report_type = 'INSERT_REPORT_TYPE_HERE'
42
-
43
- # Get report fields.
44
- fields = report_def_srv.get_report_fields(report_type)
45
- if fields
46
- puts 'Report type \'%s\' contains the following fields:' % report_type
47
- fields.each do |field|
48
- puts ' - %s (%s)' % [field[:field_name], field[:field_type]]
49
- puts ' := [%s]' % field[:enum_values].join(', ') if field[:enum_values]
50
- end
51
- end
52
- end
53
-
54
- if __FILE__ == $0
55
- begin
56
- get_report_fields()
57
-
58
- # Connection error. Likely transitory.
59
- rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
60
- puts 'Connection Error: %s' % e
61
- puts 'Source: %s' % e.backtrace.first
62
-
63
- # API Error.
64
- rescue AdwordsApi::Errors::ApiException => e
65
- puts 'API Exception caught.'
66
- puts 'Message: %s' % e.message
67
- puts 'Code: %d' % e.code if e.code
68
- puts 'Trigger: %s' % e.trigger if e.trigger
69
- puts 'Errors:'
70
- if e.errors
71
- e.errors.each_with_index do |error, index|
72
- puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
73
- error.each_pair do |field, value|
74
- if field != :xsi_type
75
- puts ' %s: %s' % [field, value]
76
- end
77
- end
78
- end
79
- end
80
- end
81
- end