google-adx-buyer-api 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (133) hide show
  1. data/COPYING +201 -0
  2. data/ChangeLog +2 -0
  3. data/README +208 -0
  4. data/Rakefile +50 -0
  5. data/examples/v201003/add_ad_group.rb +98 -0
  6. data/examples/v201003/add_ad_group_criteria.rb +100 -0
  7. data/examples/v201003/add_ads.rb +110 -0
  8. data/examples/v201003/add_campaign.rb +101 -0
  9. data/examples/v201003/add_negative_campaign_criterion.rb +95 -0
  10. data/examples/v201003/add_placement_performance_report_definition.rb +108 -0
  11. data/examples/v201003/check_campaigns.rb +132 -0
  12. data/examples/v201003/delete_ad.rb +94 -0
  13. data/examples/v201003/delete_ad_group.rb +86 -0
  14. data/examples/v201003/delete_ad_group_criterion.rb +95 -0
  15. data/examples/v201003/delete_campaign.rb +87 -0
  16. data/examples/v201003/download_report.rb +71 -0
  17. data/examples/v201003/get_all_active_ad_group_criteria.rb +93 -0
  18. data/examples/v201003/get_all_ad_group_criteria.rb +91 -0
  19. data/examples/v201003/get_all_ad_groups.rb +88 -0
  20. data/examples/v201003/get_all_ads.rb +91 -0
  21. data/examples/v201003/get_all_campaign_targets.rb +83 -0
  22. data/examples/v201003/get_all_campaigns.rb +83 -0
  23. data/examples/v201003/get_all_disapproved_ads.rb +94 -0
  24. data/examples/v201003/get_all_images.rb +88 -0
  25. data/examples/v201003/get_all_paused_campaigns.rb +86 -0
  26. data/examples/v201003/get_all_report_definitions.rb +84 -0
  27. data/examples/v201003/get_criterion_bid_landscape.rb +105 -0
  28. data/examples/v201003/get_geo_location_info.rb +108 -0
  29. data/examples/v201003/get_related_placements.rb +111 -0
  30. data/examples/v201003/get_report_fields.rb +81 -0
  31. data/examples/v201003/perform_bulk_mutate_job.rb +222 -0
  32. data/examples/v201003/set_campaign_targets.rb +124 -0
  33. data/examples/v201003/update_ad.rb +95 -0
  34. data/examples/v201003/update_ad_group.rb +90 -0
  35. data/examples/v201003/update_ad_group_criterion.rb +108 -0
  36. data/examples/v201003/update_campaign.rb +92 -0
  37. data/examples/v201003/upload_image.rb +97 -0
  38. data/examples/v201008/add_ad_group.rb +98 -0
  39. data/examples/v201008/add_ad_group_criteria.rb +100 -0
  40. data/examples/v201008/add_ads.rb +110 -0
  41. data/examples/v201008/add_campaign.rb +101 -0
  42. data/examples/v201008/add_experiment.rb +162 -0
  43. data/examples/v201008/add_negative_campaign_criterion.rb +95 -0
  44. data/examples/v201008/add_placement_performance_report_definition.rb +108 -0
  45. data/examples/v201008/add_user_list.rb +96 -0
  46. data/examples/v201008/check_campaigns.rb +132 -0
  47. data/examples/v201008/delete_ad.rb +94 -0
  48. data/examples/v201008/delete_ad_group.rb +86 -0
  49. data/examples/v201008/delete_ad_group_criterion.rb +95 -0
  50. data/examples/v201008/delete_bulk_mutate_job.rb +96 -0
  51. data/examples/v201008/delete_campaign.rb +87 -0
  52. data/examples/v201008/delete_experiment.rb +87 -0
  53. data/examples/v201008/delete_user_list.rb +87 -0
  54. data/examples/v201008/download_report.rb +71 -0
  55. data/examples/v201008/get_all_account_changes.rb +144 -0
  56. data/examples/v201008/get_all_active_ad_group_criteria.rb +93 -0
  57. data/examples/v201008/get_all_ad_group_criteria.rb +91 -0
  58. data/examples/v201008/get_all_ad_groups.rb +88 -0
  59. data/examples/v201008/get_all_ads.rb +91 -0
  60. data/examples/v201008/get_all_campaign_targets.rb +83 -0
  61. data/examples/v201008/get_all_campaigns.rb +83 -0
  62. data/examples/v201008/get_all_disapproved_ads.rb +94 -0
  63. data/examples/v201008/get_all_experiments.rb +93 -0
  64. data/examples/v201008/get_all_images.rb +88 -0
  65. data/examples/v201008/get_all_paused_campaigns.rb +86 -0
  66. data/examples/v201008/get_all_report_definitions.rb +84 -0
  67. data/examples/v201008/get_all_user_lists.rb +84 -0
  68. data/examples/v201008/get_bulk_mutate_job.rb +106 -0
  69. data/examples/v201008/get_campaign_alerts.rb +103 -0
  70. data/examples/v201008/get_criterion_bid_landscape.rb +105 -0
  71. data/examples/v201008/get_geo_location_info.rb +108 -0
  72. data/examples/v201008/get_related_placements.rb +114 -0
  73. data/examples/v201008/get_report_fields.rb +81 -0
  74. data/examples/v201008/perform_bulk_mutate_job.rb +222 -0
  75. data/examples/v201008/promote_experiment.rb +88 -0
  76. data/examples/v201008/set_campaign_targets.rb +124 -0
  77. data/examples/v201008/update_ad.rb +95 -0
  78. data/examples/v201008/update_ad_group.rb +90 -0
  79. data/examples/v201008/update_ad_group_criterion.rb +108 -0
  80. data/examples/v201008/update_campaign.rb +93 -0
  81. data/examples/v201008/update_user_list.rb +91 -0
  82. data/examples/v201008/upload_image.rb +97 -0
  83. data/examples/v201101/add_ad_group.rb +98 -0
  84. data/examples/v201101/add_ad_group_criteria.rb +100 -0
  85. data/examples/v201101/add_ads.rb +110 -0
  86. data/examples/v201101/add_campaign.rb +108 -0
  87. data/examples/v201101/add_conversion.rb +97 -0
  88. data/examples/v201101/add_experiment.rb +162 -0
  89. data/examples/v201101/add_negative_campaign_criterion.rb +95 -0
  90. data/examples/v201101/add_placement_performance_report_definition.rb +108 -0
  91. data/examples/v201101/add_rtb_campaign.rb +113 -0
  92. data/examples/v201101/add_user_list.rb +122 -0
  93. data/examples/v201101/check_campaigns.rb +132 -0
  94. data/examples/v201101/delete_ad.rb +94 -0
  95. data/examples/v201101/delete_ad_group.rb +86 -0
  96. data/examples/v201101/delete_ad_group_criterion.rb +95 -0
  97. data/examples/v201101/delete_bulk_mutate_job.rb +96 -0
  98. data/examples/v201101/delete_campaign.rb +87 -0
  99. data/examples/v201101/delete_experiment.rb +87 -0
  100. data/examples/v201101/delete_user_list.rb +87 -0
  101. data/examples/v201101/download_report.rb +71 -0
  102. data/examples/v201101/get_ad_group_bid_landscape.rb +103 -0
  103. data/examples/v201101/get_all_account_changes.rb +146 -0
  104. data/examples/v201101/get_all_active_ad_group_criteria.rb +106 -0
  105. data/examples/v201101/get_all_ad_group_criteria.rb +97 -0
  106. data/examples/v201101/get_all_ad_groups.rb +94 -0
  107. data/examples/v201101/get_all_ads.rb +99 -0
  108. data/examples/v201101/get_all_campaign_targets.rb +83 -0
  109. data/examples/v201101/get_all_campaigns.rb +86 -0
  110. data/examples/v201101/get_all_conversions.rb +88 -0
  111. data/examples/v201101/get_all_disapproved_ads.rb +102 -0
  112. data/examples/v201101/get_all_experiments.rb +98 -0
  113. data/examples/v201101/get_all_images.rb +90 -0
  114. data/examples/v201101/get_all_paused_campaigns.rb +92 -0
  115. data/examples/v201101/get_all_report_definitions.rb +84 -0
  116. data/examples/v201101/get_all_user_lists.rb +87 -0
  117. data/examples/v201101/get_bulk_mutate_job.rb +106 -0
  118. data/examples/v201101/get_campaign_alerts.rb +103 -0
  119. data/examples/v201101/get_criterion_bid_landscape.rb +102 -0
  120. data/examples/v201101/get_geo_location_info.rb +108 -0
  121. data/examples/v201101/get_related_placements.rb +114 -0
  122. data/examples/v201101/get_report_fields.rb +81 -0
  123. data/examples/v201101/perform_bulk_mutate_job.rb +222 -0
  124. data/examples/v201101/promote_experiment.rb +88 -0
  125. data/examples/v201101/set_campaign_targets.rb +111 -0
  126. data/examples/v201101/update_ad.rb +95 -0
  127. data/examples/v201101/update_ad_group.rb +90 -0
  128. data/examples/v201101/update_ad_group_criterion.rb +108 -0
  129. data/examples/v201101/update_campaign.rb +93 -0
  130. data/examples/v201101/update_conversion.rb +96 -0
  131. data/examples/v201101/update_user_list.rb +91 -0
  132. data/examples/v201101/upload_image.rb +97 -0
  133. metadata +208 -0
@@ -0,0 +1,83 @@
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 all the campaigns for an account.
21
+ #
22
+ # Tags: CampaignService.get
23
+
24
+ require 'rubygems'
25
+ gem 'google-adwords-api'
26
+ require 'adwords_api'
27
+
28
+ API_VERSION = :v201008
29
+
30
+ def get_all_campaigns()
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
+ campaign_srv = adwords.service(:CampaignService, API_VERSION)
35
+
36
+ # Get all the campaigns for this account; empty selector.
37
+ selector = {}
38
+ response = campaign_srv.get(selector)
39
+
40
+ if response and response[:entries]
41
+ campaigns = response[:entries]
42
+ campaigns.each do |campaign|
43
+ puts "Campaign name is \"#{campaign[:name]}\", id is #{campaign[:id]} " +
44
+ "and status is \"#{campaign[:status]}\"."
45
+ end
46
+ else
47
+ puts "No campaigns were found."
48
+ end
49
+ end
50
+
51
+ if __FILE__ == $0
52
+ # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
53
+ # variable to 'true'. This can be done either from your operating system
54
+ # environment or via code, as done below.
55
+ ENV['ADWORDSAPI_DEBUG'] = 'false'
56
+
57
+ begin
58
+ get_all_campaigns()
59
+
60
+ # Connection error. Likely transitory.
61
+ rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
62
+ puts 'Connection Error: %s' % e
63
+ puts 'Source: %s' % e.backtrace.first
64
+
65
+ # API Error.
66
+ rescue AdwordsApi::Errors::ApiException => e
67
+ puts 'API Exception caught.'
68
+ puts 'Message: %s' % e.message
69
+ puts 'Code: %d' % e.code if e.code
70
+ puts 'Trigger: %s' % e.trigger if e.trigger
71
+ puts 'Errors:'
72
+ if e.errors
73
+ e.errors.each_with_index do |error, index|
74
+ puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
75
+ error.each_pair do |field, value|
76
+ if field != :xsi_type
77
+ puts ' %s: %s' % [field, value]
78
+ end
79
+ end
80
+ end
81
+ end
82
+ end
83
+ end
@@ -0,0 +1,94 @@
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 all the disapproved ads in a given
21
+ # campaign. To add ads, run add_ads.rb.
22
+ #
23
+ # Tags: AdGroupAdService.get
24
+
25
+ require 'rubygems'
26
+ gem 'google-adwords-api'
27
+ require 'adwords_api'
28
+
29
+ API_VERSION = :v201008
30
+
31
+ def get_all_disapproved_ads()
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
+ ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
36
+
37
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
38
+
39
+ # Get all the disapproved ads for this campaign.
40
+ selector = {
41
+ :campaign_ids => [campaign_id]
42
+ }
43
+ response = ad_group_ad_srv.get(selector)
44
+ if response and response[:entries]
45
+ ad_group_ads = response[:entries]
46
+ disapproved_ads = []
47
+ disapproved_ads = ad_group_ads.select do |ad_group_ad|
48
+ ad_group_ad[:ad][:approval_status] == 'DISAPPROVED'
49
+ end
50
+ puts "Campaign ##{campaign_id} has #{disapproved_ads.length} " +
51
+ "disapproved ad(s)."
52
+ disapproved_ads.each do |ad_group_ad|
53
+ puts " Ad id is #{ad_group_ad[:ad][:id]}, type is " +
54
+ "#{ad_group_ad[:ad][:xsi_type]} and status is " +
55
+ "\"#{ad_group_ad[:status]}\"."
56
+ end
57
+ else
58
+ puts "No disapproved ads found for campaign ##{campaign_id}."
59
+ end
60
+ end
61
+
62
+ if __FILE__ == $0
63
+ # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
64
+ # variable to 'true'. This can be done either from your operating system
65
+ # environment or via code, as done below.
66
+ ENV['ADWORDSAPI_DEBUG'] = 'false'
67
+
68
+ begin
69
+ get_all_disapproved_ads()
70
+
71
+ # Connection error. Likely transitory.
72
+ rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
73
+ puts 'Connection Error: %s' % e
74
+ puts 'Source: %s' % e.backtrace.first
75
+
76
+ # API Error.
77
+ rescue AdwordsApi::Errors::ApiException => e
78
+ puts 'API Exception caught.'
79
+ puts 'Message: %s' % e.message
80
+ puts 'Code: %d' % e.code if e.code
81
+ puts 'Trigger: %s' % e.trigger if e.trigger
82
+ puts 'Errors:'
83
+ if e.errors
84
+ e.errors.each_with_index do |error, index|
85
+ puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
86
+ error.each_pair do |field, value|
87
+ if field != :xsi_type
88
+ puts ' %s: %s' % [field, value]
89
+ end
90
+ end
91
+ end
92
+ end
93
+ end
94
+ end
@@ -0,0 +1,93 @@
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 all experiments in a campaign. To add an experiment, run
21
+ # add_experiment.rb. To get campaigns, run get_all_campaigns.rb.
22
+ #
23
+ # Tags: ExperimentService.get
24
+
25
+ require 'rubygems'
26
+ gem 'google-adwords-api'
27
+ require 'adwords_api'
28
+
29
+ API_VERSION = :v201008
30
+
31
+ def get_all_experiments()
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
+ experiment_srv = adwords.service(:ExperimentService, API_VERSION)
36
+
37
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
38
+
39
+ # Get all the experiments for this campaign.
40
+ selector = {
41
+ :campaign_ids => [campaign_id],
42
+ :include_stats => true
43
+ }
44
+ response = experiment_srv.get(selector)
45
+
46
+ if response and response[:entries]
47
+ experiments = response[:entries]
48
+ experiments.each do |experiment|
49
+ experiment_stats = experiment[:experiment_summary_stats]
50
+ puts "Experiment with name \"#{experiment[:name]}\", " +
51
+ "id #{experiment[:id]} and control id " +
52
+ "#{experiment[:control_id]} was found and it includes " +
53
+ "#{experiment_stats[:ad_groups_count]} ad group(s) and " +
54
+ "#{experiment_stats[:ad_group_criteria_count]} criteria.\n"
55
+ end
56
+ else
57
+ puts "No experiments were found."
58
+ end
59
+ end
60
+
61
+ if __FILE__ == $0
62
+ # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
63
+ # variable to 'true'. This can be done either from your operating system
64
+ # environment or via code, as done below.
65
+ ENV['ADWORDSAPI_DEBUG'] = 'false'
66
+
67
+ begin
68
+ get_all_experiments()
69
+
70
+ # Connection error. Likely transitory.
71
+ rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
72
+ puts 'Connection Error: %s' % e
73
+ puts 'Source: %s' % e.backtrace.first
74
+
75
+ # API Error.
76
+ rescue AdwordsApi::Errors::ApiException => e
77
+ puts 'API Exception caught.'
78
+ puts 'Message: %s' % e.message
79
+ puts 'Code: %d' % e.code if e.code
80
+ puts 'Trigger: %s' % e.trigger if e.trigger
81
+ puts 'Errors:'
82
+ if e.errors
83
+ e.errors.each_with_index do |error, index|
84
+ puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
85
+ error.each_pair do |field, value|
86
+ if field != :xsi_type
87
+ puts ' %s: %s' % [field, value]
88
+ end
89
+ end
90
+ end
91
+ end
92
+ end
93
+ end
@@ -0,0 +1,88 @@
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 all images. To upload an image, run
21
+ # upload_image.rb.
22
+ #
23
+ # Tags: MediaService.get
24
+
25
+ require 'rubygems'
26
+ gem 'google-adwords-api'
27
+ require 'adwords_api'
28
+
29
+ API_VERSION = :v201008
30
+
31
+ def get_all_images()
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
+ media_srv = adwords.service(:MediaService, API_VERSION)
36
+
37
+ # Get all the images.
38
+ selector = {
39
+ :media_type => 'IMAGE'
40
+ }
41
+ response = media_srv.get(selector)
42
+ if response and response[:entries]
43
+ images = response[:entries]
44
+ puts "#{images.length} images(s) found."
45
+ images.each do |image|
46
+ dimensions = AdwordsApi::Utils.map(image[:dimensions])
47
+ puts " Image id is #{image[:media_id]}, dimensions are " +
48
+ "#{dimensions['FULL'][:height]}x#{dimensions['FULL'][:width]} " +
49
+ "and MIME type is \"#{image[:mime_type]}\"."
50
+ end
51
+ else
52
+ puts "No images found."
53
+ end
54
+ end
55
+
56
+ if __FILE__ == $0
57
+ # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
58
+ # variable to 'true'. This can be done either from your operating system
59
+ # environment or via code, as done below.
60
+ ENV['ADWORDSAPI_DEBUG'] = 'false'
61
+
62
+ begin
63
+ get_all_images()
64
+
65
+ # Connection error. Likely transitory.
66
+ rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
67
+ puts 'Connection Error: %s' % e
68
+ puts 'Source: %s' % e.backtrace.first
69
+
70
+ # API Error.
71
+ rescue AdwordsApi::Errors::ApiException => e
72
+ puts 'API Exception caught.'
73
+ puts 'Message: %s' % e.message
74
+ puts 'Code: %d' % e.code if e.code
75
+ puts 'Trigger: %s' % e.trigger if e.trigger
76
+ puts 'Errors:'
77
+ if e.errors
78
+ e.errors.each_with_index do |error, index|
79
+ puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
80
+ error.each_pair do |field, value|
81
+ if field != :xsi_type
82
+ puts ' %s: %s' % [field, value]
83
+ end
84
+ end
85
+ end
86
+ end
87
+ end
88
+ end
@@ -0,0 +1,86 @@
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 all the paused campaigns for an
21
+ # account.
22
+ #
23
+ # Tags: CampaignService.get
24
+
25
+ require 'rubygems'
26
+ gem 'google-adwords-api'
27
+ require 'adwords_api'
28
+
29
+ API_VERSION = :v201008
30
+
31
+ def get_all_paused_campaigns()
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
+ campaign_srv = adwords.service(:CampaignService, API_VERSION)
36
+
37
+ # Get all the paused campaigns for this account.
38
+ selector = {
39
+ :campaign_statuses => 'PAUSED'
40
+ }
41
+ response = campaign_srv.get(selector)
42
+
43
+ if response and response[:entries]
44
+ campaigns = response[:entries]
45
+ campaigns.each do |campaign|
46
+ puts "Campaign name is \"#{campaign[:name]}\", id is #{campaign[:id]} " +
47
+ "and status is \"#{campaign[:status]}\"."
48
+ end
49
+ else
50
+ puts "No campaigns were found."
51
+ end
52
+ end
53
+
54
+ if __FILE__ == $0
55
+ # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
56
+ # variable to 'true'. This can be done either from your operating system
57
+ # environment or via code, as done below.
58
+ ENV['ADWORDSAPI_DEBUG'] = 'false'
59
+
60
+ begin
61
+ get_all_paused_campaigns()
62
+
63
+ # Connection error. Likely transitory.
64
+ rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
65
+ puts 'Connection Error: %s' % e
66
+ puts 'Source: %s' % e.backtrace.first
67
+
68
+ # API Error.
69
+ rescue AdwordsApi::Errors::ApiException => e
70
+ puts 'API Exception caught.'
71
+ puts 'Message: %s' % e.message
72
+ puts 'Code: %d' % e.code if e.code
73
+ puts 'Trigger: %s' % e.trigger if e.trigger
74
+ puts 'Errors:'
75
+ if e.errors
76
+ e.errors.each_with_index do |error, index|
77
+ puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
78
+ error.each_pair do |field, value|
79
+ if field != :xsi_type
80
+ puts ' %s: %s' % [field, value]
81
+ end
82
+ end
83
+ end
84
+ end
85
+ end
86
+ end
@@ -0,0 +1,84 @@
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 all report definitions. To add a report definition, run
21
+ # add_keywords_performance_report.rb.
22
+ #
23
+ # Tags: ReportDefinitionService.get
24
+
25
+ require 'rubygems'
26
+ gem 'google-adwords-api'
27
+ require 'adwords_api'
28
+
29
+ API_VERSION = :v201008
30
+
31
+ def get_all_report_definitions()
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
+ report_def_srv = adwords.service(:ReportDefinitionService, API_VERSION)
36
+
37
+ # Get all the report definitions.
38
+ selector = {}
39
+ response = report_def_srv.get(selector)
40
+ if response and response[:entries]
41
+ entries = response[:entries]
42
+ puts "#{entries.length} report definition(s) found."
43
+ entries.each do |entry|
44
+ puts " Report definition id is #{entry[:id]} and name is " +
45
+ "\"#{entry[:report_name]}\"."
46
+ end
47
+ else
48
+ puts "No report definitions found."
49
+ end
50
+ end
51
+
52
+ if __FILE__ == $0
53
+ # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
54
+ # variable to 'true'. This can be done either from your operating system
55
+ # environment or via code, as done below.
56
+ ENV['ADWORDSAPI_DEBUG'] = 'false'
57
+
58
+ begin
59
+ get_all_report_definitions()
60
+
61
+ # Connection error. Likely transitory.
62
+ rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
63
+ puts 'Connection Error: %s' % e
64
+ puts 'Source: %s' % e.backtrace.first
65
+
66
+ # API Error.
67
+ rescue AdwordsApi::Errors::ApiException => e
68
+ puts 'API Exception caught.'
69
+ puts 'Message: %s' % e.message
70
+ puts 'Code: %d' % e.code if e.code
71
+ puts 'Trigger: %s' % e.trigger if e.trigger
72
+ puts 'Errors:'
73
+ if e.errors
74
+ e.errors.each_with_index do |error, index|
75
+ puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
76
+ error.each_pair do |field, value|
77
+ if field != :xsi_type
78
+ puts ' %s: %s' % [field, value]
79
+ end
80
+ end
81
+ end
82
+ end
83
+ end
84
+ end