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,132 @@
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 shows how to use the 'validate only' header. No objects will be
21
+ # created, but exceptions will still be thrown.
22
+ #
23
+ # Tags: CampaignService.mutate
24
+
25
+ require 'rubygems'
26
+ gem 'google-adwords-api'
27
+ require 'adwords_api'
28
+
29
+ API_VERSION = :v201008
30
+
31
+ def check_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
+ # Enable 'validate only'
38
+ adwords.validate_only = true
39
+
40
+ # Prepare for adding campaign.
41
+ operation = {
42
+ :operator => 'ADD',
43
+ :operand => {
44
+ :name => 'Interplanetary Cruise #%s' % (Time.new.to_f * 1000).to_i,
45
+ :status => 'PAUSED',
46
+ :bidding_strategy => {
47
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
48
+ # being created. It's only necessary when you must provide an explicit
49
+ # type that the client library can't infer.
50
+ :xsi_type => 'ManualCPM'
51
+ },
52
+ :budget => {
53
+ :period => 'DAILY',
54
+ :amount => {
55
+ :micro_amount => 50000000
56
+ },
57
+ :delivery_method => 'STANDARD'
58
+ }
59
+ }
60
+ }
61
+
62
+ # Validate campaign add operation.
63
+ response = campaign_srv.mutate([operation])
64
+ if response and response[:value]
65
+ campaigns = response[:value]
66
+ campaigns.each do |campaign|
67
+ puts "Unexpected campaign creation! Name \"#{campaign[:name]}\", id " +
68
+ "#{campaign[:id]} and status is \"#{campaign[:status]}\"."
69
+ end
70
+ else
71
+ puts 'No campaigns created.'
72
+ end
73
+
74
+ # Provide an invalid bidding strategy that will cause an exception during
75
+ # validation.
76
+ operation = {
77
+ :operator => 'ADD',
78
+ :operand => {
79
+ :name => 'Interplanetary Cruise #%s' % (Time.new.to_f * 1000).to_i,
80
+ :status => 'PAUSED',
81
+ :bidding_strategy => nil,
82
+ :budget => {
83
+ :period => 'DAILY',
84
+ :amount => {
85
+ :micro_amount => 50000000
86
+ },
87
+ :delivery_method => 'STANDARD'
88
+ }
89
+ }
90
+ }
91
+
92
+ # Validate campaign add operation.
93
+ begin
94
+ response = campaign_srv.mutate([operation])
95
+ rescue AdwordsApi::Errors::ApiException => e
96
+ puts "Validation correctly failed: #{e.message}"
97
+ end
98
+ end
99
+
100
+ if __FILE__ == $0
101
+ # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
102
+ # variable to 'true'. This can be done either from your operating system
103
+ # environment or via code, as done below.
104
+ ENV['ADWORDSAPI_DEBUG'] = 'false'
105
+
106
+ begin
107
+ check_campaigns()
108
+
109
+ # Connection error. Likely transitory.
110
+ rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
111
+ puts 'Connection Error: %s' % e
112
+ puts 'Source: %s' % e.backtrace.first
113
+
114
+ # API Error.
115
+ rescue AdwordsApi::Errors::ApiException => e
116
+ puts 'API Exception caught.'
117
+ puts 'Message: %s' % e.message
118
+ puts 'Code: %d' % e.code if e.code
119
+ puts 'Trigger: %s' % e.trigger if e.trigger
120
+ puts 'Errors:'
121
+ if e.errors
122
+ e.errors.each_with_index do |error, index|
123
+ puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
124
+ error.each_pair do |field, value|
125
+ if field != :xsi_type
126
+ puts ' %s: %s' % [field, value]
127
+ end
128
+ end
129
+ end
130
+ end
131
+ end
132
+ 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 deletes an ad using the 'REMOVE' operator. To get ads,
21
+ # run get_all_ads.rb.
22
+ #
23
+ # Tags: AdGroupAdService.mutate
24
+
25
+ require 'rubygems'
26
+ gem 'google-adwords-api'
27
+ require 'adwords_api'
28
+
29
+ API_VERSION = :v201008
30
+
31
+ def delete_ad()
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
+ ad_id = 'INSERT_AD_ID_HERE'.to_i
39
+
40
+ # Prepare for deleting ad.
41
+ operation = {
42
+ :operator => 'REMOVE',
43
+ :operand => {
44
+ :ad_group_id => ad_group_id,
45
+ :ad => {
46
+ :xsi_type => 'Ad',
47
+ :id => ad_id
48
+ }
49
+ }
50
+ }
51
+
52
+ # Delete ad.
53
+ response = ad_group_ad_srv.mutate([operation])
54
+ if response and response[:value]
55
+ ad = response[:value].first
56
+ puts 'Ad id %d was successfully deleted.' % ad[:ad][:id]
57
+ else
58
+ puts 'No ads were deleted.'
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
+ delete_ad()
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,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 deletes an ad group by setting the status to 'DELETED'.
21
+ # To get ad groups, run get_all_ad_groups.rb.
22
+ #
23
+ # Tags: AdGroupService.mutate
24
+
25
+ require 'rubygems'
26
+ gem 'google-adwords-api'
27
+ require 'adwords_api'
28
+
29
+ API_VERSION = :v201008
30
+
31
+ def delete_ad_group()
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
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
38
+
39
+ # Prepare for deleting ad group.
40
+ operation = {
41
+ :operator => 'SET',
42
+ :operand => {
43
+ :status => 'DELETED',
44
+ :id => ad_group_id
45
+ }
46
+ }
47
+
48
+ # Delete ad group.
49
+ response = ad_group_srv.mutate([operation])
50
+ ad_group = response[:value].first
51
+ puts 'Ad group id %d was successfully deleted.' % ad_group[:id]
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
+ delete_ad_group()
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,95 @@
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 an ad group criterion using the 'REMOVE' operator. To
21
+ # get ad group criteria, run get_all_ad_group_criteria.rb.
22
+ #
23
+ # Tags: AdGroupCriterionService.mutate
24
+
25
+ require 'rubygems'
26
+ gem 'google-adwords-api'
27
+ require 'adwords_api'
28
+
29
+ API_VERSION = :v201008
30
+
31
+ def delete_ad_group_criterion()
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
+ criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
40
+
41
+ # Prepare for deleting ad group criterion.
42
+ operation = {
43
+ :operator => 'REMOVE',
44
+ :operand => {
45
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
46
+ # being created. It's only necessary when you must provide an explicit
47
+ # type that the client library can't infer.
48
+ :xsi_type => 'BiddableAdGroupCriterion',
49
+ :ad_group_id => ad_group_id,
50
+ :criterion => {
51
+ :id => criterion_id
52
+ }
53
+ }
54
+ }
55
+
56
+ # Delete criterion.
57
+ response = ad_group_criterion_srv.mutate([operation])
58
+ ad_group_criterion = response[:value].first
59
+ puts 'Criterion id %d was successfully deleted.' %
60
+ ad_group_criterion[:criterion][:id]
61
+ end
62
+
63
+ if __FILE__ == $0
64
+ # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
65
+ # variable to 'true'. This can be done either from your operating system
66
+ # environment or via code, as done below.
67
+ ENV['ADWORDSAPI_DEBUG'] = 'false'
68
+
69
+ begin
70
+ delete_ad_group_criterion()
71
+
72
+ # Connection error. Likely transitory.
73
+ rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
74
+ puts 'Connection Error: %s' % e
75
+ puts 'Source: %s' % e.backtrace.first
76
+
77
+ # API Error.
78
+ rescue AdwordsApi::Errors::ApiException => e
79
+ puts 'API Exception caught.'
80
+ puts 'Message: %s' % e.message
81
+ puts 'Code: %d' % e.code if e.code
82
+ puts 'Trigger: %s' % e.trigger if e.trigger
83
+ puts 'Errors:'
84
+ if e.errors
85
+ e.errors.each_with_index do |error, index|
86
+ puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
87
+ error.each_pair do |field, value|
88
+ if field != :xsi_type
89
+ puts ' %s: %s' % [field, value]
90
+ end
91
+ end
92
+ end
93
+ end
94
+ end
95
+ end
@@ -0,0 +1,96 @@
1
+ #!/usr/bin/ruby
2
+ #
3
+ # Author:: sgomes@google.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 bulk mutate job using the 'REMOVE' operator. Jobs may
21
+ # only deleted if they are in the 'PENDING' state and have not yet recieved
22
+ # all of their request parts. To get bulk mutate jobs, run
23
+ # get_all_bulk_mutate_jobs.rb.
24
+ #
25
+ # Tags: BulkMutateJobService.mutate
26
+
27
+ require 'rubygems'
28
+ gem 'google-adwords-api'
29
+ require 'adwords_api'
30
+
31
+ API_VERSION = :v201008
32
+
33
+ def delete_bulk_mutate_job()
34
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
35
+ # when called without parameters.
36
+ adwords = AdwordsApi::Api.new
37
+ bulk_mutate_job_srv = adwords.service(:BulkMutateJobService, API_VERSION)
38
+
39
+ job_id = 'INSERT_BULK_MUTATE_JOB_ID_HERE'
40
+
41
+ # Create operation.
42
+ operation = {
43
+ :operator => 'REMOVE',
44
+ :operand => {
45
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
46
+ # being created. It's only necessary when you must provide an explicit
47
+ # type that the client library can't infer.
48
+ :xsi_type => 'BulkMutateJob',
49
+ :id => job_id
50
+ }
51
+ }
52
+
53
+ # Delete job.
54
+ response = bulk_mutate_job_srv.mutate(operation)
55
+ if response and response[:value]
56
+ job = response[:value].first
57
+ puts 'Job id %d was successfully deleted.' % job[:id]
58
+ else
59
+ puts 'No jobs were deleted.'
60
+ end
61
+
62
+ end
63
+
64
+ if __FILE__ == $0
65
+ # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
66
+ # variable to 'true'. This can be done either from your operating system
67
+ # environment or via code, as done below.
68
+ ENV['ADWORDSAPI_DEBUG'] = 'false'
69
+
70
+ begin
71
+ delete_bulk_mutate_job()
72
+
73
+ # Connection error. Likely transitory.
74
+ rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
75
+ puts 'Connection Error: %s' % e
76
+ puts 'Source: %s' % e.backtrace.first
77
+
78
+ # API Error.
79
+ rescue AdwordsApi::Errors::ApiException => e
80
+ puts 'API Exception caught.'
81
+ puts 'Message: %s' % e.message
82
+ puts 'Code: %d' % e.code if e.code
83
+ puts 'Trigger: %s' % e.trigger if e.trigger
84
+ puts 'Errors:'
85
+ if e.errors
86
+ e.errors.each_with_index do |error, index|
87
+ puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
88
+ error.each_pair do |field, value|
89
+ if field != :xsi_type
90
+ puts ' %s: %s' % [field, value]
91
+ end
92
+ end
93
+ end
94
+ end
95
+ end
96
+ end