google-adwords-api 0.7.0 → 0.7.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (130) hide show
  1. data/ChangeLog +3 -0
  2. data/README +3 -3
  3. data/examples/v201206/basic_operations/add_campaigns.rb +7 -2
  4. data/examples/v201209/account_management/create_account.rb +84 -0
  5. data/examples/v201209/account_management/get_account_alerts.rb +111 -0
  6. data/examples/v201209/account_management/get_account_changes.rb +137 -0
  7. data/examples/v201209/account_management/get_account_hierarchy.rb +92 -0
  8. data/examples/v201209/account_management/get_client_customer_id.rb +85 -0
  9. data/examples/v201209/account_management/get_client_unit_usage.rb +87 -0
  10. data/examples/v201209/basic_operations/add_ad_groups.rb +136 -0
  11. data/examples/v201209/basic_operations/add_campaigns.rb +159 -0
  12. data/examples/v201209/basic_operations/add_keywords.rb +108 -0
  13. data/examples/v201209/basic_operations/add_text_ads.rb +105 -0
  14. data/examples/v201209/basic_operations/delete_ad.rb +85 -0
  15. data/examples/v201209/basic_operations/delete_ad_group.rb +102 -0
  16. data/examples/v201209/basic_operations/delete_campaign.rb +103 -0
  17. data/examples/v201209/basic_operations/delete_keyword.rb +90 -0
  18. data/examples/v201209/basic_operations/get_ad_groups.rb +98 -0
  19. data/examples/v201209/basic_operations/get_campaigns.rb +93 -0
  20. data/examples/v201209/basic_operations/get_campaigns_with_awql.rb +85 -0
  21. data/examples/v201209/basic_operations/get_keywords.rb +104 -0
  22. data/examples/v201209/basic_operations/get_text_ads.rb +106 -0
  23. data/examples/v201209/basic_operations/pause_ad.rb +84 -0
  24. data/examples/v201209/basic_operations/update_ad_group.rb +81 -0
  25. data/examples/v201209/basic_operations/update_campaign.rb +82 -0
  26. data/examples/v201209/basic_operations/update_keyword.rb +99 -0
  27. data/examples/v201209/campaign_management/add_experiment.rb +158 -0
  28. data/examples/v201209/campaign_management/add_keywords_in_bulk.rb +150 -0
  29. data/examples/v201209/campaign_management/add_location_extension.rb +117 -0
  30. data/examples/v201209/campaign_management/add_location_extension_override.rb +83 -0
  31. data/examples/v201209/campaign_management/get_all_disapproved_ads.rb +93 -0
  32. data/examples/v201209/campaign_management/get_all_disapproved_ads_with_awql.rb +84 -0
  33. data/examples/v201209/campaign_management/promote_experiment.rb +77 -0
  34. data/examples/v201209/campaign_management/set_ad_parameters.rb +114 -0
  35. data/examples/v201209/campaign_management/validate_text_ad.rb +106 -0
  36. data/examples/v201209/error_handling/handle_captcha_challenge.rb +93 -0
  37. data/examples/v201209/error_handling/handle_partial_failures.rb +126 -0
  38. data/examples/v201209/error_handling/handle_policy_violation_error.rb +137 -0
  39. data/examples/v201209/error_handling/handle_two_factor_authorization_error.rb +87 -0
  40. data/examples/v201209/misc/get_all_images_and_videos.rb +100 -0
  41. data/examples/v201209/misc/upload_image.rb +89 -0
  42. data/examples/v201209/misc/use_oauth.rb +100 -0
  43. data/examples/v201209/misc/use_oauth2.rb +97 -0
  44. data/examples/v201209/optimization/estimate_keyword_traffic.rb +129 -0
  45. data/examples/v201209/optimization/get_keyword_bid_simulations.rb +92 -0
  46. data/examples/v201209/optimization/get_keyword_ideas.rb +114 -0
  47. data/examples/v201209/optimization/get_placement_ideas.rb +104 -0
  48. data/examples/v201209/remarketing/add_audience.rb +115 -0
  49. data/examples/v201209/remarketing/add_conversion_tracker.rb +97 -0
  50. data/examples/v201209/reporting/download_criteria_report.rb +79 -0
  51. data/examples/v201209/reporting/download_criteria_report_with_awql.rb +78 -0
  52. data/examples/v201209/reporting/get_campaign_stats.rb +105 -0
  53. data/examples/v201209/reporting/get_report_fields.rb +71 -0
  54. data/examples/v201209/reporting/parallel_report_download.rb +160 -0
  55. data/examples/v201209/targeting/add_campaign_targeting_criteria.rb +118 -0
  56. data/examples/v201209/targeting/add_demographic_targeting_criteria.rb +108 -0
  57. data/examples/v201209/targeting/get_campaign_targeting_criteria.rb +102 -0
  58. data/examples/v201209/targeting/get_targetable_languages_and_carriers.rb +86 -0
  59. data/examples/v201209/targeting/lookup_location.rb +104 -0
  60. data/lib/adwords_api/api_config.rb +64 -5
  61. data/lib/adwords_api/errors.rb +15 -0
  62. data/lib/adwords_api/report_utils.rb +30 -11
  63. data/lib/adwords_api/v201209/ad_extension_override_service.rb +38 -0
  64. data/lib/adwords_api/v201209/ad_extension_override_service_registry.rb +46 -0
  65. data/lib/adwords_api/v201209/ad_group_ad_service.rb +42 -0
  66. data/lib/adwords_api/v201209/ad_group_ad_service_registry.rb +46 -0
  67. data/lib/adwords_api/v201209/ad_group_criterion_service.rb +42 -0
  68. data/lib/adwords_api/v201209/ad_group_criterion_service_registry.rb +46 -0
  69. data/lib/adwords_api/v201209/ad_group_service.rb +42 -0
  70. data/lib/adwords_api/v201209/ad_group_service_registry.rb +46 -0
  71. data/lib/adwords_api/v201209/ad_param_service.rb +38 -0
  72. data/lib/adwords_api/v201209/ad_param_service_registry.rb +46 -0
  73. data/lib/adwords_api/v201209/alert_service.rb +34 -0
  74. data/lib/adwords_api/v201209/alert_service_registry.rb +46 -0
  75. data/lib/adwords_api/v201209/budget_order_service.rb +42 -0
  76. data/lib/adwords_api/v201209/budget_order_service_registry.rb +46 -0
  77. data/lib/adwords_api/v201209/budget_service.rb +38 -0
  78. data/lib/adwords_api/v201209/budget_service_registry.rb +46 -0
  79. data/lib/adwords_api/v201209/campaign_ad_extension_service.rb +38 -0
  80. data/lib/adwords_api/v201209/campaign_ad_extension_service_registry.rb +46 -0
  81. data/lib/adwords_api/v201209/campaign_criterion_service.rb +42 -0
  82. data/lib/adwords_api/v201209/campaign_criterion_service_registry.rb +46 -0
  83. data/lib/adwords_api/v201209/campaign_service.rb +42 -0
  84. data/lib/adwords_api/v201209/campaign_service_registry.rb +46 -0
  85. data/lib/adwords_api/v201209/constant_data_service.rb +62 -0
  86. data/lib/adwords_api/v201209/constant_data_service_registry.rb +46 -0
  87. data/lib/adwords_api/v201209/conversion_tracker_service.rb +38 -0
  88. data/lib/adwords_api/v201209/conversion_tracker_service_registry.rb +46 -0
  89. data/lib/adwords_api/v201209/customer_service.rb +34 -0
  90. data/lib/adwords_api/v201209/customer_service_registry.rb +46 -0
  91. data/lib/adwords_api/v201209/customer_sync_service.rb +34 -0
  92. data/lib/adwords_api/v201209/customer_sync_service_registry.rb +47 -0
  93. data/lib/adwords_api/v201209/data_service.rb +38 -0
  94. data/lib/adwords_api/v201209/data_service_registry.rb +46 -0
  95. data/lib/adwords_api/v201209/experiment_service.rb +38 -0
  96. data/lib/adwords_api/v201209/experiment_service_registry.rb +46 -0
  97. data/lib/adwords_api/v201209/geo_location_service.rb +34 -0
  98. data/lib/adwords_api/v201209/geo_location_service_registry.rb +46 -0
  99. data/lib/adwords_api/v201209/info_service.rb +34 -0
  100. data/lib/adwords_api/v201209/info_service_registry.rb +46 -0
  101. data/lib/adwords_api/v201209/location_criterion_service.rb +34 -0
  102. data/lib/adwords_api/v201209/location_criterion_service_registry.rb +46 -0
  103. data/lib/adwords_api/v201209/managed_customer_service.rb +38 -0
  104. data/lib/adwords_api/v201209/managed_customer_service_registry.rb +46 -0
  105. data/lib/adwords_api/v201209/media_service.rb +38 -0
  106. data/lib/adwords_api/v201209/media_service_registry.rb +46 -0
  107. data/lib/adwords_api/v201209/mutate_job_service.rb +42 -0
  108. data/lib/adwords_api/v201209/mutate_job_service_registry.rb +46 -0
  109. data/lib/adwords_api/v201209/report_definition_service.rb +34 -0
  110. data/lib/adwords_api/v201209/report_definition_service_registry.rb +46 -0
  111. data/lib/adwords_api/v201209/targeting_idea_service.rb +38 -0
  112. data/lib/adwords_api/v201209/targeting_idea_service_registry.rb +46 -0
  113. data/lib/adwords_api/v201209/traffic_estimator_service.rb +34 -0
  114. data/lib/adwords_api/v201209/traffic_estimator_service_registry.rb +46 -0
  115. data/lib/adwords_api/v201209/user_list_service.rb +38 -0
  116. data/lib/adwords_api/v201209/user_list_service_registry.rb +46 -0
  117. data/lib/adwords_api/version.rb +1 -1
  118. data/test/adwords_api/test_report_utils.rb +94 -6
  119. data/test/examples/v201209/test_account_management.rb +60 -0
  120. data/test/examples/v201209/test_basic_operations.rb +177 -0
  121. data/test/examples/v201209/test_campaign_management.rb +124 -0
  122. data/test/examples/v201209/test_error_handling.rb +63 -0
  123. data/test/examples/v201209/test_misc.rb +45 -0
  124. data/test/examples/v201209/test_optimization.rb +63 -0
  125. data/test/examples/v201209/test_remarketing.rb +39 -0
  126. data/test/examples/v201209/test_reporting.rb +84 -0
  127. data/test/examples/v201209/test_targeting.rb +60 -0
  128. data/test/examples/v201209/utils.rb +238 -0
  129. data/test/suite_exampletests_v201209.rb +37 -0
  130. metadata +123 -2
@@ -0,0 +1,108 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
+ #
6
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
+ #
8
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
+ # you may not use this file except in compliance with the License.
10
+ # You may obtain a copy of the License at
11
+ #
12
+ # http://www.apache.org/licenses/LICENSE-2.0
13
+ #
14
+ # Unless required by applicable law or agreed to in writing, software
15
+ # distributed under the License is distributed on an "AS IS" BASIS,
16
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
+ # implied.
18
+ # See the License for the specific language governing permissions and
19
+ # limitations under the License.
20
+ #
21
+ # This example illustrates how to add multiple keywords to a given ad group. To
22
+ # create an ad group, run add_ad_group.rb.
23
+ #
24
+ # Tags: AdGroupCriterionService.mutate
25
+
26
+ require 'adwords_api'
27
+
28
+ def add_keywords(ad_group_id)
29
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
30
+ # when called without parameters.
31
+ adwords = AdwordsApi::Api.new
32
+
33
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
34
+ # the configuration file or provide your own logger:
35
+ # adwords.logger = Logger.new('adwords_xml.log')
36
+
37
+ ad_group_criterion_srv =
38
+ adwords.service(:AdGroupCriterionService, API_VERSION)
39
+
40
+ # Create keywords.
41
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
42
+ # being created. It's only necessary when you must provide an explicit
43
+ # type that the client library can't infer.
44
+ keywords = [
45
+ {:xsi_type => 'BiddableAdGroupCriterion',
46
+ :ad_group_id => ad_group_id,
47
+ :criterion => {
48
+ :xsi_type => 'Keyword',
49
+ :text => 'mars cruise',
50
+ :match_type => 'BROAD'
51
+ },
52
+ # Optional fields:
53
+ :user_status => 'PAUSED',
54
+ :destination_url => 'http://example.com/mars'
55
+ },
56
+ {:xsi_type => 'BiddableAdGroupCriterion',
57
+ :ad_group_id => ad_group_id,
58
+ :criterion => {
59
+ :xsi_type => 'Keyword',
60
+ :text => 'space hotel',
61
+ :match_type => 'BROAD'}}
62
+ ]
63
+
64
+ # Create 'ADD' operations.
65
+ operations = keywords.map do |keyword|
66
+ {:operator => 'ADD', :operand => keyword}
67
+ end
68
+
69
+ # Add keywords.
70
+ response = ad_group_criterion_srv.mutate(operations)
71
+ if response and response[:value]
72
+ ad_group_criteria = response[:value]
73
+ puts "Added %d keywords to ad group ID %d:" %
74
+ [ad_group_criteria.length, ad_group_id]
75
+ ad_group_criteria.each do |ad_group_criterion|
76
+ puts "\tKeyword ID is %d and type is '%s'" %
77
+ [ad_group_criterion[:criterion][:id],
78
+ ad_group_criterion[:criterion][:type]]
79
+ end
80
+ else
81
+ raise StandardError, 'No keywords were added.'
82
+ end
83
+ end
84
+
85
+ if __FILE__ == $0
86
+ API_VERSION = :v201209
87
+
88
+ begin
89
+ # Ad group ID to add keywords to.
90
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
91
+ add_keywords(ad_group_id)
92
+
93
+ # HTTP errors.
94
+ rescue AdsCommon::Errors::HttpError => e
95
+ puts "HTTP Error: %s" % e
96
+
97
+ # API errors.
98
+ rescue AdwordsApi::Errors::ApiException => e
99
+ puts "Message: %s" % e.message
100
+ puts 'Errors:'
101
+ e.errors.each_with_index do |error, index|
102
+ puts "\tError [%d]:" % (index + 1)
103
+ error.each do |field, value|
104
+ puts "\t\t%s: %s" % [field, value]
105
+ end
106
+ end
107
+ end
108
+ end
@@ -0,0 +1,105 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
+ #
6
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
+ #
8
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
+ # you may not use this file except in compliance with the License.
10
+ # You may obtain a copy of the License at
11
+ #
12
+ # http://www.apache.org/licenses/LICENSE-2.0
13
+ #
14
+ # Unless required by applicable law or agreed to in writing, software
15
+ # distributed under the License is distributed on an "AS IS" BASIS,
16
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
+ # implied.
18
+ # See the License for the specific language governing permissions and
19
+ # limitations under the License.
20
+ #
21
+ # This example illustrates how to add text ads to a given ad group. To create an
22
+ # ad group, run add_ad_group.rb.
23
+ #
24
+ # Tags: AdGroupAdService.mutate
25
+
26
+ require 'adwords_api'
27
+
28
+ def add_text_ads(ad_group_id)
29
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
30
+ # when called without parameters.
31
+ adwords = AdwordsApi::Api.new
32
+
33
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
34
+ # the configuration file or provide your own logger:
35
+ # adwords.logger = Logger.new('adwords_xml.log')
36
+
37
+ ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
38
+
39
+ # Create text ads.
40
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
41
+ # being created. It's only necessary when you must provide an explicit
42
+ # type that the client library can't infer.
43
+ text_ads = [
44
+ {
45
+ :xsi_type => 'TextAd',
46
+ :headline => 'Luxury Cruise to Mars',
47
+ :description1 => 'Visit the Red Planet in style.',
48
+ :description2 => 'Low-gravity fun for everyone!',
49
+ :url => 'http://www.example.com',
50
+ :display_url => 'www.example.com'
51
+ },
52
+ {
53
+ :xsi_type => 'TextAd',
54
+ :headline => 'Luxury Cruise to Mars',
55
+ :description1 => 'Enjoy your stay at Red Planet.',
56
+ :description2 => 'Buy your tickets now!',
57
+ :url => 'http://www.example.com',
58
+ :display_url => 'www.example.com'
59
+ }
60
+ ]
61
+
62
+ # Create ad 'ADD' operations.
63
+ text_ad_operations = text_ads.map do |text_ad|
64
+ {:operator => 'ADD',
65
+ :operand => {:ad_group_id => ad_group_id, :ad => text_ad}}
66
+ end
67
+
68
+ # Add ads.
69
+ response = ad_group_ad_srv.mutate(text_ad_operations)
70
+ if response and response[:value]
71
+ ads = response[:value]
72
+ puts "Added %d ad(s) to ad group ID %d:" % [ads.length, ad_group_id]
73
+ ads.each do |ad|
74
+ puts "\tAd ID %d, type '%s' and status '%s'" %
75
+ [ad[:ad][:id], ad[:ad][:ad_type], ad[:status]]
76
+ end
77
+ else
78
+ raise StandardError, 'No ads were added.'
79
+ end
80
+ end
81
+
82
+ if __FILE__ == $0
83
+ API_VERSION = :v201209
84
+
85
+ begin
86
+ # Ad group ID to add text ads to.
87
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
88
+ add_text_ads(ad_group_id)
89
+
90
+ # HTTP errors.
91
+ rescue AdsCommon::Errors::HttpError => e
92
+ puts "HTTP Error: %s" % e
93
+
94
+ # API errors.
95
+ rescue AdwordsApi::Errors::ApiException => e
96
+ puts "Message: %s" % e.message
97
+ puts 'Errors:'
98
+ e.errors.each_with_index do |error, index|
99
+ puts "\tError [%d]:" % (index + 1)
100
+ error.each do |field, value|
101
+ puts "\t\t%s: %s" % [field, value]
102
+ end
103
+ end
104
+ end
105
+ end
@@ -0,0 +1,85 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Author:: api.sgomes@gmail.com (Sérgio Gomes)
5
+ #
6
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
+ #
8
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
+ # you may not use this file except in compliance with the License.
10
+ # You may obtain a copy of the License at
11
+ #
12
+ # http://www.apache.org/licenses/LICENSE-2.0
13
+ #
14
+ # Unless required by applicable law or agreed to in writing, software
15
+ # distributed under the License is distributed on an "AS IS" BASIS,
16
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
+ # implied.
18
+ # See the License for the specific language governing permissions and
19
+ # limitations under the License.
20
+ #
21
+ # This example deletes an ad using the 'REMOVE' operator. To get ads, run
22
+ # get_text_ads.rb.
23
+ #
24
+ # Tags: AdGroupAdService.mutate
25
+
26
+ require 'adwords_api'
27
+
28
+ def delete_ad(ad_group_id, ad_id)
29
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
30
+ # when called without parameters.
31
+ adwords = AdwordsApi::Api.new
32
+
33
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
34
+ # the configuration file or provide your own logger:
35
+ # adwords.logger = Logger.new('adwords_xml.log')
36
+
37
+ ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
38
+
39
+ # Prepare for deleting ad.
40
+ operation = {
41
+ :operator => 'REMOVE',
42
+ :operand => {
43
+ :ad_group_id => ad_group_id,
44
+ :ad => {
45
+ :xsi_type => 'Ad',
46
+ :id => ad_id
47
+ }
48
+ }
49
+ }
50
+
51
+ # Delete ad.
52
+ response = ad_group_ad_srv.mutate([operation])
53
+ if response and response[:value]
54
+ ad = response[:value].first
55
+ puts "Ad ID %d was successfully deleted." % ad[:ad][:id]
56
+ else
57
+ puts 'No ads were deleted.'
58
+ end
59
+ end
60
+
61
+ if __FILE__ == $0
62
+ API_VERSION = :v201209
63
+
64
+ begin
65
+ # IDs of an ad to delete and its ad group.
66
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
67
+ ad_id = 'INSERT_AD_ID_HERE'.to_i
68
+ delete_ad(ad_group_id, ad_id)
69
+
70
+ # HTTP errors.
71
+ rescue AdsCommon::Errors::HttpError => e
72
+ puts "HTTP Error: %s" % e
73
+
74
+ # API errors.
75
+ rescue AdwordsApi::Errors::ApiException => e
76
+ puts "Message: %s" % e.message
77
+ puts 'Errors:'
78
+ e.errors.each_with_index do |error, index|
79
+ puts "\tError [%d]:" % (index + 1)
80
+ error.each do |field, value|
81
+ puts "\t\t%s: %s" % [field, value]
82
+ end
83
+ end
84
+ end
85
+ end
@@ -0,0 +1,102 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
+ #
6
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
+ #
8
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
+ # you may not use this file except in compliance with the License.
10
+ # You may obtain a copy of the License at
11
+ #
12
+ # http://www.apache.org/licenses/LICENSE-2.0
13
+ #
14
+ # Unless required by applicable law or agreed to in writing, software
15
+ # distributed under the License is distributed on an "AS IS" BASIS,
16
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
+ # implied.
18
+ # See the License for the specific language governing permissions and
19
+ # limitations under the License.
20
+ #
21
+ # This example deletes an ad group by setting the status to 'DELETED'. To get ad
22
+ # groups, run get_ad_groups.rb.
23
+ #
24
+ # Tags: AdGroupService.mutate
25
+
26
+ require 'adwords_api'
27
+
28
+ def delete_ad_group(ad_group_id)
29
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
30
+ # when called without parameters.
31
+ adwords = AdwordsApi::Api.new
32
+
33
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
34
+ # the configuration file or provide your own logger:
35
+ # adwords.logger = Logger.new('adwords_xml.log')
36
+
37
+ ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
38
+
39
+ # Retrieve the ad group to obtain its name. This is optional but recommended
40
+ # to keep deleted objects searchable. In production the name is already known
41
+ # in most cases.
42
+ selector = {
43
+ :fields => ['Id', 'Name'],
44
+ :predicates => [
45
+ {:field => 'Id', :operator => 'EQUALS', :values => [ad_group_id]}
46
+ ]
47
+ }
48
+ result = ad_group_srv.get(selector)
49
+
50
+ if result.nil? or result[:entries].empty?
51
+ raise StandardError, "Ad group with ID %d was not found." % ad_group_id
52
+ end
53
+
54
+ # We recommend renaming object on delete to avoid name conflicts later.
55
+ ad_group_name = result[:entries].first[:name]
56
+ ad_group_name += Time.now.strftime(" (deleted on %Y-%m-%d %H:%M:%S)")
57
+
58
+ # Prepare for deleting ad group.
59
+ operation = {
60
+ :operator => 'SET',
61
+ :operand => {
62
+ :id => ad_group_id,
63
+ :name => ad_group_name,
64
+ :status => 'DELETED'
65
+ }
66
+ }
67
+
68
+ # Delete ad group.
69
+ response = ad_group_srv.mutate([operation])
70
+ if response and response[:value]
71
+ ad_group = response[:value].first
72
+ puts "Ad group ID %d was successfully deleted and renamed to '%s'." %
73
+ [ad_group[:id], ad_group[:name]]
74
+ else
75
+ puts 'No ad group was updated.'
76
+ end
77
+ end
78
+
79
+ if __FILE__ == $0
80
+ API_VERSION = :v201209
81
+
82
+ begin
83
+ # ID of an ad group to delete.
84
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
85
+ delete_ad_group(ad_group_id)
86
+
87
+ # HTTP errors.
88
+ rescue AdsCommon::Errors::HttpError => e
89
+ puts "HTTP Error: %s" % e
90
+
91
+ # API errors.
92
+ rescue AdwordsApi::Errors::ApiException => e
93
+ puts "Message: %s" % e.message
94
+ puts 'Errors:'
95
+ e.errors.each_with_index do |error, index|
96
+ puts "\tError [%d]:" % (index + 1)
97
+ error.each do |field, value|
98
+ puts "\t\t%s: %s" % [field, value]
99
+ end
100
+ end
101
+ end
102
+ end
@@ -0,0 +1,103 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
+ #
6
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
+ #
8
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
+ # you may not use this file except in compliance with the License.
10
+ # You may obtain a copy of the License at
11
+ #
12
+ # http://www.apache.org/licenses/LICENSE-2.0
13
+ #
14
+ # Unless required by applicable law or agreed to in writing, software
15
+ # distributed under the License is distributed on an "AS IS" BASIS,
16
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
+ # implied.
18
+ # See the License for the specific language governing permissions and
19
+ # limitations under the License.
20
+ #
21
+ # This example deletes a campaign by setting the status to 'DELETED'. To get
22
+ # campaigns, run get_campaigns.rb.
23
+ #
24
+ # Tags: CampaignService.mutate
25
+
26
+ require 'adwords_api'
27
+
28
+ def delete_campaign(campaign_id)
29
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
30
+ # when called without parameters.
31
+ adwords = AdwordsApi::Api.new
32
+
33
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
34
+ # the configuration file or provide your own logger:
35
+ # adwords.logger = Logger.new('adwords_xml.log')
36
+
37
+ campaign_srv = adwords.service(:CampaignService, API_VERSION)
38
+
39
+ # Retrieve the campaign to obtain its name. This is optional but recommended
40
+ # to keep deleted objects searchable. In production the name is already known
41
+ # in most cases.
42
+ selector = {
43
+ :fields => ['Id', 'Name'],
44
+ :predicates => [
45
+ {:field => 'Id', :operator => 'EQUALS', :values => [campaign_id]}
46
+ ]
47
+ }
48
+ result = campaign_srv.get(selector)
49
+
50
+ if result.nil? or result[:entries].empty?
51
+ raise StandardError, "Campaign with ID %d was not found." % campaign_id
52
+ end
53
+
54
+ # We recommend renaming object on delete to avoid name conflicts later.
55
+ campaign_name = result[:entries].first[:name]
56
+ campaign_name += Time.now.strftime(" (deleted on %Y-%m-%d %H:%M:%S)")
57
+
58
+ # Prepare for deleting campaign.
59
+ operation = {
60
+ :operator => 'SET',
61
+ :operand => {
62
+ :id => campaign_id,
63
+ :name => campaign_name,
64
+ :status => 'DELETED',
65
+ }
66
+ }
67
+
68
+ # Delete campaign.
69
+ response = campaign_srv.mutate([operation])
70
+
71
+ if response and response[:value]
72
+ campaign = response[:value].first
73
+ puts "Campaign ID %d was renamed to '%s' and deleted." %
74
+ [campaign[:id], campaign[:name]]
75
+ else
76
+ puts 'No campaign was updated.'
77
+ end
78
+ end
79
+
80
+ if __FILE__ == $0
81
+ API_VERSION = :v201209
82
+
83
+ begin
84
+ # ID of a campaign to delete.
85
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
86
+ delete_campaign(campaign_id)
87
+
88
+ # HTTP errors.
89
+ rescue AdsCommon::Errors::HttpError => e
90
+ puts "HTTP Error: %s" % e
91
+
92
+ # API errors.
93
+ rescue AdwordsApi::Errors::ApiException => e
94
+ puts "Message: %s" % e.message
95
+ puts 'Errors:'
96
+ e.errors.each_with_index do |error, index|
97
+ puts "\tError [%d]:" % (index + 1)
98
+ error.each do |field, value|
99
+ puts "\t\t%s: %s" % [field, value]
100
+ end
101
+ end
102
+ end
103
+ end