google-adwords-api 0.15.1 → 0.15.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +8 -8
- data/ChangeLog +4 -0
- data/examples/v201502/extensions/add_google_my_business_location_extensions.rb +4 -4
- data/examples/v201506/account_management/create_account.rb +92 -0
- data/examples/v201506/account_management/get_account_changes.rb +143 -0
- data/examples/v201506/account_management/get_account_hierarchy.rb +98 -0
- data/examples/v201506/advanced_operations/add_ad_customizers.rb +189 -0
- data/examples/v201506/advanced_operations/add_ad_group_bid_modifier.rb +105 -0
- data/examples/v201506/advanced_operations/add_click_to_download_ad.rb +137 -0
- data/examples/v201506/advanced_operations/add_text_ad_with_upgraded_urls.rb +138 -0
- data/examples/v201506/advanced_operations/create_and_attach_shared_keyword_set.rb +137 -0
- data/examples/v201506/advanced_operations/find_and_remove_criteria_from_shared_set.rb +171 -0
- data/examples/v201506/advanced_operations/get_ad_group_bid_modifiers.rb +106 -0
- data/examples/v201506/advanced_operations/upload_offline_conversions.rb +117 -0
- data/examples/v201506/advanced_operations/use_shared_bidding_strategy.rb +152 -0
- data/examples/v201506/basic_operations/add_ad_groups.rb +144 -0
- data/examples/v201506/basic_operations/add_campaigns.rb +143 -0
- data/examples/v201506/basic_operations/add_keywords.rb +118 -0
- data/examples/v201506/basic_operations/add_text_ads.rb +113 -0
- data/examples/v201506/basic_operations/get_ad_groups.rb +106 -0
- data/examples/v201506/basic_operations/get_campaigns.rb +101 -0
- data/examples/v201506/basic_operations/get_campaigns_with_awql.rb +93 -0
- data/examples/v201506/basic_operations/get_keywords.rb +112 -0
- data/examples/v201506/basic_operations/get_text_ads.rb +114 -0
- data/examples/v201506/basic_operations/pause_ad.rb +92 -0
- data/examples/v201506/basic_operations/remove_ad.rb +93 -0
- data/examples/v201506/basic_operations/remove_ad_group.rb +89 -0
- data/examples/v201506/basic_operations/remove_campaign.rb +91 -0
- data/examples/v201506/basic_operations/remove_keyword.rb +98 -0
- data/examples/v201506/basic_operations/update_ad_group.rb +89 -0
- data/examples/v201506/basic_operations/update_campaign.rb +90 -0
- data/examples/v201506/basic_operations/update_keyword.rb +110 -0
- data/examples/v201506/campaign_management/add_campaign_labels.rb +86 -0
- data/examples/v201506/campaign_management/add_experiment.rb +166 -0
- data/examples/v201506/campaign_management/add_keywords_in_bulk.rb +158 -0
- data/examples/v201506/campaign_management/get_all_disapproved_ads.rb +101 -0
- data/examples/v201506/campaign_management/get_all_disapproved_ads_with_awql.rb +93 -0
- data/examples/v201506/campaign_management/get_campaigns_by_label.rb +112 -0
- data/examples/v201506/campaign_management/promote_experiment.rb +85 -0
- data/examples/v201506/campaign_management/set_ad_parameters.rb +122 -0
- data/examples/v201506/campaign_management/set_criterion_bid_modifier.rb +108 -0
- data/examples/v201506/campaign_management/validate_text_ad.rb +114 -0
- data/examples/v201506/error_handling/handle_partial_failures.rb +134 -0
- data/examples/v201506/error_handling/handle_policy_violation_error.rb +145 -0
- data/examples/v201506/extensions/add_google_my_business_location_extensions.rb +190 -0
- data/examples/v201506/extensions/add_site_links.rb +168 -0
- data/examples/v201506/extensions/add_site_links_using_feeds.rb +276 -0
- data/examples/v201506/migration/migrate_to_extension_settings.rb +392 -0
- data/examples/v201506/migration/upgrade_ad_url.rb +97 -0
- data/examples/v201506/misc/create_ad_words_session_without_properties_file.rb +94 -0
- data/examples/v201506/misc/get_all_images_and_videos.rb +108 -0
- data/examples/v201506/misc/setup_oauth2.rb +88 -0
- data/examples/v201506/misc/upload_image.rb +97 -0
- data/examples/v201506/misc/use_oauth2_jwt.rb +97 -0
- data/examples/v201506/optimization/estimate_keyword_traffic.rb +150 -0
- data/examples/v201506/optimization/get_keyword_bid_simulations.rb +99 -0
- data/examples/v201506/optimization/get_keyword_ideas.rb +130 -0
- data/examples/v201506/remarketing/add_audience.rb +122 -0
- data/examples/v201506/remarketing/add_conversion_tracker.rb +104 -0
- data/examples/v201506/remarketing/add_rule_based_user_lists.rb +171 -0
- data/examples/v201506/reporting/download_criteria_report.rb +94 -0
- data/examples/v201506/reporting/download_criteria_report_with_awql.rb +95 -0
- data/examples/v201506/reporting/get_report_fields.rb +79 -0
- data/examples/v201506/reporting/parallel_report_download.rb +168 -0
- data/examples/v201506/shopping_campaigns/add_product_partition_tree.rb +269 -0
- data/examples/v201506/shopping_campaigns/add_product_scope.rb +133 -0
- data/examples/v201506/shopping_campaigns/add_shopping_campaign.rb +133 -0
- data/examples/v201506/shopping_campaigns/get_product_category_taxonomy.rb +117 -0
- data/examples/v201506/targeting/add_campaign_targeting_criteria.rb +184 -0
- data/examples/v201506/targeting/add_demographic_targeting_criteria.rb +116 -0
- data/examples/v201506/targeting/get_campaign_targeting_criteria.rb +110 -0
- data/examples/v201506/targeting/get_targetable_languages_and_carriers.rb +94 -0
- data/examples/v201506/targeting/lookup_location.rb +112 -0
- data/lib/adwords_api.rb +9 -0
- data/lib/adwords_api/api_config.rb +90 -4
- data/lib/adwords_api/report_header_handler.rb +5 -0
- data/lib/adwords_api/v201506/account_label_service.rb +38 -0
- data/lib/adwords_api/v201506/account_label_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/ad_customizer_feed_service.rb +38 -0
- data/lib/adwords_api/v201506/ad_customizer_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/ad_group_ad_service.rb +50 -0
- data/lib/adwords_api/v201506/ad_group_ad_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/ad_group_bid_modifier_service.rb +42 -0
- data/lib/adwords_api/v201506/ad_group_bid_modifier_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/ad_group_criterion_service.rb +46 -0
- data/lib/adwords_api/v201506/ad_group_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/ad_group_extension_setting_service.rb +42 -0
- data/lib/adwords_api/v201506/ad_group_extension_setting_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/ad_group_feed_service.rb +42 -0
- data/lib/adwords_api/v201506/ad_group_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/ad_group_service.rb +46 -0
- data/lib/adwords_api/v201506/ad_group_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/ad_param_service.rb +38 -0
- data/lib/adwords_api/v201506/ad_param_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/adwords_user_list_service.rb +38 -0
- data/lib/adwords_api/v201506/adwords_user_list_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/bidding_strategy_service.rb +42 -0
- data/lib/adwords_api/v201506/bidding_strategy_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/budget_order_service.rb +42 -0
- data/lib/adwords_api/v201506/budget_order_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/budget_service.rb +42 -0
- data/lib/adwords_api/v201506/budget_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/campaign_criterion_service.rb +42 -0
- data/lib/adwords_api/v201506/campaign_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/campaign_extension_setting_service.rb +42 -0
- data/lib/adwords_api/v201506/campaign_extension_setting_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/campaign_feed_service.rb +42 -0
- data/lib/adwords_api/v201506/campaign_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/campaign_service.rb +46 -0
- data/lib/adwords_api/v201506/campaign_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/campaign_shared_set_service.rb +42 -0
- data/lib/adwords_api/v201506/campaign_shared_set_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/constant_data_service.rb +66 -0
- data/lib/adwords_api/v201506/constant_data_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/conversion_tracker_service.rb +42 -0
- data/lib/adwords_api/v201506/conversion_tracker_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/customer_extension_setting_service.rb +42 -0
- data/lib/adwords_api/v201506/customer_extension_setting_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/customer_feed_service.rb +42 -0
- data/lib/adwords_api/v201506/customer_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/customer_service.rb +38 -0
- data/lib/adwords_api/v201506/customer_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/customer_sync_service.rb +34 -0
- data/lib/adwords_api/v201506/customer_sync_service_registry.rb +47 -0
- data/lib/adwords_api/v201506/data_service.rb +54 -0
- data/lib/adwords_api/v201506/data_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/experiment_service.rb +38 -0
- data/lib/adwords_api/v201506/experiment_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/feed_item_service.rb +42 -0
- data/lib/adwords_api/v201506/feed_item_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/feed_mapping_service.rb +42 -0
- data/lib/adwords_api/v201506/feed_mapping_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/feed_service.rb +42 -0
- data/lib/adwords_api/v201506/feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/geo_location_service.rb +34 -0
- data/lib/adwords_api/v201506/geo_location_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/label_service.rb +42 -0
- data/lib/adwords_api/v201506/label_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/location_criterion_service.rb +38 -0
- data/lib/adwords_api/v201506/location_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/managed_customer_service.rb +54 -0
- data/lib/adwords_api/v201506/managed_customer_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/media_service.rb +42 -0
- data/lib/adwords_api/v201506/media_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/mutate_job_service.rb +42 -0
- data/lib/adwords_api/v201506/mutate_job_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/offline_conversion_feed_service.rb +34 -0
- data/lib/adwords_api/v201506/offline_conversion_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/report_definition_service.rb +34 -0
- data/lib/adwords_api/v201506/report_definition_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/shared_criterion_service.rb +42 -0
- data/lib/adwords_api/v201506/shared_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/shared_set_service.rb +42 -0
- data/lib/adwords_api/v201506/shared_set_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/targeting_idea_service.rb +34 -0
- data/lib/adwords_api/v201506/targeting_idea_service_registry.rb +46 -0
- data/lib/adwords_api/v201506/traffic_estimator_service.rb +34 -0
- data/lib/adwords_api/v201506/traffic_estimator_service_registry.rb +46 -0
- data/lib/adwords_api/version.rb +1 -1
- data/test/adwords_api/test_adwords_api.rb +1 -1
- data/test/adwords_api/test_api_config.rb +8 -8
- data/test/adwords_api/test_choices.rb +2 -2
- data/test/adwords_api/test_report_utils.rb +1 -1
- data/test/templates/v201506/basic_operations_get_campaigns.def +116 -0
- data/test/templates/v201506/misc_use_oauth2_jwt.def +131 -0
- metadata +156 -2
@@ -0,0 +1,92 @@
|
|
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 update an ad, setting its status to 'PAUSED'.
|
22
|
+
# To create ads, run add_text_ads.rb.
|
23
|
+
#
|
24
|
+
# Tags: AdGroupAdService.mutate
|
25
|
+
|
26
|
+
require 'adwords_api'
|
27
|
+
|
28
|
+
def pause_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 operation for updating ad.
|
40
|
+
operation = {
|
41
|
+
:operator => 'SET',
|
42
|
+
:operand => {
|
43
|
+
:ad_group_id => ad_group_id,
|
44
|
+
:status => 'PAUSED',
|
45
|
+
:ad => {:id => ad_id}
|
46
|
+
}
|
47
|
+
}
|
48
|
+
|
49
|
+
# Update ad.
|
50
|
+
response = ad_group_ad_srv.mutate([operation])
|
51
|
+
if response and response[:value]
|
52
|
+
ad = response[:value].first
|
53
|
+
puts "Ad ID %d was successfully updated, status set to '%s'." %
|
54
|
+
[ad[:ad][:id], ad[:status]]
|
55
|
+
else
|
56
|
+
puts 'No ads were updated.'
|
57
|
+
end
|
58
|
+
end
|
59
|
+
|
60
|
+
if __FILE__ == $0
|
61
|
+
API_VERSION = :v201506
|
62
|
+
|
63
|
+
begin
|
64
|
+
# IDs of ad to pause and its ad group.
|
65
|
+
ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
|
66
|
+
ad_id = 'INSERT_AD_ID_HERE'.to_i
|
67
|
+
pause_ad(ad_group_id, ad_id)
|
68
|
+
|
69
|
+
# Authorization error.
|
70
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
71
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
72
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
73
|
+
"to retrieve and store OAuth2 tokens."
|
74
|
+
puts "See this wiki page for more details:\n\n " +
|
75
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
76
|
+
|
77
|
+
# HTTP errors.
|
78
|
+
rescue AdsCommon::Errors::HttpError => e
|
79
|
+
puts "HTTP Error: %s" % e
|
80
|
+
|
81
|
+
# API errors.
|
82
|
+
rescue AdwordsApi::Errors::ApiException => e
|
83
|
+
puts "Message: %s" % e.message
|
84
|
+
puts 'Errors:'
|
85
|
+
e.errors.each_with_index do |error, index|
|
86
|
+
puts "\tError [%d]:" % (index + 1)
|
87
|
+
error.each do |field, value|
|
88
|
+
puts "\t\t%s: %s" % [field, value]
|
89
|
+
end
|
90
|
+
end
|
91
|
+
end
|
92
|
+
end
|
@@ -0,0 +1,93 @@
|
|
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 removes 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 remove_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
|
+
# Remove 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 removed." % ad[:ad][:id]
|
56
|
+
else
|
57
|
+
puts 'No ads were removed.'
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
61
|
+
if __FILE__ == $0
|
62
|
+
API_VERSION = :v201506
|
63
|
+
|
64
|
+
begin
|
65
|
+
# IDs of an ad to remove 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
|
+
remove_ad(ad_group_id, ad_id)
|
69
|
+
|
70
|
+
# Authorization error.
|
71
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
72
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
73
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
74
|
+
"to retrieve and store OAuth2 tokens."
|
75
|
+
puts "See this wiki page for more details:\n\n " +
|
76
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
77
|
+
|
78
|
+
# HTTP errors.
|
79
|
+
rescue AdsCommon::Errors::HttpError => e
|
80
|
+
puts "HTTP Error: %s" % e
|
81
|
+
|
82
|
+
# API errors.
|
83
|
+
rescue AdwordsApi::Errors::ApiException => e
|
84
|
+
puts "Message: %s" % e.message
|
85
|
+
puts 'Errors:'
|
86
|
+
e.errors.each_with_index do |error, index|
|
87
|
+
puts "\tError [%d]:" % (index + 1)
|
88
|
+
error.each do |field, value|
|
89
|
+
puts "\t\t%s: %s" % [field, value]
|
90
|
+
end
|
91
|
+
end
|
92
|
+
end
|
93
|
+
end
|
@@ -0,0 +1,89 @@
|
|
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 removes an ad group by setting the status to 'REMOVED'. To get ad
|
22
|
+
# groups, run get_ad_groups.rb.
|
23
|
+
#
|
24
|
+
# Tags: AdGroupService.mutate
|
25
|
+
|
26
|
+
require 'adwords_api'
|
27
|
+
|
28
|
+
def remove_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
|
+
# Prepare for deleting ad group.
|
40
|
+
operation = {
|
41
|
+
:operator => 'SET',
|
42
|
+
:operand => {
|
43
|
+
:id => ad_group_id,
|
44
|
+
:status => 'REMOVED'
|
45
|
+
}
|
46
|
+
}
|
47
|
+
|
48
|
+
# Remove ad group.
|
49
|
+
response = ad_group_srv.mutate([operation])
|
50
|
+
if response and response[:value]
|
51
|
+
ad_group = response[:value].first
|
52
|
+
puts "Ad group ID %d was successfully removed." % [ad_group[:id]]
|
53
|
+
else
|
54
|
+
puts 'No ad group was updated.'
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
58
|
+
if __FILE__ == $0
|
59
|
+
API_VERSION = :v201506
|
60
|
+
|
61
|
+
begin
|
62
|
+
# ID of an ad group to remove.
|
63
|
+
ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
|
64
|
+
remove_ad_group(ad_group_id)
|
65
|
+
|
66
|
+
# Authorization error.
|
67
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
68
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
69
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
70
|
+
"to retrieve and store OAuth2 tokens."
|
71
|
+
puts "See this wiki page for more details:\n\n " +
|
72
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
73
|
+
|
74
|
+
# HTTP errors.
|
75
|
+
rescue AdsCommon::Errors::HttpError => e
|
76
|
+
puts "HTTP Error: %s" % e
|
77
|
+
|
78
|
+
# API errors.
|
79
|
+
rescue AdwordsApi::Errors::ApiException => e
|
80
|
+
puts "Message: %s" % e.message
|
81
|
+
puts 'Errors:'
|
82
|
+
e.errors.each_with_index do |error, index|
|
83
|
+
puts "\tError [%d]:" % (index + 1)
|
84
|
+
error.each do |field, value|
|
85
|
+
puts "\t\t%s: %s" % [field, value]
|
86
|
+
end
|
87
|
+
end
|
88
|
+
end
|
89
|
+
end
|
@@ -0,0 +1,91 @@
|
|
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 removes a campaign by setting the status to 'REMOVED'. To get
|
22
|
+
# campaigns, run get_campaigns.rb.
|
23
|
+
#
|
24
|
+
# Tags: CampaignService.mutate
|
25
|
+
|
26
|
+
require 'adwords_api'
|
27
|
+
|
28
|
+
def remove_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
|
+
# Prepare for deleting campaign.
|
40
|
+
operation = {
|
41
|
+
:operator => 'SET',
|
42
|
+
:operand => {
|
43
|
+
:id => campaign_id,
|
44
|
+
:status => 'REMOVED'
|
45
|
+
}
|
46
|
+
}
|
47
|
+
|
48
|
+
# Remove campaign.
|
49
|
+
response = campaign_srv.mutate([operation])
|
50
|
+
|
51
|
+
if response and response[:value]
|
52
|
+
campaign = response[:value].first
|
53
|
+
puts "Campaign ID %d was removed." %
|
54
|
+
[campaign[:id]]
|
55
|
+
else
|
56
|
+
puts 'No campaign was updated.'
|
57
|
+
end
|
58
|
+
end
|
59
|
+
|
60
|
+
if __FILE__ == $0
|
61
|
+
API_VERSION = :v201506
|
62
|
+
|
63
|
+
begin
|
64
|
+
# ID of a campaign to remove.
|
65
|
+
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
|
66
|
+
remove_campaign(campaign_id)
|
67
|
+
|
68
|
+
# Authorization error.
|
69
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
70
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
71
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
72
|
+
"to retrieve and store OAuth2 tokens."
|
73
|
+
puts "See this wiki page for more details:\n\n " +
|
74
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
75
|
+
|
76
|
+
# HTTP errors.
|
77
|
+
rescue AdsCommon::Errors::HttpError => e
|
78
|
+
puts "HTTP Error: %s" % e
|
79
|
+
|
80
|
+
# API errors.
|
81
|
+
rescue AdwordsApi::Errors::ApiException => e
|
82
|
+
puts "Message: %s" % e.message
|
83
|
+
puts 'Errors:'
|
84
|
+
e.errors.each_with_index do |error, index|
|
85
|
+
puts "\tError [%d]:" % (index + 1)
|
86
|
+
error.each do |field, value|
|
87
|
+
puts "\t\t%s: %s" % [field, value]
|
88
|
+
end
|
89
|
+
end
|
90
|
+
end
|
91
|
+
end
|
@@ -0,0 +1,98 @@
|
|
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 removes a keyword using the 'REMOVE' operator. To get list of
|
22
|
+
# keywords, run get_keywords.rb.
|
23
|
+
#
|
24
|
+
# Tags: AdGroupCriterionService.mutate
|
25
|
+
|
26
|
+
require 'adwords_api'
|
27
|
+
|
28
|
+
def remove_keyword(ad_group_id, criterion_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
|
+
# Prepare for deleting keyword.
|
41
|
+
operation = {
|
42
|
+
:operator => 'REMOVE',
|
43
|
+
:operand => {
|
44
|
+
# The 'xsi_type' field allows you to specify the xsi:type of the object
|
45
|
+
# being created. It's only necessary when you must provide an explicit
|
46
|
+
# type that the client library can't infer.
|
47
|
+
:xsi_type => 'BiddableAdGroupCriterion',
|
48
|
+
:ad_group_id => ad_group_id,
|
49
|
+
:criterion => {
|
50
|
+
:id => criterion_id
|
51
|
+
}
|
52
|
+
}
|
53
|
+
}
|
54
|
+
|
55
|
+
# Remove keyword.
|
56
|
+
response = ad_group_criterion_srv.mutate([operation])
|
57
|
+
ad_group_criterion = response[:value].first
|
58
|
+
if ad_group_criterion
|
59
|
+
puts "Keyword ID %d was successfully removed." %
|
60
|
+
ad_group_criterion[:criterion][:id]
|
61
|
+
else
|
62
|
+
puts 'No keywords were removed.'
|
63
|
+
end
|
64
|
+
end
|
65
|
+
|
66
|
+
if __FILE__ == $0
|
67
|
+
API_VERSION = :v201506
|
68
|
+
|
69
|
+
begin
|
70
|
+
# IDs of criterion to remove and its ad group.
|
71
|
+
ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
|
72
|
+
criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
|
73
|
+
remove_keyword(ad_group_id, criterion_id)
|
74
|
+
|
75
|
+
# Authorization error.
|
76
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
77
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
78
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
79
|
+
"to retrieve and store OAuth2 tokens."
|
80
|
+
puts "See this wiki page for more details:\n\n " +
|
81
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
82
|
+
|
83
|
+
# HTTP errors.
|
84
|
+
rescue AdsCommon::Errors::HttpError => e
|
85
|
+
puts "HTTP Error: %s" % e
|
86
|
+
|
87
|
+
# API errors.
|
88
|
+
rescue AdwordsApi::Errors::ApiException => e
|
89
|
+
puts "Message: %s" % e.message
|
90
|
+
puts 'Errors:'
|
91
|
+
e.errors.each_with_index do |error, index|
|
92
|
+
puts "\tError [%d]:" % (index + 1)
|
93
|
+
error.each do |field, value|
|
94
|
+
puts "\t\t%s: %s" % [field, value]
|
95
|
+
end
|
96
|
+
end
|
97
|
+
end
|
98
|
+
end
|