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,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 update a user list, setting its description.
21
+ # To create a user list, run add_user_list.rb.
22
+ #
23
+ # Tags: UserListService.mutate
24
+
25
+ require 'rubygems'
26
+ gem 'google-adwords-api'
27
+ require 'adwords_api'
28
+
29
+ API_VERSION = :v201008
30
+
31
+ def update_user_list()
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
+ user_list_srv = adwords.service(:UserListService, API_VERSION)
36
+
37
+ user_list_id = 'INSERT_USER_LIST_ID_HERE'.to_i
38
+
39
+ # Prepare for updating remarketing user list.
40
+ operation = {
41
+ :operator => 'SET',
42
+ :operand => {
43
+ :id => user_list_id,
44
+ :description => 'Last updated at %s' % Time.now.to_s
45
+ }
46
+ }
47
+
48
+ # Update user list.
49
+ response = user_list_srv.mutate([operation])
50
+ if response and response[:value]
51
+ user_list = response[:value].first
52
+ puts 'User list id %d was successfully updated, description set to "%s."' %
53
+ [user_list[:id], user_list[:description]]
54
+ else
55
+ puts 'No user lists were updated.'
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
+ update_user_list()
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,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 uploads an image. To get images, run get_all_images.rb.
21
+ #
22
+ # Tags: MediaService.upload
23
+
24
+ require 'rubygems'
25
+ gem 'google-adwords-api'
26
+ require 'adwords_api'
27
+ require 'base64'
28
+
29
+ API_VERSION = :v201008
30
+
31
+ def upload_image()
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
+ # Create image.
38
+ image_url = 'https://sandbox.google.com/sandboximages/image.jpg'
39
+ # This utility method retrieves the contents of a URL using all of the config
40
+ # options provided to the Api object.
41
+ image_data = AdsCommon::Http.get(image_url, adwords.config)
42
+ base64_image_data = Base64.encode64(image_data)
43
+ image = {
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 => 'Image',
48
+ :data => base64_image_data,
49
+ :type => 'IMAGE'
50
+ }
51
+
52
+ # Upload image.
53
+ response = media_srv.upload([image])
54
+ if response and !response.empty?
55
+ ret_image = response.first
56
+ dimensions = AdwordsApi::Utils.map(ret_image[:dimensions])
57
+ puts "Image with id #{ret_image[:media_id]}, dimensions " +
58
+ "#{dimensions['FULL'][:height]}x#{dimensions['FULL'][:width]} " +
59
+ "and MIME type \"#{ret_image[:mime_type]}\" uploaded successfully."
60
+ else
61
+ puts "No images uploaded."
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
+ upload_image()
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,98 @@
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 an ad group. To create a campaign, run
21
+ # add_campaign.rb.
22
+ #
23
+ # Tags: AdGroupService.mutate
24
+
25
+ require 'rubygems'
26
+ gem 'google-adwords-api'
27
+ require 'adwords_api'
28
+
29
+ API_VERSION = :v201101
30
+
31
+ def add_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
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
38
+
39
+ # Prepare for adding ad group.
40
+ operation = {
41
+ :operator => 'ADD',
42
+ :operand => {
43
+ :name => 'Earth to Mars Cruises #%s' % (Time.new.to_f * 1000).to_i,
44
+ :status => 'ENABLED',
45
+ :campaign_id => campaign_id,
46
+ :bids => {
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 => 'ManualCPMAdGroupBids',
51
+ :max_cpc => {
52
+ :amount => {
53
+ :micro_amount => 10000000
54
+ }
55
+ }
56
+ },
57
+ }
58
+ }
59
+
60
+ # Add ad group.
61
+ response = ad_group_srv.mutate([operation])
62
+ ad_group = response[:value].first
63
+ puts 'Ad group id %d was successfully added.' % ad_group[:id]
64
+ end
65
+
66
+ if __FILE__ == $0
67
+ # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
68
+ # variable to 'true'. This can be done either from your operating system
69
+ # environment or via code, as done below.
70
+ ENV['ADWORDSAPI_DEBUG'] = 'false'
71
+
72
+ begin
73
+ add_ad_group()
74
+
75
+ # Connection error. Likely transitory.
76
+ rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
77
+ puts 'Connection Error: %s' % e
78
+ puts 'Source: %s' % e.backtrace.first
79
+
80
+ # API Error.
81
+ rescue AdwordsApi::Errors::ApiException => e
82
+ puts 'API Exception caught.'
83
+ puts 'Message: %s' % e.message
84
+ puts 'Code: %d' % e.code if e.code
85
+ puts 'Trigger: %s' % e.trigger if e.trigger
86
+ puts 'Errors:'
87
+ if e.errors
88
+ e.errors.each_with_index do |error, index|
89
+ puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
90
+ error.each_pair do |field, value|
91
+ if field != :xsi_type
92
+ puts ' %s: %s' % [field, value]
93
+ end
94
+ end
95
+ end
96
+ end
97
+ end
98
+ end
@@ -0,0 +1,100 @@
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 a criterion to a given ad group. To create
21
+ # an ad group, run add_ad_group.rb.
22
+ #
23
+ # Tags: AdGroupCriterionService.mutate
24
+
25
+ require 'rubygems'
26
+ gem 'google-adwords-api'
27
+ require 'adwords_api'
28
+
29
+ API_VERSION = :v201101
30
+
31
+ def add_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
+ # Create placement.
41
+ plc_operation = {
42
+ :operator => 'ADD',
43
+ :operand => {
44
+ :xsi_type => 'BiddableAdGroupCriterion',
45
+ :ad_group_id => ad_group_id,
46
+ :criterion => {
47
+ :xsi_type => 'Placement',
48
+ :url => 'http://mars.google.com'
49
+ }
50
+ }
51
+ }
52
+
53
+ # Add criteria.
54
+ response = ad_group_criterion_srv.mutate([plc_operation])
55
+ if response and response[:value]
56
+ ad_group_criteria = response[:value]
57
+ puts "Added #{ad_group_criteria.length} criteria to ad group " +
58
+ "#{ad_group_id}."
59
+ ad_group_criteria.each do |ad_group_criterion|
60
+ puts " Criterion id is #{ad_group_criterion[:criterion][:id]} and " +
61
+ "type is #{ad_group_criterion[:criterion][:xsi_type]}."
62
+ end
63
+ else
64
+ puts "No criteria were added."
65
+ end
66
+ end
67
+
68
+ if __FILE__ == $0
69
+ # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
70
+ # variable to 'true'. This can be done either from your operating system
71
+ # environment or via code, as done below.
72
+ ENV['ADWORDSAPI_DEBUG'] = 'false'
73
+
74
+ begin
75
+ add_ad_group_criteria()
76
+
77
+ # Connection error. Likely transitory.
78
+ rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
79
+ puts 'Connection Error: %s' % e
80
+ puts 'Source: %s' % e.backtrace.first
81
+
82
+ # API Error.
83
+ rescue AdwordsApi::Errors::ApiException => e
84
+ puts 'API Exception caught.'
85
+ puts 'Message: %s' % e.message
86
+ puts 'Code: %d' % e.code if e.code
87
+ puts 'Trigger: %s' % e.trigger if e.trigger
88
+ puts 'Errors:'
89
+ if e.errors
90
+ e.errors.each_with_index do |error, index|
91
+ puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
92
+ error.each_pair do |field, value|
93
+ if field != :xsi_type
94
+ puts ' %s: %s' % [field, value]
95
+ end
96
+ end
97
+ end
98
+ end
99
+ end
100
+ end
@@ -0,0 +1,110 @@
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 image ad to a given ad group. To create
21
+ # an ad group, run add_ad_group.rb.
22
+ #
23
+ # Tags: AdGroupAdService.mutate
24
+
25
+ require 'rubygems'
26
+ gem 'google-adwords-api'
27
+ require 'adwords_api'
28
+ require 'base64'
29
+
30
+ API_VERSION = :v201101
31
+
32
+ def add_ads()
33
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
34
+ # when called without parameters.
35
+ adwords = AdwordsApi::Api.new
36
+ ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
37
+
38
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
39
+
40
+ # Retrieve image and encode it.
41
+ image_url = 'https://sandbox.google.com/sandboximages/image.jpg'
42
+ # This utility method retrieves the contents of a URL using all of the config
43
+ # options provided to the Api object.
44
+ image_data = AdsCommon::Http.get(image_url, adwords.config)
45
+ base64_image_data = Base64.encode64(image_data)
46
+
47
+ # Create image ad.
48
+ image_ad_operation = {
49
+ :operator => 'ADD',
50
+ :operand => {
51
+ :ad_group_id => ad_group_id,
52
+ :ad => {
53
+ :xsi_type => 'ImageAd',
54
+ :name => 'Cruise to mars image ad #%s' % (Time.new.to_f * 1000).to_i,
55
+ :url => 'http://www.example.com',
56
+ :display_url => 'www.example.com',
57
+ :image => {
58
+ :data => base64_image_data
59
+ }
60
+ }
61
+ }
62
+ }
63
+
64
+ # Add ad.
65
+ response = ad_group_ad_srv.mutate([image_ad_operation])
66
+ if response and response[:value]
67
+ ads = response[:value]
68
+ puts "Added #{ads.length} ad(s) to ad group #{ad_group_id}."
69
+ ads.each do |ad|
70
+ puts " Ad id is #{ad[:ad][:id]}, type is #{ad[:ad][:xsi_type]} and " +
71
+ "status is \"#{ad[:status]}\"."
72
+ end
73
+ else
74
+ puts "No ads were added."
75
+ end
76
+ end
77
+
78
+ if __FILE__ == $0
79
+ # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
80
+ # variable to 'true'. This can be done either from your operating system
81
+ # environment or via code, as done below.
82
+ ENV['ADWORDSAPI_DEBUG'] = 'false'
83
+
84
+ begin
85
+ add_ads()
86
+
87
+ # Connection error. Likely transitory.
88
+ rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
89
+ puts 'Connection Error: %s' % e
90
+ puts 'Source: %s' % e.backtrace.first
91
+
92
+ # API Error.
93
+ rescue AdwordsApi::Errors::ApiException => e
94
+ puts 'API Exception caught.'
95
+ puts 'Message: %s' % e.message
96
+ puts 'Code: %d' % e.code if e.code
97
+ puts 'Trigger: %s' % e.trigger if e.trigger
98
+ puts 'Errors:'
99
+ if e.errors
100
+ e.errors.each_with_index do |error, index|
101
+ puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
102
+ error.each_pair do |field, value|
103
+ if field != :xsi_type
104
+ puts ' %s: %s' % [field, value]
105
+ end
106
+ end
107
+ end
108
+ end
109
+ end
110
+ end