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,87 @@
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 deletes a campaign by setting the status to 'DELETED'. To get
21
+ # campaigns, run get_all_campaigns.rb.
22
+ #
23
+ # Tags: CampaignService.mutate
24
+
25
+ require 'rubygems'
26
+ gem 'google-adwords-api'
27
+ require 'adwords_api'
28
+
29
+ API_VERSION = :v201003
30
+
31
+ def delete_campaign()
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
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
38
+
39
+ # Prepare for deleting campaign.
40
+ operation = {
41
+ :operator => 'SET',
42
+ :operand => {
43
+ :id => campaign_id,
44
+ :status => 'DELETED',
45
+ }
46
+ }
47
+
48
+ # Delete campaign.
49
+ response = campaign_srv.mutate([operation])
50
+ campaign = response[:value].first
51
+ puts 'Campaign with name "%s" and id %d was deleted.' %
52
+ [campaign[:name], campaign[:id]]
53
+ end
54
+
55
+ if __FILE__ == $0
56
+ # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
57
+ # variable to 'true'. This can be done either from your operating system
58
+ # environment or via code, as done below.
59
+ ENV['ADWORDSAPI_DEBUG'] = 'false'
60
+
61
+ begin
62
+ delete_campaign()
63
+
64
+ # Connection error. Likely transitory.
65
+ rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
66
+ puts 'Connection Error: %s' % e
67
+ puts 'Source: %s' % e.backtrace.first
68
+
69
+ # API Error.
70
+ rescue AdwordsApi::Errors::ApiException => e
71
+ puts 'API Exception caught.'
72
+ puts 'Message: %s' % e.message
73
+ puts 'Code: %d' % e.code if e.code
74
+ puts 'Trigger: %s' % e.trigger if e.trigger
75
+ puts 'Errors:'
76
+ if e.errors
77
+ e.errors.each_with_index do |error, index|
78
+ puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
79
+ error.each_pair do |field, value|
80
+ if field != :xsi_type
81
+ puts ' %s: %s' % [field, value]
82
+ end
83
+ end
84
+ end
85
+ end
86
+ end
87
+ end
@@ -0,0 +1,71 @@
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 and downloads a report from a report definition. To get a
21
+ # report definition, run add_keywords_performance_report_definition.rb.
22
+
23
+ require 'rubygems'
24
+ gem 'google-adwords-api'
25
+ require 'adwords_api'
26
+
27
+ API_VERSION = :v201003
28
+
29
+ def download_report()
30
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
31
+ # when called without parameters.
32
+ adwords = AdwordsApi::Api.new
33
+ report_def_srv = adwords.service(:ReportDefinitionService, API_VERSION)
34
+
35
+ report_definition_id = 'INSERT_REPORT_DEFINITION_ID'.to_i
36
+ file_name = 'INSERT_OUTPUT_FILE_NAME_HERE'
37
+
38
+ # Download report, using "download_report_as_file" extension method.
39
+ report_def_srv.download_report_as_file(report_definition_id, file_name)
40
+ puts 'Report with definition id %d was downloaded to \'%s\'.' %
41
+ [report_definition_id, file_name]
42
+ end
43
+
44
+ if __FILE__ == $0
45
+ begin
46
+ download_report()
47
+
48
+ # Connection error. Likely transitory.
49
+ rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
50
+ puts 'Connection Error: %s' % e
51
+ puts 'Source: %s' % e.backtrace.first
52
+
53
+ # API Error.
54
+ rescue AdwordsApi::Errors::ApiException => e
55
+ puts 'API Exception caught.'
56
+ puts 'Message: %s' % e.message
57
+ puts 'Code: %d' % e.code if e.code
58
+ puts 'Trigger: %s' % e.trigger if e.trigger
59
+ puts 'Errors:'
60
+ if e.errors
61
+ e.errors.each_with_index do |error, index|
62
+ puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
63
+ error.each_pair do |field, value|
64
+ if field != :xsi_type
65
+ puts ' %s: %s' % [field, value]
66
+ end
67
+ end
68
+ end
69
+ end
70
+ end
71
+ 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 illustrates how to retrieve all the active criteria for an ad
21
+ # group. To add criteria to an existing ad group, run add_ad_group_criteria.rb.
22
+ #
23
+ # Tags: AdGroupCriterionService.get
24
+
25
+ require 'rubygems'
26
+ gem 'google-adwords-api'
27
+ require 'adwords_api'
28
+
29
+ API_VERSION = :v201003
30
+
31
+ def get_all_active_ad_group_criteria()
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_criterion_srv =
36
+ adwords.service(:AdGroupCriterionService, API_VERSION)
37
+
38
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
39
+
40
+ # Get all the active criteria for this ad group
41
+ selector = {
42
+ :id_filters => [{
43
+ :ad_group_id => ad_group_id
44
+ }],
45
+ :user_statuses => ['ACTIVE']
46
+ }
47
+ response = ad_group_criterion_srv.get(selector)
48
+ if response and response[:entries]
49
+ ad_group_criteria = response[:entries]
50
+ puts "Ad group ##{ad_group_id} has #{ad_group_criteria.length} active " +
51
+ "criteria."
52
+ ad_group_criteria.each do |ad_group_criterion|
53
+ puts " Criterion id is #{ad_group_criterion[:criterion][:id]} and " +
54
+ "type is #{ad_group_criterion[:criterion][:xsi_type]}."
55
+ end
56
+ else
57
+ puts "No active criteria found for ad group ##{ad_group_id}."
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_active_ad_group_criteria()
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,91 @@
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 criteria for an ad group.
21
+ # To add criteria to an existing ad group, run add_ad_group_criteria.rb.
22
+ #
23
+ # Tags: AdGroupCriterionService.get
24
+
25
+ require 'rubygems'
26
+ gem 'google-adwords-api'
27
+ require 'adwords_api'
28
+
29
+ API_VERSION = :v201003
30
+
31
+ def get_all_ad_group_criteria()
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_criterion_srv =
36
+ adwords.service(:AdGroupCriterionService, API_VERSION)
37
+
38
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
39
+
40
+ # Get all the criteria for this ad group.
41
+ selector = {
42
+ :id_filters => [{
43
+ :ad_group_id => ad_group_id
44
+ }]
45
+ }
46
+ response = ad_group_criterion_srv.get(selector)
47
+ if response and response[:entries]
48
+ ad_group_criteria = response[:entries]
49
+ puts "Ad group ##{ad_group_id} has #{ad_group_criteria.length} criteria."
50
+ ad_group_criteria.each do |ad_group_criterion|
51
+ puts " Criterion id is #{ad_group_criterion[:criterion][:id]} and " +
52
+ "type is #{ad_group_criterion[:criterion][:xsi_type]}."
53
+ end
54
+ else
55
+ puts "No criteria found for ad group ##{ad_group_id}."
56
+ end
57
+ end
58
+
59
+ if __FILE__ == $0
60
+ # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
61
+ # variable to 'true'. This can be done either from your operating system
62
+ # environment or via code, as done below.
63
+ ENV['ADWORDSAPI_DEBUG'] = 'false'
64
+
65
+ begin
66
+ get_all_ad_group_criteria()
67
+
68
+ # Connection error. Likely transitory.
69
+ rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
70
+ puts 'Connection Error: %s' % e
71
+ puts 'Source: %s' % e.backtrace.first
72
+
73
+ # API Error.
74
+ rescue AdwordsApi::Errors::ApiException => e
75
+ puts 'API Exception caught.'
76
+ puts 'Message: %s' % e.message
77
+ puts 'Code: %d' % e.code if e.code
78
+ puts 'Trigger: %s' % e.trigger if e.trigger
79
+ puts 'Errors:'
80
+ if e.errors
81
+ e.errors.each_with_index do |error, index|
82
+ puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
83
+ error.each_pair do |field, value|
84
+ if field != :xsi_type
85
+ puts ' %s: %s' % [field, value]
86
+ end
87
+ end
88
+ end
89
+ end
90
+ end
91
+ 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 the ad groups for a campaign. To
21
+ # create an ad group, run add_ad_group.rb.
22
+ #
23
+ # Tags: AdGroupService.get
24
+
25
+ require 'rubygems'
26
+ gem 'google-adwords-api'
27
+ require 'adwords_api'
28
+
29
+ API_VERSION = :v201003
30
+
31
+ def get_all_ad_groups()
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_srv = adwords.service(:AdGroupService, API_VERSION)
36
+
37
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
38
+
39
+ # Get all the ad groups for this campaign.
40
+ selector = {
41
+ :campaign_ids => [campaign_id]
42
+ }
43
+ response = ad_group_srv.get(selector)
44
+ if response and response[:entries]
45
+ ad_groups = response[:entries]
46
+ puts "Campaign ##{campaign_id} has #{ad_groups.length} ad group(s)."
47
+ ad_groups.each do |ad_group|
48
+ puts " Ad group name is \"#{ad_group[:name]}\" and id is " +
49
+ "#{ad_group[:id]}."
50
+ end
51
+ else
52
+ puts "No ad groups found for campaign ##{campaign_id}."
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_ad_groups()
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,91 @@
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 ads for an ad group. To add
21
+ # ads to an existing ad group, 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 = :v201003
30
+
31
+ def get_all_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
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
38
+
39
+ # Get all the ads for this ad group.
40
+ selector = {
41
+ :ad_group_ids => [ad_group_id],
42
+ # By default, disabled ads aren't returned by the selector. To return them,
43
+ # include the DISABLED status in the statuses field.
44
+ :statuses => ['ENABLED', 'PAUSED', 'DISABLED']
45
+ }
46
+ response = ad_group_ad_srv.get(selector)
47
+ if response and response[:entries]
48
+ ads = response[:entries]
49
+ puts "Ad group ##{ad_group_id} has #{ads.length} ad(s)."
50
+ ads.each do |ad|
51
+ puts " Ad id is #{ad[:ad][:id]}, type is #{ad[:ad][:xsi_type]} and " +
52
+ "status is \"#{ad[:status]}\"."
53
+ end
54
+ else
55
+ puts "No ads found for ad group ##{ad_group_id}."
56
+ end
57
+ end
58
+
59
+ if __FILE__ == $0
60
+ # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
61
+ # variable to 'true'. This can be done either from your operating system
62
+ # environment or via code, as done below.
63
+ ENV['ADWORDSAPI_DEBUG'] = 'false'
64
+
65
+ begin
66
+ get_all_ads()
67
+
68
+ # Connection error. Likely transitory.
69
+ rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
70
+ puts 'Connection Error: %s' % e
71
+ puts 'Source: %s' % e.backtrace.first
72
+
73
+ # API Error.
74
+ rescue AdwordsApi::Errors::ApiException => e
75
+ puts 'API Exception caught.'
76
+ puts 'Message: %s' % e.message
77
+ puts 'Code: %d' % e.code if e.code
78
+ puts 'Trigger: %s' % e.trigger if e.trigger
79
+ puts 'Errors:'
80
+ if e.errors
81
+ e.errors.each_with_index do |error, index|
82
+ puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
83
+ error.each_pair do |field, value|
84
+ if field != :xsi_type
85
+ puts ' %s: %s' % [field, value]
86
+ end
87
+ end
88
+ end
89
+ end
90
+ end
91
+ end