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,108 +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 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
-
35
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
36
- # the configuration file or provide your own logger:
37
- # adwords.logger = Logger.new('adwords_xml.log')
38
-
39
- campaign_srv = adwords.service(:CampaignService, API_VERSION)
40
-
41
- # Prepare for adding campaign.
42
- operation = {
43
- :operator => 'ADD',
44
- :operand => {
45
- :name => 'Interplanetary Cruise #%s' % (Time.new.to_f * 1000).to_i,
46
- :status => 'PAUSED',
47
- :bidding_strategy => {
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 => 'ManualCPM'
52
- },
53
- :budget => {
54
- :period => 'DAILY',
55
- :amount => {
56
- :micro_amount => 50000000
57
- },
58
- :delivery_method => 'STANDARD'
59
- },
60
- # Set the campaign network options to Search and Search Network.
61
- :network_setting => {
62
- :target_google_search => true,
63
- :target_search_network => true,
64
- :target_content_network => false,
65
- :target_content_contextual => false
66
- }
67
- }
68
- }
69
-
70
- # Add campaign.
71
- response = campaign_srv.mutate([operation])
72
- if response and response[:value]
73
- campaign = response[:value].first
74
- puts 'Campaign with name "%s" and id %d was added.' %
75
- [campaign[:name], campaign[:id]]
76
- else
77
- puts 'No campaigns were added.'
78
- end
79
- end
80
-
81
- if __FILE__ == $0
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
@@ -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 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
-
35
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
36
- # the configuration file or provide your own logger:
37
- # adwords.logger = Logger.new('adwords_xml.log')
38
-
39
- conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
40
-
41
- # Prepare for adding conversion.
42
- operation = {
43
- :operator => 'ADD',
44
- :operand => {
45
- # The 'xsi_type' field allows you to specify the xsi:type of the object
46
- # being created. It's only necessary when you must provide an explicit
47
- # type that the client library can't infer.
48
- :xsi_type => 'AdWordsConversionTracker',
49
- :name => 'Earth to Mars Cruises Conversion #%s' %
50
- (Time.new.to_f * 1000).to_i,
51
- :category => 'DEFAULT',
52
- :markup_language => 'HTML',
53
- :http_protocol => 'HTTP',
54
- :text_format => 'HIDDEN'
55
- }
56
- }
57
-
58
- # Add conversion.
59
- response = conv_tracker_srv.mutate([operation])
60
- if response and response[:value]
61
- conversion = response[:value].first
62
- puts "Conversion with id #{conversion[:id]}, name " +
63
- "\"#{conversion[:name]}\", status \"#{conversion[:status]}\" and " +
64
- " category \"#{conversion[:category]}\" was added."
65
- else
66
- puts 'No conversions were added.'
67
- end
68
- end
69
-
70
- if __FILE__ == $0
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
@@ -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 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
-
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_criterion_srv =
41
- adwords.service(:CampaignCriterionService, API_VERSION)
42
-
43
- campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
44
-
45
- # Prepare for adding criterion.
46
- operation = {
47
- :operator => 'ADD',
48
- :operand => {
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 => 'NegativeCampaignCriterion',
53
- :campaign_id => campaign_id,
54
- :criterion => {
55
- :xsi_type => 'Placement',
56
- :url => 'http://jupiter.google.com'
57
- }
58
- }
59
- }
60
-
61
- # Add criterion.
62
- response = campaign_criterion_srv.mutate([operation])
63
- campaign_criterion = response[:value].first
64
- puts 'Campaign criterion id %d was successfully added.' %
65
- campaign_criterion[:criterion][:id]
66
- end
67
-
68
- if __FILE__ == $0
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
@@ -1,108 +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 adds a placement performance report. To get ad groups, run
21
- # get_all_ad_groups.rb. To get report fields, run get_report_fields.rb.
22
- #
23
- # Tags: ReportDefinitionService.mutate
24
-
25
- require 'rubygems'
26
- gem 'google-adwords-api'
27
- require 'adwords_api'
28
-
29
- API_VERSION = :v201101
30
-
31
- def add_placement_performance_report_definition()
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
- report_def_srv = adwords.service(:ReportDefinitionService, API_VERSION)
41
-
42
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
43
- start_date = 'INSERT_START_DATE_HERE'
44
- end_date = 'INSERT_END_DATE_HERE'
45
-
46
- # Prepare for adding report definition.
47
- operation = {
48
- :operator => 'ADD',
49
- :operand => {
50
- :selector => {
51
- :fields => ['AdGroupId', 'Id', 'PlacementUrl', 'Impressions', 'Clicks',
52
- 'Cost'],
53
- :predicates => [{
54
- :operator => 'EQUALS',
55
- :field => 'AdGroupId',
56
- :values => [ad_group_id]
57
- }],
58
- :date_range => {
59
- :min => start_date,
60
- :max => end_date
61
- }
62
- },
63
- :report_name => 'Placement performance report #%s' %
64
- (Time.new.to_f * 1000).to_i,
65
- :report_type => 'MANAGED_PLACEMENTS_PERFORMANCE_REPORT',
66
- :date_range_type => 'CUSTOM_DATE',
67
- :download_format => 'XML'
68
- }
69
- }
70
-
71
- # Add report definition.
72
- response = report_def_srv.mutate([operation])
73
- if response
74
- response.each do |report_definition|
75
- puts 'Report definition with name \'%s\' and id \'%s\' was added' %
76
- [report_definition[:report_name], report_definition[:id]]
77
- end
78
- end
79
- end
80
-
81
- if __FILE__ == $0
82
- begin
83
- add_placement_performance_report_definition()
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
@@ -1,113 +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 campaign with Real Time Bidding
21
- # turned on.
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 add_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
- # Prepare for adding campaign.
43
- operation = {
44
- :operator => 'ADD',
45
- :operand => {
46
- :name => 'Interplanetary Cruise #%s' % (Time.new.to_f * 1000).to_i,
47
- :status => 'PAUSED',
48
- :bidding_strategy => {
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 => 'ManualCPC'
53
- },
54
- :budget => {
55
- :period => 'DAILY',
56
- :amount => {
57
- :micro_amount => 50000000
58
- },
59
- :delivery_method => 'STANDARD'
60
- },
61
- # Set the campaign network options to Search and Search Network.
62
- :network_setting => {
63
- :target_google_search => true,
64
- :target_search_network => true,
65
- :target_content_network => false,
66
- :target_content_contextual => false
67
- },
68
- :settings => {
69
- :xsi_type => 'RealTimeBiddingSetting',
70
- :opt_in => 'true'
71
- }
72
- }
73
- }
74
-
75
- # Add campaign.
76
- response = campaign_srv.mutate([operation])
77
- if response and response[:value]
78
- campaign = response[:value].first
79
- puts 'Campaign with name "%s" and id %d was added.' %
80
- [campaign[:name], campaign[:id]]
81
- else
82
- puts 'No campaigns were added.'
83
- end
84
- end
85
-
86
- if __FILE__ == $0
87
- begin
88
- add_campaign()
89
-
90
- # Connection error. Likely transitory.
91
- rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
92
- puts 'Connection Error: %s' % e
93
- puts 'Source: %s' % e.backtrace.first
94
-
95
- # API Error.
96
- rescue AdwordsApi::Errors::ApiException => e
97
- puts 'API Exception caught.'
98
- puts 'Message: %s' % e.message
99
- puts 'Code: %d' % e.code if e.code
100
- puts 'Trigger: %s' % e.trigger if e.trigger
101
- puts 'Errors:'
102
- if e.errors
103
- e.errors.each_with_index do |error, index|
104
- puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
105
- error.each_pair do |field, value|
106
- if field != :xsi_type
107
- puts ' %s: %s' % [field, value]
108
- end
109
- end
110
- end
111
- end
112
- end
113
- end