google-adwords-api 0.9.3 → 0.10.0
Sign up to get free protection for your applications and to get access to all the features.
- data/ChangeLog +4 -0
- data/README +4 -4
- data/examples/{v201209 → v201309}/account_management/create_account.rb +9 -1
- data/examples/{v201209 → v201309}/account_management/get_account_alerts.rb +9 -1
- data/examples/{v201209 → v201309}/account_management/get_account_changes.rb +9 -1
- data/examples/{v201209 → v201309}/account_management/get_account_hierarchy.rb +9 -1
- data/examples/v201309/advanced_operations/add_ad_group_bid_modifier.rb +105 -0
- data/examples/v201309/advanced_operations/add_click_to_download_ad.rb +137 -0
- data/examples/v201309/advanced_operations/add_site_links.rb +244 -0
- data/examples/v201309/advanced_operations/create_and_attach_shared_keyword_set.rb +147 -0
- data/examples/v201309/advanced_operations/find_and_remove_criteria_from_shared_set.rb +181 -0
- data/examples/{v201209/adwords_for_video/get_video_campaign_criteria.rb → v201309/advanced_operations/get_ad_group_bid_modifiers.rb} +30 -23
- data/examples/v201309/advanced_operations/upload_offline_conversions.rb +117 -0
- data/examples/v201309/advanced_operations/use_shared_bidding_strategy.rb +163 -0
- data/examples/{v201209 → v201309}/basic_operations/add_ad_groups.rb +28 -21
- data/examples/{v201209 → v201309}/basic_operations/add_campaigns.rb +18 -15
- data/examples/{v201209 → v201309}/basic_operations/add_keywords.rb +9 -1
- data/examples/{v201209 → v201309}/basic_operations/add_text_ads.rb +9 -1
- data/examples/{v201209 → v201309}/basic_operations/delete_ad.rb +9 -1
- data/examples/{v201209 → v201309}/basic_operations/delete_ad_group.rb +9 -1
- data/examples/{v201209 → v201309}/basic_operations/delete_campaign.rb +9 -1
- data/examples/{v201209 → v201309}/basic_operations/delete_keyword.rb +9 -1
- data/examples/{v201209 → v201309}/basic_operations/get_ad_groups.rb +9 -1
- data/examples/{v201209 → v201309}/basic_operations/get_campaigns.rb +9 -1
- data/examples/{v201209 → v201309}/basic_operations/get_campaigns_with_awql.rb +9 -1
- data/examples/{v201209 → v201309}/basic_operations/get_keywords.rb +9 -1
- data/examples/{v201209 → v201309}/basic_operations/get_text_ads.rb +9 -1
- data/examples/{v201209 → v201309}/basic_operations/pause_ad.rb +9 -1
- data/examples/{v201209 → v201309}/basic_operations/update_ad_group.rb +9 -1
- data/examples/{v201209 → v201309}/basic_operations/update_campaign.rb +9 -1
- data/examples/{v201209 → v201309}/basic_operations/update_keyword.rb +21 -10
- data/examples/{v201209 → v201309}/campaign_management/add_experiment.rb +9 -1
- data/examples/{v201209 → v201309}/campaign_management/add_keywords_in_bulk.rb +10 -2
- data/examples/{v201209 → v201309}/campaign_management/add_location_extension.rb +9 -1
- data/examples/{v201209 → v201309}/campaign_management/add_location_extension_override.rb +9 -1
- data/examples/{v201209 → v201309}/campaign_management/get_all_disapproved_ads.rb +21 -13
- data/examples/{v201209 → v201309}/campaign_management/get_all_disapproved_ads_with_awql.rb +17 -8
- data/examples/{v201209 → v201309}/campaign_management/promote_experiment.rb +9 -1
- data/examples/{v201209 → v201309}/campaign_management/set_ad_parameters.rb +9 -1
- data/examples/{v201209 → v201309}/campaign_management/set_criterion_bid_modifier.rb +11 -5
- data/examples/{v201209 → v201309}/campaign_management/validate_text_ad.rb +9 -1
- data/examples/{v201209 → v201309}/error_handling/handle_captcha_challenge.rb +1 -1
- data/examples/{v201209 → v201309}/error_handling/handle_partial_failures.rb +9 -1
- data/examples/{v201209 → v201309}/error_handling/handle_policy_violation_error.rb +9 -1
- data/examples/{v201209 → v201309}/error_handling/handle_two_factor_authorization_error.rb +1 -1
- data/examples/{v201209 → v201309}/misc/get_all_images_and_videos.rb +9 -1
- data/examples/{v201209/misc/use_oauth2.rb → v201309/misc/setup_oauth2.rb} +17 -26
- data/examples/{v201209 → v201309}/misc/upload_image.rb +9 -1
- data/examples/{v201209 → v201309}/misc/use_oauth2_jwt.rb +1 -1
- data/examples/{v201209 → v201309}/optimization/estimate_keyword_traffic.rb +9 -1
- data/examples/{v201209 → v201309}/optimization/get_keyword_bid_simulations.rb +9 -1
- data/examples/{v201209 → v201309}/optimization/get_keyword_ideas.rb +17 -1
- data/examples/{v201209 → v201309}/optimization/get_placement_ideas.rb +9 -1
- data/examples/{v201209 → v201309}/remarketing/add_audience.rb +11 -3
- data/examples/{v201209 → v201309}/remarketing/add_conversion_tracker.rb +9 -2
- data/examples/{v201209 → v201309}/reporting/download_criteria_report.rb +9 -1
- data/examples/{v201209 → v201309}/reporting/download_criteria_report_with_awql.rb +9 -1
- data/examples/{v201209 → v201309}/reporting/get_campaign_stats.rb +9 -1
- data/examples/{v201209 → v201309}/reporting/get_report_fields.rb +9 -1
- data/examples/{v201209 → v201309}/reporting/parallel_report_download.rb +9 -1
- data/examples/{v201209 → v201309}/targeting/add_campaign_targeting_criteria.rb +10 -5
- data/examples/{v201209 → v201309}/targeting/add_demographic_targeting_criteria.rb +9 -1
- data/examples/{v201209 → v201309}/targeting/get_campaign_targeting_criteria.rb +9 -1
- data/examples/{v201209 → v201309}/targeting/get_targetable_languages_and_carriers.rb +9 -1
- data/examples/{v201209 → v201309}/targeting/lookup_location.rb +9 -1
- data/lib/adwords_api/api_config.rb +57 -55
- data/lib/adwords_api/{v201209 → v201309}/ad_group_ad_service.rb +7 -7
- data/lib/adwords_api/v201309/ad_group_ad_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209 → v201309}/ad_group_bid_modifier_service.rb +6 -6
- data/lib/adwords_api/v201309/ad_group_bid_modifier_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209 → v201309}/ad_group_criterion_service.rb +7 -7
- data/lib/adwords_api/v201309/ad_group_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201309/ad_group_feed_service.rb +38 -0
- data/lib/adwords_api/v201309/ad_group_feed_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209 → v201309}/ad_group_service.rb +7 -7
- data/lib/adwords_api/v201309/ad_group_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209 → v201309}/ad_param_service.rb +7 -7
- data/lib/adwords_api/v201309/ad_param_service_registry.rb +46 -0
- data/lib/adwords_api/v201309/adwords_user_list_service.rb +38 -0
- data/lib/adwords_api/v201309/adwords_user_list_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209 → v201309}/alert_service.rb +7 -7
- data/lib/adwords_api/v201309/alert_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209/managed_customer_service.rb → v201309/bidding_strategy_service.rb} +9 -9
- data/lib/adwords_api/v201309/bidding_strategy_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209 → v201309}/budget_order_service.rb +7 -7
- data/lib/adwords_api/v201309/budget_order_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209 → v201309}/budget_service.rb +7 -7
- data/lib/adwords_api/v201309/budget_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209 → v201309}/campaign_ad_extension_service.rb +7 -7
- data/lib/adwords_api/v201309/campaign_ad_extension_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209 → v201309}/campaign_criterion_service.rb +7 -7
- data/lib/adwords_api/v201309/campaign_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201309/campaign_feed_service.rb +38 -0
- data/lib/adwords_api/v201309/campaign_feed_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209 → v201309}/campaign_service.rb +7 -7
- data/lib/adwords_api/v201309/campaign_service_registry.rb +46 -0
- data/lib/adwords_api/v201309/campaign_shared_set_service.rb +38 -0
- data/lib/adwords_api/v201309/campaign_shared_set_service_registry.rb +47 -0
- data/lib/adwords_api/{v201209 → v201309}/constant_data_service.rb +7 -7
- data/lib/adwords_api/v201309/constant_data_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209 → v201309}/conversion_tracker_service.rb +7 -7
- data/lib/adwords_api/v201309/conversion_tracker_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209 → v201309}/customer_service.rb +7 -7
- data/lib/adwords_api/v201309/customer_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209 → v201309}/customer_sync_service.rb +7 -7
- data/lib/adwords_api/v201309/customer_sync_service_registry.rb +47 -0
- data/lib/adwords_api/{v201209 → v201309}/data_service.rb +7 -7
- data/lib/adwords_api/v201309/data_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209 → v201309}/experiment_service.rb +7 -7
- data/lib/adwords_api/v201309/experiment_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209/user_list_service.rb → v201309/feed_item_service.rb} +9 -9
- data/lib/adwords_api/v201309/feed_item_service_registry.rb +46 -0
- data/lib/adwords_api/v201309/feed_mapping_service.rb +38 -0
- data/lib/adwords_api/v201309/feed_mapping_service_registry.rb +46 -0
- data/lib/adwords_api/v201309/feed_service.rb +38 -0
- data/lib/adwords_api/v201309/feed_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209 → v201309}/geo_location_service.rb +7 -7
- data/lib/adwords_api/v201309/geo_location_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209 → v201309}/location_criterion_service.rb +7 -7
- data/lib/adwords_api/v201309/location_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201309/managed_customer_service.rb +50 -0
- data/lib/adwords_api/v201309/managed_customer_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209 → v201309}/media_service.rb +7 -7
- data/lib/adwords_api/v201309/media_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209 → v201309}/mutate_job_service.rb +7 -7
- data/lib/adwords_api/v201309/mutate_job_service_registry.rb +46 -0
- data/lib/adwords_api/v201309/offline_conversion_feed_service.rb +34 -0
- data/lib/adwords_api/v201309/offline_conversion_feed_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209 → v201309}/report_definition_service.rb +7 -7
- data/lib/adwords_api/v201309/report_definition_service_registry.rb +46 -0
- data/lib/adwords_api/v201309/shared_criterion_service.rb +38 -0
- data/lib/adwords_api/v201309/shared_criterion_service_registry.rb +47 -0
- data/lib/adwords_api/v201309/shared_set_service.rb +38 -0
- data/lib/adwords_api/v201309/shared_set_service_registry.rb +47 -0
- data/lib/adwords_api/{v201209 → v201309}/targeting_idea_service.rb +7 -7
- data/lib/adwords_api/v201309/targeting_idea_service_registry.rb +46 -0
- data/lib/adwords_api/{v201209 → v201309}/traffic_estimator_service.rb +7 -7
- data/lib/adwords_api/{v201209 → v201309}/traffic_estimator_service_registry.rb +5 -5
- data/lib/adwords_api/version.rb +1 -1
- data/test/adwords_api/test_adwords_api.rb +1 -1
- data/test/adwords_api/test_api_config.rb +8 -8
- data/test/adwords_api/test_report_utils.rb +1 -1
- data/test/bugs/test_issue_00000031.rb +2 -2
- data/test/bugs/test_issue_00000063.rb +6 -6
- data/test/templates/v201302/basic_operations_get_campaigns.def +1 -1
- data/test/templates/v201302/misc_use_oauth2_jwt.def +1 -1
- data/test/templates/v201306/basic_operations_get_campaigns.def +1 -1
- data/test/templates/v201306/misc_use_oauth2_jwt.def +1 -1
- data/test/templates/{v201209 → v201309}/basic_operations_get_campaigns.def +7 -7
- data/test/templates/v201309/misc_use_oauth2_jwt.def +131 -0
- metadata +416 -430
- data/examples/v201209/account_management/get_client_customer_id.rb +0 -88
- data/examples/v201209/account_management/get_client_unit_usage.rb +0 -90
- data/examples/v201209/adwords_for_video/add_video_campaign.rb +0 -103
- data/examples/v201209/adwords_for_video/find_videos.rb +0 -92
- data/examples/v201209/adwords_for_video/get_keyword_criteria.rb +0 -101
- data/examples/v201209/adwords_for_video/get_targeting_groups.rb +0 -93
- data/examples/v201209/adwords_for_video/get_video_campaign_stats.rb +0 -126
- data/examples/v201209/adwords_for_video/get_video_campaigns.rb +0 -94
- data/examples/v201209/campaign_management/set_campaign_enhanced.rb +0 -89
- data/lib/adwords_api/v201209/ad_extension_override_service.rb +0 -38
- data/lib/adwords_api/v201209/ad_extension_override_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/ad_group_ad_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/ad_group_bid_modifier_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/ad_group_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/ad_group_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/ad_param_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/alert_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/budget_order_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/budget_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/campaign_ad_extension_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/campaign_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/campaign_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/constant_data_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/conversion_tracker_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/customer_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/customer_sync_service_registry.rb +0 -47
- data/lib/adwords_api/v201209/data_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/experiment_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/geo_location_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/info_service.rb +0 -34
- data/lib/adwords_api/v201209/info_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/location_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/managed_customer_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/media_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/mutate_job_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/report_definition_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/targeting_idea_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/user_list_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/video_ad_service.rb +0 -38
- data/lib/adwords_api/v201209/video_ad_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/video_campaign_criterion_service.rb +0 -38
- data/lib/adwords_api/v201209/video_campaign_criterion_service_registry.rb +0 -47
- data/lib/adwords_api/v201209/video_campaign_service.rb +0 -38
- data/lib/adwords_api/v201209/video_campaign_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/video_service.rb +0 -42
- data/lib/adwords_api/v201209/video_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/video_targeting_group_criterion_service.rb +0 -38
- data/lib/adwords_api/v201209/video_targeting_group_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201209/video_targeting_group_service.rb +0 -38
- data/lib/adwords_api/v201209/video_targeting_group_service_registry.rb +0 -46
- data/test/examples/v201209/test_account_management.rb +0 -60
- data/test/examples/v201209/test_basic_operations.rb +0 -177
- data/test/examples/v201209/test_campaign_management.rb +0 -124
- data/test/examples/v201209/test_error_handling.rb +0 -63
- data/test/examples/v201209/test_misc.rb +0 -39
- data/test/examples/v201209/test_optimization.rb +0 -63
- data/test/examples/v201209/test_remarketing.rb +0 -39
- data/test/examples/v201209/test_reporting.rb +0 -84
- data/test/examples/v201209/test_targeting.rb +0 -60
- data/test/examples/v201209/utils.rb +0 -261
- data/test/suite_exampletests_v201209.rb +0 -37
- data/test/suite_exampletests_v201306.rb +0 -37
@@ -0,0 +1,147 @@
|
|
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 creates a shared list of negative broad match keywords, it then
|
22
|
+
# attaches them to a campaign.
|
23
|
+
#
|
24
|
+
# Note: Shared sets is a Beta feature.
|
25
|
+
#
|
26
|
+
# Tags: SharedSetService.mutate, CampaignSharedSetService.mutate
|
27
|
+
|
28
|
+
require 'adwords_api'
|
29
|
+
require 'date'
|
30
|
+
|
31
|
+
def create_and_attach_shared_keyword_set(campaign_id)
|
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
|
+
shared_set_srv = adwords.service(:SharedSetService, API_VERSION)
|
41
|
+
shared_criterion_srv = adwords.service(:SharedCriterionService, API_VERSION)
|
42
|
+
campaign_shared_set_srv =
|
43
|
+
adwords.service(:CampaignSharedSetService, API_VERSION)
|
44
|
+
|
45
|
+
# Keywords to create a shared set of.
|
46
|
+
keywords = ['mars cruise', 'mars hotels']
|
47
|
+
|
48
|
+
# Create shared negative keyword set.
|
49
|
+
shared_set = {
|
50
|
+
:name => 'API Negative keyword list - %d' % (Time.new.to_f * 1000).to_i,
|
51
|
+
:type => 'NEGATIVE_KEYWORDS'
|
52
|
+
}
|
53
|
+
|
54
|
+
# Add shared set.
|
55
|
+
response = shared_set_srv.mutate([
|
56
|
+
{:operator => 'ADD', :operand => shared_set}
|
57
|
+
])
|
58
|
+
|
59
|
+
if response and response[:value]
|
60
|
+
shared_set = response[:value].first
|
61
|
+
shared_set_id = shared_set[:shared_set_id]
|
62
|
+
puts "Shared set with ID %d and name '%s' was successfully added." %
|
63
|
+
[shared_set_id, shared_set[:name]]
|
64
|
+
else
|
65
|
+
raise StandardError, 'No shared set was added'
|
66
|
+
end
|
67
|
+
|
68
|
+
# Add negative keywords to shared set.
|
69
|
+
shared_criteria = keywords.map do |keyword|
|
70
|
+
{
|
71
|
+
:criterion => {
|
72
|
+
:xsi_type => 'Keyword',
|
73
|
+
:text => keyword,
|
74
|
+
:match_type => 'BROAD'
|
75
|
+
},
|
76
|
+
:negative => true,
|
77
|
+
:shared_set_id => shared_set_id
|
78
|
+
}
|
79
|
+
end
|
80
|
+
|
81
|
+
operations = shared_criteria.map do |criterion|
|
82
|
+
{:operator => 'ADD', :operand => criterion}
|
83
|
+
end
|
84
|
+
|
85
|
+
response = shared_criterion_srv.mutate(operations)
|
86
|
+
if response and response[:value]
|
87
|
+
response[:value].each do |shared_criterion|
|
88
|
+
puts "Added shared criterion ID %d '%s' to shared set with ID %d." %
|
89
|
+
[shared_criterion[:criterion][:id],
|
90
|
+
shared_criterion[:criterion][:text],
|
91
|
+
shared_criterion[:shared_set_id]]
|
92
|
+
end
|
93
|
+
else
|
94
|
+
raise StandardError, 'No shared keyword was added'
|
95
|
+
end
|
96
|
+
|
97
|
+
# Attach the articles to the campaign.
|
98
|
+
campaign_set = {
|
99
|
+
:campaign_id => campaign_id,
|
100
|
+
:shared_set_id => shared_set_id
|
101
|
+
}
|
102
|
+
|
103
|
+
response = campaign_shared_set_srv.mutate([
|
104
|
+
{:operator => 'ADD', :operand => campaign_set}
|
105
|
+
])
|
106
|
+
if response and response[:value]
|
107
|
+
campaign_shared_set = response[:value].first
|
108
|
+
puts 'Shared set ID %d was attached to campaign ID %d' %
|
109
|
+
[campaign_shared_set[:shared_set_id], campaign_shared_set[:campaign_id]]
|
110
|
+
else
|
111
|
+
raise StandardError, 'No campaign shared set was added'
|
112
|
+
end
|
113
|
+
end
|
114
|
+
|
115
|
+
if __FILE__ == $0
|
116
|
+
API_VERSION = :v201309
|
117
|
+
|
118
|
+
begin
|
119
|
+
# Campaign ID to attach shared keyword set to.
|
120
|
+
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
|
121
|
+
|
122
|
+
create_and_attach_shared_keyword_set(campaign_id)
|
123
|
+
|
124
|
+
# Authorization error.
|
125
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
126
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
127
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
128
|
+
"to retrieve and store OAuth2 tokens."
|
129
|
+
puts "See this wiki page for more details:\n\n " +
|
130
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
131
|
+
|
132
|
+
# HTTP errors.
|
133
|
+
rescue AdsCommon::Errors::HttpError => e
|
134
|
+
puts "HTTP Error: %s" % e
|
135
|
+
|
136
|
+
# API errors.
|
137
|
+
rescue AdwordsApi::Errors::ApiException => e
|
138
|
+
puts "Message: %s" % e.message
|
139
|
+
puts 'Errors:'
|
140
|
+
e.errors.each_with_index do |error, index|
|
141
|
+
puts "\tError [%d]:" % (index + 1)
|
142
|
+
error.each do |field, value|
|
143
|
+
puts "\t\t%s: %s" % [field, value]
|
144
|
+
end
|
145
|
+
end
|
146
|
+
end
|
147
|
+
end
|
@@ -0,0 +1,181 @@
|
|
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 demonstrates how to find shared sets, shared set criterions and
|
22
|
+
# how to remove them.
|
23
|
+
#
|
24
|
+
# Note: Shared sets is a Beta feature.
|
25
|
+
#
|
26
|
+
# Tags: CampaignSharedSetService.get
|
27
|
+
# Tags: SharedCriterionService.get, SharedCriterionService.mutate
|
28
|
+
|
29
|
+
require 'adwords_api'
|
30
|
+
|
31
|
+
def find_and_remove_criteria_from_shared_set(campaign_id)
|
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
|
+
campaign_shared_set_srv =
|
41
|
+
adwords.service(:CampaignSharedSetService, API_VERSION)
|
42
|
+
shared_criterion_srv = adwords.service(:SharedCriterionService, API_VERSION)
|
43
|
+
|
44
|
+
shared_set_ids = []
|
45
|
+
criterion_ids = []
|
46
|
+
|
47
|
+
# First, retrieve all shared sets associated with the campaign.
|
48
|
+
|
49
|
+
# Create selector for shared sets to:
|
50
|
+
# - filter by campaign ID,
|
51
|
+
# - filter by shared set type.
|
52
|
+
selector = {
|
53
|
+
:fields => ['SharedSetId', 'CampaignId', 'SharedSetName', 'SharedSetType',
|
54
|
+
'Status'],
|
55
|
+
:predicates => [
|
56
|
+
{:field => 'CampaignId', :operator => 'EQUALS', :values => [campaign_id]},
|
57
|
+
{:field => 'SharedSetType', :operator => 'IN', :values =>
|
58
|
+
['NEGATIVE_KEYWORDS', 'NEGATIVE_PLACEMENTS']}
|
59
|
+
],
|
60
|
+
:paging => {
|
61
|
+
:start_index => 0,
|
62
|
+
:number_results => PAGE_SIZE
|
63
|
+
}
|
64
|
+
}
|
65
|
+
|
66
|
+
# Set initial values.
|
67
|
+
offset, page = 0, {}
|
68
|
+
|
69
|
+
begin
|
70
|
+
page = campaign_shared_set_srv.get(selector)
|
71
|
+
if page[:entries]
|
72
|
+
page[:entries].each do |shared_set|
|
73
|
+
puts "Campaign shared set ID %d and name '%s'" %
|
74
|
+
[shared_set[:shared_set_id], shared_set[:shared_set_name]]
|
75
|
+
shared_set_ids << shared_set[:shared_set_id]
|
76
|
+
end
|
77
|
+
# Increment values to request the next page.
|
78
|
+
offset += PAGE_SIZE
|
79
|
+
selector[:paging][:start_index] = offset
|
80
|
+
end
|
81
|
+
end while page[:total_num_entries] > offset
|
82
|
+
|
83
|
+
# Next, Retrieve criterion IDs for all found shared sets.
|
84
|
+
selector = {
|
85
|
+
:fields => ['SharedSetId', 'Id', 'KeywordText', 'KeywordMatchType',
|
86
|
+
'PlacementUrl'],
|
87
|
+
:predicates => [
|
88
|
+
{:field => 'SharedSetId', :operator => 'IN', :values => shared_set_ids}
|
89
|
+
],
|
90
|
+
:paging => {
|
91
|
+
:start_index => 0,
|
92
|
+
:number_results => PAGE_SIZE
|
93
|
+
}
|
94
|
+
}
|
95
|
+
|
96
|
+
# Set initial values.
|
97
|
+
offset, page = 0, {}
|
98
|
+
|
99
|
+
begin
|
100
|
+
page = shared_criterion_srv.get(selector)
|
101
|
+
if page[:entries]
|
102
|
+
page[:entries].each do |shared_criterion|
|
103
|
+
if shared_criterion[:criterion][:type] == 'KEYWORD'
|
104
|
+
puts "Shared negative keyword with ID %d and text '%s' was found." %
|
105
|
+
[shared_criterion[:criterion][:id],
|
106
|
+
shared_criterion[:criterion][:text]]
|
107
|
+
elsif shared_criterion[:criterion][:type] == 'PLACEMENT'
|
108
|
+
puts "Shared negative placement with ID %d and url '%s' was found." %
|
109
|
+
[shared_criterion[:criterion][:id],
|
110
|
+
shared_criterion[:criterion][:url]]
|
111
|
+
else
|
112
|
+
puts 'Shared criterion with ID %d was found.' %
|
113
|
+
[shared_criterion[:criterion][:id]]
|
114
|
+
end
|
115
|
+
criterion_ids << {
|
116
|
+
:shared_set_id => shared_criterion[:shared_set_id],
|
117
|
+
:criterion_id => shared_criterion[:criterion][:id]
|
118
|
+
}
|
119
|
+
end
|
120
|
+
# Increment values to request the next page.
|
121
|
+
offset += PAGE_SIZE
|
122
|
+
selector[:paging][:start_index] = offset
|
123
|
+
end
|
124
|
+
end while page[:total_num_entries] > offset
|
125
|
+
|
126
|
+
# Finally, remove the criteria.
|
127
|
+
operations = criterion_ids.map do |criterion|
|
128
|
+
{
|
129
|
+
:operator => 'REMOVE',
|
130
|
+
:operand => {
|
131
|
+
:criterion => {:id => criterion[:criterion_id]},
|
132
|
+
:shared_set_id => criterion[:shared_set_id]
|
133
|
+
}
|
134
|
+
}
|
135
|
+
end
|
136
|
+
|
137
|
+
response = shared_criterion_srv.mutate(operations)
|
138
|
+
if response and response[:value]
|
139
|
+
response[:value].each do |criterion|
|
140
|
+
puts "Criterion ID %d was successfully removed from shared set ID %d." %
|
141
|
+
[criterion[:criterion][:id], criterion[:shared_set_id]]
|
142
|
+
end
|
143
|
+
else
|
144
|
+
puts 'No shared criteria were removed.'
|
145
|
+
end
|
146
|
+
end
|
147
|
+
|
148
|
+
if __FILE__ == $0
|
149
|
+
API_VERSION = :v201309
|
150
|
+
PAGE_SIZE = 500
|
151
|
+
|
152
|
+
begin
|
153
|
+
# ID of a campaign to remove shared criteria from.
|
154
|
+
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
|
155
|
+
|
156
|
+
find_and_remove_criteria_from_shared_set(campaign_id)
|
157
|
+
|
158
|
+
# Authorization error.
|
159
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
160
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
161
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
162
|
+
"to retrieve and store OAuth2 tokens."
|
163
|
+
puts "See this wiki page for more details:\n\n " +
|
164
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
165
|
+
|
166
|
+
# HTTP errors.
|
167
|
+
rescue AdsCommon::Errors::HttpError => e
|
168
|
+
puts "HTTP Error: %s" % e
|
169
|
+
|
170
|
+
# API errors.
|
171
|
+
rescue AdwordsApi::Errors::ApiException => e
|
172
|
+
puts "Message: %s" % e.message
|
173
|
+
puts 'Errors:'
|
174
|
+
e.errors.each_with_index do |error, index|
|
175
|
+
puts "\tError [%d]:" % (index + 1)
|
176
|
+
error.each do |field, value|
|
177
|
+
puts "\t\t%s: %s" % [field, value]
|
178
|
+
end
|
179
|
+
end
|
180
|
+
end
|
181
|
+
end
|
@@ -18,15 +18,14 @@
|
|
18
18
|
# See the License for the specific language governing permissions and
|
19
19
|
# limitations under the License.
|
20
20
|
#
|
21
|
-
# This example
|
21
|
+
# This example illustrates how to retrieve ad group level bid modifiers for a
|
22
|
+
# campaign.
|
22
23
|
#
|
23
|
-
#
|
24
|
-
#
|
25
|
-
# Tags: VideoCampaignCriterionService.get
|
24
|
+
# Tags: AdGroupBidModifierService.get
|
26
25
|
|
27
26
|
require 'adwords_api'
|
28
27
|
|
29
|
-
def
|
28
|
+
def get_ad_group_bid_modifiers(campaign_id)
|
30
29
|
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
31
30
|
# when called without parameters.
|
32
31
|
adwords = AdwordsApi::Api.new
|
@@ -35,12 +34,14 @@ def get_video_campaign_criteria(campaign_id)
|
|
35
34
|
# the configuration file or provide your own logger:
|
36
35
|
# adwords.logger = Logger.new('adwords_xml.log')
|
37
36
|
|
38
|
-
|
39
|
-
adwords.service(:VideoCampaignCriterionService, API_VERSION)
|
37
|
+
bid_modifier_srv = adwords.service(:AdGroupBidModifierService, API_VERSION)
|
40
38
|
|
41
|
-
# Get all
|
39
|
+
# Get all ad group bid modifiers for the campaign.
|
42
40
|
selector = {
|
43
|
-
:
|
41
|
+
:fields => ['CampaignId', 'AdGroupId', 'Id', 'BidModifier'],
|
42
|
+
:predicates => [
|
43
|
+
{:field => 'CampaignId', :operator => 'EQUALS', :values => [campaign_id]}
|
44
|
+
],
|
44
45
|
:paging => {
|
45
46
|
:start_index => 0,
|
46
47
|
:number_results => PAGE_SIZE
|
@@ -51,35 +52,41 @@ def get_video_campaign_criteria(campaign_id)
|
|
51
52
|
offset, page = 0, {}
|
52
53
|
|
53
54
|
begin
|
54
|
-
page =
|
55
|
+
page = bid_modifier_srv.get(selector)
|
55
56
|
if page[:entries]
|
56
|
-
page[:entries].each do |
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
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]
|
62
63
|
end
|
63
64
|
# Increment values to request the next page.
|
64
65
|
offset += PAGE_SIZE
|
65
66
|
selector[:paging][:start_index] = offset
|
67
|
+
else
|
68
|
+
puts 'No ad group level bid overrides returned.'
|
66
69
|
end
|
67
70
|
end while page[:total_num_entries] > offset
|
68
|
-
|
69
|
-
if page.include?(:total_num_entries)
|
70
|
-
puts "\tTotal number of criteria found: %d." % [page[:total_num_entries]]
|
71
|
-
end
|
72
71
|
end
|
73
72
|
|
74
73
|
if __FILE__ == $0
|
75
|
-
API_VERSION = :
|
74
|
+
API_VERSION = :v201309
|
76
75
|
PAGE_SIZE = 500
|
77
76
|
|
78
77
|
begin
|
79
|
-
#
|
78
|
+
# ID of a campaign to pull overrides for.
|
80
79
|
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
|
81
80
|
|
82
|
-
|
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'
|
83
90
|
|
84
91
|
# HTTP errors.
|
85
92
|
rescue AdsCommon::Errors::HttpError => e
|
@@ -0,0 +1,117 @@
|
|
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 = :v201309
|
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
|