google-adwords-api 0.14.2 → 0.15.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +8 -8
- data/ChangeLog +7 -0
- data/README.md +3 -3
- data/adwords_api.yml +5 -0
- data/examples/v201409/account_management/get_account_hierarchy.rb +2 -2
- data/examples/v201409/advanced_operations/{add_ad_customizer.rb → add_ad_customizers.rb} +4 -4
- data/examples/v201409/extensions/add_site_links_using_feeds.rb +12 -12
- data/examples/v201409/migration/migrate_to_extension_settings.rb +29 -2
- data/examples/v201409/reporting/parallel_report_download.rb +1 -1
- data/examples/v201502/advanced_operations/{add_ad_customizer.rb → add_ad_customizers.rb} +37 -125
- data/examples/v201502/extensions/add_site_links_using_feeds.rb +22 -52
- data/examples/v201502/migration/migrate_to_extension_settings.rb +29 -2
- data/lib/adwords_api.rb +9 -29
- data/lib/adwords_api/api_config.rb +0 -80
- data/lib/adwords_api/credential_handler.rb +8 -9
- data/lib/adwords_api/report_header_handler.rb +6 -2
- data/lib/adwords_api/version.rb +1 -1
- data/test/adwords_api/test_adwords_api.rb +0 -9
- data/test/adwords_api/test_api_config.rb +8 -8
- data/test/adwords_api/test_credential_handler.rb +17 -0
- data/test/adwords_api/test_report_utils.rb +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 +1 -1
- data/test/templates/v201502/misc_use_oauth2_jwt.def +1 -1
- metadata +4 -153
- data/examples/v201406/account_management/create_account.rb +0 -92
- data/examples/v201406/account_management/get_account_alerts.rb +0 -122
- data/examples/v201406/account_management/get_account_changes.rb +0 -145
- data/examples/v201406/account_management/get_account_hierarchy.rb +0 -103
- data/examples/v201406/advanced_operations/add_ad_customizer.rb +0 -277
- data/examples/v201406/advanced_operations/add_ad_group_bid_modifier.rb +0 -105
- data/examples/v201406/advanced_operations/add_click_to_download_ad.rb +0 -137
- data/examples/v201406/advanced_operations/add_google_my_business_location_extensions.rb +0 -167
- data/examples/v201406/advanced_operations/add_site_links.rb +0 -306
- data/examples/v201406/advanced_operations/add_text_ad_with_upgraded_urls.rb +0 -137
- data/examples/v201406/advanced_operations/get_ad_group_bid_modifiers.rb +0 -106
- data/examples/v201406/advanced_operations/upload_offline_conversions.rb +0 -117
- data/examples/v201406/advanced_operations/use_shared_bidding_strategy.rb +0 -164
- data/examples/v201406/basic_operations/add_ad_groups.rb +0 -144
- data/examples/v201406/basic_operations/add_campaigns.rb +0 -153
- data/examples/v201406/basic_operations/add_keywords.rb +0 -116
- data/examples/v201406/basic_operations/add_text_ads.rb +0 -113
- data/examples/v201406/basic_operations/get_ad_groups.rb +0 -106
- data/examples/v201406/basic_operations/get_campaigns.rb +0 -101
- data/examples/v201406/basic_operations/get_campaigns_with_awql.rb +0 -93
- data/examples/v201406/basic_operations/get_keywords.rb +0 -112
- data/examples/v201406/basic_operations/get_text_ads.rb +0 -114
- data/examples/v201406/basic_operations/pause_ad.rb +0 -92
- data/examples/v201406/basic_operations/remove_ad.rb +0 -93
- data/examples/v201406/basic_operations/remove_ad_group.rb +0 -89
- data/examples/v201406/basic_operations/remove_campaign.rb +0 -91
- data/examples/v201406/basic_operations/remove_keyword.rb +0 -98
- data/examples/v201406/basic_operations/update_ad_group.rb +0 -89
- data/examples/v201406/basic_operations/update_campaign.rb +0 -90
- data/examples/v201406/basic_operations/update_keyword.rb +0 -110
- data/examples/v201406/campaign_management/add_campaign_labels.rb +0 -86
- data/examples/v201406/campaign_management/add_experiment.rb +0 -166
- data/examples/v201406/campaign_management/add_keywords_in_bulk.rb +0 -158
- data/examples/v201406/campaign_management/add_location_extension.rb +0 -125
- data/examples/v201406/campaign_management/get_all_disapproved_ads.rb +0 -101
- data/examples/v201406/campaign_management/get_all_disapproved_ads_with_awql.rb +0 -93
- data/examples/v201406/campaign_management/get_campaigns_by_label.rb +0 -112
- data/examples/v201406/campaign_management/promote_experiment.rb +0 -85
- data/examples/v201406/campaign_management/set_ad_parameters.rb +0 -122
- data/examples/v201406/campaign_management/set_criterion_bid_modifier.rb +0 -108
- data/examples/v201406/campaign_management/validate_text_ad.rb +0 -114
- data/examples/v201406/error_handling/handle_captcha_challenge.rb +0 -93
- data/examples/v201406/error_handling/handle_partial_failures.rb +0 -134
- data/examples/v201406/error_handling/handle_policy_violation_error.rb +0 -145
- data/examples/v201406/error_handling/handle_two_factor_authorization_error.rb +0 -88
- data/examples/v201406/misc/create_ad_words_session_without_properties_file.rb +0 -94
- data/examples/v201406/misc/get_all_images_and_videos.rb +0 -108
- data/examples/v201406/misc/setup_oauth2.rb +0 -88
- data/examples/v201406/misc/upload_image.rb +0 -97
- data/examples/v201406/misc/use_oauth2_jwt.rb +0 -97
- data/examples/v201406/optimization/estimate_keyword_traffic.rb +0 -155
- data/examples/v201406/optimization/get_keyword_bid_simulations.rb +0 -100
- data/examples/v201406/optimization/get_keyword_ideas.rb +0 -130
- data/examples/v201406/optimization/get_placement_ideas.rb +0 -112
- data/examples/v201406/remarketing/add_audience.rb +0 -123
- data/examples/v201406/remarketing/add_conversion_tracker.rb +0 -105
- data/examples/v201406/reporting/download_criteria_report.rb +0 -87
- data/examples/v201406/reporting/download_criteria_report_with_awql.rb +0 -86
- data/examples/v201406/reporting/get_report_fields.rb +0 -79
- data/examples/v201406/reporting/parallel_report_download.rb +0 -171
- data/examples/v201406/shopping_campaigns/add_product_partition_tree.rb +0 -269
- data/examples/v201406/shopping_campaigns/add_product_scope.rb +0 -133
- data/examples/v201406/shopping_campaigns/add_shopping_campaign.rb +0 -135
- data/examples/v201406/shopping_campaigns/get_product_category_taxonomy.rb +0 -117
- data/examples/v201406/shopping_campaigns/set_product_sales_channel.rb +0 -98
- data/examples/v201406/targeting/add_campaign_targeting_criteria.rb +0 -173
- data/examples/v201406/targeting/add_demographic_targeting_criteria.rb +0 -116
- data/examples/v201406/targeting/get_campaign_targeting_criteria.rb +0 -110
- data/examples/v201406/targeting/get_targetable_languages_and_carriers.rb +0 -94
- data/examples/v201406/targeting/lookup_location.rb +0 -112
- data/examples/v201502/campaign_management/add_location_extension.rb +0 -125
- data/lib/adwords_api/v201406/ad_group_ad_service.rb +0 -46
- data/lib/adwords_api/v201406/ad_group_ad_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/ad_group_bid_modifier_service.rb +0 -42
- data/lib/adwords_api/v201406/ad_group_bid_modifier_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/ad_group_criterion_service.rb +0 -46
- data/lib/adwords_api/v201406/ad_group_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/ad_group_feed_service.rb +0 -42
- data/lib/adwords_api/v201406/ad_group_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/ad_group_service.rb +0 -46
- data/lib/adwords_api/v201406/ad_group_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/ad_param_service.rb +0 -38
- data/lib/adwords_api/v201406/ad_param_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/adwords_user_list_service.rb +0 -38
- data/lib/adwords_api/v201406/adwords_user_list_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/alert_service.rb +0 -34
- data/lib/adwords_api/v201406/alert_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/bidding_strategy_service.rb +0 -42
- data/lib/adwords_api/v201406/bidding_strategy_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/budget_order_service.rb +0 -42
- data/lib/adwords_api/v201406/budget_order_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/budget_service.rb +0 -42
- data/lib/adwords_api/v201406/budget_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/campaign_ad_extension_service.rb +0 -38
- data/lib/adwords_api/v201406/campaign_ad_extension_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/campaign_criterion_service.rb +0 -42
- data/lib/adwords_api/v201406/campaign_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/campaign_feed_service.rb +0 -42
- data/lib/adwords_api/v201406/campaign_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/campaign_service.rb +0 -46
- data/lib/adwords_api/v201406/campaign_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/campaign_shared_set_service.rb +0 -38
- data/lib/adwords_api/v201406/campaign_shared_set_service_registry.rb +0 -47
- data/lib/adwords_api/v201406/constant_data_service.rb +0 -66
- data/lib/adwords_api/v201406/constant_data_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/conversion_tracker_service.rb +0 -38
- data/lib/adwords_api/v201406/conversion_tracker_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/customer_feed_service.rb +0 -42
- data/lib/adwords_api/v201406/customer_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/customer_service.rb +0 -38
- data/lib/adwords_api/v201406/customer_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/customer_sync_service.rb +0 -34
- data/lib/adwords_api/v201406/customer_sync_service_registry.rb +0 -47
- data/lib/adwords_api/v201406/data_service.rb +0 -54
- data/lib/adwords_api/v201406/data_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/experiment_service.rb +0 -38
- data/lib/adwords_api/v201406/experiment_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/feed_item_service.rb +0 -42
- data/lib/adwords_api/v201406/feed_item_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/feed_mapping_service.rb +0 -42
- data/lib/adwords_api/v201406/feed_mapping_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/feed_service.rb +0 -42
- data/lib/adwords_api/v201406/feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/geo_location_service.rb +0 -34
- data/lib/adwords_api/v201406/geo_location_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/label_service.rb +0 -42
- data/lib/adwords_api/v201406/label_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/location_criterion_service.rb +0 -38
- data/lib/adwords_api/v201406/location_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/managed_customer_service.rb +0 -50
- data/lib/adwords_api/v201406/managed_customer_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/media_service.rb +0 -42
- data/lib/adwords_api/v201406/media_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/mutate_job_service.rb +0 -42
- data/lib/adwords_api/v201406/mutate_job_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/offline_conversion_feed_service.rb +0 -34
- data/lib/adwords_api/v201406/offline_conversion_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/report_definition_service.rb +0 -34
- data/lib/adwords_api/v201406/report_definition_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/shared_criterion_service.rb +0 -38
- data/lib/adwords_api/v201406/shared_criterion_service_registry.rb +0 -47
- data/lib/adwords_api/v201406/shared_set_service.rb +0 -38
- data/lib/adwords_api/v201406/shared_set_service_registry.rb +0 -47
- data/lib/adwords_api/v201406/targeting_idea_service.rb +0 -38
- data/lib/adwords_api/v201406/targeting_idea_service_registry.rb +0 -46
- data/lib/adwords_api/v201406/traffic_estimator_service.rb +0 -34
- data/lib/adwords_api/v201406/traffic_estimator_service_registry.rb +0 -46
- data/test/templates/v201406/basic_operations_get_campaigns.def +0 -114
- data/test/templates/v201406/misc_use_oauth2_jwt.def +0 -131
@@ -1,155 +0,0 @@
|
|
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 gets keyword traffic estimates.
|
22
|
-
#
|
23
|
-
# Tags: TrafficEstimatorService.get
|
24
|
-
|
25
|
-
require 'adwords_api'
|
26
|
-
|
27
|
-
def estimate_keyword_traffic()
|
28
|
-
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
29
|
-
# when called without parameters.
|
30
|
-
adwords = AdwordsApi::Api.new
|
31
|
-
|
32
|
-
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
33
|
-
# the configuration file or provide your own logger:
|
34
|
-
# adwords.logger = Logger.new('adwords_xml.log')
|
35
|
-
|
36
|
-
traffic_estimator_srv = adwords.service(:TrafficEstimatorService, API_VERSION)
|
37
|
-
|
38
|
-
# Create keywords. Up to 2000 keywords can be passed in a single request.
|
39
|
-
keywords = [
|
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
|
-
{:xsi_type => 'Keyword', :text => 'mars cruise', :match_type => 'BROAD'},
|
44
|
-
{:xsi_type => 'Keyword', :text => 'cheap cruise', :match_type => 'PHRASE'},
|
45
|
-
{:xsi_type => 'Keyword', :text => 'cruise', :match_type => 'EXACT'},
|
46
|
-
{:xsi_type => 'Keyword', :text => 'moon walk', :match_type => 'BROAD'}
|
47
|
-
]
|
48
|
-
|
49
|
-
# Create a keyword estimate request for each keyword.
|
50
|
-
keyword_requests = keywords.map {|keyword| {:keyword => keyword}}
|
51
|
-
|
52
|
-
# Negative keywords don't return estimates, but adjust the estimates of the
|
53
|
-
# other keywords in the hypothetical ad group. To specify a negative keyword
|
54
|
-
# set the is_negative field to true.
|
55
|
-
keyword_requests[3][:is_negative] = true
|
56
|
-
|
57
|
-
# Create ad group estimate requests.
|
58
|
-
ad_group_request = {
|
59
|
-
:keyword_estimate_requests => keyword_requests,
|
60
|
-
:max_cpc => {
|
61
|
-
:micro_amount => 1000000
|
62
|
-
}
|
63
|
-
}
|
64
|
-
|
65
|
-
# Create campaign estimate requests.
|
66
|
-
campaign_request = {
|
67
|
-
:ad_group_estimate_requests => [ad_group_request],
|
68
|
-
# Set targeting criteria. Only locations and languages are supported.
|
69
|
-
:criteria => [
|
70
|
-
{:xsi_type => 'Location', :id => 2840}, # United States
|
71
|
-
{:xsi_type => 'Language', :id => 1000} # English
|
72
|
-
]
|
73
|
-
}
|
74
|
-
|
75
|
-
# Create selector and retrieve reults.
|
76
|
-
selector = {:campaign_estimate_requests => [campaign_request]}
|
77
|
-
response = traffic_estimator_srv.get(selector)
|
78
|
-
|
79
|
-
if response and response[:campaign_estimates]
|
80
|
-
campaign_estimates = response[:campaign_estimates]
|
81
|
-
keyword_estimates =
|
82
|
-
campaign_estimates.first[:ad_group_estimates].first[:keyword_estimates]
|
83
|
-
keyword_estimates.each_with_index do |estimate, index|
|
84
|
-
keyword = keyword_requests[index][:keyword]
|
85
|
-
|
86
|
-
# Find the mean of the min and max values.
|
87
|
-
mean_avg_cpc = calculate_mean(
|
88
|
-
estimate[:min][:average_cpc][:micro_amount],
|
89
|
-
estimate[:max][:average_cpc][:micro_amount]
|
90
|
-
)
|
91
|
-
mean_avg_position = calculate_mean(
|
92
|
-
estimate[:min][:average_position],
|
93
|
-
estimate[:max][:average_position])
|
94
|
-
)
|
95
|
-
mean_clicks = calculate_mean(
|
96
|
-
estimate[:min][:clicks_per_day],
|
97
|
-
estimate[:max][:clicks_per_day]
|
98
|
-
)
|
99
|
-
mean_total_cost = calculate_mean(
|
100
|
-
estimate[:min][:total_cost][:micro_amount],
|
101
|
-
estimate[:max][:total_cost][:micro_amount]
|
102
|
-
)
|
103
|
-
|
104
|
-
puts "Results for the keyword with text '%s' and match type %s:" %
|
105
|
-
[keyword[:text], keyword[:match_type]]
|
106
|
-
puts "\tEstimated average CPC: %s" % format_mean(mean_avg_cpc)
|
107
|
-
puts "\tEstimated ad position: %s" % format_mean(mean_avg_position)
|
108
|
-
puts "\tEstimated daily clicks: %s" % format_mean(mean_clicks)
|
109
|
-
puts "\tEstimated daily cost: %s" % format_mean(mean_total_cost)
|
110
|
-
end
|
111
|
-
else
|
112
|
-
puts 'No traffic estimates were returned.'
|
113
|
-
end
|
114
|
-
end
|
115
|
-
|
116
|
-
def format_mean(mean)
|
117
|
-
return "nil" if mean.nil?
|
118
|
-
return "%.2f" % mean
|
119
|
-
end
|
120
|
-
|
121
|
-
def calculate_mean(min_money, max_money)
|
122
|
-
return nil if min_money.nil? || max_money.nil?
|
123
|
-
return (min_money.to_f + max_money.to_f) / 2.0
|
124
|
-
end
|
125
|
-
|
126
|
-
if __FILE__ == $0
|
127
|
-
API_VERSION = :v201406
|
128
|
-
|
129
|
-
begin
|
130
|
-
estimate_keyword_traffic()
|
131
|
-
|
132
|
-
# Authorization error.
|
133
|
-
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
134
|
-
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
135
|
-
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
136
|
-
"to retrieve and store OAuth2 tokens."
|
137
|
-
puts "See this wiki page for more details:\n\n " +
|
138
|
-
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
139
|
-
|
140
|
-
# HTTP errors.
|
141
|
-
rescue AdsCommon::Errors::HttpError => e
|
142
|
-
puts "HTTP Error: %s" % e
|
143
|
-
|
144
|
-
# API errors.
|
145
|
-
rescue AdwordsApi::Errors::ApiException => e
|
146
|
-
puts "Message: %s" % e.message
|
147
|
-
puts 'Errors:'
|
148
|
-
e.errors.each_with_index do |error, index|
|
149
|
-
puts "\tError [%d]:" % (index + 1)
|
150
|
-
error.each do |field, value|
|
151
|
-
puts "\t\t%s: %s" % [field, value]
|
152
|
-
end
|
153
|
-
end
|
154
|
-
end
|
155
|
-
end
|
@@ -1,100 +0,0 @@
|
|
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 gets bid landscapes for a keyword. To get keywords, run
|
22
|
-
# get_keywords.rb.
|
23
|
-
#
|
24
|
-
# Tags: DataService.getCriterionBidLandscape
|
25
|
-
|
26
|
-
require 'adwords_api'
|
27
|
-
|
28
|
-
def get_criterion_bid_landscapes(ad_group_id, keyword_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
|
-
data_srv = adwords.service(:DataService, API_VERSION)
|
38
|
-
|
39
|
-
# Get keyword bid landscape.
|
40
|
-
selector = {
|
41
|
-
:fields => ['AdGroupId', 'CriterionId', 'StartDate', 'EndDate', 'Bid',
|
42
|
-
'LocalClicks', 'LocalCost', 'MarginalCpc', 'LocalImpressions'],
|
43
|
-
:predicates => [
|
44
|
-
{:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]},
|
45
|
-
{:field => 'CriterionId', :operator => 'IN', :values => [keyword_id]},
|
46
|
-
]
|
47
|
-
}
|
48
|
-
page = data_srv.get_criterion_bid_landscape(selector)
|
49
|
-
if page and page[:entries]
|
50
|
-
puts "Bid landscape(s) retrieved: %d." % [page[:entries].length]
|
51
|
-
page[:entries].each do |bid_landscape|
|
52
|
-
puts ("Retrieved keyword bid landscape with ad group ID %d" +
|
53
|
-
", keyword ID %d, start date '%s', end date '%s'" +
|
54
|
-
", with landscape points:") %
|
55
|
-
[bid_landscape[:ad_group_id], bid_landscape[:criterion_id],
|
56
|
-
bid_landscape[:start_date], bid_landscape[:end_date]]
|
57
|
-
bid_landscape[:landscape_points].each do |point|
|
58
|
-
puts "\t%d => clicks: %d, cost: %d, marginalCpc: %d, impressions: %d" %
|
59
|
-
[point[:bid][:micro_amount], point.clicks,
|
60
|
-
point[:cost][:micro_amount], point[:marginal_cpc][:micro_amount],
|
61
|
-
point[:impressions]]
|
62
|
-
end
|
63
|
-
end
|
64
|
-
else
|
65
|
-
puts 'No bid landscapes retrieved.'
|
66
|
-
end
|
67
|
-
end
|
68
|
-
|
69
|
-
if __FILE__ == $0
|
70
|
-
API_VERSION = :v201406
|
71
|
-
|
72
|
-
begin
|
73
|
-
ad_group_id = 'INSERT_ADGROUP_ID_HERE'.to_i
|
74
|
-
keyword_id = 'INSERT_KEYWORD_ID_HERE'.to_i
|
75
|
-
get_criterion_bid_landscapes(ad_group_id, keyword_id)
|
76
|
-
|
77
|
-
# Authorization error.
|
78
|
-
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
79
|
-
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
80
|
-
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
81
|
-
"to retrieve and store OAuth2 tokens."
|
82
|
-
puts "See this wiki page for more details:\n\n " +
|
83
|
-
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
84
|
-
|
85
|
-
# HTTP errors.
|
86
|
-
rescue AdsCommon::Errors::HttpError => e
|
87
|
-
puts "HTTP Error: %s" % e
|
88
|
-
|
89
|
-
# API errors.
|
90
|
-
rescue AdwordsApi::Errors::ApiException => e
|
91
|
-
puts "Message: %s" % e.message
|
92
|
-
puts 'Errors:'
|
93
|
-
e.errors.each_with_index do |error, index|
|
94
|
-
puts "\tError [%d]:" % (index + 1)
|
95
|
-
error.each do |field, value|
|
96
|
-
puts "\t\t%s: %s" % [field, value]
|
97
|
-
end
|
98
|
-
end
|
99
|
-
end
|
100
|
-
end
|
@@ -1,130 +0,0 @@
|
|
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 retrieves keywords that are related to a given keyword.
|
22
|
-
#
|
23
|
-
# Tags: TargetingIdeaService.get
|
24
|
-
|
25
|
-
require 'adwords_api'
|
26
|
-
|
27
|
-
def get_keyword_ideas(keyword_text)
|
28
|
-
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
29
|
-
# when called without parameters.
|
30
|
-
adwords = AdwordsApi::Api.new
|
31
|
-
|
32
|
-
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
33
|
-
# the configuration file or provide your own logger:
|
34
|
-
# adwords.logger = Logger.new('adwords_xml.log')
|
35
|
-
|
36
|
-
targeting_idea_srv = adwords.service(:TargetingIdeaService, API_VERSION)
|
37
|
-
|
38
|
-
# Construct selector object.
|
39
|
-
selector = {
|
40
|
-
:idea_type => 'KEYWORD',
|
41
|
-
:request_type => 'IDEAS',
|
42
|
-
:requested_attribute_types =>
|
43
|
-
['KEYWORD_TEXT', 'SEARCH_VOLUME', 'CATEGORY_PRODUCTS_AND_SERVICES'],
|
44
|
-
:search_parameters => [
|
45
|
-
{
|
46
|
-
# The 'xsi_type' field allows you to specify the xsi:type of the object
|
47
|
-
# being created. It's only necessary when you must provide an explicit
|
48
|
-
# type that the client library can't infer.
|
49
|
-
:xsi_type => 'RelatedToQuerySearchParameter',
|
50
|
-
:queries => [keyword_text]
|
51
|
-
},
|
52
|
-
{
|
53
|
-
# Language setting (optional).
|
54
|
-
# The ID can be found in the documentation:
|
55
|
-
# https://developers.google.com/adwords/api/docs/appendix/languagecodes
|
56
|
-
# Only one LanguageSearchParameter is allowed per request.
|
57
|
-
:xsi_type => 'LanguageSearchParameter',
|
58
|
-
:languages => [{:id => 1000}]
|
59
|
-
}
|
60
|
-
],
|
61
|
-
:paging => {
|
62
|
-
:start_index => 0,
|
63
|
-
:number_results => PAGE_SIZE
|
64
|
-
}
|
65
|
-
}
|
66
|
-
|
67
|
-
# Define initial values.
|
68
|
-
offset = 0
|
69
|
-
results = []
|
70
|
-
|
71
|
-
begin
|
72
|
-
# Perform request.
|
73
|
-
page = targeting_idea_srv.get(selector)
|
74
|
-
results += page[:entries] if page and page[:entries]
|
75
|
-
|
76
|
-
# Prepare next page request.
|
77
|
-
offset += PAGE_SIZE
|
78
|
-
selector[:paging][:start_index] = offset
|
79
|
-
end while offset < page[:total_num_entries]
|
80
|
-
|
81
|
-
# Display results.
|
82
|
-
results.each do |result|
|
83
|
-
data = result[:data]
|
84
|
-
keyword = data['KEYWORD_TEXT'][:value]
|
85
|
-
puts "Found keyword with text '%s'" % keyword
|
86
|
-
products_and_services = data['CATEGORY_PRODUCTS_AND_SERVICES'][:value]
|
87
|
-
if products_and_services
|
88
|
-
puts "\tWith Products and Services categories: [%s]" %
|
89
|
-
products_and_services.join(', ')
|
90
|
-
end
|
91
|
-
average_monthly_searches = data['SEARCH_VOLUME'][:value]
|
92
|
-
if average_monthly_searches
|
93
|
-
puts "\tand average monthly search volume: %d" % average_monthly_searches
|
94
|
-
end
|
95
|
-
end
|
96
|
-
puts "Total keywords related to '%s': %d." % [keyword_text, results.length]
|
97
|
-
end
|
98
|
-
|
99
|
-
if __FILE__ == $0
|
100
|
-
API_VERSION = :v201406
|
101
|
-
PAGE_SIZE = 100
|
102
|
-
|
103
|
-
begin
|
104
|
-
keyword_text = 'INSERT_KEYWORD_TEXT_HERE'
|
105
|
-
get_keyword_ideas(keyword_text)
|
106
|
-
|
107
|
-
# Authorization error.
|
108
|
-
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
109
|
-
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
110
|
-
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
111
|
-
"to retrieve and store OAuth2 tokens."
|
112
|
-
puts "See this wiki page for more details:\n\n " +
|
113
|
-
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
114
|
-
|
115
|
-
# HTTP errors.
|
116
|
-
rescue AdsCommon::Errors::HttpError => e
|
117
|
-
puts "HTTP Error: %s" % e
|
118
|
-
|
119
|
-
# API errors.
|
120
|
-
rescue AdwordsApi::Errors::ApiException => e
|
121
|
-
puts "Message: %s" % e.message
|
122
|
-
puts 'Errors:'
|
123
|
-
e.errors.each_with_index do |error, index|
|
124
|
-
puts "\tError [%d]:" % (index + 1)
|
125
|
-
error.each do |field, value|
|
126
|
-
puts "\t\t%s: %s" % [field, value]
|
127
|
-
end
|
128
|
-
end
|
129
|
-
end
|
130
|
-
end
|
@@ -1,112 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
# Encoding: utf-8
|
3
|
-
#
|
4
|
-
# Author:: api.sgomes@gmail.com (Sérgio Gomes)
|
5
|
-
#
|
6
|
-
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
7
|
-
#
|
8
|
-
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
9
|
-
# you may not use this file except in compliance with the License.
|
10
|
-
# You may obtain a copy of the License at
|
11
|
-
#
|
12
|
-
# http://www.apache.org/licenses/LICENSE-2.0
|
13
|
-
#
|
14
|
-
# Unless required by applicable law or agreed to in writing, software
|
15
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
16
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
17
|
-
# implied.
|
18
|
-
# See the License for the specific language governing permissions and
|
19
|
-
# limitations under the License.
|
20
|
-
#
|
21
|
-
# This example retrieves URLs that have content keywords related to a given
|
22
|
-
# website.
|
23
|
-
#
|
24
|
-
# Tags: TargetingIdeaService.get
|
25
|
-
|
26
|
-
require 'adwords_api'
|
27
|
-
|
28
|
-
def get_placement_ideas(url)
|
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
|
-
targeting_idea_srv = adwords.service(:TargetingIdeaService, API_VERSION)
|
38
|
-
|
39
|
-
# Construct selector.
|
40
|
-
selector = {
|
41
|
-
:idea_type => 'PLACEMENT',
|
42
|
-
:request_type => 'IDEAS',
|
43
|
-
:requested_attribute_types => ['CRITERION'],
|
44
|
-
:search_parameters => [{
|
45
|
-
# The 'xsi_type' field allows you to specify the xsi:type of the object
|
46
|
-
# being created. It's only necessary when you must provide an explicit
|
47
|
-
# type that the client library can't infer.
|
48
|
-
:xsi_type => 'RelatedToUrlSearchParameter',
|
49
|
-
:urls => [url],
|
50
|
-
:include_sub_urls => false
|
51
|
-
}],
|
52
|
-
:paging => {
|
53
|
-
:start_index => 0,
|
54
|
-
:number_results => PAGE_SIZE
|
55
|
-
}
|
56
|
-
}
|
57
|
-
|
58
|
-
# Define initial values.
|
59
|
-
offset = 0
|
60
|
-
results = []
|
61
|
-
|
62
|
-
begin
|
63
|
-
# Perform request.
|
64
|
-
page = targeting_idea_srv.get(selector)
|
65
|
-
results += page[:entries] if page and page[:entries]
|
66
|
-
|
67
|
-
# Prepare next page request.
|
68
|
-
offset += PAGE_SIZE
|
69
|
-
selector[:paging][:start_index] = offset
|
70
|
-
end while offset < page[:total_num_entries]
|
71
|
-
|
72
|
-
# Display results.
|
73
|
-
results.each do |result|
|
74
|
-
placement = result[:data]['CRITERION'][:value]
|
75
|
-
puts "Related placement found at URL [%s]" % placement[:url]
|
76
|
-
end
|
77
|
-
puts "Total URLs found with keywords related to keywords at [%s]: %d." %
|
78
|
-
[url, results.length]
|
79
|
-
end
|
80
|
-
|
81
|
-
if __FILE__ == $0
|
82
|
-
API_VERSION = :v201406
|
83
|
-
PAGE_SIZE = 100
|
84
|
-
|
85
|
-
begin
|
86
|
-
url = 'INSERT_PLACEMENT_URL_HERE'
|
87
|
-
get_placement_ideas(url)
|
88
|
-
|
89
|
-
# Authorization error.
|
90
|
-
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
91
|
-
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
92
|
-
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
93
|
-
"to retrieve and store OAuth2 tokens."
|
94
|
-
puts "See this wiki page for more details:\n\n " +
|
95
|
-
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
96
|
-
|
97
|
-
# HTTP errors.
|
98
|
-
rescue AdsCommon::Errors::HttpError => e
|
99
|
-
puts "HTTP Error: %s" % e
|
100
|
-
|
101
|
-
# API errors.
|
102
|
-
rescue AdwordsApi::Errors::ApiException => e
|
103
|
-
puts "Message: %s" % e.message
|
104
|
-
puts 'Errors:'
|
105
|
-
e.errors.each_with_index do |error, index|
|
106
|
-
puts "\tError [%d]:" % (index + 1)
|
107
|
-
error.each do |field, value|
|
108
|
-
puts "\t\t%s: %s" % [field, value]
|
109
|
-
end
|
110
|
-
end
|
111
|
-
end
|
112
|
-
end
|