google-adx-buyer-api 0.4.0 → 0.4.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (185) hide show
  1. data/ChangeLog +4 -0
  2. data/README +39 -25
  3. data/examples/v201109/account_management/get_account_changes.rb +137 -0
  4. data/examples/{v201008 → v201109/basic_operations}/add_ad_group.rb +18 -28
  5. data/examples/{v201003 → v201109/basic_operations}/add_campaign.rb +28 -30
  6. data/examples/{v201008/add_ad_group_criteria.rb → v201109/basic_operations/add_placements.rb} +45 -46
  7. data/examples/v201109/basic_operations/add_thirdparty_redirect_ad.rb +105 -0
  8. data/examples/{v201008 → v201109/basic_operations}/delete_ad.rb +21 -35
  9. data/examples/{v201101 → v201109/basic_operations}/delete_ad_group.rb +18 -28
  10. data/examples/v201109/{delete_campaign.rb → basic_operations/delete_campaign.rb} +18 -28
  11. data/examples/{v201008/delete_ad_group_criterion.rb → v201109/basic_operations/delete_placement.rb} +24 -33
  12. data/examples/{v201101/get_all_ad_groups.rb → v201109/basic_operations/get_ad_groups.rb} +21 -35
  13. data/examples/{v201101/get_all_campaigns.rb → v201109/basic_operations/get_campaigns.rb} +14 -23
  14. data/examples/{v201008/get_all_ad_group_criteria.rb → v201109/basic_operations/get_placements.rb} +37 -36
  15. data/examples/v201109/{get_all_ads.rb → basic_operations/get_thirdparty_redirect_ads.rb} +37 -36
  16. data/examples/v201109/{get_client_customer_id.rb → basic_operations/pause_ad.rb} +27 -33
  17. data/examples/{v201003 → v201109/basic_operations}/update_ad_group.rb +18 -32
  18. data/examples/{v201101 → v201109/basic_operations}/update_campaign.rb +19 -33
  19. data/examples/{v201003/delete_ad_group_criterion.rb → v201109/basic_operations/update_placement.rb} +35 -36
  20. data/examples/v201109/{perform_mutate_job.rb → campaign_management/add_placements_in_bulk.rb} +11 -11
  21. data/examples/v201109/{get_all_disapproved_ads.rb → campaign_management/get_all_disapproved_ads.rb} +18 -28
  22. data/examples/v201109/error_handling/handle_captcha_challenge.rb +93 -0
  23. data/examples/v201109/error_handling/handle_partial_failures.rb +117 -0
  24. data/examples/v201109/error_handling/handle_policy_violation_error.rb +138 -0
  25. data/examples/v201109/error_handling/handle_two_factor_authorization_error.rb +87 -0
  26. data/examples/v201109/misc/get_all_images_and_videos.rb +101 -0
  27. data/examples/{v201101 → v201109/misc}/upload_image.rb +23 -33
  28. data/examples/v201109/{get_all_campaigns.rb → misc/use_oauth.rb} +42 -31
  29. data/examples/{v201003/get_related_placements.rb → v201109/optimization/get_placement_ideas.rb} +32 -37
  30. data/examples/{v201008/add_user_list.rb → v201109/remarketing/add_audience.rb} +49 -34
  31. data/examples/v201109/{add_conversion.rb → remarketing/add_conversion_tracker.rb} +31 -35
  32. data/examples/v201109/{download_adhoc_report.rb → reporting/download_criteria_report.rb} +24 -24
  33. data/examples/{v201008/download_report.rb → v201109/reporting/download_defined_report.rb} +20 -29
  34. data/examples/v201109/reporting/get_campaign_stats.rb +105 -0
  35. data/examples/{v201008/get_all_report_definitions.rb → v201109/reporting/get_defined_reports.rb} +18 -27
  36. data/examples/v201109/{get_all_carriers.rb → reporting/get_report_fields.rb} +18 -19
  37. data/examples/v201109/reporting/parallel_report_download.rb +159 -0
  38. data/examples/v201109/{add_campaign_targeting_criteria.rb → targeting/add_campaign_targeting_criteria.rb} +27 -19
  39. data/examples/v201109/targeting/get_campaign_targeting_criteria.rb +104 -0
  40. data/examples/v201109/{get_all_languages.rb → targeting/get_targetable_languages_and_carriers.rb} +18 -9
  41. data/examples/v201109/{get_location_criteria.rb → targeting/lookup_location.rb} +7 -7
  42. metadata +59 -191
  43. data/Rakefile +0 -50
  44. data/examples/v201003/add_ad_group.rb +0 -98
  45. data/examples/v201003/add_ad_group_criteria.rb +0 -100
  46. data/examples/v201003/add_ads.rb +0 -110
  47. data/examples/v201003/add_negative_campaign_criterion.rb +0 -95
  48. data/examples/v201003/add_placement_performance_report_definition.rb +0 -108
  49. data/examples/v201003/check_campaigns.rb +0 -132
  50. data/examples/v201003/delete_ad.rb +0 -94
  51. data/examples/v201003/delete_ad_group.rb +0 -86
  52. data/examples/v201003/delete_campaign.rb +0 -87
  53. data/examples/v201003/download_report.rb +0 -76
  54. data/examples/v201003/get_all_active_ad_group_criteria.rb +0 -93
  55. data/examples/v201003/get_all_ad_group_criteria.rb +0 -91
  56. data/examples/v201003/get_all_ad_groups.rb +0 -88
  57. data/examples/v201003/get_all_ads.rb +0 -91
  58. data/examples/v201003/get_all_campaign_targets.rb +0 -83
  59. data/examples/v201003/get_all_campaigns.rb +0 -83
  60. data/examples/v201003/get_all_disapproved_ads.rb +0 -94
  61. data/examples/v201003/get_all_images.rb +0 -88
  62. data/examples/v201003/get_all_paused_campaigns.rb +0 -86
  63. data/examples/v201003/get_all_report_definitions.rb +0 -84
  64. data/examples/v201003/get_criterion_bid_landscape.rb +0 -105
  65. data/examples/v201003/get_geo_location_info.rb +0 -108
  66. data/examples/v201003/get_report_fields.rb +0 -81
  67. data/examples/v201003/perform_bulk_mutate_job.rb +0 -222
  68. data/examples/v201003/set_campaign_targets.rb +0 -124
  69. data/examples/v201003/update_ad.rb +0 -95
  70. data/examples/v201003/update_ad_group_criterion.rb +0 -108
  71. data/examples/v201003/update_campaign.rb +0 -92
  72. data/examples/v201003/upload_image.rb +0 -97
  73. data/examples/v201008/add_ads.rb +0 -110
  74. data/examples/v201008/add_campaign.rb +0 -101
  75. data/examples/v201008/add_negative_campaign_criterion.rb +0 -95
  76. data/examples/v201008/add_placement_performance_report_definition.rb +0 -108
  77. data/examples/v201008/check_campaigns.rb +0 -132
  78. data/examples/v201008/delete_ad_group.rb +0 -86
  79. data/examples/v201008/delete_bulk_mutate_job.rb +0 -96
  80. data/examples/v201008/delete_campaign.rb +0 -87
  81. data/examples/v201008/delete_user_list.rb +0 -87
  82. data/examples/v201008/get_all_account_changes.rb +0 -144
  83. data/examples/v201008/get_all_active_ad_group_criteria.rb +0 -93
  84. data/examples/v201008/get_all_ad_groups.rb +0 -88
  85. data/examples/v201008/get_all_ads.rb +0 -91
  86. data/examples/v201008/get_all_campaign_targets.rb +0 -83
  87. data/examples/v201008/get_all_campaigns.rb +0 -83
  88. data/examples/v201008/get_all_disapproved_ads.rb +0 -94
  89. data/examples/v201008/get_all_images.rb +0 -88
  90. data/examples/v201008/get_all_paused_campaigns.rb +0 -86
  91. data/examples/v201008/get_all_user_lists.rb +0 -84
  92. data/examples/v201008/get_bulk_mutate_job.rb +0 -106
  93. data/examples/v201008/get_campaign_alerts.rb +0 -103
  94. data/examples/v201008/get_criterion_bid_landscape.rb +0 -105
  95. data/examples/v201008/get_geo_location_info.rb +0 -108
  96. data/examples/v201008/get_related_placements.rb +0 -114
  97. data/examples/v201008/get_report_fields.rb +0 -81
  98. data/examples/v201008/perform_bulk_mutate_job.rb +0 -222
  99. data/examples/v201008/set_campaign_targets.rb +0 -124
  100. data/examples/v201008/update_ad.rb +0 -95
  101. data/examples/v201008/update_ad_group.rb +0 -90
  102. data/examples/v201008/update_ad_group_criterion.rb +0 -108
  103. data/examples/v201008/update_campaign.rb +0 -93
  104. data/examples/v201008/update_user_list.rb +0 -91
  105. data/examples/v201008/upload_image.rb +0 -97
  106. data/examples/v201101/add_ad_group.rb +0 -98
  107. data/examples/v201101/add_ad_group_criteria.rb +0 -100
  108. data/examples/v201101/add_ads.rb +0 -110
  109. data/examples/v201101/add_campaign.rb +0 -108
  110. data/examples/v201101/add_conversion.rb +0 -97
  111. data/examples/v201101/add_negative_campaign_criterion.rb +0 -95
  112. data/examples/v201101/add_placement_performance_report_definition.rb +0 -108
  113. data/examples/v201101/add_rtb_campaign.rb +0 -113
  114. data/examples/v201101/add_user_list.rb +0 -122
  115. data/examples/v201101/check_campaigns.rb +0 -132
  116. data/examples/v201101/delete_ad.rb +0 -94
  117. data/examples/v201101/delete_ad_group_criterion.rb +0 -95
  118. data/examples/v201101/delete_bulk_mutate_job.rb +0 -96
  119. data/examples/v201101/delete_campaign.rb +0 -87
  120. data/examples/v201101/delete_user_list.rb +0 -87
  121. data/examples/v201101/download_report.rb +0 -76
  122. data/examples/v201101/get_ad_group_bid_landscape.rb +0 -103
  123. data/examples/v201101/get_all_account_changes.rb +0 -146
  124. data/examples/v201101/get_all_active_ad_group_criteria.rb +0 -106
  125. data/examples/v201101/get_all_ad_group_criteria.rb +0 -97
  126. data/examples/v201101/get_all_ads.rb +0 -99
  127. data/examples/v201101/get_all_campaign_targets.rb +0 -83
  128. data/examples/v201101/get_all_conversions.rb +0 -88
  129. data/examples/v201101/get_all_disapproved_ads.rb +0 -102
  130. data/examples/v201101/get_all_images.rb +0 -90
  131. data/examples/v201101/get_all_paused_campaigns.rb +0 -92
  132. data/examples/v201101/get_all_report_definitions.rb +0 -84
  133. data/examples/v201101/get_all_user_lists.rb +0 -87
  134. data/examples/v201101/get_bulk_mutate_job.rb +0 -106
  135. data/examples/v201101/get_campaign_alerts.rb +0 -103
  136. data/examples/v201101/get_criterion_bid_landscape.rb +0 -102
  137. data/examples/v201101/get_geo_location_info.rb +0 -108
  138. data/examples/v201101/get_related_placements.rb +0 -114
  139. data/examples/v201101/get_report_fields.rb +0 -81
  140. data/examples/v201101/perform_bulk_mutate_job.rb +0 -222
  141. data/examples/v201101/set_campaign_targets.rb +0 -111
  142. data/examples/v201101/update_ad.rb +0 -95
  143. data/examples/v201101/update_ad_group.rb +0 -90
  144. data/examples/v201101/update_ad_group_criterion.rb +0 -108
  145. data/examples/v201101/update_conversion.rb +0 -96
  146. data/examples/v201101/update_user_list.rb +0 -91
  147. data/examples/v201109/add_ad_group.rb +0 -98
  148. data/examples/v201109/add_ad_group_criteria.rb +0 -100
  149. data/examples/v201109/add_ads.rb +0 -110
  150. data/examples/v201109/add_campaign.rb +0 -108
  151. data/examples/v201109/add_negative_campaign_criterion.rb +0 -95
  152. data/examples/v201109/add_rtb_campaign.rb +0 -113
  153. data/examples/v201109/add_user_list.rb +0 -122
  154. data/examples/v201109/check_campaigns.rb +0 -132
  155. data/examples/v201109/delete_ad.rb +0 -94
  156. data/examples/v201109/delete_ad_group.rb +0 -86
  157. data/examples/v201109/delete_ad_group_criterion.rb +0 -95
  158. data/examples/v201109/delete_bulk_mutate_job.rb +0 -96
  159. data/examples/v201109/delete_user_list.rb +0 -87
  160. data/examples/v201109/download_report.rb +0 -76
  161. data/examples/v201109/get_ad_group_bid_landscape.rb +0 -103
  162. data/examples/v201109/get_all_account_changes.rb +0 -146
  163. data/examples/v201109/get_all_active_ad_group_criteria.rb +0 -106
  164. data/examples/v201109/get_all_ad_group_criteria.rb +0 -98
  165. data/examples/v201109/get_all_ad_groups.rb +0 -94
  166. data/examples/v201109/get_all_campaign_targets.rb +0 -83
  167. data/examples/v201109/get_all_conversions.rb +0 -88
  168. data/examples/v201109/get_all_images.rb +0 -90
  169. data/examples/v201109/get_all_paused_campaigns.rb +0 -92
  170. data/examples/v201109/get_all_report_definitions.rb +0 -84
  171. data/examples/v201109/get_all_user_lists.rb +0 -87
  172. data/examples/v201109/get_bulk_mutate_job.rb +0 -106
  173. data/examples/v201109/get_campaign_alerts.rb +0 -103
  174. data/examples/v201109/get_criterion_bid_landscape.rb +0 -102
  175. data/examples/v201109/get_geo_location_info.rb +0 -108
  176. data/examples/v201109/get_related_placements.rb +0 -114
  177. data/examples/v201109/get_report_fields.rb +0 -81
  178. data/examples/v201109/perform_bulk_mutate_job.rb +0 -222
  179. data/examples/v201109/update_ad.rb +0 -95
  180. data/examples/v201109/update_ad_group.rb +0 -90
  181. data/examples/v201109/update_ad_group_criterion.rb +0 -108
  182. data/examples/v201109/update_campaign.rb +0 -93
  183. data/examples/v201109/update_conversion.rb +0 -96
  184. data/examples/v201109/update_user_list.rb +0 -91
  185. data/examples/v201109/upload_image.rb +0 -97
@@ -1,93 +0,0 @@
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 campaign, setting its budget delivery
21
- # to 'ACCELERATED'. To create a campaign, run add_campaign.rb.
22
- #
23
- # Tags: CampaignService.mutate
24
-
25
- require 'rubygems'
26
- gem 'google-adwords-api'
27
- require 'adwords_api'
28
-
29
- API_VERSION = :v201109
30
-
31
- def update_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
-
36
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
37
- # the configuration file or provide your own logger:
38
- # adwords.logger = Logger.new('adwords_xml.log')
39
-
40
- campaign_srv = adwords.service(:CampaignService, API_VERSION)
41
-
42
- campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
43
-
44
- # Prepare for updating campaign.
45
- operation = {
46
- :operator => 'SET',
47
- :operand => {
48
- :id => campaign_id,
49
- :budget => {
50
- :delivery_method => 'ACCELERATED'
51
- }
52
- }
53
- }
54
-
55
- # Update campaign.
56
- response = campaign_srv.mutate([operation])
57
- if response and response[:value]
58
- campaign = response[:value].first
59
- puts 'Campaign id %d successfully updated, delivery method set to %s.' %
60
- [campaign[:id], campaign[:budget][:delivery_method]]
61
- else
62
- puts 'No campaigns were updated.'
63
- end
64
- end
65
-
66
- if __FILE__ == $0
67
- begin
68
- update_campaign()
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
@@ -1,96 +0,0 @@
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 conversion by setting its status to
21
- # 'DISABLED'. To get conversions, run get_all_conversions.rb.
22
- #
23
- # Tags: ConversionTrackerService.mutate
24
-
25
- require 'rubygems'
26
- gem 'google-adwords-api'
27
- require 'adwords_api'
28
-
29
- API_VERSION = :v201109
30
-
31
- def update_conversion()
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
-
36
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
37
- # the configuration file or provide your own logger:
38
- # adwords.logger = Logger.new('adwords_xml.log')
39
-
40
- conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
41
-
42
- conversion_id = 'INSERT_CONVERSION_ID_HERE'.to_i
43
-
44
- # Prepare for updating conversion.
45
- operation = {
46
- :operator => 'SET',
47
- :operand => {
48
- # The 'xsi_type' field allows you to specify the xsi:type of the object
49
- # being created. It's only necessary when you must provide an explicit
50
- # type that the client library can't infer.
51
- :xsi_type => 'AdWordsConversionTracker',
52
- :id => conversion_id,
53
- :status => 'DISABLED'
54
- }
55
- }
56
-
57
- # Update conversion.
58
- response = conv_tracker_srv.mutate([operation])
59
- if response and response[:value]
60
- conversion = response[:value].first
61
- puts "Conversion with id #{conversion[:id]}, name " +
62
- "\"#{conversion[:name]}\", status \"#{conversion[:status]}\" and " +
63
- " category \"#{conversion[:category]}\" was disabled."
64
- else
65
- puts 'No conversions were updated.'
66
- end
67
- end
68
-
69
- if __FILE__ == $0
70
- begin
71
- update_conversion()
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
@@ -1,91 +0,0 @@
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 = :v201109
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
-
36
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
37
- # the configuration file or provide your own logger:
38
- # adwords.logger = Logger.new('adwords_xml.log')
39
-
40
- user_list_srv = adwords.service(:UserListService, API_VERSION)
41
-
42
- user_list_id = 'INSERT_USER_LIST_ID_HERE'.to_i
43
-
44
- # Prepare for updating remarketing user list.
45
- operation = {
46
- :operator => 'SET',
47
- :operand => {
48
- :id => user_list_id,
49
- :description => 'Last updated at %s' % Time.now.to_s
50
- }
51
- }
52
-
53
- # Update user list.
54
- response = user_list_srv.mutate([operation])
55
- if response and response[:value]
56
- user_list = response[:value].first
57
- puts 'User list id %d was successfully updated, description set to "%s."' %
58
- [user_list[:id], user_list[:description]]
59
- else
60
- puts 'No user lists were updated.'
61
- end
62
- end
63
-
64
- if __FILE__ == $0
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
@@ -1,97 +0,0 @@
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 = :v201109
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
-
36
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
37
- # the configuration file or provide your own logger:
38
- # adwords.logger = Logger.new('adwords_xml.log')
39
-
40
- media_srv = adwords.service(:MediaService, API_VERSION)
41
-
42
- # Create image.
43
- image_url = 'https://sandbox.google.com/sandboximages/image.jpg'
44
- # This utility method retrieves the contents of a URL using all of the config
45
- # options provided to the Api object.
46
- image_data = AdsCommon::Http.get(image_url, adwords.config)
47
- base64_image_data = Base64.encode64(image_data)
48
- image = {
49
- # The 'xsi_type' field allows you to specify the xsi:type of the object
50
- # being created. It's only necessary when you must provide an explicit
51
- # type that the client library can't infer.
52
- :xsi_type => 'Image',
53
- :data => base64_image_data,
54
- :type => 'IMAGE'
55
- }
56
-
57
- # Upload image.
58
- response = media_srv.upload([image])
59
- if response and !response.empty?
60
- ret_image = response.first
61
- dimensions = AdwordsApi::Utils.map(ret_image[:dimensions])
62
- puts "Image with id #{ret_image[:media_id]}, dimensions " +
63
- "#{dimensions['FULL'][:height]}x#{dimensions['FULL'][:width]} " +
64
- "and MIME type \"#{ret_image[:mime_type]}\" uploaded successfully."
65
- else
66
- puts "No images uploaded."
67
- end
68
- end
69
-
70
- if __FILE__ == $0
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