google-adwords-api 0.21.0 → 0.21.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/ChangeLog +5 -0
- data/examples/v201603/shopping_campaigns/add_product_scope.rb +3 -2
- data/examples/v201605/shopping_campaigns/add_product_scope.rb +3 -2
- data/examples/v201607/shopping_campaigns/add_product_scope.rb +3 -2
- data/examples/v201609/account_management/create_account.rb +88 -0
- data/examples/v201609/account_management/get_account_changes.rb +135 -0
- data/examples/v201609/account_management/get_account_hierarchy.rb +132 -0
- data/examples/v201609/advanced_operations/add_ad_customizers.rb +183 -0
- data/examples/v201609/advanced_operations/add_ad_group_bid_modifier.rb +101 -0
- data/examples/v201609/advanced_operations/add_click_to_download_ad.rb +148 -0
- data/examples/v201609/advanced_operations/add_expanded_text_ad_with_upgraded_urls.rb +132 -0
- data/examples/v201609/advanced_operations/add_html5_ad.rb +137 -0
- data/examples/v201609/advanced_operations/add_responsive_display_ad.rb +130 -0
- data/examples/v201609/advanced_operations/add_universal_app_campaign.rb +215 -0
- data/examples/v201609/advanced_operations/create_and_attach_shared_keyword_set.rb +141 -0
- data/examples/v201609/advanced_operations/find_and_remove_criteria_from_shared_set.rb +174 -0
- data/examples/v201609/advanced_operations/get_ad_group_bid_modifiers.rb +102 -0
- data/examples/v201609/advanced_operations/use_portfolio_bidding_strategy.rb +146 -0
- data/examples/v201609/basic_operations/add_ad_groups.rb +142 -0
- data/examples/v201609/basic_operations/add_campaigns.rb +138 -0
- data/examples/v201609/basic_operations/add_expanded_text_ads.rb +108 -0
- data/examples/v201609/basic_operations/add_keywords.rb +114 -0
- data/examples/v201609/basic_operations/get_ad_groups.rb +102 -0
- data/examples/v201609/basic_operations/get_campaigns.rb +97 -0
- data/examples/v201609/basic_operations/get_campaigns_with_awql.rb +89 -0
- data/examples/v201609/basic_operations/get_expanded_text_ads.rb +122 -0
- data/examples/v201609/basic_operations/get_keywords.rb +109 -0
- data/examples/v201609/basic_operations/get_text_ads.rb +109 -0
- data/examples/v201609/basic_operations/pause_ad.rb +87 -0
- data/examples/v201609/basic_operations/remove_ad.rb +89 -0
- data/examples/v201609/basic_operations/remove_ad_group.rb +85 -0
- data/examples/v201609/basic_operations/remove_campaign.rb +87 -0
- data/examples/v201609/basic_operations/remove_keyword.rb +94 -0
- data/examples/v201609/basic_operations/update_ad_group.rb +85 -0
- data/examples/v201609/basic_operations/update_campaign.rb +86 -0
- data/examples/v201609/basic_operations/update_keyword.rb +106 -0
- data/examples/v201609/campaign_management/add_campaign_labels.rb +82 -0
- data/examples/v201609/campaign_management/add_complete_campaigns_using_batch_job.rb +354 -0
- data/examples/v201609/campaign_management/add_draft.rb +113 -0
- data/examples/v201609/campaign_management/add_keywords_using_incremental_batch_job.rb +210 -0
- data/examples/v201609/campaign_management/add_trial.rb +141 -0
- data/examples/v201609/campaign_management/get_all_disapproved_ads.rb +97 -0
- data/examples/v201609/campaign_management/get_all_disapproved_ads_with_awql.rb +89 -0
- data/examples/v201609/campaign_management/get_campaigns_by_label.rb +108 -0
- data/examples/v201609/campaign_management/graduate_trial.rb +106 -0
- data/examples/v201609/campaign_management/set_ad_parameters.rb +118 -0
- data/examples/v201609/campaign_management/set_criterion_bid_modifier.rb +104 -0
- data/examples/v201609/campaign_management/validate_text_ad.rb +109 -0
- data/examples/v201609/error_handling/handle_partial_failures.rb +130 -0
- data/examples/v201609/error_handling/handle_policy_violation_error.rb +141 -0
- data/examples/v201609/extensions/add_google_my_business_location_extensions.rb +193 -0
- data/examples/v201609/extensions/add_prices.rb +162 -0
- data/examples/v201609/extensions/add_site_links.rb +199 -0
- data/examples/v201609/extensions/add_site_links_using_feeds.rb +286 -0
- data/examples/v201609/migration/migrate_to_extension_settings.rb +386 -0
- data/examples/v201609/misc/get_all_images_and_videos.rb +104 -0
- data/examples/v201609/misc/setup_oauth2.rb +84 -0
- data/examples/v201609/misc/upload_image.rb +93 -0
- data/examples/v201609/misc/upload_media_bundle.rb +90 -0
- data/examples/v201609/misc/use_oauth2_jwt.rb +93 -0
- data/examples/v201609/misc/use_runtime_config.rb +92 -0
- data/examples/v201609/optimization/estimate_keyword_traffic.rb +191 -0
- data/examples/v201609/optimization/get_campaign_criterion_bid_modifier_simulations.rb +128 -0
- data/examples/v201609/optimization/get_keyword_bid_simulations.rb +95 -0
- data/examples/v201609/optimization/get_keyword_ideas.rb +136 -0
- data/examples/v201609/remarketing/add_audience.rb +118 -0
- data/examples/v201609/remarketing/add_conversion_tracker.rb +97 -0
- data/examples/v201609/remarketing/add_crm_based_user_list.rb +116 -0
- data/examples/v201609/remarketing/add_rule_based_user_lists.rb +167 -0
- data/examples/v201609/remarketing/upload_offline_call_conversions.rb +111 -0
- data/examples/v201609/remarketing/upload_offline_conversions.rb +98 -0
- data/examples/v201609/reporting/download_criteria_report.rb +92 -0
- data/examples/v201609/reporting/download_criteria_report_with_awql.rb +93 -0
- data/examples/v201609/reporting/get_report_fields.rb +75 -0
- data/examples/v201609/reporting/parallel_report_download.rb +164 -0
- data/examples/v201609/reporting/stream_criteria_report_results.rb +97 -0
- data/examples/v201609/shopping_campaigns/add_product_partition_tree.rb +267 -0
- data/examples/v201609/shopping_campaigns/add_product_scope.rb +130 -0
- data/examples/v201609/shopping_campaigns/add_shopping_campaign.rb +129 -0
- data/examples/v201609/shopping_campaigns/get_product_category_taxonomy.rb +115 -0
- data/examples/v201609/targeting/add_campaign_targeting_criteria.rb +166 -0
- data/examples/v201609/targeting/add_demographic_targeting_criteria.rb +112 -0
- data/examples/v201609/targeting/get_campaign_targeting_criteria.rb +106 -0
- data/examples/v201609/targeting/get_targetable_languages_and_carriers.rb +89 -0
- data/examples/v201609/targeting/lookup_location.rb +108 -0
- data/lib/adwords_api/api_config.rb +96 -4
- data/lib/adwords_api/batch_job_utils.rb +6 -0
- data/lib/adwords_api/report_utils.rb +9 -4
- data/lib/adwords_api/v201609/account_label_service.rb +46 -0
- data/lib/adwords_api/v201609/account_label_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/ad_customizer_feed_service.rb +46 -0
- data/lib/adwords_api/v201609/ad_customizer_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/ad_group_ad_service.rb +70 -0
- data/lib/adwords_api/v201609/ad_group_ad_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/ad_group_bid_modifier_service.rb +54 -0
- data/lib/adwords_api/v201609/ad_group_bid_modifier_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/ad_group_criterion_service.rb +62 -0
- data/lib/adwords_api/v201609/ad_group_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/ad_group_extension_setting_service.rb +54 -0
- data/lib/adwords_api/v201609/ad_group_extension_setting_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/ad_group_feed_service.rb +54 -0
- data/lib/adwords_api/v201609/ad_group_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/ad_group_service.rb +62 -0
- data/lib/adwords_api/v201609/ad_group_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/ad_param_service.rb +46 -0
- data/lib/adwords_api/v201609/ad_param_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/adwords_user_list_service.rb +62 -0
- data/lib/adwords_api/v201609/adwords_user_list_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/batch_job_service.rb +54 -0
- data/lib/adwords_api/v201609/batch_job_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/bidding_strategy_service.rb +54 -0
- data/lib/adwords_api/v201609/bidding_strategy_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/budget_order_service.rb +54 -0
- data/lib/adwords_api/v201609/budget_order_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/budget_service.rb +54 -0
- data/lib/adwords_api/v201609/budget_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/campaign_criterion_service.rb +54 -0
- data/lib/adwords_api/v201609/campaign_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/campaign_extension_setting_service.rb +54 -0
- data/lib/adwords_api/v201609/campaign_extension_setting_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/campaign_feed_service.rb +54 -0
- data/lib/adwords_api/v201609/campaign_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/campaign_service.rb +62 -0
- data/lib/adwords_api/v201609/campaign_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/campaign_shared_set_service.rb +54 -0
- data/lib/adwords_api/v201609/campaign_shared_set_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/constant_data_service.rb +110 -0
- data/lib/adwords_api/v201609/constant_data_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/conversion_tracker_service.rb +54 -0
- data/lib/adwords_api/v201609/conversion_tracker_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/customer_extension_setting_service.rb +54 -0
- data/lib/adwords_api/v201609/customer_extension_setting_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/customer_feed_service.rb +54 -0
- data/lib/adwords_api/v201609/customer_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/customer_service.rb +62 -0
- data/lib/adwords_api/v201609/customer_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/customer_sync_service.rb +38 -0
- data/lib/adwords_api/v201609/customer_sync_service_registry.rb +47 -0
- data/lib/adwords_api/v201609/data_service.rb +94 -0
- data/lib/adwords_api/v201609/data_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/draft_async_error_service.rb +46 -0
- data/lib/adwords_api/v201609/draft_async_error_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/draft_service.rb +54 -0
- data/lib/adwords_api/v201609/draft_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/feed_item_service.rb +54 -0
- data/lib/adwords_api/v201609/feed_item_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/feed_mapping_service.rb +54 -0
- data/lib/adwords_api/v201609/feed_mapping_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/feed_service.rb +54 -0
- data/lib/adwords_api/v201609/feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/label_service.rb +54 -0
- data/lib/adwords_api/v201609/label_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/location_criterion_service.rb +46 -0
- data/lib/adwords_api/v201609/location_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/managed_customer_service.rb +78 -0
- data/lib/adwords_api/v201609/managed_customer_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/media_service.rb +54 -0
- data/lib/adwords_api/v201609/media_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/offline_call_conversion_feed_service.rb +38 -0
- data/lib/adwords_api/v201609/offline_call_conversion_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/offline_conversion_feed_service.rb +38 -0
- data/lib/adwords_api/v201609/offline_conversion_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/report_definition_service.rb +38 -0
- data/lib/adwords_api/v201609/report_definition_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/shared_criterion_service.rb +54 -0
- data/lib/adwords_api/v201609/shared_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/shared_set_service.rb +54 -0
- data/lib/adwords_api/v201609/shared_set_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/targeting_idea_service.rb +38 -0
- data/lib/adwords_api/v201609/targeting_idea_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/traffic_estimator_service.rb +38 -0
- data/lib/adwords_api/v201609/traffic_estimator_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/trial_async_error_service.rb +46 -0
- data/lib/adwords_api/v201609/trial_async_error_service_registry.rb +46 -0
- data/lib/adwords_api/v201609/trial_service.rb +54 -0
- data/lib/adwords_api/v201609/trial_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_batch_job_utils.rb +2 -2
- data/test/adwords_api/test_choices.rb +2 -2
- data/test/adwords_api/test_report_stream.rb +1 -1
- data/test/adwords_api/test_report_utils.rb +1 -1
- data/test/templates/v201609/basic_operations_get_campaigns.def +116 -0
- data/test/templates/v201609/basic_operations_update_keyword.def +125 -0
- data/test/templates/v201609/misc_use_oauth2_jwt.def +131 -0
- metadata +174 -2
@@ -0,0 +1,142 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# Encoding: utf-8
|
3
|
+
#
|
4
|
+
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
5
|
+
#
|
6
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
7
|
+
# you may not use this file except in compliance with the License.
|
8
|
+
# You may obtain a copy of the License at
|
9
|
+
#
|
10
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
11
|
+
#
|
12
|
+
# Unless required by applicable law or agreed to in writing, software
|
13
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
14
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
15
|
+
# implied.
|
16
|
+
# See the License for the specific language governing permissions and
|
17
|
+
# limitations under the License.
|
18
|
+
#
|
19
|
+
# This example illustrates how to create ad groups. To get a list of existing
|
20
|
+
# campaigns run get_campaigns.rb.
|
21
|
+
|
22
|
+
require 'adwords_api'
|
23
|
+
|
24
|
+
def add_ad_groups(campaign_id)
|
25
|
+
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
26
|
+
# when called without parameters.
|
27
|
+
adwords = AdwordsApi::Api.new
|
28
|
+
|
29
|
+
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
30
|
+
# the configuration file or provide your own logger:
|
31
|
+
# adwords.logger = Logger.new('adwords_xml.log')
|
32
|
+
|
33
|
+
ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
|
34
|
+
|
35
|
+
ad_groups = [
|
36
|
+
{
|
37
|
+
:name => "Earth to Mars Cruises #%d" % (Time.new.to_f * 1000).to_i,
|
38
|
+
:status => 'ENABLED',
|
39
|
+
:campaign_id => campaign_id,
|
40
|
+
:bidding_strategy_configuration => {
|
41
|
+
:bids => [
|
42
|
+
{
|
43
|
+
# The 'xsi_type' field allows you to specify the xsi:type of the
|
44
|
+
# object being created. It's only necessary when you must provide
|
45
|
+
# an explicit type that the client library can't infer.
|
46
|
+
:xsi_type => 'CpcBid',
|
47
|
+
:bid => {:micro_amount => 10000000}
|
48
|
+
}
|
49
|
+
]
|
50
|
+
},
|
51
|
+
:settings => [
|
52
|
+
# Targeting restriction settings. Depending on the :criterion_type_group
|
53
|
+
# value, most TargetingSettingDetail only affect Display campaigns.
|
54
|
+
# However, the USER_INTEREST_AND_LIST value works for RLSA campaigns -
|
55
|
+
# Search campaigns targeting using a remarketing list.
|
56
|
+
{
|
57
|
+
:xsi_type => 'TargetingSetting',
|
58
|
+
:details => [
|
59
|
+
# Restricting to serve ads that match your ad group placements.
|
60
|
+
# This is equivalent to choosing "Target and bid" in the UI.
|
61
|
+
{
|
62
|
+
:xsi_type => 'TargetingSettingDetail',
|
63
|
+
:criterion_type_group => 'PLACEMENT',
|
64
|
+
:target_all => false
|
65
|
+
},
|
66
|
+
# Using your ad group verticals only for bidding. This is equivalent
|
67
|
+
# to choosing "Bid only" in the UI.
|
68
|
+
{
|
69
|
+
:xsi_type => 'TargetingSettingDetail',
|
70
|
+
:criterion_type_group => 'VERTICAL',
|
71
|
+
:target_all => true
|
72
|
+
}
|
73
|
+
]
|
74
|
+
}
|
75
|
+
]
|
76
|
+
},
|
77
|
+
{
|
78
|
+
:name => 'Earth to Pluto Cruises #%d' % (Time.new.to_f * 1000).to_i,
|
79
|
+
:status => 'ENABLED',
|
80
|
+
:campaign_id => campaign_id,
|
81
|
+
:bidding_strategy_configuration => {
|
82
|
+
:bids => [
|
83
|
+
{
|
84
|
+
# The 'xsi_type' field allows you to specify the xsi:type of the
|
85
|
+
# object being created. It's only necessary when you must provide
|
86
|
+
# an explicit type that the client library can't infer.
|
87
|
+
:xsi_type => 'CpcBid',
|
88
|
+
:bid => {:micro_amount => 10000000}
|
89
|
+
}
|
90
|
+
]
|
91
|
+
}
|
92
|
+
}
|
93
|
+
]
|
94
|
+
|
95
|
+
# Prepare operations for adding ad groups.
|
96
|
+
operations = ad_groups.map do |ad_group|
|
97
|
+
{:operator => 'ADD', :operand => ad_group}
|
98
|
+
end
|
99
|
+
|
100
|
+
# Add ad groups.
|
101
|
+
response = ad_group_srv.mutate(operations)
|
102
|
+
if response and response[:value]
|
103
|
+
response[:value].each do |ad_group|
|
104
|
+
puts "Ad group ID %d was successfully added." % ad_group[:id]
|
105
|
+
end
|
106
|
+
else
|
107
|
+
raise StandardError, 'No ad group was added'
|
108
|
+
end
|
109
|
+
end
|
110
|
+
|
111
|
+
if __FILE__ == $0
|
112
|
+
API_VERSION = :v201609
|
113
|
+
|
114
|
+
begin
|
115
|
+
# Campaign ID to add ad group to.
|
116
|
+
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
|
117
|
+
add_ad_groups(campaign_id)
|
118
|
+
|
119
|
+
# Authorization error.
|
120
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
121
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
122
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
123
|
+
"to retrieve and store OAuth2 tokens."
|
124
|
+
puts "See this wiki page for more details:\n\n " +
|
125
|
+
'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
|
126
|
+
|
127
|
+
# HTTP errors.
|
128
|
+
rescue AdsCommon::Errors::HttpError => e
|
129
|
+
puts "HTTP Error: %s" % e
|
130
|
+
|
131
|
+
# API errors.
|
132
|
+
rescue AdwordsApi::Errors::ApiException => e
|
133
|
+
puts "Message: %s" % e.message
|
134
|
+
puts 'Errors:'
|
135
|
+
e.errors.each_with_index do |error, index|
|
136
|
+
puts "\tError [%d]:" % (index + 1)
|
137
|
+
error.each do |field, value|
|
138
|
+
puts "\t\t%s: %s" % [field, value]
|
139
|
+
end
|
140
|
+
end
|
141
|
+
end
|
142
|
+
end
|
@@ -0,0 +1,138 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# Encoding: utf-8
|
3
|
+
#
|
4
|
+
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
5
|
+
#
|
6
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
7
|
+
# you may not use this file except in compliance with the License.
|
8
|
+
# You may obtain a copy of the License at
|
9
|
+
#
|
10
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
11
|
+
#
|
12
|
+
# Unless required by applicable law or agreed to in writing, software
|
13
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
14
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
15
|
+
# implied.
|
16
|
+
# See the License for the specific language governing permissions and
|
17
|
+
# limitations under the License.
|
18
|
+
#
|
19
|
+
# This example illustrates how to create campaigns.
|
20
|
+
|
21
|
+
require 'adwords_api'
|
22
|
+
require 'date'
|
23
|
+
|
24
|
+
def add_campaigns()
|
25
|
+
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
26
|
+
# when called without parameters.
|
27
|
+
adwords = AdwordsApi::Api.new
|
28
|
+
|
29
|
+
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
30
|
+
# the configuration file or provide your own logger:
|
31
|
+
# adwords.logger = Logger.new('adwords_xml.log')
|
32
|
+
|
33
|
+
budget_srv = adwords.service(:BudgetService, API_VERSION)
|
34
|
+
campaign_srv = adwords.service(:CampaignService, API_VERSION)
|
35
|
+
|
36
|
+
# Create a budget, which can be shared by multiple campaigns.
|
37
|
+
budget = {
|
38
|
+
:name => 'Interplanetary budget #%d' % (Time.new.to_f * 1000).to_i,
|
39
|
+
:amount => {:micro_amount => 50000000},
|
40
|
+
:delivery_method => 'STANDARD'
|
41
|
+
}
|
42
|
+
budget_operation = {:operator => 'ADD', :operand => budget}
|
43
|
+
|
44
|
+
# Add budget.
|
45
|
+
return_budget = budget_srv.mutate([budget_operation])
|
46
|
+
budget_id = return_budget[:value].first[:budget_id]
|
47
|
+
|
48
|
+
# Create campaigns.
|
49
|
+
campaigns = [
|
50
|
+
{
|
51
|
+
:name => "Interplanetary Cruise #%d" % (Time.new.to_f * 1000).to_i,
|
52
|
+
:status => 'PAUSED',
|
53
|
+
:bidding_strategy_configuration => {
|
54
|
+
:bidding_strategy_type => 'MANUAL_CPC'
|
55
|
+
},
|
56
|
+
# Budget (required) - note only the budget ID is required.
|
57
|
+
:budget => {:budget_id => budget_id},
|
58
|
+
:advertising_channel_type => 'SEARCH',
|
59
|
+
# Optional fields:
|
60
|
+
:start_date =>
|
61
|
+
DateTime.parse((Date.today + 1).to_s).strftime('%Y%m%d'),
|
62
|
+
:ad_serving_optimization_status => 'ROTATE',
|
63
|
+
:network_setting => {
|
64
|
+
:target_google_search => true,
|
65
|
+
:target_search_network => true,
|
66
|
+
:target_content_network => true
|
67
|
+
},
|
68
|
+
:settings => [
|
69
|
+
{
|
70
|
+
:xsi_type => 'GeoTargetTypeSetting',
|
71
|
+
:positive_geo_target_type => 'DONT_CARE',
|
72
|
+
:negative_geo_target_type => 'DONT_CARE'
|
73
|
+
}
|
74
|
+
],
|
75
|
+
:frequency_cap => {
|
76
|
+
:impressions => '5',
|
77
|
+
:time_unit => 'DAY',
|
78
|
+
:level => 'ADGROUP'
|
79
|
+
}
|
80
|
+
},
|
81
|
+
{
|
82
|
+
:name => "Interplanetary Cruise banner #%d" % (Time.new.to_f * 1000).to_i,
|
83
|
+
:status => 'PAUSED',
|
84
|
+
:bidding_strategy_configuration => {
|
85
|
+
:bidding_strategy_type => 'MANUAL_CPC'
|
86
|
+
},
|
87
|
+
:budget => {:budget_id => budget_id},
|
88
|
+
:advertising_channel_type => 'DISPLAY'
|
89
|
+
}
|
90
|
+
]
|
91
|
+
|
92
|
+
# Prepare for adding campaign.
|
93
|
+
operations = campaigns.map do |campaign|
|
94
|
+
{:operator => 'ADD', :operand => campaign}
|
95
|
+
end
|
96
|
+
|
97
|
+
# Add campaign.
|
98
|
+
response = campaign_srv.mutate(operations)
|
99
|
+
if response and response[:value]
|
100
|
+
response[:value].each do |campaign|
|
101
|
+
puts "Campaign with name '%s' and ID %d was added." %
|
102
|
+
[campaign[:name], campaign[:id]]
|
103
|
+
end
|
104
|
+
else
|
105
|
+
raise new StandardError, 'No campaigns were added.'
|
106
|
+
end
|
107
|
+
end
|
108
|
+
|
109
|
+
if __FILE__ == $0
|
110
|
+
API_VERSION = :v201609
|
111
|
+
|
112
|
+
begin
|
113
|
+
add_campaigns()
|
114
|
+
|
115
|
+
# Authorization error.
|
116
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
117
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
118
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
119
|
+
"to retrieve and store OAuth2 tokens."
|
120
|
+
puts "See this wiki page for more details:\n\n " +
|
121
|
+
'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
|
122
|
+
|
123
|
+
# HTTP errors.
|
124
|
+
rescue AdsCommon::Errors::HttpError => e
|
125
|
+
puts "HTTP Error: %s" % e
|
126
|
+
|
127
|
+
# API errors.
|
128
|
+
rescue AdwordsApi::Errors::ApiException => e
|
129
|
+
puts "Message: %s" % e.message
|
130
|
+
puts 'Errors:'
|
131
|
+
e.errors.each_with_index do |error, index|
|
132
|
+
puts "\tError [%d]:" % (index + 1)
|
133
|
+
error.each do |field, value|
|
134
|
+
puts "\t\t%s: %s" % [field, value]
|
135
|
+
end
|
136
|
+
end
|
137
|
+
end
|
138
|
+
end
|
@@ -0,0 +1,108 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# Encoding: utf-8
|
3
|
+
#
|
4
|
+
# Copyright:: Copyright 2016, Google Inc. All Rights Reserved.
|
5
|
+
#
|
6
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
7
|
+
# you may not use this file except in compliance with the License.
|
8
|
+
# You may obtain a copy of the License at
|
9
|
+
#
|
10
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
11
|
+
#
|
12
|
+
# Unless required by applicable law or agreed to in writing, software
|
13
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
14
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
15
|
+
# implied.
|
16
|
+
# See the License for the specific language governing permissions and
|
17
|
+
# limitations under the License.
|
18
|
+
#
|
19
|
+
# This example adds expanded text ads to a given ad group.
|
20
|
+
# To get ad groups, run get_ad_groups.rb.
|
21
|
+
|
22
|
+
require 'adwords_api'
|
23
|
+
require 'date'
|
24
|
+
|
25
|
+
def add_expanded_text_ads(ad_group_id)
|
26
|
+
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
27
|
+
# when called without parameters.
|
28
|
+
adwords = AdwordsApi::Api.new
|
29
|
+
|
30
|
+
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
31
|
+
# the configuration file or provide your own logger:
|
32
|
+
# adwords.logger = Logger.new('adwords_xml.log')
|
33
|
+
|
34
|
+
ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
|
35
|
+
|
36
|
+
# Create text ads.
|
37
|
+
# The 'xsi_type' field allows you to specify the xsi:type of the object
|
38
|
+
# being created. It's only necessary when you must provide an explicit
|
39
|
+
# type that the client library can't infer.
|
40
|
+
operations = 5.times.map do |i|
|
41
|
+
expanded_text_ad = {
|
42
|
+
:xsi_type => 'ExpandedTextAd',
|
43
|
+
:headline_part1 => 'Cruise to Mars #%d' % (Time.new.to_f * 1000).to_i,
|
44
|
+
:headline_part2 => 'Best Space Cruise Line',
|
45
|
+
:description => 'Buy your tickets now!',
|
46
|
+
:final_urls => ['http://www.example.com/%d' % i],
|
47
|
+
:path1 => 'all-inclusive',
|
48
|
+
:path2 => 'deals'
|
49
|
+
}
|
50
|
+
|
51
|
+
ad_group_ad = {
|
52
|
+
:ad_group_id => ad_group_id,
|
53
|
+
:ad => expanded_text_ad,
|
54
|
+
# Additional properties (non-required).
|
55
|
+
:status => 'PAUSED'
|
56
|
+
}
|
57
|
+
|
58
|
+
operation = {
|
59
|
+
:operator => 'ADD',
|
60
|
+
:operand => ad_group_ad
|
61
|
+
}
|
62
|
+
end
|
63
|
+
|
64
|
+
# Add ads.
|
65
|
+
response = ad_group_ad_srv.mutate(operations)
|
66
|
+
if response and response[:value]
|
67
|
+
response[:value].each do |ad_group_ad|
|
68
|
+
puts ('New expanded text ad with id "%d" and headine "%s - %s" was ' +
|
69
|
+
'added.') % [ad_group_ad[:ad][:id], ad_group_ad[:ad][:headline_part1],
|
70
|
+
ad_group_ad[:ad][:headline_part2]]
|
71
|
+
end
|
72
|
+
else
|
73
|
+
raise StandardError, 'No ads were added.'
|
74
|
+
end
|
75
|
+
end
|
76
|
+
|
77
|
+
if __FILE__ == $0
|
78
|
+
API_VERSION = :v201609
|
79
|
+
|
80
|
+
begin
|
81
|
+
# Ad group ID to add text ads to.
|
82
|
+
ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
|
83
|
+
add_expanded_text_ads(ad_group_id)
|
84
|
+
|
85
|
+
# Authorization error.
|
86
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
87
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
88
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
89
|
+
"to retrieve and store OAuth2 tokens."
|
90
|
+
puts "See this wiki page for more details:\n\n " +
|
91
|
+
'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
|
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,114 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# Encoding: utf-8
|
3
|
+
#
|
4
|
+
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
5
|
+
#
|
6
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
7
|
+
# you may not use this file except in compliance with the License.
|
8
|
+
# You may obtain a copy of the License at
|
9
|
+
#
|
10
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
11
|
+
#
|
12
|
+
# Unless required by applicable law or agreed to in writing, software
|
13
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
14
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
15
|
+
# implied.
|
16
|
+
# See the License for the specific language governing permissions and
|
17
|
+
# limitations under the License.
|
18
|
+
#
|
19
|
+
# This example illustrates how to add multiple keywords to a given ad group. To
|
20
|
+
# create an ad group, run add_ad_group.rb.
|
21
|
+
|
22
|
+
require 'adwords_api'
|
23
|
+
|
24
|
+
def add_keywords(ad_group_id)
|
25
|
+
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
26
|
+
# when called without parameters.
|
27
|
+
adwords = AdwordsApi::Api.new
|
28
|
+
|
29
|
+
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
30
|
+
# the configuration file or provide your own logger:
|
31
|
+
# adwords.logger = Logger.new('adwords_xml.log')
|
32
|
+
|
33
|
+
ad_group_criterion_srv =
|
34
|
+
adwords.service(:AdGroupCriterionService, API_VERSION)
|
35
|
+
|
36
|
+
# Create keywords.
|
37
|
+
# The 'xsi_type' field allows you to specify the xsi:type of the object
|
38
|
+
# being created. It's only necessary when you must provide an explicit
|
39
|
+
# type that the client library can't infer.
|
40
|
+
keywords = [
|
41
|
+
{:xsi_type => 'BiddableAdGroupCriterion',
|
42
|
+
:ad_group_id => ad_group_id,
|
43
|
+
:criterion => {
|
44
|
+
:xsi_type => 'Keyword',
|
45
|
+
:text => 'mars cruise',
|
46
|
+
:match_type => 'BROAD'
|
47
|
+
},
|
48
|
+
# Optional fields:
|
49
|
+
:user_status => 'PAUSED',
|
50
|
+
:final_urls => {
|
51
|
+
:urls => ['http://example.com/mars']
|
52
|
+
}
|
53
|
+
},
|
54
|
+
{:xsi_type => 'BiddableAdGroupCriterion',
|
55
|
+
:ad_group_id => ad_group_id,
|
56
|
+
:criterion => {
|
57
|
+
:xsi_type => 'Keyword',
|
58
|
+
:text => 'space hotel',
|
59
|
+
:match_type => 'BROAD'}}
|
60
|
+
]
|
61
|
+
|
62
|
+
# Create 'ADD' operations.
|
63
|
+
operations = keywords.map do |keyword|
|
64
|
+
{:operator => 'ADD', :operand => keyword}
|
65
|
+
end
|
66
|
+
|
67
|
+
# Add keywords.
|
68
|
+
response = ad_group_criterion_srv.mutate(operations)
|
69
|
+
if response and response[:value]
|
70
|
+
ad_group_criteria = response[:value]
|
71
|
+
puts "Added %d keywords to ad group ID %d:" %
|
72
|
+
[ad_group_criteria.length, ad_group_id]
|
73
|
+
ad_group_criteria.each do |ad_group_criterion|
|
74
|
+
puts "\tKeyword ID is %d and type is '%s'" %
|
75
|
+
[ad_group_criterion[:criterion][:id],
|
76
|
+
ad_group_criterion[:criterion][:type]]
|
77
|
+
end
|
78
|
+
else
|
79
|
+
raise StandardError, 'No keywords were added.'
|
80
|
+
end
|
81
|
+
end
|
82
|
+
|
83
|
+
if __FILE__ == $0
|
84
|
+
API_VERSION = :v201609
|
85
|
+
|
86
|
+
begin
|
87
|
+
# Ad group ID to add keywords to.
|
88
|
+
ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
|
89
|
+
add_keywords(ad_group_id)
|
90
|
+
|
91
|
+
# Authorization error.
|
92
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
93
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
94
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
95
|
+
"to retrieve and store OAuth2 tokens."
|
96
|
+
puts "See this wiki page for more details:\n\n " +
|
97
|
+
'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
|
98
|
+
|
99
|
+
# HTTP errors.
|
100
|
+
rescue AdsCommon::Errors::HttpError => e
|
101
|
+
puts "HTTP Error: %s" % e
|
102
|
+
|
103
|
+
# API errors.
|
104
|
+
rescue AdwordsApi::Errors::ApiException => e
|
105
|
+
puts "Message: %s" % e.message
|
106
|
+
puts 'Errors:'
|
107
|
+
e.errors.each_with_index do |error, index|
|
108
|
+
puts "\tError [%d]:" % (index + 1)
|
109
|
+
error.each do |field, value|
|
110
|
+
puts "\t\t%s: %s" % [field, value]
|
111
|
+
end
|
112
|
+
end
|
113
|
+
end
|
114
|
+
end
|