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,137 +0,0 @@
|
|
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 text ad that uses upgraded URLs. This example will only
|
22
|
-
# work if your account is a test account or is whitelisted for this feature.
|
23
|
-
#
|
24
|
-
# Tags: AdGroupAdService.mutate
|
25
|
-
|
26
|
-
require 'adwords_api'
|
27
|
-
|
28
|
-
def add_text_ad_with_upgraded_urls(ad_group_id)
|
29
|
-
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
30
|
-
# when called without parameters.
|
31
|
-
adwords = AdwordsApi::Api.new
|
32
|
-
|
33
|
-
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
34
|
-
# the configuration file or provide your own logger:
|
35
|
-
# adwords.logger = Logger.new('adwords_xml.log')
|
36
|
-
|
37
|
-
ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
|
38
|
-
|
39
|
-
# Since your tracking URL will have two custom parameters, provide their
|
40
|
-
# values too. This can be provided at campaign, ad group, ad, criterion, or
|
41
|
-
# feed item levels.
|
42
|
-
season_parameter = {
|
43
|
-
:key => 'season',
|
44
|
-
:value => 'christmas'
|
45
|
-
}
|
46
|
-
|
47
|
-
promo_code_parameter = {
|
48
|
-
:key => 'promocode',
|
49
|
-
:value => 'NYC123'
|
50
|
-
}
|
51
|
-
|
52
|
-
tracking_url_parameters = {
|
53
|
-
:parameters => [season_parameter, promo_code_parameter]
|
54
|
-
}
|
55
|
-
|
56
|
-
text_ad = {
|
57
|
-
:xsi_type => 'TextAd',
|
58
|
-
:headline => 'Luxury Cruise to Mars',
|
59
|
-
:description1 => 'Visit the Red Planet in style.',
|
60
|
-
:description2 => 'Low-gravity fun for everyone!',
|
61
|
-
:display_url => 'www.example.com',
|
62
|
-
# Specify a tracking URL for 3rd party tracking provider. You may specify
|
63
|
-
# one at customer, campaign, ad group, ad, criterion, or feed item levels.
|
64
|
-
:tracking_url_template => 'http://tracker.example.com/' +
|
65
|
-
'?season={_season}&promocode={_promocode}&u={lpurl}',
|
66
|
-
:url_custom_parameters => tracking_url_parameters,
|
67
|
-
# Specify a list of final URLs. This field cannot be set if :url field
|
68
|
-
# is set. This may be specified at ad, criterion, and feed item levels.
|
69
|
-
:final_urls => [
|
70
|
-
'http://www.example.com/cruise/space/',
|
71
|
-
'http://www.example.com/locations/mars/'
|
72
|
-
],
|
73
|
-
# Specify a list of final mobile URLs. This field cannot be set if :url
|
74
|
-
# field is set. This may be specificed at ad, criterion, and
|
75
|
-
# feed item levels.
|
76
|
-
:final_mobile_urls => [
|
77
|
-
'http://mobile.example.com/cruise/space/',
|
78
|
-
'http://mobile.example.com/locations/mars/'
|
79
|
-
]
|
80
|
-
}
|
81
|
-
|
82
|
-
operation = {
|
83
|
-
:operator => 'ADD',
|
84
|
-
:operand => {:ad_group_id => ad_group_id, :ad => text_ad}
|
85
|
-
}
|
86
|
-
|
87
|
-
# Add ads.
|
88
|
-
response = ad_group_ad_srv.mutate([operation])
|
89
|
-
if response and response[:value]
|
90
|
-
response[:value].each do |ad|
|
91
|
-
text_ad = ad[:ad]
|
92
|
-
puts "Ad with ID %d and displayUrl '%s' was added." %
|
93
|
-
[text_ad[:id], text_ad[:display_url]]
|
94
|
-
puts "\tFinal URLs: %s" % [text_ad[:final_urls].join(', ')]
|
95
|
-
puts "\tFinal Mobile URLs: %s" % [text_ad[:final_mobile_urls].join(', ')]
|
96
|
-
puts "\tTracking URL template: %s" % [text_ad[:tracking_url_template]]
|
97
|
-
custom_parameters = text_ad[:custom_parameters].map do |custom_parameter|
|
98
|
-
"%s=%s" % [custom_parameter[:key], custom_parameter[:value]]
|
99
|
-
end
|
100
|
-
puts "\tCustom parameters: %s" % [custom_parameters.join(', ')]
|
101
|
-
end
|
102
|
-
else
|
103
|
-
raise StandardError, 'No ads were added.'
|
104
|
-
end
|
105
|
-
end
|
106
|
-
|
107
|
-
if __FILE__ == $0
|
108
|
-
API_VERSION = :v201406
|
109
|
-
|
110
|
-
begin
|
111
|
-
ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
|
112
|
-
add_text_ad_with_upgraded_urls(ad_group_id)
|
113
|
-
|
114
|
-
# Authorization error.
|
115
|
-
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
116
|
-
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
117
|
-
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
118
|
-
"to retrieve and store OAuth2 tokens."
|
119
|
-
puts "See this wiki page for more details:\n\n " +
|
120
|
-
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
121
|
-
|
122
|
-
# HTTP errors.
|
123
|
-
rescue AdsCommon::Errors::HttpError => e
|
124
|
-
puts "HTTP Error: %s" % e
|
125
|
-
|
126
|
-
# API errors.
|
127
|
-
rescue AdwordsApi::Errors::ApiException => e
|
128
|
-
puts "Message: %s" % e.message
|
129
|
-
puts 'Errors:'
|
130
|
-
e.errors.each_with_index do |error, index|
|
131
|
-
puts "\tError [%d]:" % (index + 1)
|
132
|
-
error.each do |field, value|
|
133
|
-
puts "\t\t%s: %s" % [field, value]
|
134
|
-
end
|
135
|
-
end
|
136
|
-
end
|
137
|
-
end
|
@@ -1,106 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
# Encoding: utf-8
|
3
|
-
#
|
4
|
-
# Author:: api.dklimkin@gmail.com (Danial Klimkin)
|
5
|
-
#
|
6
|
-
# Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
|
7
|
-
#
|
8
|
-
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
9
|
-
# you may not use this file except in compliance with the License.
|
10
|
-
# You may obtain a copy of the License at
|
11
|
-
#
|
12
|
-
# http://www.apache.org/licenses/LICENSE-2.0
|
13
|
-
#
|
14
|
-
# Unless required by applicable law or agreed to in writing, software
|
15
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
16
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
17
|
-
# implied.
|
18
|
-
# See the License for the specific language governing permissions and
|
19
|
-
# limitations under the License.
|
20
|
-
#
|
21
|
-
# This example illustrates how to retrieve ad group level bid modifiers for a
|
22
|
-
# campaign.
|
23
|
-
#
|
24
|
-
# Tags: AdGroupBidModifierService.get
|
25
|
-
|
26
|
-
require 'adwords_api'
|
27
|
-
|
28
|
-
def get_ad_group_bid_modifiers(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
|
-
bid_modifier_srv = adwords.service(:AdGroupBidModifierService, API_VERSION)
|
38
|
-
|
39
|
-
# Get all ad group bid modifiers for the campaign.
|
40
|
-
selector = {
|
41
|
-
:fields => ['CampaignId', 'AdGroupId', 'Id', 'BidModifier'],
|
42
|
-
:predicates => [
|
43
|
-
{:field => 'CampaignId', :operator => 'EQUALS', :values => [campaign_id]}
|
44
|
-
],
|
45
|
-
:paging => {
|
46
|
-
:start_index => 0,
|
47
|
-
:number_results => PAGE_SIZE
|
48
|
-
}
|
49
|
-
}
|
50
|
-
|
51
|
-
# Set initial values.
|
52
|
-
offset, page = 0, {}
|
53
|
-
|
54
|
-
begin
|
55
|
-
page = bid_modifier_srv.get(selector)
|
56
|
-
if page[:entries]
|
57
|
-
page[:entries].each do |modifier|
|
58
|
-
value = modifier[:bid_modifier] || 'unset'
|
59
|
-
puts ('Campaign ID %d, AdGroup ID %d, Criterion ID %d has ad group ' +
|
60
|
-
'level modifier: %s') %
|
61
|
-
[modifier[:campaign_id], modifier[:ad_group_id],
|
62
|
-
modifier[:criterion][:id], value]
|
63
|
-
end
|
64
|
-
# Increment values to request the next page.
|
65
|
-
offset += PAGE_SIZE
|
66
|
-
selector[:paging][:start_index] = offset
|
67
|
-
else
|
68
|
-
puts 'No ad group level bid overrides returned.'
|
69
|
-
end
|
70
|
-
end while page[:total_num_entries] > offset
|
71
|
-
end
|
72
|
-
|
73
|
-
if __FILE__ == $0
|
74
|
-
API_VERSION = :v201406
|
75
|
-
PAGE_SIZE = 500
|
76
|
-
|
77
|
-
begin
|
78
|
-
# ID of a campaign to pull overrides for.
|
79
|
-
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
|
80
|
-
|
81
|
-
get_ad_group_bid_modifiers(campaign_id)
|
82
|
-
|
83
|
-
# Authorization error.
|
84
|
-
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
85
|
-
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
86
|
-
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
87
|
-
"to retrieve and store OAuth2 tokens."
|
88
|
-
puts "See this wiki page for more details:\n\n " +
|
89
|
-
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
90
|
-
|
91
|
-
# HTTP errors.
|
92
|
-
rescue AdsCommon::Errors::HttpError => e
|
93
|
-
puts "HTTP Error: %s" % e
|
94
|
-
|
95
|
-
# API errors.
|
96
|
-
rescue AdwordsApi::Errors::ApiException => e
|
97
|
-
puts "Message: %s" % e.message
|
98
|
-
puts 'Errors:'
|
99
|
-
e.errors.each_with_index do |error, index|
|
100
|
-
puts "\tError [%d]:" % (index + 1)
|
101
|
-
error.each do |field, value|
|
102
|
-
puts "\t\t%s: %s" % [field, value]
|
103
|
-
end
|
104
|
-
end
|
105
|
-
end
|
106
|
-
end
|
@@ -1,117 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
# Encoding: utf-8
|
3
|
-
#
|
4
|
-
# Author:: api.dklimkin@gmail.com (Danial Klimkin)
|
5
|
-
#
|
6
|
-
# Copyright:: Copyright 2013, 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 code example imports offline conversion values for specific clicks to
|
22
|
-
# your account. To get Google Click ID for a click, run
|
23
|
-
# CLICK_PERFORMANCE_REPORT.
|
24
|
-
#
|
25
|
-
# Tags: ConversionTrackerService.mutate, OfflineConversionFeedService.mutate
|
26
|
-
|
27
|
-
require 'adwords_api'
|
28
|
-
require 'date'
|
29
|
-
|
30
|
-
def upload_offline_conversions(conversion_name, google_click_id,
|
31
|
-
conversion_time, conversion_value)
|
32
|
-
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
33
|
-
# when called without parameters.
|
34
|
-
adwords = AdwordsApi::Api.new
|
35
|
-
|
36
|
-
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
37
|
-
# the configuration file or provide your own logger:
|
38
|
-
# adwords.logger = Logger.new('adwords_xml.log')
|
39
|
-
|
40
|
-
conversion_tracker_srv =
|
41
|
-
adwords.service(:ConversionTrackerService, API_VERSION)
|
42
|
-
conversion_feed_srv =
|
43
|
-
adwords.service(:OfflineConversionFeedService, API_VERSION)
|
44
|
-
|
45
|
-
# Create an upload conversion. Once created, this entry will be visible under
|
46
|
-
# Tools and Analysis->Conversion and will have Source = Import.
|
47
|
-
upload_conversion = {
|
48
|
-
:xsi_type => 'UploadConversion',
|
49
|
-
:category => 'PAGE_VIEW',
|
50
|
-
:name => conversion_name,
|
51
|
-
:viewthrough_lookback_window => 30,
|
52
|
-
:ctc_lookback_window => 90
|
53
|
-
}
|
54
|
-
return_conversions = conversion_tracker_srv.mutate([
|
55
|
-
{:operator => 'ADD', :operand => upload_conversion}])
|
56
|
-
return_conversions[:value].each do |tracker|
|
57
|
-
puts "Upload conversion tracker with name '%s' and ID %d was created." %
|
58
|
-
[tracker[:name], tracker[:id]]
|
59
|
-
end
|
60
|
-
|
61
|
-
# Associate offline conversions with the upload conversion tracker we created.
|
62
|
-
feed = {
|
63
|
-
:conversion_name => conversion_name,
|
64
|
-
:google_click_id => google_click_id,
|
65
|
-
:conversion_time => conversion_time,
|
66
|
-
:conversion_value => conversion_value
|
67
|
-
}
|
68
|
-
return_feeds = conversion_feed_srv.mutate([
|
69
|
-
{:operator => 'ADD', :operand => feed}])
|
70
|
-
return_feeds[:value].each do |return_feed|
|
71
|
-
puts ("Uploaded offline conversion value %.2f for Google Click ID '%s', " +
|
72
|
-
'to %s') % [return_feed[:conversion_value],
|
73
|
-
return_feed[:google_click_id],
|
74
|
-
return_feed[:conversion_name]]
|
75
|
-
end
|
76
|
-
end
|
77
|
-
|
78
|
-
if __FILE__ == $0
|
79
|
-
API_VERSION = :v201406
|
80
|
-
|
81
|
-
begin
|
82
|
-
# Name of the upload conversion to be created.
|
83
|
-
conversion_name = 'INSERT_CONVERSION_NAME_HERE'
|
84
|
-
# Google Click ID of the click for which offline conversions are uploaded.
|
85
|
-
google_click_id = 'INSERT_GOOGLE_CLICK_ID_HERE'
|
86
|
-
# Conversion time in 'yyyymmdd hhmmss' format.
|
87
|
-
conversion_time = Time.new.strftime("%Y%m%d %H%M%S")
|
88
|
-
# Conversion value to be uploaded.
|
89
|
-
conversion_value = 'INSERT_CONVERSION_VALUE_HERE'.to_f
|
90
|
-
|
91
|
-
upload_offline_conversions(conversion_name, google_click_id,
|
92
|
-
conversion_time, conversion_value)
|
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
|
@@ -1,164 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
# Encoding: utf-8
|
3
|
-
#
|
4
|
-
# Author:: api.dklimkin@gmail.com (Danial Klimkin)
|
5
|
-
#
|
6
|
-
# Copyright:: Copyright 2013, 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 Shared Bidding Strategy and uses it to construct a
|
22
|
-
# campaign.
|
23
|
-
#
|
24
|
-
# Tags: BiddingStrategyService.mutate, CampaignService.mutate
|
25
|
-
# Tags: BudgetService.mutate
|
26
|
-
|
27
|
-
require 'adwords_api'
|
28
|
-
require 'date'
|
29
|
-
|
30
|
-
def use_shared_bidding_strategy()
|
31
|
-
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
32
|
-
# when called without parameters.
|
33
|
-
adwords = AdwordsApi::Api.new
|
34
|
-
|
35
|
-
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
36
|
-
# the configuration file or provide your own logger:
|
37
|
-
# adwords.logger = Logger.new('adwords_xml.log')
|
38
|
-
|
39
|
-
budget_srv = adwords.service(:BudgetService, API_VERSION)
|
40
|
-
bidding_srv = adwords.service(:BiddingStrategyService, API_VERSION)
|
41
|
-
campaign_srv = adwords.service(:CampaignService, API_VERSION)
|
42
|
-
|
43
|
-
# Create a budget, which can be shared by multiple campaigns.
|
44
|
-
budget = {
|
45
|
-
:name => 'Interplanetary budget #%d' % (Time.new.to_f * 1000).to_i,
|
46
|
-
:amount => {:micro_amount => 50000000},
|
47
|
-
:delivery_method => 'STANDARD',
|
48
|
-
:period => 'DAILY',
|
49
|
-
:is_explicitly_shared => true
|
50
|
-
}
|
51
|
-
return_budget = budget_srv.mutate([
|
52
|
-
{:operator => 'ADD', :operand => budget}])
|
53
|
-
budget_id = return_budget[:value].first[:budget_id]
|
54
|
-
|
55
|
-
# Create a shared bidding strategy.
|
56
|
-
shared_bidding_strategy = {
|
57
|
-
:name => 'Maximize Clicks #%d' % (Time.new.to_f * 1000).to_i,
|
58
|
-
:bidding_scheme => {
|
59
|
-
:xsi_type => 'TargetSpendBiddingScheme',
|
60
|
-
# Optionally set additional bidding scheme parameters.
|
61
|
-
:bid_ceiling => {:micro_amount => 20000000},
|
62
|
-
:spend_target => {:micro_amount => 40000000}
|
63
|
-
}
|
64
|
-
}
|
65
|
-
return_strategy = bidding_srv.mutate([
|
66
|
-
{:operator => 'ADD', :operand => shared_bidding_strategy}])
|
67
|
-
|
68
|
-
bidding_strategy = return_strategy[:value].first
|
69
|
-
puts ("Shared bidding strategy with name '%s' and ID %d of type '%s' was " +
|
70
|
-
'created') %
|
71
|
-
[bidding_strategy[:name], bidding_strategy[:id], bidding_strategy[:type]]
|
72
|
-
|
73
|
-
# Create campaigns.
|
74
|
-
campaigns = [
|
75
|
-
{
|
76
|
-
:name => "Interplanetary Cruise #%d" % (Time.new.to_f * 1000).to_i,
|
77
|
-
:status => 'PAUSED',
|
78
|
-
:bidding_strategy_configuration => {
|
79
|
-
:bidding_strategy_id => bidding_strategy[:id]
|
80
|
-
},
|
81
|
-
# Budget (required) - note only the budget ID is required.
|
82
|
-
:budget => {:budget_id => budget_id},
|
83
|
-
:advertising_channel_type => 'SEARCH',
|
84
|
-
:network_setting => {
|
85
|
-
:target_google_search => true,
|
86
|
-
:target_search_network => true,
|
87
|
-
:target_content_network => true
|
88
|
-
},
|
89
|
-
:settings => [
|
90
|
-
{
|
91
|
-
:xsi_type => 'KeywordMatchSetting',
|
92
|
-
:opt_in => true
|
93
|
-
}
|
94
|
-
]
|
95
|
-
},
|
96
|
-
{
|
97
|
-
:name => "Interplanetary Cruise banner #%d" % (Time.new.to_f * 1000).to_i,
|
98
|
-
:status => 'PAUSED',
|
99
|
-
:bidding_strategy_configuration => {
|
100
|
-
:bidding_strategy_id => bidding_strategy[:id]
|
101
|
-
},
|
102
|
-
:budget => {:budget_id => budget_id},
|
103
|
-
:advertising_channel_type => 'DISPLAY',
|
104
|
-
:settings => [
|
105
|
-
{
|
106
|
-
:xsi_type => 'KeywordMatchSetting',
|
107
|
-
:opt_in => true
|
108
|
-
}
|
109
|
-
],
|
110
|
-
:network_setting => {
|
111
|
-
:target_google_search => false,
|
112
|
-
:target_search_network => false,
|
113
|
-
:target_content_network => true
|
114
|
-
}
|
115
|
-
}
|
116
|
-
]
|
117
|
-
|
118
|
-
# Prepare for adding campaign.
|
119
|
-
operations = campaigns.map do |campaign|
|
120
|
-
{:operator => 'ADD', :operand => campaign}
|
121
|
-
end
|
122
|
-
|
123
|
-
# Add campaign.
|
124
|
-
response = campaign_srv.mutate(operations)
|
125
|
-
if response and response[:value]
|
126
|
-
response[:value].each do |campaign|
|
127
|
-
puts "Campaign with name '%s' and ID %d was added." %
|
128
|
-
[campaign[:name], campaign[:id]]
|
129
|
-
end
|
130
|
-
else
|
131
|
-
raise new StandardError, 'No campaigns were added.'
|
132
|
-
end
|
133
|
-
end
|
134
|
-
|
135
|
-
if __FILE__ == $0
|
136
|
-
API_VERSION = :v201406
|
137
|
-
|
138
|
-
begin
|
139
|
-
use_shared_bidding_strategy()
|
140
|
-
|
141
|
-
# Authorization error.
|
142
|
-
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
143
|
-
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
144
|
-
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
145
|
-
"to retrieve and store OAuth2 tokens."
|
146
|
-
puts "See this wiki page for more details:\n\n " +
|
147
|
-
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
148
|
-
|
149
|
-
# HTTP errors.
|
150
|
-
rescue AdsCommon::Errors::HttpError => e
|
151
|
-
puts "HTTP Error: %s" % e
|
152
|
-
|
153
|
-
# API errors.
|
154
|
-
rescue AdwordsApi::Errors::ApiException => e
|
155
|
-
puts "Message: %s" % e.message
|
156
|
-
puts 'Errors:'
|
157
|
-
e.errors.each_with_index do |error, index|
|
158
|
-
puts "\tError [%d]:" % (index + 1)
|
159
|
-
error.each do |field, value|
|
160
|
-
puts "\t\t%s: %s" % [field, value]
|
161
|
-
end
|
162
|
-
end
|
163
|
-
end
|
164
|
-
end
|