google-adwords-api 0.15.2 → 0.16.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/adwords_api.yml +3 -2
- data/examples/v201506/basic_operations/get_keywords.rb +4 -3
- data/examples/v201506/misc/{create_ad_words_session_without_properties_file.rb → use_runtime_config.rb} +2 -2
- data/lib/adwords_api.rb +1 -1
- data/lib/adwords_api/api_config.rb +0 -86
- data/lib/adwords_api/report_header_handler.rb +4 -4
- data/lib/adwords_api/version.rb +1 -1
- data/test/templates/v201502/basic_operations_get_campaigns.def +1 -1
- data/test/templates/v201502/{misc_use_oauth2_jwt.def → misc_use_oauth2_service_account.def} +2 -2
- data/test/templates/v201506/basic_operations_get_campaigns.def +1 -1
- data/test/templates/v201506/{misc_use_oauth2_jwt.def → misc_use_oauth2_service_account.def} +2 -2
- metadata +7 -160
- data/examples/v201409/account_management/create_account.rb +0 -92
- data/examples/v201409/account_management/get_account_changes.rb +0 -145
- data/examples/v201409/account_management/get_account_hierarchy.rb +0 -102
- data/examples/v201409/advanced_operations/add_ad_customizers.rb +0 -277
- data/examples/v201409/advanced_operations/add_ad_group_bid_modifier.rb +0 -105
- data/examples/v201409/advanced_operations/add_click_to_download_ad.rb +0 -137
- data/examples/v201409/advanced_operations/add_text_ad_with_upgraded_urls.rb +0 -137
- data/examples/v201409/advanced_operations/get_ad_group_bid_modifiers.rb +0 -106
- data/examples/v201409/advanced_operations/upload_offline_conversions.rb +0 -117
- data/examples/v201409/advanced_operations/use_shared_bidding_strategy.rb +0 -152
- data/examples/v201409/basic_operations/add_ad_groups.rb +0 -144
- data/examples/v201409/basic_operations/add_campaigns.rb +0 -143
- data/examples/v201409/basic_operations/add_keywords.rb +0 -118
- data/examples/v201409/basic_operations/add_text_ads.rb +0 -113
- data/examples/v201409/basic_operations/get_ad_groups.rb +0 -106
- data/examples/v201409/basic_operations/get_campaigns.rb +0 -101
- data/examples/v201409/basic_operations/get_campaigns_with_awql.rb +0 -93
- data/examples/v201409/basic_operations/get_keywords.rb +0 -112
- data/examples/v201409/basic_operations/get_text_ads.rb +0 -114
- data/examples/v201409/basic_operations/pause_ad.rb +0 -92
- data/examples/v201409/basic_operations/remove_ad.rb +0 -93
- data/examples/v201409/basic_operations/remove_ad_group.rb +0 -89
- data/examples/v201409/basic_operations/remove_campaign.rb +0 -91
- data/examples/v201409/basic_operations/remove_keyword.rb +0 -98
- data/examples/v201409/basic_operations/update_ad_group.rb +0 -89
- data/examples/v201409/basic_operations/update_campaign.rb +0 -90
- data/examples/v201409/basic_operations/update_keyword.rb +0 -110
- data/examples/v201409/campaign_management/add_campaign_labels.rb +0 -86
- data/examples/v201409/campaign_management/add_experiment.rb +0 -166
- data/examples/v201409/campaign_management/add_keywords_in_bulk.rb +0 -158
- data/examples/v201409/campaign_management/add_location_extension.rb +0 -125
- data/examples/v201409/campaign_management/get_all_disapproved_ads.rb +0 -101
- data/examples/v201409/campaign_management/get_all_disapproved_ads_with_awql.rb +0 -93
- data/examples/v201409/campaign_management/get_campaigns_by_label.rb +0 -112
- data/examples/v201409/campaign_management/promote_experiment.rb +0 -85
- data/examples/v201409/campaign_management/set_ad_parameters.rb +0 -122
- data/examples/v201409/campaign_management/set_criterion_bid_modifier.rb +0 -108
- data/examples/v201409/campaign_management/validate_text_ad.rb +0 -114
- data/examples/v201409/error_handling/handle_partial_failures.rb +0 -134
- data/examples/v201409/error_handling/handle_policy_violation_error.rb +0 -145
- data/examples/v201409/extensions/add_google_my_business_location_extensions.rb +0 -183
- data/examples/v201409/extensions/add_site_links.rb +0 -167
- data/examples/v201409/extensions/add_site_links_using_feeds.rb +0 -306
- data/examples/v201409/migration/migrate_to_extension_settings.rb +0 -392
- data/examples/v201409/migration/upgrade_ad_url.rb +0 -97
- data/examples/v201409/misc/create_ad_words_session_without_properties_file.rb +0 -94
- data/examples/v201409/misc/get_all_images_and_videos.rb +0 -108
- data/examples/v201409/misc/setup_oauth2.rb +0 -88
- data/examples/v201409/misc/upload_image.rb +0 -97
- data/examples/v201409/misc/use_oauth2_jwt.rb +0 -97
- data/examples/v201409/optimization/estimate_keyword_traffic.rb +0 -155
- data/examples/v201409/optimization/get_keyword_bid_simulations.rb +0 -100
- data/examples/v201409/optimization/get_keyword_ideas.rb +0 -130
- data/examples/v201409/remarketing/add_audience.rb +0 -122
- data/examples/v201409/remarketing/add_conversion_tracker.rb +0 -105
- data/examples/v201409/remarketing/add_rule_based_user_lists.rb +0 -171
- data/examples/v201409/reporting/download_criteria_report.rb +0 -87
- data/examples/v201409/reporting/download_criteria_report_with_awql.rb +0 -86
- data/examples/v201409/reporting/get_report_fields.rb +0 -79
- data/examples/v201409/reporting/parallel_report_download.rb +0 -171
- data/examples/v201409/shopping_campaigns/add_product_partition_tree.rb +0 -269
- data/examples/v201409/shopping_campaigns/add_product_scope.rb +0 -133
- data/examples/v201409/shopping_campaigns/add_shopping_campaign.rb +0 -131
- data/examples/v201409/shopping_campaigns/get_product_category_taxonomy.rb +0 -117
- data/examples/v201409/targeting/add_campaign_targeting_criteria.rb +0 -173
- data/examples/v201409/targeting/add_demographic_targeting_criteria.rb +0 -116
- data/examples/v201409/targeting/get_campaign_targeting_criteria.rb +0 -110
- data/examples/v201409/targeting/get_targetable_languages_and_carriers.rb +0 -94
- data/examples/v201409/targeting/lookup_location.rb +0 -112
- data/lib/adwords_api/v201409/ad_customizer_feed_service.rb +0 -38
- data/lib/adwords_api/v201409/ad_customizer_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/ad_group_ad_service.rb +0 -50
- data/lib/adwords_api/v201409/ad_group_ad_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/ad_group_bid_modifier_service.rb +0 -42
- data/lib/adwords_api/v201409/ad_group_bid_modifier_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/ad_group_criterion_service.rb +0 -46
- data/lib/adwords_api/v201409/ad_group_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/ad_group_extension_setting_service.rb +0 -42
- data/lib/adwords_api/v201409/ad_group_extension_setting_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/ad_group_feed_service.rb +0 -42
- data/lib/adwords_api/v201409/ad_group_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/ad_group_service.rb +0 -46
- data/lib/adwords_api/v201409/ad_group_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/ad_param_service.rb +0 -38
- data/lib/adwords_api/v201409/ad_param_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/adwords_user_list_service.rb +0 -38
- data/lib/adwords_api/v201409/adwords_user_list_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/bidding_strategy_service.rb +0 -42
- data/lib/adwords_api/v201409/bidding_strategy_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/budget_order_service.rb +0 -42
- data/lib/adwords_api/v201409/budget_order_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/budget_service.rb +0 -42
- data/lib/adwords_api/v201409/budget_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/campaign_ad_extension_service.rb +0 -38
- data/lib/adwords_api/v201409/campaign_ad_extension_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/campaign_criterion_service.rb +0 -42
- data/lib/adwords_api/v201409/campaign_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/campaign_extension_setting_service.rb +0 -42
- data/lib/adwords_api/v201409/campaign_extension_setting_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/campaign_feed_service.rb +0 -42
- data/lib/adwords_api/v201409/campaign_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/campaign_service.rb +0 -46
- data/lib/adwords_api/v201409/campaign_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/campaign_shared_set_service.rb +0 -38
- data/lib/adwords_api/v201409/campaign_shared_set_service_registry.rb +0 -47
- data/lib/adwords_api/v201409/constant_data_service.rb +0 -66
- data/lib/adwords_api/v201409/constant_data_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/conversion_tracker_service.rb +0 -38
- data/lib/adwords_api/v201409/conversion_tracker_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/customer_extension_setting_service.rb +0 -42
- data/lib/adwords_api/v201409/customer_extension_setting_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/customer_feed_service.rb +0 -42
- data/lib/adwords_api/v201409/customer_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/customer_service.rb +0 -38
- data/lib/adwords_api/v201409/customer_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/customer_sync_service.rb +0 -34
- data/lib/adwords_api/v201409/customer_sync_service_registry.rb +0 -47
- data/lib/adwords_api/v201409/data_service.rb +0 -54
- data/lib/adwords_api/v201409/data_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/experiment_service.rb +0 -38
- data/lib/adwords_api/v201409/experiment_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/feed_item_service.rb +0 -42
- data/lib/adwords_api/v201409/feed_item_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/feed_mapping_service.rb +0 -42
- data/lib/adwords_api/v201409/feed_mapping_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/feed_service.rb +0 -42
- data/lib/adwords_api/v201409/feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/geo_location_service.rb +0 -34
- data/lib/adwords_api/v201409/geo_location_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/label_service.rb +0 -42
- data/lib/adwords_api/v201409/label_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/location_criterion_service.rb +0 -38
- data/lib/adwords_api/v201409/location_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/managed_customer_service.rb +0 -50
- data/lib/adwords_api/v201409/managed_customer_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/media_service.rb +0 -42
- data/lib/adwords_api/v201409/media_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/mutate_job_service.rb +0 -42
- data/lib/adwords_api/v201409/mutate_job_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/offline_conversion_feed_service.rb +0 -34
- data/lib/adwords_api/v201409/offline_conversion_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/report_definition_service.rb +0 -34
- data/lib/adwords_api/v201409/report_definition_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/shared_criterion_service.rb +0 -38
- data/lib/adwords_api/v201409/shared_criterion_service_registry.rb +0 -47
- data/lib/adwords_api/v201409/shared_set_service.rb +0 -38
- data/lib/adwords_api/v201409/shared_set_service_registry.rb +0 -47
- data/lib/adwords_api/v201409/targeting_idea_service.rb +0 -34
- data/lib/adwords_api/v201409/targeting_idea_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/traffic_estimator_service.rb +0 -34
- data/lib/adwords_api/v201409/traffic_estimator_service_registry.rb +0 -46
- data/test/templates/v201409/basic_operations_get_campaigns.def +0 -116
- data/test/templates/v201409/misc_use_oauth2_jwt.def +0 -131
@@ -1,105 +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 add an ad group level mobile bid modifier
|
22
|
-
# override for a campaign.
|
23
|
-
#
|
24
|
-
# Tags: AdGroupBidModifierService.mutate
|
25
|
-
|
26
|
-
require 'adwords_api'
|
27
|
-
|
28
|
-
def add_ad_group_bid_modifier(ad_group_id, bid_modifier)
|
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
|
-
# Mobile criterion ID.
|
40
|
-
criterion_id = 30001
|
41
|
-
|
42
|
-
# Prepare to add an ad group level override.
|
43
|
-
operation = {
|
44
|
-
# Use 'ADD' to add a new modifier and 'SET' to update an existing one. A
|
45
|
-
# modifier can be removed with the 'REMOVE' operator.
|
46
|
-
:operator => 'ADD',
|
47
|
-
:operand => {
|
48
|
-
:ad_group_id => ad_group_id,
|
49
|
-
:criterion => {
|
50
|
-
:xsi_type => 'Platform',
|
51
|
-
:id => criterion_id
|
52
|
-
},
|
53
|
-
:bid_modifier => bid_modifier
|
54
|
-
}
|
55
|
-
}
|
56
|
-
|
57
|
-
# Add ad group level mobile bid modifier.
|
58
|
-
response = bid_modifier_srv.mutate([operation])
|
59
|
-
if response and response[:value]
|
60
|
-
modifier = response[:value].first
|
61
|
-
value = modifier[:bid_modifier] || 'unset'
|
62
|
-
puts ('Campaign ID %d, AdGroup ID %d, Criterion ID %d was updated with ' +
|
63
|
-
'ad group level modifier: %s') %
|
64
|
-
[modifier[:campaign_id], modifier[:ad_group_id],
|
65
|
-
modifier[:criterion][:id], value]
|
66
|
-
else
|
67
|
-
puts 'No modifiers were added.'
|
68
|
-
end
|
69
|
-
end
|
70
|
-
|
71
|
-
if __FILE__ == $0
|
72
|
-
API_VERSION = :v201409
|
73
|
-
|
74
|
-
begin
|
75
|
-
# ID of an ad group to add an override for.
|
76
|
-
ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
|
77
|
-
# Bid modifier to override with.
|
78
|
-
bid_modifier = 1.5
|
79
|
-
|
80
|
-
add_ad_group_bid_modifier(ad_group_id, bid_modifier)
|
81
|
-
|
82
|
-
# Authorization error.
|
83
|
-
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
84
|
-
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
85
|
-
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
86
|
-
"to retrieve and store OAuth2 tokens."
|
87
|
-
puts "See this wiki page for more details:\n\n " +
|
88
|
-
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
89
|
-
|
90
|
-
# HTTP errors.
|
91
|
-
rescue AdsCommon::Errors::HttpError => e
|
92
|
-
puts "HTTP Error: %s" % e
|
93
|
-
|
94
|
-
# API errors.
|
95
|
-
rescue AdwordsApi::Errors::ApiException => e
|
96
|
-
puts "Message: %s" % e.message
|
97
|
-
puts 'Errors:'
|
98
|
-
e.errors.each_with_index do |error, index|
|
99
|
-
puts "\tError [%d]:" % (index + 1)
|
100
|
-
error.each do |field, value|
|
101
|
-
puts "\t\t%s: %s" % [field, value]
|
102
|
-
end
|
103
|
-
end
|
104
|
-
end
|
105
|
-
end
|
@@ -1,137 +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 creates a click-to-download ad, also known as an app
|
22
|
-
# promotion ad to a given ad group. To list ad groups, run get_ad_groups.rb.
|
23
|
-
#
|
24
|
-
# Tags: AdGroupAdService.mutate
|
25
|
-
|
26
|
-
require 'adwords_api'
|
27
|
-
|
28
|
-
def add_click_to_download_ad(ad_group_id)
|
29
|
-
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
30
|
-
# when called without parameters.
|
31
|
-
adwords = AdwordsApi::Api.new
|
32
|
-
|
33
|
-
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
34
|
-
# the configuration file or provide your own logger:
|
35
|
-
# adwords.logger = Logger.new('adwords_xml.log')
|
36
|
-
|
37
|
-
ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
|
38
|
-
|
39
|
-
# Create the template elements for the ad. You can refer to
|
40
|
-
# https://developers.google.com/adwords/api/docs/appendix/templateads
|
41
|
-
# for the list of available template fields.
|
42
|
-
ad_data = {
|
43
|
-
:unique_name => 'adData',
|
44
|
-
:fields => [
|
45
|
-
{
|
46
|
-
:name => 'headline',
|
47
|
-
:field_text => 'Enjoy your drive in Mars',
|
48
|
-
:type => 'TEXT'
|
49
|
-
},
|
50
|
-
{
|
51
|
-
:name => 'description1',
|
52
|
-
:field_text => 'Realistic physics simulation',
|
53
|
-
:type => 'TEXT'
|
54
|
-
},
|
55
|
-
{
|
56
|
-
:name => 'description2',
|
57
|
-
:field_text => 'Race against players online',
|
58
|
-
:type => 'TEXT'
|
59
|
-
},
|
60
|
-
{
|
61
|
-
:name => 'appId',
|
62
|
-
:field_text => 'com.example.demogame',
|
63
|
-
:type => 'TEXT'
|
64
|
-
},
|
65
|
-
{
|
66
|
-
:name => 'appStore',
|
67
|
-
:field_text => '2',
|
68
|
-
:type => 'ENUM'
|
69
|
-
}
|
70
|
-
]
|
71
|
-
}
|
72
|
-
|
73
|
-
# Create click to download ad.
|
74
|
-
click_to_download_app_ad = {
|
75
|
-
:xsi_type => 'TemplateAd',
|
76
|
-
:name => 'Ad for demo game',
|
77
|
-
:template_id => 353,
|
78
|
-
:final_urls =>
|
79
|
-
['http://play.google.com/store/apps/details?id=com.example.demogame'],
|
80
|
-
:display_url => 'play.google.com',
|
81
|
-
:template_elements => [ad_data]
|
82
|
-
}
|
83
|
-
|
84
|
-
# Create ad group ad.
|
85
|
-
ad_group_ad = {
|
86
|
-
:ad_group_id => ad_group_id,
|
87
|
-
:ad => click_to_download_app_ad,
|
88
|
-
# Optional.
|
89
|
-
:status => 'PAUSED'
|
90
|
-
}
|
91
|
-
|
92
|
-
# Add ad.
|
93
|
-
response = ad_group_ad_srv.mutate([
|
94
|
-
{:operator => 'ADD', :operand => ad_group_ad}
|
95
|
-
])
|
96
|
-
if response and response[:value]
|
97
|
-
response[:value].each do |ad|
|
98
|
-
puts "Added new click-to-download ad to ad group ID %d with url '%s'." %
|
99
|
-
[ad[:ad][:id], ad[:ad][:final_urls[0]]]
|
100
|
-
end
|
101
|
-
else
|
102
|
-
raise StandardError, 'No ads were added.'
|
103
|
-
end
|
104
|
-
end
|
105
|
-
|
106
|
-
if __FILE__ == $0
|
107
|
-
API_VERSION = :v201409
|
108
|
-
|
109
|
-
begin
|
110
|
-
# Ad group ID to add text ads to.
|
111
|
-
ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
|
112
|
-
add_click_to_download_ad(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,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 code example adds a text ad that uses advanced features of upgraded
|
22
|
-
# URLs.
|
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 = :v201409
|
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 = :v201409
|
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
|