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,122 +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 create a user list and show its associated
21
- # conversion tracker code snippet.
22
- #
23
- # Tags: UserListService.mutate, ConversionTrackerService.get
24
-
25
- require 'rubygems'
26
- gem 'google-adwords-api'
27
- require 'adwords_api'
28
-
29
- API_VERSION = :v201101
30
-
31
- def add_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
- conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
42
-
43
- # Prepare for adding remarketing user list.
44
- name = 'Mars cruise customers #%s' % (Time.new.to_f * 1000).to_i
45
- operation = {
46
- :operator => 'ADD',
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 => 'RemarketingUserList',
52
- :name => name,
53
- :description => 'A list of mars cruise customers in the last year',
54
- :status => 'OPEN',
55
- :membership_life_span => 365,
56
- :conversion_types => [{:name => name}]
57
- }
58
- }
59
-
60
- # Add user list.
61
- response = user_list_srv.mutate([operation])
62
- if response and response[:value]
63
- user_list = response[:value].first
64
-
65
- # Get conversion snippets.
66
- if user_list and user_list[:conversion_types]
67
- conversion_ids = user_list[:conversion_types].map {|type| type[:id]}
68
- selector = {
69
- # We're actually interested in the 'Snippet' field, which is returned
70
- # automatically.
71
- :fields => ['Id'],
72
- :predicates => [
73
- {:field => 'Id', :operator => 'IN', :values => conversion_ids}
74
- ]
75
- }
76
- conv_tracker_response = conv_tracker_srv.get(selector)
77
- if conv_tracker_response and conv_tracker_response[:entries]
78
- conversions = conv_tracker_response[:entries]
79
- end
80
- end
81
- puts 'User list with name "%s" and id %d was added.' %
82
- [user_list[:name], user_list[:id]]
83
- # Display user list associated conversion code snippets.
84
- if conversions
85
- conversions.each do |conversion|
86
- puts "Conversion type code snipped associated to the list:\n%s\n" %
87
- conversion[:snippet]
88
- end
89
- end
90
- else
91
- puts 'No user lists were added.'
92
- end
93
- end
94
-
95
- if __FILE__ == $0
96
- begin
97
- add_user_list()
98
-
99
- # Connection error. Likely transitory.
100
- rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
101
- puts 'Connection Error: %s' % e
102
- puts 'Source: %s' % e.backtrace.first
103
-
104
- # API Error.
105
- rescue AdwordsApi::Errors::ApiException => e
106
- puts 'API Exception caught.'
107
- puts 'Message: %s' % e.message
108
- puts 'Code: %d' % e.code if e.code
109
- puts 'Trigger: %s' % e.trigger if e.trigger
110
- puts 'Errors:'
111
- if e.errors
112
- e.errors.each_with_index do |error, index|
113
- puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
114
- error.each_pair do |field, value|
115
- if field != :xsi_type
116
- puts ' %s: %s' % [field, value]
117
- end
118
- end
119
- end
120
- end
121
- end
122
- end
@@ -1,132 +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 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 = :v201101
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
-
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
- # Enable 'validate only'
43
- adwords.validate_only = true
44
-
45
- # Prepare for adding campaign.
46
- operation = {
47
- :operator => 'ADD',
48
- :operand => {
49
- :name => 'Interplanetary Cruise #%s' % (Time.new.to_f * 1000).to_i,
50
- :status => 'PAUSED',
51
- :bidding_strategy => {
52
- # The 'xsi_type' field allows you to specify the xsi:type of the object
53
- # being created. It's only necessary when you must provide an explicit
54
- # type that the client library can't infer.
55
- :xsi_type => 'ManualCPM'
56
- },
57
- :budget => {
58
- :period => 'DAILY',
59
- :amount => {
60
- :micro_amount => 50000000
61
- },
62
- :delivery_method => 'STANDARD'
63
- }
64
- }
65
- }
66
-
67
- # Validate campaign add operation.
68
- response = campaign_srv.mutate([operation])
69
- if response and response[:value]
70
- campaigns = response[:value]
71
- campaigns.each do |campaign|
72
- puts "Unexpected campaign creation! Name \"#{campaign[:name]}\", id " +
73
- "#{campaign[:id]} and status is \"#{campaign[:status]}\"."
74
- end
75
- else
76
- puts 'No campaigns created.'
77
- end
78
-
79
- # Provide an invalid bidding strategy that will cause an exception during
80
- # validation.
81
- operation = {
82
- :operator => 'ADD',
83
- :operand => {
84
- :name => 'Interplanetary Cruise #%s' % (Time.new.to_f * 1000).to_i,
85
- :status => 'PAUSED',
86
- :bidding_strategy => nil,
87
- :budget => {
88
- :period => 'DAILY',
89
- :amount => {
90
- :micro_amount => 50000000
91
- },
92
- :delivery_method => 'STANDARD'
93
- }
94
- }
95
- }
96
-
97
- # Validate campaign add operation.
98
- begin
99
- response = campaign_srv.mutate([operation])
100
- rescue AdwordsApi::Errors::ApiException => e
101
- puts "Validation correctly failed: #{e.message}"
102
- end
103
- end
104
-
105
- if __FILE__ == $0
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
@@ -1,94 +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 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 = :v201101
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
-
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
- ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
41
-
42
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
43
- ad_id = 'INSERT_AD_ID_HERE'.to_i
44
-
45
- # Prepare for deleting ad.
46
- operation = {
47
- :operator => 'REMOVE',
48
- :operand => {
49
- :ad_group_id => ad_group_id,
50
- :ad => {
51
- :xsi_type => 'Ad',
52
- :id => ad_id
53
- }
54
- }
55
- }
56
-
57
- # Delete ad.
58
- response = ad_group_ad_srv.mutate([operation])
59
- if response and response[:value]
60
- ad = response[:value].first
61
- puts 'Ad id %d was successfully deleted.' % ad[:ad][:id]
62
- else
63
- puts 'No ads were deleted.'
64
- end
65
- end
66
-
67
- if __FILE__ == $0
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
@@ -1,95 +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 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 = :v201101
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
-
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
- ad_group_criterion_srv =
41
- adwords.service(:AdGroupCriterionService, API_VERSION)
42
-
43
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
44
- criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
45
-
46
- # Prepare for deleting ad group criterion.
47
- operation = {
48
- :operator => 'REMOVE',
49
- :operand => {
50
- # The 'xsi_type' field allows you to specify the xsi:type of the object
51
- # being created. It's only necessary when you must provide an explicit
52
- # type that the client library can't infer.
53
- :xsi_type => 'BiddableAdGroupCriterion',
54
- :ad_group_id => ad_group_id,
55
- :criterion => {
56
- :id => criterion_id
57
- }
58
- }
59
- }
60
-
61
- # Delete criterion.
62
- response = ad_group_criterion_srv.mutate([operation])
63
- ad_group_criterion = response[:value].first
64
- puts 'Criterion id %d was successfully deleted.' %
65
- ad_group_criterion[:criterion][:id]
66
- end
67
-
68
- if __FILE__ == $0
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
@@ -1,96 +0,0 @@
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 = :v201101
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
-
38
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
39
- # the configuration file or provide your own logger:
40
- # adwords.logger = Logger.new('adwords_xml.log')
41
-
42
- bulk_mutate_job_srv = adwords.service(:BulkMutateJobService, API_VERSION)
43
-
44
- job_id = 'INSERT_BULK_MUTATE_JOB_ID_HERE'
45
-
46
- # Create operation.
47
- operation = {
48
- :operator => 'REMOVE',
49
- :operand => {
50
- # The 'xsi_type' field allows you to specify the xsi:type of the object
51
- # being created. It's only necessary when you must provide an explicit
52
- # type that the client library can't infer.
53
- :xsi_type => 'BulkMutateJob',
54
- :id => job_id
55
- }
56
- }
57
-
58
- # Delete job.
59
- response = bulk_mutate_job_srv.mutate(operation)
60
- if response and response[:value]
61
- job = response[:value].first
62
- puts 'Job id %d was successfully deleted.' % job[:id]
63
- else
64
- puts 'No jobs were deleted.'
65
- end
66
-
67
- end
68
-
69
- if __FILE__ == $0
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