google-adwords-api 0.11.0 → 0.11.1
Sign up to get free protection for your applications and to get access to all the features.
- data/ChangeLog +4 -0
- data/README +124 -107
- data/examples/v201306/misc/use_oauth2_jwt.rb +5 -1
- data/examples/v201309/misc/use_oauth2_jwt.rb +5 -1
- data/examples/v201402/account_management/create_account.rb +95 -0
- data/examples/v201402/account_management/get_account_alerts.rb +122 -0
- data/examples/v201402/account_management/get_account_changes.rb +145 -0
- data/examples/v201402/account_management/get_account_hierarchy.rb +103 -0
- data/examples/v201402/advanced_operations/add_ad_group_bid_modifier.rb +105 -0
- data/examples/v201402/advanced_operations/add_click_to_download_ad.rb +137 -0
- data/examples/v201402/advanced_operations/add_places_location_extensions.rb +159 -0
- data/examples/v201402/advanced_operations/add_places_location_extensions.rb~ +159 -0
- data/examples/v201402/advanced_operations/add_site_links.rb +306 -0
- data/examples/v201402/advanced_operations/get_ad_group_bid_modifiers.rb +106 -0
- data/examples/v201402/advanced_operations/update_site_links.rb +194 -0
- data/examples/v201402/advanced_operations/upload_offline_conversions.rb +117 -0
- data/examples/v201402/advanced_operations/use_shared_bidding_strategy.rb +163 -0
- data/examples/v201402/basic_operations/add_ad_groups.rb +142 -0
- data/examples/v201402/basic_operations/add_ad_groups.rb~ +147 -0
- data/examples/v201402/basic_operations/add_campaigns.rb +153 -0
- data/examples/v201402/basic_operations/add_keywords.rb +116 -0
- data/examples/v201402/basic_operations/add_text_ads.rb +113 -0
- data/examples/v201402/basic_operations/delete_ad.rb +93 -0
- data/examples/v201402/basic_operations/delete_ad_group.rb +110 -0
- data/examples/v201402/basic_operations/delete_campaign.rb +111 -0
- data/examples/v201402/basic_operations/delete_keyword.rb +98 -0
- data/examples/v201402/basic_operations/get_ad_groups.rb +106 -0
- data/examples/v201402/basic_operations/get_campaigns.rb +101 -0
- data/examples/v201402/basic_operations/get_campaigns_with_awql.rb +93 -0
- data/examples/v201402/basic_operations/get_keywords.rb +112 -0
- data/examples/v201402/basic_operations/get_text_ads.rb +114 -0
- data/examples/v201402/basic_operations/pause_ad.rb +92 -0
- data/examples/v201402/basic_operations/update_ad_group.rb +89 -0
- data/examples/v201402/basic_operations/update_campaign.rb +90 -0
- data/examples/v201402/basic_operations/update_keyword.rb +110 -0
- data/examples/v201402/campaign_management/add_experiment.rb +166 -0
- data/examples/v201402/campaign_management/add_keywords_in_bulk.rb +158 -0
- data/examples/v201402/campaign_management/add_location_extension.rb +125 -0
- data/examples/v201402/campaign_management/get_all_disapproved_ads.rb +101 -0
- data/examples/v201402/campaign_management/get_all_disapproved_ads_with_awql.rb +93 -0
- data/examples/v201402/campaign_management/promote_experiment.rb +85 -0
- data/examples/v201402/campaign_management/set_ad_parameters.rb +122 -0
- data/examples/v201402/campaign_management/set_criterion_bid_modifier.rb +108 -0
- data/examples/v201402/campaign_management/validate_text_ad.rb +114 -0
- data/examples/v201402/error_handling/handle_captcha_challenge.rb +93 -0
- data/examples/v201402/error_handling/handle_partial_failures.rb +134 -0
- data/examples/v201402/error_handling/handle_policy_violation_error.rb +145 -0
- data/examples/v201402/error_handling/handle_two_factor_authorization_error.rb +88 -0
- data/examples/v201402/misc/create_ad_words_session_without_properties_file.rb +94 -0
- data/examples/v201402/misc/create_ad_words_session_without_properties_file.rb~ +94 -0
- data/examples/v201402/misc/get_all_images_and_videos.rb +108 -0
- data/examples/v201402/misc/setup_oauth2.rb +88 -0
- data/examples/v201402/misc/upload_image.rb +97 -0
- data/examples/v201402/misc/use_oauth2_jwt.rb +97 -0
- data/examples/v201402/optimization/estimate_keyword_traffic.rb +137 -0
- data/examples/v201402/optimization/get_keyword_bid_simulations.rb +100 -0
- data/examples/v201402/optimization/get_keyword_ideas.rb +130 -0
- data/examples/v201402/optimization/get_placement_ideas.rb +112 -0
- data/examples/v201402/remarketing/add_audience.rb +123 -0
- data/examples/v201402/remarketing/add_conversion_tracker.rb +105 -0
- data/examples/v201402/remarketing/add_conversion_tracker.rb~ +109 -0
- data/examples/v201402/reporting/download_criteria_report.rb +87 -0
- data/examples/v201402/reporting/download_criteria_report_with_awql.rb +86 -0
- data/examples/v201402/reporting/get_report_fields.rb +79 -0
- data/examples/v201402/reporting/parallel_report_download.rb +171 -0
- data/examples/v201402/shopping_campaigns/add_product_partition_tree.rb +269 -0
- data/examples/v201402/shopping_campaigns/add_product_partition_tree.rb~ +269 -0
- data/examples/v201402/shopping_campaigns/add_product_scope.rb +133 -0
- data/examples/v201402/shopping_campaigns/add_shopping_campaign.rb +135 -0
- data/examples/v201402/shopping_campaigns/add_shopping_campaign.rb~ +136 -0
- data/examples/v201402/shopping_campaigns/get_product_category_taxonomy.rb +117 -0
- data/examples/v201402/shopping_campaigns/get_product_category_taxonomy.rb~ +128 -0
- data/examples/v201402/shopping_campaigns/set_product_sales_channel.rb +98 -0
- data/examples/v201402/shopping_campaigns/set_product_sales_channel.rb~ +98 -0
- data/examples/v201402/targeting/add_campaign_targeting_criteria.rb +157 -0
- data/examples/v201402/targeting/add_demographic_targeting_criteria.rb +116 -0
- data/examples/v201402/targeting/get_campaign_targeting_criteria.rb +110 -0
- data/examples/v201402/targeting/get_targetable_languages_and_carriers.rb +94 -0
- data/examples/v201402/targeting/lookup_location.rb +112 -0
- data/lib/adwords_api.rb +7 -0
- data/lib/adwords_api/api_config.rb +76 -4
- data/lib/adwords_api/report_header_handler.rb +1 -1
- data/lib/adwords_api/v201402/ad_group_ad_service.rb +42 -0
- data/lib/adwords_api/v201402/ad_group_ad_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/ad_group_bid_modifier_service.rb +42 -0
- data/lib/adwords_api/v201402/ad_group_bid_modifier_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/ad_group_criterion_service.rb +42 -0
- data/lib/adwords_api/v201402/ad_group_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/ad_group_feed_service.rb +42 -0
- data/lib/adwords_api/v201402/ad_group_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/ad_group_service.rb +42 -0
- data/lib/adwords_api/v201402/ad_group_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/ad_param_service.rb +38 -0
- data/lib/adwords_api/v201402/ad_param_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/adwords_user_list_service.rb +38 -0
- data/lib/adwords_api/v201402/adwords_user_list_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/alert_service.rb +34 -0
- data/lib/adwords_api/v201402/alert_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/bidding_strategy_service.rb +42 -0
- data/lib/adwords_api/v201402/bidding_strategy_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/budget_order_service.rb +42 -0
- data/lib/adwords_api/v201402/budget_order_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/budget_service.rb +42 -0
- data/lib/adwords_api/v201402/budget_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/campaign_ad_extension_service.rb +38 -0
- data/lib/adwords_api/v201402/campaign_ad_extension_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/campaign_criterion_service.rb +42 -0
- data/lib/adwords_api/v201402/campaign_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/campaign_feed_service.rb +42 -0
- data/lib/adwords_api/v201402/campaign_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/campaign_service.rb +42 -0
- data/lib/adwords_api/v201402/campaign_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/constant_data_service.rb +66 -0
- data/lib/adwords_api/v201402/constant_data_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/conversion_tracker_service.rb +38 -0
- data/lib/adwords_api/v201402/conversion_tracker_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/customer_feed_service.rb +42 -0
- data/lib/adwords_api/v201402/customer_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/customer_service.rb +38 -0
- data/lib/adwords_api/v201402/customer_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/customer_sync_service.rb +34 -0
- data/lib/adwords_api/v201402/customer_sync_service_registry.rb +47 -0
- data/lib/adwords_api/v201402/data_service.rb +46 -0
- data/lib/adwords_api/v201402/data_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/experiment_service.rb +38 -0
- data/lib/adwords_api/v201402/experiment_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/feed_item_service.rb +42 -0
- data/lib/adwords_api/v201402/feed_item_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/feed_mapping_service.rb +42 -0
- data/lib/adwords_api/v201402/feed_mapping_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/feed_service.rb +42 -0
- data/lib/adwords_api/v201402/feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/geo_location_service.rb +34 -0
- data/lib/adwords_api/v201402/geo_location_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/location_criterion_service.rb +38 -0
- data/lib/adwords_api/v201402/location_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/managed_customer_service.rb +50 -0
- data/lib/adwords_api/v201402/managed_customer_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/media_service.rb +42 -0
- data/lib/adwords_api/v201402/media_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/mutate_job_service.rb +42 -0
- data/lib/adwords_api/v201402/mutate_job_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/offline_conversion_feed_service.rb +34 -0
- data/lib/adwords_api/v201402/offline_conversion_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/report_definition_service.rb +34 -0
- data/lib/adwords_api/v201402/report_definition_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/targeting_idea_service.rb +38 -0
- data/lib/adwords_api/v201402/targeting_idea_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/traffic_estimator_service.rb +34 -0
- data/lib/adwords_api/v201402/traffic_estimator_service_registry.rb +46 -0
- data/lib/adwords_api/version.rb +1 -1
- data/test/adwords_api/test_adwords_api.rb +15 -2
- data/test/adwords_api/test_adwords_api.rb~ +127 -0
- data/test/templates/v201306/basic_operations_get_campaigns.def +1 -1
- data/test/templates/v201306/misc_use_oauth2_jwt.def +1 -1
- data/test/templates/v201309/basic_operations_get_campaigns.def +1 -1
- data/test/templates/v201309/misc_use_oauth2_jwt.def +1 -1
- metadata +146 -2
@@ -0,0 +1,133 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# Encoding: utf-8
|
3
|
+
#
|
4
|
+
# Author:: api.mcloonan@gmail.com (Michael Cloonan)
|
5
|
+
#
|
6
|
+
# Copyright:: Copyright 2014, 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 restricts the products that will be included in the campaign by
|
22
|
+
# setting a ProductScope.
|
23
|
+
#
|
24
|
+
# Tags: CampaignCriterionService.mutate
|
25
|
+
|
26
|
+
require 'adwords_api'
|
27
|
+
|
28
|
+
def add_product_scope(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_criterion_srv = adwords.service(:CampaignCriterionService,
|
38
|
+
API_VERSION)
|
39
|
+
|
40
|
+
product_scope = {
|
41
|
+
# This set of dimensions is for demonstration purposes only. It is
|
42
|
+
# extremely unlikely that you want to include so many dimensions in your
|
43
|
+
# product scope.
|
44
|
+
:dimensions => [
|
45
|
+
{
|
46
|
+
:xsi_type => 'ProductBrand',
|
47
|
+
:value => 'Nexus'
|
48
|
+
},
|
49
|
+
{
|
50
|
+
:xsi_type => 'ProductCanonicalCondition',
|
51
|
+
:value => 'NEW'
|
52
|
+
},
|
53
|
+
{
|
54
|
+
:xsi_type => 'ProductCustomAttribute',
|
55
|
+
:type => 'CUSTOM_ATTRIBUTE_0',
|
56
|
+
:value => 'my attribute value'
|
57
|
+
},
|
58
|
+
{
|
59
|
+
:xsi_type => 'ProductOfferId',
|
60
|
+
:value => 'book1'
|
61
|
+
},
|
62
|
+
{
|
63
|
+
:xsi_type => 'ProductType',
|
64
|
+
:type => 'PRODUCT_TYPE_L1',
|
65
|
+
:value => 'Media'
|
66
|
+
},
|
67
|
+
{
|
68
|
+
:xsi_type => 'ProductType',
|
69
|
+
:type => 'PRODUCT_TYPE_L2',
|
70
|
+
:value => 'Books'
|
71
|
+
},
|
72
|
+
# The value for the bidding category is a fixed ID for the
|
73
|
+
# 'Luggage & Bags' category. You can retrieve IDs for categories from
|
74
|
+
# the ConstantDataService. See the 'get_product_category_taxonomy'
|
75
|
+
# example for more details.
|
76
|
+
{
|
77
|
+
:xsi_type => 'ProductBiddingCategory',
|
78
|
+
:type => 'BIDDING_CATEGORY_L1',
|
79
|
+
:value => '-5914235892932915235',
|
80
|
+
}
|
81
|
+
]
|
82
|
+
}
|
83
|
+
|
84
|
+
campaign_criterion = {
|
85
|
+
:campaign_id => campaign_id,
|
86
|
+
:product_scope => product_scope
|
87
|
+
}
|
88
|
+
|
89
|
+
campaign_criterion_operation = {
|
90
|
+
:operator => 'ADD',
|
91
|
+
:operand => campaign_criterion
|
92
|
+
}
|
93
|
+
|
94
|
+
# Make the mutate request.
|
95
|
+
result = campaign_criterion_srv.mutate([campaign_criterion_operation])
|
96
|
+
|
97
|
+
campaign_criterion = result[:value].first
|
98
|
+
puts "Created a ProductScope criterion with ID %d." %
|
99
|
+
[campaign_criterion[:criterion][:id]]
|
100
|
+
end
|
101
|
+
|
102
|
+
if __FILE__ == $0
|
103
|
+
API_VERSION = :v201402
|
104
|
+
|
105
|
+
begin
|
106
|
+
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
|
107
|
+
|
108
|
+
add_product_scope(campaign_id)
|
109
|
+
|
110
|
+
# Authorization error.
|
111
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
112
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
113
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
114
|
+
"to retrieve and store OAuth2 tokens."
|
115
|
+
puts "See this wiki page for more details:\n\n " +
|
116
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
117
|
+
|
118
|
+
# HTTP errors.
|
119
|
+
rescue AdsCommon::Errors::HttpError => e
|
120
|
+
puts "HTTP Error: %s" % e
|
121
|
+
|
122
|
+
# API errors.
|
123
|
+
rescue AdwordsApi::Errors::ApiException => e
|
124
|
+
puts "Message: %s" % e.message
|
125
|
+
puts 'Errors:'
|
126
|
+
e.errors.each_with_index do |error, index|
|
127
|
+
puts "\tError [%d]:" % (index + 1)
|
128
|
+
error.each do |field, value|
|
129
|
+
puts "\t\t%s: %s" % [field, value]
|
130
|
+
end
|
131
|
+
end
|
132
|
+
end
|
133
|
+
end
|
@@ -0,0 +1,135 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# Encoding: utf-8
|
3
|
+
#
|
4
|
+
# Author:: api.mcloonan@gmail.com (Michael Cloonan)
|
5
|
+
#
|
6
|
+
# Copyright:: Copyright 2014, 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 adds a Shopping campaign.
|
22
|
+
#
|
23
|
+
# Tags: CampaignService.mutate, AdGroupService.mutate, AdGroupAdService.mutate
|
24
|
+
|
25
|
+
require 'adwords_api'
|
26
|
+
require 'date'
|
27
|
+
|
28
|
+
def add_shopping_campaign(budget_id, merchant_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
|
+
ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
|
39
|
+
ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
|
40
|
+
|
41
|
+
# Create campaign.
|
42
|
+
campaign = {
|
43
|
+
:name => "Shopping campaign #%d" % (Time.new.to_f * 1000).to_i,
|
44
|
+
# The advertising_channel_type is what makes this a Shopping campaign.
|
45
|
+
:advertising_channel_type => 'SHOPPING',
|
46
|
+
:budget => {:budget_id => budget_id},
|
47
|
+
:bidding_strategy_configuration => {
|
48
|
+
:bidding_strategy_type => 'MANUAL_CPC'
|
49
|
+
},
|
50
|
+
:settings => [
|
51
|
+
{
|
52
|
+
:xsi_type => 'KeywordMatchSetting',
|
53
|
+
:opt_in => false
|
54
|
+
},
|
55
|
+
{
|
56
|
+
:xsi_type => 'ShoppingSetting',
|
57
|
+
:sales_country => 'US',
|
58
|
+
:campaign_priority => 0,
|
59
|
+
:merchant_id => merchant_id
|
60
|
+
}
|
61
|
+
]
|
62
|
+
}
|
63
|
+
campaign_operation = {:operator => 'ADD', :operand => campaign}
|
64
|
+
|
65
|
+
# Make the mutate request.
|
66
|
+
result = campaign_srv.mutate([campaign_operation])
|
67
|
+
|
68
|
+
# Print the result.
|
69
|
+
campaign = result[:value].first
|
70
|
+
puts "Campaign with name '%s' and ID %d was added." %
|
71
|
+
[campaign[:name], campaign[:id]]
|
72
|
+
|
73
|
+
# Create ad group.
|
74
|
+
ad_group = {
|
75
|
+
:campaign_id => campaign[:id],
|
76
|
+
:name => 'Ad Group #%d' % (Time.new.to_f * 1000).to_i
|
77
|
+
}
|
78
|
+
ad_group_operation = {:operator => 'ADD', :operand => ad_group}
|
79
|
+
|
80
|
+
# Make the mutate request.
|
81
|
+
result = ad_group_srv.mutate([ad_group_operation])
|
82
|
+
|
83
|
+
# Print the result.
|
84
|
+
ad_group = result[:value].first
|
85
|
+
puts "Ad group with name '%s' and ID %d was added." %
|
86
|
+
[ad_group[:name], ad_group[:id]]
|
87
|
+
|
88
|
+
# Create product ad.
|
89
|
+
ad_group_ad = {
|
90
|
+
:ad_group_id => ad_group[:id],
|
91
|
+
:ad => {:xsi_type => 'ProductAd'}
|
92
|
+
}
|
93
|
+
ad_group_operation = {:operator => 'ADD', :operand => ad_group_ad}
|
94
|
+
|
95
|
+
# Make the mutate request.
|
96
|
+
result = ad_group_ad_srv.mutate([ad_group_operation])
|
97
|
+
|
98
|
+
# Print the result.
|
99
|
+
ad_group_ad = result[:value].first
|
100
|
+
puts "Product ad with ID %d was added." % [ad_group_ad[:id]]
|
101
|
+
end
|
102
|
+
|
103
|
+
if __FILE__ == $0
|
104
|
+
API_VERSION = :v201402
|
105
|
+
|
106
|
+
begin
|
107
|
+
budget_id = 'INSERT_BUDGET_ID_HERE'.to_i
|
108
|
+
merchant_id = 'INSERT_MERCHANT_ID_HERE'.to_i
|
109
|
+
|
110
|
+
add_shopping_campaign(budget_id, merchant_id)
|
111
|
+
|
112
|
+
# Authorization error.
|
113
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
114
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
115
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
116
|
+
"to retrieve and store OAuth2 tokens."
|
117
|
+
puts "See this wiki page for more details:\n\n " +
|
118
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
119
|
+
|
120
|
+
# HTTP errors.
|
121
|
+
rescue AdsCommon::Errors::HttpError => e
|
122
|
+
puts "HTTP Error: %s" % e
|
123
|
+
|
124
|
+
# API errors.
|
125
|
+
rescue AdwordsApi::Errors::ApiException => e
|
126
|
+
puts "Message: %s" % e.message
|
127
|
+
puts 'Errors:'
|
128
|
+
e.errors.each_with_index do |error, index|
|
129
|
+
puts "\tError [%d]:" % (index + 1)
|
130
|
+
error.each do |field, value|
|
131
|
+
puts "\t\t%s: %s" % [field, value]
|
132
|
+
end
|
133
|
+
end
|
134
|
+
end
|
135
|
+
end
|
@@ -0,0 +1,136 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# Encoding: utf-8
|
3
|
+
#
|
4
|
+
# Author:: api.mcloonan@gmail.com (Michael Cloonan)
|
5
|
+
#
|
6
|
+
# Copyright:: Copyright 2014, 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 adds a Shopping campaign.
|
22
|
+
#
|
23
|
+
# Tags: CampaignService.mutate, AdGroupService.mutate, AdGroupAdService.mutate
|
24
|
+
|
25
|
+
require 'adwords_api'
|
26
|
+
require 'date'
|
27
|
+
|
28
|
+
def add_shopping_campaign(budget_id, merchant_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
|
+
ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
|
39
|
+
ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
|
40
|
+
|
41
|
+
# Create campaign.
|
42
|
+
campaign = {
|
43
|
+
:name => "Shopping campaign #%d" % (Time.new.to_f * 1000).to_i,
|
44
|
+
# The advertising_channel_type is what makes this a Shopping campaign.
|
45
|
+
:advertising_channel_type => 'SHOPPING',
|
46
|
+
:budget => {:budget_id => budget_id},
|
47
|
+
:bidding_strategy_configuration => {
|
48
|
+
:bidding_strategy_type => 'MANUAL_CPC'
|
49
|
+
},
|
50
|
+
:settings => [
|
51
|
+
{
|
52
|
+
:xsi_type => 'KeywordMatchSetting',
|
53
|
+
:opt_in => false
|
54
|
+
},
|
55
|
+
{
|
56
|
+
:xsi_type => 'ShoppingSetting',
|
57
|
+
:sales_country => 'US',
|
58
|
+
:campaign_priority => 0,
|
59
|
+
:merchant_id => merchant_id
|
60
|
+
}
|
61
|
+
]
|
62
|
+
}
|
63
|
+
campaign_operation = {:operator => 'ADD', :operand => campaign}
|
64
|
+
|
65
|
+
# Make the mutate request.
|
66
|
+
result = campaign_srv.mutate([campaign_operation])
|
67
|
+
|
68
|
+
# Print the result.
|
69
|
+
campaign = result[:value].first
|
70
|
+
puts "Campaign with name '%s' and ID %d was added." %
|
71
|
+
[campaign[:name], campaign[:id]]
|
72
|
+
|
73
|
+
# Create ad group.
|
74
|
+
ad_group = {
|
75
|
+
:campaign_id => campaign[:id],
|
76
|
+
:name => 'Ad Group #%d' % (Time.new.to_f * 1000).to_i
|
77
|
+
}
|
78
|
+
ad_group_operation = {:operator => 'ADD', :operand => ad_group}
|
79
|
+
|
80
|
+
# Make the mutate request.
|
81
|
+
result = ad_group_srv.mutate([ad_group_operation])
|
82
|
+
|
83
|
+
# Print the result.
|
84
|
+
ad_group = result[:value].first
|
85
|
+
puts "Ad group with name '%s' and ID %d was added." %
|
86
|
+
[ad_group[:name], ad_group[:id]]
|
87
|
+
|
88
|
+
# Create product ad.
|
89
|
+
ad_group_ad = {
|
90
|
+
:ad_group_id => ad_group[:id],
|
91
|
+
:ad => {:xsi_type => 'ProductAd'}
|
92
|
+
}
|
93
|
+
ad_group_operation = {:operator => 'ADD', :operand => ad_group_ad}
|
94
|
+
|
95
|
+
# Make the mutate request.
|
96
|
+
result = ad_group_ad_srv.mutate([ad_group_operation])
|
97
|
+
|
98
|
+
# Print the result.
|
99
|
+
ad_group_ad = result[:value].first
|
100
|
+
puts "Product ad with ID %d was added." %
|
101
|
+
[ad_group_ad[:id]]
|
102
|
+
end
|
103
|
+
|
104
|
+
if __FILE__ == $0
|
105
|
+
API_VERSION = :v201402
|
106
|
+
|
107
|
+
begin
|
108
|
+
budget_id = 'INSERT_BUDGET_ID_HERE'.to_i
|
109
|
+
merchant_id = 'INSERT_MERCHANT_ID_HERE'.to_i
|
110
|
+
|
111
|
+
add_shopping_campaign(budget_id, merchant_id)
|
112
|
+
|
113
|
+
# Authorization error.
|
114
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
115
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
116
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
117
|
+
"to retrieve and store OAuth2 tokens."
|
118
|
+
puts "See this wiki page for more details:\n\n " +
|
119
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
120
|
+
|
121
|
+
# HTTP errors.
|
122
|
+
rescue AdsCommon::Errors::HttpError => e
|
123
|
+
puts "HTTP Error: %s" % e
|
124
|
+
|
125
|
+
# API errors.
|
126
|
+
rescue AdwordsApi::Errors::ApiException => e
|
127
|
+
puts "Message: %s" % e.message
|
128
|
+
puts 'Errors:'
|
129
|
+
e.errors.each_with_index do |error, index|
|
130
|
+
puts "\tError [%d]:" % (index + 1)
|
131
|
+
error.each do |field, value|
|
132
|
+
puts "\t\t%s: %s" % [field, value]
|
133
|
+
end
|
134
|
+
end
|
135
|
+
end
|
136
|
+
end
|
@@ -0,0 +1,117 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# Encoding: utf-8
|
3
|
+
#
|
4
|
+
# Author:: api.mcloonan@gmail.com (Michael Cloonan)
|
5
|
+
#
|
6
|
+
# Copyright:: Copyright 2014, 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 fetches the set of valid ProductBiddingCategories.
|
22
|
+
#
|
23
|
+
# Tags: ConstantDataService.getProductBiddingCategoryData
|
24
|
+
|
25
|
+
require 'adwords_api'
|
26
|
+
|
27
|
+
def display_categories(categories, prefix='')
|
28
|
+
categories.each do |category|
|
29
|
+
puts "%s%s [%s]" % [prefix, category[:name], category[:id]]
|
30
|
+
if category[:children]
|
31
|
+
display_categories(category[:children],
|
32
|
+
"%s%s > " % [prefix, category[:name]])
|
33
|
+
end
|
34
|
+
end
|
35
|
+
end
|
36
|
+
|
37
|
+
def get_product_category_taxonomy()
|
38
|
+
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
39
|
+
# when called without parameters.
|
40
|
+
adwords = AdwordsApi::Api.new
|
41
|
+
|
42
|
+
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
43
|
+
# the configuration file or provide your own logger:
|
44
|
+
# adwords.logger = Logger.new('adwords_xml.log')
|
45
|
+
|
46
|
+
constant_data_srv = adwords.service(:ConstantDataService, API_VERSION)
|
47
|
+
|
48
|
+
selector = {
|
49
|
+
:predicates => {:field => 'Country', :operator => 'IN', :values => ['US']}
|
50
|
+
}
|
51
|
+
|
52
|
+
results = constant_data_srv.get_product_bidding_category_data(selector)
|
53
|
+
|
54
|
+
bidding_categories = {}
|
55
|
+
root_categories = []
|
56
|
+
|
57
|
+
result[:value].each do |product_bidding_category|
|
58
|
+
id = product_bidding_category[:dimension_value][:value]
|
59
|
+
parent_id = nil
|
60
|
+
name = product_bidding_category[:display_value].first[:value]
|
61
|
+
|
62
|
+
if product_bidding_category[:parent_dimension_value]
|
63
|
+
parent_id = product_bidding_category[:parent_dimension_value][:value]
|
64
|
+
end
|
65
|
+
|
66
|
+
bidding_categories[id] ||= {}
|
67
|
+
|
68
|
+
category = bidding_categories[id]
|
69
|
+
|
70
|
+
if parent_id
|
71
|
+
bidding_categories[parent_id] ||= {}
|
72
|
+
|
73
|
+
parent = bidding_categories[parent_id]
|
74
|
+
|
75
|
+
parent[:children] ||= []
|
76
|
+
parent[:children] << category
|
77
|
+
else
|
78
|
+
root_categories << category
|
79
|
+
end
|
80
|
+
|
81
|
+
category[:id] = id
|
82
|
+
category[:name] = name
|
83
|
+
end
|
84
|
+
|
85
|
+
display_categories(root_categories)
|
86
|
+
end
|
87
|
+
|
88
|
+
if __FILE__ == $0
|
89
|
+
API_VERSION = :v201402
|
90
|
+
|
91
|
+
begin
|
92
|
+
get_product_category_taxonomy()
|
93
|
+
|
94
|
+
# Authorization error.
|
95
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
96
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
97
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
98
|
+
"to retrieve and store OAuth2 tokens."
|
99
|
+
puts "See this wiki page for more details:\n\n " +
|
100
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
101
|
+
|
102
|
+
# HTTP errors.
|
103
|
+
rescue AdsCommon::Errors::HttpError => e
|
104
|
+
puts "HTTP Error: %s" % e
|
105
|
+
|
106
|
+
# API errors.
|
107
|
+
rescue AdwordsApi::Errors::ApiException => e
|
108
|
+
puts "Message: %s" % e.message
|
109
|
+
puts 'Errors:'
|
110
|
+
e.errors.each_with_index do |error, index|
|
111
|
+
puts "\tError [%d]:" % (index + 1)
|
112
|
+
error.each do |field, value|
|
113
|
+
puts "\t\t%s: %s" % [field, value]
|
114
|
+
end
|
115
|
+
end
|
116
|
+
end
|
117
|
+
end
|