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,108 @@
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 create a campaign.
21
+ #
22
+ # Tags: CampaignService.mutate
23
+
24
+ require 'rubygems'
25
+ gem 'google-adwords-api'
26
+ require 'adwords_api'
27
+
28
+ API_VERSION = :v201101
29
+
30
+ def add_campaign()
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
+ # Prepare for adding campaign.
37
+ operation = {
38
+ :operator => 'ADD',
39
+ :operand => {
40
+ :name => 'Interplanetary Cruise #%s' % (Time.new.to_f * 1000).to_i,
41
+ :status => 'PAUSED',
42
+ :bidding_strategy => {
43
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
44
+ # being created. It's only necessary when you must provide an explicit
45
+ # type that the client library can't infer.
46
+ :xsi_type => 'ManualCPM'
47
+ },
48
+ :budget => {
49
+ :period => 'DAILY',
50
+ :amount => {
51
+ :micro_amount => 50000000
52
+ },
53
+ :delivery_method => 'STANDARD'
54
+ },
55
+ # Set the campaign network options to Search and Search Network.
56
+ :network_setting => {
57
+ :target_google_search => true,
58
+ :target_search_network => true,
59
+ :target_content_network => false,
60
+ :target_content_contextual => false
61
+ }
62
+ }
63
+ }
64
+
65
+ # Add campaign.
66
+ response = campaign_srv.mutate([operation])
67
+ if response and response[:value]
68
+ campaign = response[:value].first
69
+ puts 'Campaign with name "%s" and id %d was added.' %
70
+ [campaign[:name], campaign[:id]]
71
+ else
72
+ puts 'No campaigns were added.'
73
+ end
74
+ end
75
+
76
+ if __FILE__ == $0
77
+ # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
78
+ # variable to 'true'. This can be done either from your operating system
79
+ # environment or via code, as done below.
80
+ ENV['ADWORDSAPI_DEBUG'] = 'false'
81
+
82
+ begin
83
+ add_campaign()
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
@@ -0,0 +1,97 @@
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 add an AdWords conversion.
21
+ #
22
+ # Tags: ConversionTrackerService.mutate
23
+
24
+ require 'rubygems'
25
+ gem 'google-adwords-api'
26
+ require 'adwords_api'
27
+
28
+ API_VERSION = :v201101
29
+
30
+ def add_conversion()
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
+ conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
35
+
36
+ # Prepare for adding conversion.
37
+ operation = {
38
+ :operator => 'ADD',
39
+ :operand => {
40
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
41
+ # being created. It's only necessary when you must provide an explicit
42
+ # type that the client library can't infer.
43
+ :xsi_type => 'AdWordsConversionTracker',
44
+ :name => 'Earth to Mars Cruises Conversion #%s' %
45
+ (Time.new.to_f * 1000).to_i,
46
+ :category => 'DEFAULT',
47
+ :markup_language => 'HTML',
48
+ :http_protocol => 'HTTP',
49
+ :text_format => 'HIDDEN'
50
+ }
51
+ }
52
+
53
+ # Add conversion.
54
+ response = conv_tracker_srv.mutate([operation])
55
+ if response and response[:value]
56
+ conversion = response[:value].first
57
+ puts "Conversion with id #{conversion[:id]}, name " +
58
+ "\"#{conversion[:name]}\", status \"#{conversion[:status]}\" and " +
59
+ " category \"#{conversion[:category]}\" was added."
60
+ else
61
+ puts 'No conversions were added.'
62
+ end
63
+ end
64
+
65
+ if __FILE__ == $0
66
+ # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
67
+ # variable to 'true'. This can be done either from your operating system
68
+ # environment or via code, as done below.
69
+ ENV['ADWORDSAPI_DEBUG'] = 'false'
70
+
71
+ begin
72
+ add_conversion()
73
+
74
+ # Connection error. Likely transitory.
75
+ rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
76
+ puts 'Connection Error: %s' % e
77
+ puts 'Source: %s' % e.backtrace.first
78
+
79
+ # API Error.
80
+ rescue AdwordsApi::Errors::ApiException => e
81
+ puts 'API Exception caught.'
82
+ puts 'Message: %s' % e.message
83
+ puts 'Code: %d' % e.code if e.code
84
+ puts 'Trigger: %s' % e.trigger if e.trigger
85
+ puts 'Errors:'
86
+ if e.errors
87
+ e.errors.each_with_index do |error, index|
88
+ puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
89
+ error.each_pair do |field, value|
90
+ if field != :xsi_type
91
+ puts ' %s: %s' % [field, value]
92
+ end
93
+ end
94
+ end
95
+ end
96
+ end
97
+ end
@@ -0,0 +1,162 @@
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 creates an experiment using a query percentage of 10, which
21
+ # defines what fraction of auctions should go to the control split (90%) vs.
22
+ # the experiment split (10%), then adds experimental bid changes for criteria
23
+ # and ad groups. To get campaigns, run get_all_campaigns.rb. To get ad groups,
24
+ # run get_all_ad_groups.rb. To get criteria, run get_all_ad_group_criteria.rb.
25
+ #
26
+ # Tags: ExperimentService.mutate
27
+
28
+ require 'rubygems'
29
+ gem 'google-adwords-api'
30
+ require 'adwords_api'
31
+
32
+ API_VERSION = :v201101
33
+
34
+ def add_experiment()
35
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
36
+ # when called without parameters.
37
+ adwords = AdwordsApi::Api.new
38
+ experiment_srv = adwords.service(:ExperimentService, API_VERSION)
39
+ ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
40
+ ad_group_criterion_srv =
41
+ adwords.service(:AdGroupCriterionService, API_VERSION)
42
+
43
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
44
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
45
+ criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
46
+
47
+ # Prepare for adding experiment.
48
+ operation = {
49
+ :operator => 'ADD',
50
+ :operand => {
51
+ :campaign_id => campaign_id,
52
+ :name => 'Interplanetary Experiment #%s' % (Time.new.to_f * 1000).to_i,
53
+ :query_percentage => 10,
54
+ :start_date_time => Time.now.strftime("%Y%m%d %H%M%S")
55
+ }
56
+ }
57
+
58
+ # Add experiment.
59
+ response = experiment_srv.mutate([operation])
60
+ experiment = response[:value].first
61
+ puts 'Experiment with name "%s" and id %d was added.' %
62
+ [experiment[:name], experiment[:id]]
63
+
64
+ experiment_id = experiment[:id]
65
+
66
+ # Setup ad group for the experiment.
67
+ ad_group = {
68
+ :id => ad_group_id,
69
+ # Set experiment data for the ad group.
70
+ :experiment_data => {
71
+ :experiment_id => experiment_id,
72
+ :experiment_delta_status => 'MODIFIED',
73
+ # Bid multiplier rule that will modify ad group bid for the experiment.
74
+ :experiment_bid_multipliers => {
75
+ :xsi_type => 'ManualCPCAdGroupExperimentBidMultipliers',
76
+ :max_cpc_multiplier => {
77
+ :multiplier => 1.5
78
+ }
79
+ }
80
+ }
81
+ }
82
+
83
+ # Prepare for updating ad group.
84
+ operation = {
85
+ :operator => 'SET',
86
+ :operand => ad_group
87
+ }
88
+
89
+ # Update ad group.
90
+ response = ad_group_srv.mutate([operation])
91
+ ad_group = response[:value].first
92
+ puts 'Ad group id %d was updated for the experiment.' % ad_group[:id]
93
+
94
+ # Setup ad group criterion for the experiment.
95
+ ad_group_criterion = {
96
+ :xsi_type => 'BiddableAdGroupCriterion',
97
+ :ad_group_id => ad_group_id,
98
+ :criterion => {
99
+ :id => criterion_id
100
+ },
101
+ # Set experiment data for the criterion.
102
+ :experiment_data => {
103
+ :xsi_type => 'BiddableAdGroupCriterionExperimentData',
104
+ :experiment_id => experiment_id,
105
+ :experiment_delta_status => 'MODIFIED',
106
+ # Bid multiplier rule that will modify criterion bid for the experiment.
107
+ :experiment_bid_multiplier => {
108
+ :xsi_type => 'ManualCPCAdGroupCriterionExperimentBidMultiplier',
109
+ :max_cpc_multiplier => {
110
+ :multiplier => 1.5
111
+ }
112
+ }
113
+ }
114
+ }
115
+
116
+ # Prepare for updating ad group criterion.
117
+ operation = {
118
+ :operator => 'SET',
119
+ :operand => ad_group_criterion
120
+ }
121
+
122
+ # Update criterion.
123
+ response = ad_group_criterion_srv.mutate([operation])
124
+ criterion = response[:value].first
125
+ puts 'Criterion id %d was successfully updated for the experiment.' %
126
+ [criterion[:criterion][:id]]
127
+
128
+ end
129
+
130
+ if __FILE__ == $0
131
+ # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
132
+ # variable to 'true'. This can be done either from your operating system
133
+ # environment or via code, as done below.
134
+ ENV['ADWORDSAPI_DEBUG'] = 'false'
135
+
136
+ begin
137
+ add_experiment()
138
+
139
+ # Connection error. Likely transitory.
140
+ rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
141
+ puts 'Connection Error: %s' % e
142
+ puts 'Source: %s' % e.backtrace.first
143
+
144
+ # API Error.
145
+ rescue AdwordsApi::Errors::ApiException => e
146
+ puts 'API Exception caught.'
147
+ puts 'Message: %s' % e.message
148
+ puts 'Code: %d' % e.code if e.code
149
+ puts 'Trigger: %s' % e.trigger if e.trigger
150
+ puts 'Errors:'
151
+ if e.errors
152
+ e.errors.each_with_index do |error, index|
153
+ puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
154
+ error.each_pair do |field, value|
155
+ if field != :xsi_type
156
+ puts ' %s: %s' % [field, value]
157
+ end
158
+ end
159
+ end
160
+ end
161
+ end
162
+ 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 illustrates how to create a negative campaign criterion for a
21
+ # given campaign. To create a campaign, run add_campaign.rb.
22
+ #
23
+ # Tags: CampaignCriterionService.mutate
24
+
25
+ require 'rubygems'
26
+ gem 'google-adwords-api'
27
+ require 'adwords_api'
28
+
29
+ API_VERSION = :v201101
30
+
31
+ def add_negative_campaign_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
+ campaign_criterion_srv =
36
+ adwords.service(:CampaignCriterionService, API_VERSION)
37
+
38
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
39
+
40
+ # Prepare for adding criterion.
41
+ operation = {
42
+ :operator => 'ADD',
43
+ :operand => {
44
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
45
+ # being created. It's only necessary when you must provide an explicit
46
+ # type that the client library can't infer.
47
+ :xsi_type => 'NegativeCampaignCriterion',
48
+ :campaign_id => campaign_id,
49
+ :criterion => {
50
+ :xsi_type => 'Placement',
51
+ :url => 'http://jupiter.google.com'
52
+ }
53
+ }
54
+ }
55
+
56
+ # Add criterion.
57
+ response = campaign_criterion_srv.mutate([operation])
58
+ campaign_criterion = response[:value].first
59
+ puts 'Campaign criterion id %d was successfully added.' %
60
+ campaign_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
+ add_negative_campaign_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