google-adwords-api 0.14.1 → 0.14.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +8 -8
- data/ChangeLog +3 -0
- data/examples/v201406/optimization/estimate_keyword_traffic.rb +30 -12
- data/examples/v201409/basic_operations/add_keywords.rb +3 -1
- data/examples/v201409/{advanced_operations → extensions}/add_google_my_business_location_extensions.rb +1 -1
- data/examples/v201409/extensions/add_site_links.rb +167 -0
- data/examples/v201409/{advanced_operations/add_site_links.rb → extensions/add_site_links_using_feeds.rb} +0 -0
- data/examples/v201409/migration/migrate_to_extension_settings.rb +365 -0
- data/examples/v201409/optimization/estimate_keyword_traffic.rb +30 -13
- data/examples/v201502/account_management/create_account.rb +92 -0
- data/examples/v201502/account_management/get_account_changes.rb +143 -0
- data/examples/v201502/account_management/get_account_hierarchy.rb +98 -0
- data/examples/v201502/advanced_operations/add_ad_customizer.rb +277 -0
- data/examples/v201502/advanced_operations/add_ad_group_bid_modifier.rb +105 -0
- data/examples/v201502/advanced_operations/add_click_to_download_ad.rb +137 -0
- data/examples/v201502/advanced_operations/add_text_ad_with_upgraded_urls.rb +137 -0
- data/examples/v201502/advanced_operations/create_and_attach_shared_keyword_set.rb +137 -0
- data/examples/v201502/advanced_operations/find_and_remove_criteria_from_shared_set.rb +171 -0
- data/examples/v201502/advanced_operations/get_ad_group_bid_modifiers.rb +106 -0
- data/examples/v201502/advanced_operations/upload_offline_conversions.rb +117 -0
- data/examples/v201502/advanced_operations/use_shared_bidding_strategy.rb +152 -0
- data/examples/v201502/basic_operations/add_ad_groups.rb +144 -0
- data/examples/v201502/basic_operations/add_campaigns.rb +143 -0
- data/examples/v201502/basic_operations/add_keywords.rb +118 -0
- data/examples/v201502/basic_operations/add_text_ads.rb +113 -0
- data/examples/v201502/basic_operations/get_ad_groups.rb +106 -0
- data/examples/v201502/basic_operations/get_campaigns.rb +101 -0
- data/examples/v201502/basic_operations/get_campaigns_with_awql.rb +93 -0
- data/examples/v201502/basic_operations/get_keywords.rb +112 -0
- data/examples/v201502/basic_operations/get_text_ads.rb +114 -0
- data/examples/v201502/basic_operations/pause_ad.rb +92 -0
- data/examples/v201502/basic_operations/remove_ad.rb +93 -0
- data/examples/v201502/basic_operations/remove_ad_group.rb +89 -0
- data/examples/v201502/basic_operations/remove_campaign.rb +91 -0
- data/examples/v201502/basic_operations/remove_keyword.rb +98 -0
- data/examples/v201502/basic_operations/update_ad_group.rb +89 -0
- data/examples/v201502/basic_operations/update_campaign.rb +90 -0
- data/examples/v201502/basic_operations/update_keyword.rb +110 -0
- data/examples/v201502/campaign_management/add_campaign_labels.rb +86 -0
- data/examples/v201502/campaign_management/add_experiment.rb +166 -0
- data/examples/v201502/campaign_management/add_keywords_in_bulk.rb +158 -0
- data/examples/v201502/campaign_management/add_location_extension.rb +125 -0
- data/examples/v201502/campaign_management/get_all_disapproved_ads.rb +101 -0
- data/examples/v201502/campaign_management/get_all_disapproved_ads_with_awql.rb +93 -0
- data/examples/v201502/campaign_management/get_campaigns_by_label.rb +112 -0
- data/examples/v201502/campaign_management/promote_experiment.rb +85 -0
- data/examples/v201502/campaign_management/set_ad_parameters.rb +122 -0
- data/examples/v201502/campaign_management/set_criterion_bid_modifier.rb +108 -0
- data/examples/v201502/campaign_management/validate_text_ad.rb +114 -0
- data/examples/v201502/error_handling/handle_captcha_challenge.rb +93 -0
- data/examples/v201502/error_handling/handle_partial_failures.rb +134 -0
- data/examples/v201502/error_handling/handle_policy_violation_error.rb +145 -0
- data/examples/v201502/error_handling/handle_two_factor_authorization_error.rb +88 -0
- data/examples/v201502/extensions/add_google_my_business_location_extensions.rb +183 -0
- data/examples/v201502/extensions/add_site_links.rb +167 -0
- data/examples/v201502/extensions/add_site_links_using_feeds.rb +306 -0
- data/examples/v201502/migration/migrate_to_extension_settings.rb +365 -0
- data/examples/v201502/migration/upgrade_ad_url.rb +97 -0
- data/examples/v201502/misc/create_ad_words_session_without_properties_file.rb +94 -0
- data/examples/v201502/misc/get_all_images_and_videos.rb +108 -0
- data/examples/v201502/misc/setup_oauth2.rb +88 -0
- data/examples/v201502/misc/upload_image.rb +97 -0
- data/examples/v201502/misc/use_oauth2_jwt.rb +97 -0
- data/examples/v201502/optimization/estimate_keyword_traffic.rb +155 -0
- data/examples/v201502/optimization/get_keyword_bid_simulations.rb +99 -0
- data/examples/v201502/optimization/get_keyword_ideas.rb +130 -0
- data/examples/v201502/remarketing/add_audience.rb +122 -0
- data/examples/v201502/remarketing/add_conversion_tracker.rb +105 -0
- data/examples/v201502/remarketing/add_rule_based_user_lists.rb +171 -0
- data/examples/v201502/reporting/download_criteria_report.rb +87 -0
- data/examples/v201502/reporting/download_criteria_report_with_awql.rb +86 -0
- data/examples/v201502/reporting/get_report_fields.rb +79 -0
- data/examples/v201502/reporting/parallel_report_download.rb +168 -0
- data/examples/v201502/shopping_campaigns/add_product_partition_tree.rb +269 -0
- data/examples/v201502/shopping_campaigns/add_product_scope.rb +133 -0
- data/examples/v201502/shopping_campaigns/add_shopping_campaign.rb +133 -0
- data/examples/v201502/shopping_campaigns/get_product_category_taxonomy.rb +117 -0
- data/examples/v201502/targeting/add_campaign_targeting_criteria.rb +173 -0
- data/examples/v201502/targeting/add_demographic_targeting_criteria.rb +116 -0
- data/examples/v201502/targeting/get_campaign_targeting_criteria.rb +110 -0
- data/examples/v201502/targeting/get_targetable_languages_and_carriers.rb +94 -0
- data/examples/v201502/targeting/lookup_location.rb +112 -0
- data/lib/adwords_api/api_config.rb +98 -4
- data/lib/adwords_api/v201409/ad_customizer_feed_service.rb +38 -0
- data/lib/adwords_api/v201409/ad_customizer_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201409/ad_group_extension_setting_service.rb +42 -0
- data/lib/adwords_api/v201409/ad_group_extension_setting_service_registry.rb +46 -0
- data/lib/adwords_api/v201409/campaign_extension_setting_service.rb +42 -0
- data/lib/adwords_api/v201409/campaign_extension_setting_service_registry.rb +46 -0
- data/lib/adwords_api/v201409/customer_extension_setting_service.rb +42 -0
- data/lib/adwords_api/v201409/customer_extension_setting_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/account_label_service.rb +38 -0
- data/lib/adwords_api/v201502/account_label_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/ad_customizer_feed_service.rb +38 -0
- data/lib/adwords_api/v201502/ad_customizer_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/ad_group_ad_service.rb +50 -0
- data/lib/adwords_api/v201502/ad_group_ad_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/ad_group_bid_modifier_service.rb +42 -0
- data/lib/adwords_api/v201502/ad_group_bid_modifier_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/ad_group_criterion_service.rb +46 -0
- data/lib/adwords_api/v201502/ad_group_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/ad_group_extension_setting_service.rb +42 -0
- data/lib/adwords_api/v201502/ad_group_extension_setting_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/ad_group_feed_service.rb +42 -0
- data/lib/adwords_api/v201502/ad_group_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/ad_group_service.rb +46 -0
- data/lib/adwords_api/v201502/ad_group_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/ad_param_service.rb +38 -0
- data/lib/adwords_api/v201502/ad_param_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/adwords_user_list_service.rb +38 -0
- data/lib/adwords_api/v201502/adwords_user_list_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/bidding_strategy_service.rb +42 -0
- data/lib/adwords_api/v201502/bidding_strategy_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/budget_order_service.rb +42 -0
- data/lib/adwords_api/v201502/budget_order_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/budget_service.rb +42 -0
- data/lib/adwords_api/v201502/budget_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/campaign_criterion_service.rb +42 -0
- data/lib/adwords_api/v201502/campaign_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/campaign_extension_setting_service.rb +42 -0
- data/lib/adwords_api/v201502/campaign_extension_setting_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/campaign_feed_service.rb +42 -0
- data/lib/adwords_api/v201502/campaign_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/campaign_service.rb +46 -0
- data/lib/adwords_api/v201502/campaign_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/campaign_shared_set_service.rb +38 -0
- data/lib/adwords_api/v201502/campaign_shared_set_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/constant_data_service.rb +66 -0
- data/lib/adwords_api/v201502/constant_data_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/conversion_tracker_service.rb +42 -0
- data/lib/adwords_api/v201502/conversion_tracker_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/customer_extension_setting_service.rb +42 -0
- data/lib/adwords_api/v201502/customer_extension_setting_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/customer_feed_service.rb +42 -0
- data/lib/adwords_api/v201502/customer_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/customer_service.rb +38 -0
- data/lib/adwords_api/v201502/customer_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/customer_sync_service.rb +34 -0
- data/lib/adwords_api/v201502/customer_sync_service_registry.rb +47 -0
- data/lib/adwords_api/v201502/data_service.rb +54 -0
- data/lib/adwords_api/v201502/data_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/experiment_service.rb +38 -0
- data/lib/adwords_api/v201502/experiment_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/feed_item_service.rb +42 -0
- data/lib/adwords_api/v201502/feed_item_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/feed_mapping_service.rb +42 -0
- data/lib/adwords_api/v201502/feed_mapping_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/feed_service.rb +42 -0
- data/lib/adwords_api/v201502/feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/geo_location_service.rb +34 -0
- data/lib/adwords_api/v201502/geo_location_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/label_service.rb +42 -0
- data/lib/adwords_api/v201502/label_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/location_criterion_service.rb +38 -0
- data/lib/adwords_api/v201502/location_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/managed_customer_service.rb +54 -0
- data/lib/adwords_api/v201502/managed_customer_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/media_service.rb +42 -0
- data/lib/adwords_api/v201502/media_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/mutate_job_service.rb +42 -0
- data/lib/adwords_api/v201502/mutate_job_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/offline_conversion_feed_service.rb +34 -0
- data/lib/adwords_api/v201502/offline_conversion_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/report_definition_service.rb +34 -0
- data/lib/adwords_api/v201502/report_definition_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/shared_criterion_service.rb +38 -0
- data/lib/adwords_api/v201502/shared_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/shared_set_service.rb +38 -0
- data/lib/adwords_api/v201502/shared_set_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/targeting_idea_service.rb +34 -0
- data/lib/adwords_api/v201502/targeting_idea_service_registry.rb +46 -0
- data/lib/adwords_api/v201502/traffic_estimator_service.rb +34 -0
- data/lib/adwords_api/v201502/traffic_estimator_service_registry.rb +46 -0
- data/lib/adwords_api/version.rb +1 -1
- data/test/adwords_api/test_adwords_api.rb +1 -12
- data/test/templates/v201406/basic_operations_get_campaigns.def +1 -1
- data/test/templates/v201406/misc_use_oauth2_jwt.def +1 -1
- data/test/templates/v201409/basic_operations_get_campaigns.def +1 -1
- data/test/templates/v201409/misc_use_oauth2_jwt.def +1 -1
- data/test/templates/v201502/basic_operations_get_campaigns.def +114 -0
- data/test/templates/v201502/misc_use_oauth2_jwt.def +131 -0
- metadata +173 -8
- data/examples/v201406/advanced_operations/update_site_links.rb +0 -194
- data/examples/v201409/advanced_operations/update_site_links.rb +0 -194
@@ -0,0 +1,144 @@
|
|
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 create ad groups. To get a list of existing
|
22
|
+
# campaigns run get_campaigns.rb.
|
23
|
+
#
|
24
|
+
# Tags: AdGroupService.mutate
|
25
|
+
|
26
|
+
require 'adwords_api'
|
27
|
+
|
28
|
+
def add_ad_groups(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
|
+
ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
|
38
|
+
|
39
|
+
ad_groups = [
|
40
|
+
{
|
41
|
+
:name => "Earth to Mars Cruises #%d" % (Time.new.to_f * 1000).to_i,
|
42
|
+
:status => 'ENABLED',
|
43
|
+
:campaign_id => campaign_id,
|
44
|
+
:bidding_strategy_configuration => {
|
45
|
+
:bids => [
|
46
|
+
{
|
47
|
+
# The 'xsi_type' field allows you to specify the xsi:type of the
|
48
|
+
# object being created. It's only necessary when you must provide
|
49
|
+
# an explicit type that the client library can't infer.
|
50
|
+
:xsi_type => 'CpcBid',
|
51
|
+
:bid => {:micro_amount => 10000000}
|
52
|
+
}
|
53
|
+
]
|
54
|
+
},
|
55
|
+
:settings => [
|
56
|
+
# Targeting restriction settings - these settings only affect serving
|
57
|
+
# for the Display Network.
|
58
|
+
{
|
59
|
+
:xsi_type => 'TargetingSetting',
|
60
|
+
:details => [
|
61
|
+
# Restricting to serve ads that match your ad group placements.
|
62
|
+
# This is equivalent to choosing "Target and bid" in the UI.
|
63
|
+
{
|
64
|
+
:xsi_type => 'TargetingSettingDetail',
|
65
|
+
:criterion_type_group => 'PLACEMENT',
|
66
|
+
:target_all => false
|
67
|
+
},
|
68
|
+
# Using your ad group verticals only for bidding. This is equivalent
|
69
|
+
# to choosing "Bid only" in the UI.
|
70
|
+
{
|
71
|
+
:xsi_type => 'TargetingSettingDetail',
|
72
|
+
:criterion_type_group => 'VERTICAL',
|
73
|
+
:target_all => true
|
74
|
+
}
|
75
|
+
]
|
76
|
+
}
|
77
|
+
]
|
78
|
+
},
|
79
|
+
{
|
80
|
+
:name => 'Earth to Pluto Cruises #%d' % (Time.new.to_f * 1000).to_i,
|
81
|
+
:status => 'ENABLED',
|
82
|
+
:campaign_id => campaign_id,
|
83
|
+
:bidding_strategy_configuration => {
|
84
|
+
:bids => [
|
85
|
+
{
|
86
|
+
# The 'xsi_type' field allows you to specify the xsi:type of the
|
87
|
+
# object being created. It's only necessary when you must provide
|
88
|
+
# an explicit type that the client library can't infer.
|
89
|
+
:xsi_type => 'CpcBid',
|
90
|
+
:bid => {:micro_amount => 10000000}
|
91
|
+
}
|
92
|
+
]
|
93
|
+
}
|
94
|
+
}
|
95
|
+
]
|
96
|
+
|
97
|
+
# Prepare operations for adding ad groups.
|
98
|
+
operations = ad_groups.map do |ad_group|
|
99
|
+
{:operator => 'ADD', :operand => ad_group}
|
100
|
+
end
|
101
|
+
|
102
|
+
# Add ad groups.
|
103
|
+
response = ad_group_srv.mutate(operations)
|
104
|
+
if response and response[:value]
|
105
|
+
response[:value].each do |ad_group|
|
106
|
+
puts "Ad group ID %d was successfully added." % ad_group[:id]
|
107
|
+
end
|
108
|
+
else
|
109
|
+
raise StandardError, 'No ad group was added'
|
110
|
+
end
|
111
|
+
end
|
112
|
+
|
113
|
+
if __FILE__ == $0
|
114
|
+
API_VERSION = :v201502
|
115
|
+
|
116
|
+
begin
|
117
|
+
# Campaign ID to add ad group to.
|
118
|
+
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
|
119
|
+
add_ad_groups(campaign_id)
|
120
|
+
|
121
|
+
# Authorization error.
|
122
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
123
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
124
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
125
|
+
"to retrieve and store OAuth2 tokens."
|
126
|
+
puts "See this wiki page for more details:\n\n " +
|
127
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
128
|
+
|
129
|
+
# HTTP errors.
|
130
|
+
rescue AdsCommon::Errors::HttpError => e
|
131
|
+
puts "HTTP Error: %s" % e
|
132
|
+
|
133
|
+
# API errors.
|
134
|
+
rescue AdwordsApi::Errors::ApiException => e
|
135
|
+
puts "Message: %s" % e.message
|
136
|
+
puts 'Errors:'
|
137
|
+
e.errors.each_with_index do |error, index|
|
138
|
+
puts "\tError [%d]:" % (index + 1)
|
139
|
+
error.each do |field, value|
|
140
|
+
puts "\t\t%s: %s" % [field, value]
|
141
|
+
end
|
142
|
+
end
|
143
|
+
end
|
144
|
+
end
|
@@ -0,0 +1,143 @@
|
|
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 create campaigns.
|
22
|
+
#
|
23
|
+
# Tags: CampaignService.mutate, BudgetService.mutate
|
24
|
+
|
25
|
+
require 'adwords_api'
|
26
|
+
require 'date'
|
27
|
+
|
28
|
+
def add_campaigns()
|
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
|
+
budget_srv = adwords.service(:BudgetService, API_VERSION)
|
38
|
+
campaign_srv = adwords.service(:CampaignService, API_VERSION)
|
39
|
+
|
40
|
+
# Create a budget, which can be shared by multiple campaigns.
|
41
|
+
budget = {
|
42
|
+
:name => 'Interplanetary budget #%d' % (Time.new.to_f * 1000).to_i,
|
43
|
+
:amount => {:micro_amount => 50000000},
|
44
|
+
:delivery_method => 'STANDARD',
|
45
|
+
:period => 'DAILY'
|
46
|
+
}
|
47
|
+
budget_operation = {:operator => 'ADD', :operand => budget}
|
48
|
+
|
49
|
+
# Add budget.
|
50
|
+
return_budget = budget_srv.mutate([budget_operation])
|
51
|
+
budget_id = return_budget[:value].first[:budget_id]
|
52
|
+
|
53
|
+
# Create campaigns.
|
54
|
+
campaigns = [
|
55
|
+
{
|
56
|
+
:name => "Interplanetary Cruise #%d" % (Time.new.to_f * 1000).to_i,
|
57
|
+
:status => 'PAUSED',
|
58
|
+
:bidding_strategy_configuration => {
|
59
|
+
:bidding_strategy_type => 'MANUAL_CPC'
|
60
|
+
},
|
61
|
+
# Budget (required) - note only the budget ID is required.
|
62
|
+
:budget => {:budget_id => budget_id},
|
63
|
+
:advertising_channel_type => 'SEARCH',
|
64
|
+
# Optional fields:
|
65
|
+
:start_date =>
|
66
|
+
DateTime.parse((Date.today + 1).to_s).strftime('%Y%m%d'),
|
67
|
+
:ad_serving_optimization_status => 'ROTATE',
|
68
|
+
:network_setting => {
|
69
|
+
:target_google_search => true,
|
70
|
+
:target_search_network => true,
|
71
|
+
:target_content_network => true
|
72
|
+
},
|
73
|
+
:settings => [
|
74
|
+
{
|
75
|
+
:xsi_type => 'GeoTargetTypeSetting',
|
76
|
+
:positive_geo_target_type => 'DONT_CARE',
|
77
|
+
:negative_geo_target_type => 'DONT_CARE'
|
78
|
+
}
|
79
|
+
],
|
80
|
+
:frequency_cap => {
|
81
|
+
:impressions => '5',
|
82
|
+
:time_unit => 'DAY',
|
83
|
+
:level => 'ADGROUP'
|
84
|
+
}
|
85
|
+
},
|
86
|
+
{
|
87
|
+
:name => "Interplanetary Cruise banner #%d" % (Time.new.to_f * 1000).to_i,
|
88
|
+
:status => 'PAUSED',
|
89
|
+
:bidding_strategy_configuration => {
|
90
|
+
:bidding_strategy_type => 'MANUAL_CPC'
|
91
|
+
},
|
92
|
+
:budget => {:budget_id => budget_id},
|
93
|
+
:advertising_channel_type => 'DISPLAY'
|
94
|
+
}
|
95
|
+
]
|
96
|
+
|
97
|
+
# Prepare for adding campaign.
|
98
|
+
operations = campaigns.map do |campaign|
|
99
|
+
{:operator => 'ADD', :operand => campaign}
|
100
|
+
end
|
101
|
+
|
102
|
+
# Add campaign.
|
103
|
+
response = campaign_srv.mutate(operations)
|
104
|
+
if response and response[:value]
|
105
|
+
response[:value].each do |campaign|
|
106
|
+
puts "Campaign with name '%s' and ID %d was added." %
|
107
|
+
[campaign[:name], campaign[:id]]
|
108
|
+
end
|
109
|
+
else
|
110
|
+
raise new StandardError, 'No campaigns were added.'
|
111
|
+
end
|
112
|
+
end
|
113
|
+
|
114
|
+
if __FILE__ == $0
|
115
|
+
API_VERSION = :v201502
|
116
|
+
|
117
|
+
begin
|
118
|
+
add_campaigns()
|
119
|
+
|
120
|
+
# Authorization error.
|
121
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
122
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
123
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
124
|
+
"to retrieve and store OAuth2 tokens."
|
125
|
+
puts "See this wiki page for more details:\n\n " +
|
126
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
127
|
+
|
128
|
+
# HTTP errors.
|
129
|
+
rescue AdsCommon::Errors::HttpError => e
|
130
|
+
puts "HTTP Error: %s" % e
|
131
|
+
|
132
|
+
# API errors.
|
133
|
+
rescue AdwordsApi::Errors::ApiException => e
|
134
|
+
puts "Message: %s" % e.message
|
135
|
+
puts 'Errors:'
|
136
|
+
e.errors.each_with_index do |error, index|
|
137
|
+
puts "\tError [%d]:" % (index + 1)
|
138
|
+
error.each do |field, value|
|
139
|
+
puts "\t\t%s: %s" % [field, value]
|
140
|
+
end
|
141
|
+
end
|
142
|
+
end
|
143
|
+
end
|
@@ -0,0 +1,118 @@
|
|
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
|
+
:final_urls => {
|
55
|
+
:urls => ['http://example.com/mars']
|
56
|
+
}
|
57
|
+
},
|
58
|
+
{:xsi_type => 'BiddableAdGroupCriterion',
|
59
|
+
:ad_group_id => ad_group_id,
|
60
|
+
:criterion => {
|
61
|
+
:xsi_type => 'Keyword',
|
62
|
+
:text => 'space hotel',
|
63
|
+
:match_type => 'BROAD'}}
|
64
|
+
]
|
65
|
+
|
66
|
+
# Create 'ADD' operations.
|
67
|
+
operations = keywords.map do |keyword|
|
68
|
+
{:operator => 'ADD', :operand => keyword}
|
69
|
+
end
|
70
|
+
|
71
|
+
# Add keywords.
|
72
|
+
response = ad_group_criterion_srv.mutate(operations)
|
73
|
+
if response and response[:value]
|
74
|
+
ad_group_criteria = response[:value]
|
75
|
+
puts "Added %d keywords to ad group ID %d:" %
|
76
|
+
[ad_group_criteria.length, ad_group_id]
|
77
|
+
ad_group_criteria.each do |ad_group_criterion|
|
78
|
+
puts "\tKeyword ID is %d and type is '%s'" %
|
79
|
+
[ad_group_criterion[:criterion][:id],
|
80
|
+
ad_group_criterion[:criterion][:type]]
|
81
|
+
end
|
82
|
+
else
|
83
|
+
raise StandardError, 'No keywords were added.'
|
84
|
+
end
|
85
|
+
end
|
86
|
+
|
87
|
+
if __FILE__ == $0
|
88
|
+
API_VERSION = :v201502
|
89
|
+
|
90
|
+
begin
|
91
|
+
# Ad group ID to add keywords to.
|
92
|
+
ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
|
93
|
+
add_keywords(ad_group_id)
|
94
|
+
|
95
|
+
# Authorization error.
|
96
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
97
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
98
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
99
|
+
"to retrieve and store OAuth2 tokens."
|
100
|
+
puts "See this wiki page for more details:\n\n " +
|
101
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
102
|
+
|
103
|
+
# HTTP errors.
|
104
|
+
rescue AdsCommon::Errors::HttpError => e
|
105
|
+
puts "HTTP Error: %s" % e
|
106
|
+
|
107
|
+
# API errors.
|
108
|
+
rescue AdwordsApi::Errors::ApiException => e
|
109
|
+
puts "Message: %s" % e.message
|
110
|
+
puts 'Errors:'
|
111
|
+
e.errors.each_with_index do |error, index|
|
112
|
+
puts "\tError [%d]:" % (index + 1)
|
113
|
+
error.each do |field, value|
|
114
|
+
puts "\t\t%s: %s" % [field, value]
|
115
|
+
end
|
116
|
+
end
|
117
|
+
end
|
118
|
+
end
|
@@ -0,0 +1,113 @@
|
|
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
|
+
:final_urls => ['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
|
+
:final_urls => ['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 = :v201502
|
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
|
+
# Authorization error.
|
91
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
92
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
93
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
94
|
+
"to retrieve and store OAuth2 tokens."
|
95
|
+
puts "See this wiki page for more details:\n\n " +
|
96
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
97
|
+
|
98
|
+
# HTTP errors.
|
99
|
+
rescue AdsCommon::Errors::HttpError => e
|
100
|
+
puts "HTTP Error: %s" % e
|
101
|
+
|
102
|
+
# API errors.
|
103
|
+
rescue AdwordsApi::Errors::ApiException => e
|
104
|
+
puts "Message: %s" % e.message
|
105
|
+
puts 'Errors:'
|
106
|
+
e.errors.each_with_index do |error, index|
|
107
|
+
puts "\tError [%d]:" % (index + 1)
|
108
|
+
error.each do |field, value|
|
109
|
+
puts "\t\t%s: %s" % [field, value]
|
110
|
+
end
|
111
|
+
end
|
112
|
+
end
|
113
|
+
end
|