google-adwords-api 0.9.2 → 0.9.3
Sign up to get free protection for your applications and to get access to all the features.
- data/ChangeLog +5 -0
- data/README +3 -3
- data/examples/v201302/account_management/create_account.rb +8 -0
- data/examples/v201302/account_management/get_account_alerts.rb +8 -0
- data/examples/v201302/account_management/get_account_changes.rb +8 -0
- data/examples/v201302/account_management/get_account_hierarchy.rb +8 -0
- data/examples/v201302/advanced_operations/add_ad_group_bid_modifier.rb +8 -0
- data/examples/v201302/advanced_operations/add_click_to_download_ad.rb +8 -0
- data/examples/v201302/advanced_operations/add_site_links.rb +8 -0
- data/examples/v201302/advanced_operations/create_and_attach_shared_keyword_set.rb +8 -0
- data/examples/v201302/advanced_operations/find_and_remove_criteria_from_shared_set.rb +8 -0
- data/examples/v201302/advanced_operations/get_ad_group_bid_modifiers.rb +8 -0
- data/examples/v201302/basic_operations/add_ad_groups.rb +8 -0
- data/examples/v201302/basic_operations/add_campaigns.rb +8 -0
- data/examples/v201302/basic_operations/add_keywords.rb +8 -0
- data/examples/v201302/basic_operations/add_text_ads.rb +8 -0
- data/examples/v201302/basic_operations/delete_ad.rb +8 -0
- data/examples/v201302/basic_operations/delete_ad_group.rb +8 -0
- data/examples/v201302/basic_operations/delete_campaign.rb +8 -0
- data/examples/v201302/basic_operations/delete_keyword.rb +8 -0
- data/examples/v201302/basic_operations/get_ad_groups.rb +8 -0
- data/examples/v201302/basic_operations/get_campaigns.rb +8 -0
- data/examples/v201302/basic_operations/get_campaigns_with_awql.rb +8 -0
- data/examples/v201302/basic_operations/get_keywords.rb +8 -0
- data/examples/v201302/basic_operations/get_text_ads.rb +8 -0
- data/examples/v201302/basic_operations/pause_ad.rb +8 -0
- data/examples/v201302/basic_operations/update_ad_group.rb +8 -0
- data/examples/v201302/basic_operations/update_campaign.rb +8 -0
- data/examples/v201302/basic_operations/update_keyword.rb +8 -0
- data/examples/v201302/campaign_management/add_experiment.rb +8 -0
- data/examples/v201302/campaign_management/add_keywords_in_bulk.rb +8 -0
- data/examples/v201302/campaign_management/add_location_extension.rb +8 -0
- data/examples/v201302/campaign_management/add_location_extension_override.rb +8 -0
- data/examples/v201302/campaign_management/get_all_disapproved_ads.rb +8 -0
- data/examples/v201302/campaign_management/get_all_disapproved_ads_with_awql.rb +8 -0
- data/examples/v201302/campaign_management/promote_experiment.rb +8 -0
- data/examples/v201302/campaign_management/set_ad_parameters.rb +8 -0
- data/examples/v201302/campaign_management/set_criterion_bid_modifier.rb +8 -0
- data/examples/v201302/campaign_management/validate_text_ad.rb +8 -0
- data/examples/v201302/error_handling/handle_partial_failures.rb +8 -0
- data/examples/v201302/error_handling/handle_policy_violation_error.rb +8 -0
- data/examples/v201302/migration/set_campaign_enhanced.rb +8 -0
- data/examples/v201302/migration/upgrade_legacy_sitelinks.rb +8 -0
- data/examples/v201302/misc/get_all_images_and_videos.rb +8 -0
- data/examples/v201302/misc/{use_oauth2.rb → setup_oauth2.rb} +16 -25
- data/examples/v201302/misc/upload_image.rb +8 -0
- data/examples/v201302/optimization/estimate_keyword_traffic.rb +8 -0
- data/examples/v201302/optimization/get_keyword_bid_simulations.rb +8 -0
- data/examples/v201302/optimization/get_keyword_ideas.rb +8 -0
- data/examples/v201302/optimization/get_placement_ideas.rb +8 -0
- data/examples/v201302/remarketing/add_audience.rb +8 -0
- data/examples/v201302/remarketing/add_conversion_tracker.rb +8 -0
- data/examples/v201302/reporting/download_criteria_report.rb +8 -0
- data/examples/v201302/reporting/download_criteria_report_with_awql.rb +8 -0
- data/examples/v201302/reporting/get_campaign_stats.rb +8 -0
- data/examples/v201302/reporting/get_report_fields.rb +8 -0
- data/examples/v201302/reporting/parallel_report_download.rb +8 -0
- data/examples/v201302/targeting/add_campaign_targeting_criteria.rb +8 -0
- data/examples/v201302/targeting/add_demographic_targeting_criteria.rb +8 -0
- data/examples/v201302/targeting/get_campaign_targeting_criteria.rb +8 -0
- data/examples/v201302/targeting/get_targetable_languages_and_carriers.rb +8 -0
- data/examples/v201302/targeting/lookup_location.rb +8 -0
- data/examples/v201306/account_management/create_account.rb +95 -0
- data/examples/v201306/account_management/get_account_alerts.rb +122 -0
- data/examples/v201306/account_management/get_account_changes.rb +145 -0
- data/examples/v201306/account_management/get_account_hierarchy.rb +103 -0
- data/examples/v201306/advanced_operations/add_ad_group_bid_modifier.rb +105 -0
- data/examples/v201306/advanced_operations/add_click_to_download_ad.rb +137 -0
- data/examples/v201306/advanced_operations/add_site_links.rb +244 -0
- data/examples/v201306/advanced_operations/create_and_attach_shared_keyword_set.rb +147 -0
- data/examples/v201306/advanced_operations/find_and_remove_criteria_from_shared_set.rb +181 -0
- data/examples/v201306/advanced_operations/get_ad_group_bid_modifiers.rb +106 -0
- data/examples/v201306/basic_operations/add_ad_groups.rb +143 -0
- data/examples/v201306/basic_operations/add_campaigns.rb +162 -0
- data/examples/v201306/basic_operations/add_keywords.rb +116 -0
- data/examples/v201306/basic_operations/add_text_ads.rb +113 -0
- data/examples/v201306/basic_operations/delete_ad.rb +93 -0
- data/examples/v201306/basic_operations/delete_ad_group.rb +110 -0
- data/examples/v201306/basic_operations/delete_campaign.rb +111 -0
- data/examples/v201306/basic_operations/delete_keyword.rb +98 -0
- data/examples/v201306/basic_operations/get_ad_groups.rb +106 -0
- data/examples/v201306/basic_operations/get_campaigns.rb +101 -0
- data/examples/v201306/basic_operations/get_campaigns_with_awql.rb +93 -0
- data/examples/v201306/basic_operations/get_keywords.rb +112 -0
- data/examples/v201306/basic_operations/get_text_ads.rb +114 -0
- data/examples/v201306/basic_operations/pause_ad.rb +92 -0
- data/examples/v201306/basic_operations/update_ad_group.rb +89 -0
- data/examples/v201306/basic_operations/update_campaign.rb +90 -0
- data/examples/v201306/basic_operations/update_keyword.rb +110 -0
- data/examples/v201306/campaign_management/add_experiment.rb +166 -0
- data/examples/v201306/campaign_management/add_keywords_in_bulk.rb +158 -0
- data/examples/v201306/campaign_management/add_location_extension.rb +125 -0
- data/examples/v201306/campaign_management/add_location_extension_override.rb +91 -0
- data/examples/v201306/campaign_management/get_all_disapproved_ads.rb +101 -0
- data/examples/v201306/campaign_management/get_all_disapproved_ads_with_awql.rb +92 -0
- data/examples/v201306/campaign_management/promote_experiment.rb +85 -0
- data/examples/v201306/campaign_management/set_ad_parameters.rb +122 -0
- data/examples/v201306/campaign_management/set_criterion_bid_modifier.rb +110 -0
- data/examples/v201306/campaign_management/validate_text_ad.rb +114 -0
- data/examples/v201306/error_handling/handle_captcha_challenge.rb +93 -0
- data/examples/v201306/error_handling/handle_partial_failures.rb +134 -0
- data/examples/v201306/error_handling/handle_policy_violation_error.rb +145 -0
- data/examples/v201306/error_handling/handle_two_factor_authorization_error.rb +88 -0
- data/examples/v201306/migration/upgrade_legacy_sitelinks.rb +313 -0
- data/examples/v201306/misc/get_all_images_and_videos.rb +108 -0
- data/examples/v201306/misc/setup_oauth2.rb +88 -0
- data/examples/v201306/misc/upload_image.rb +97 -0
- data/examples/v201306/misc/use_oauth2_jwt.rb +93 -0
- data/examples/v201306/optimization/estimate_keyword_traffic.rb +137 -0
- data/examples/v201306/optimization/get_keyword_bid_simulations.rb +100 -0
- data/examples/v201306/optimization/get_keyword_ideas.rb +130 -0
- data/examples/v201306/optimization/get_placement_ideas.rb +112 -0
- data/examples/v201306/remarketing/add_audience.rb +123 -0
- data/examples/v201306/remarketing/add_conversion_tracker.rb +104 -0
- data/examples/v201306/reporting/download_criteria_report.rb +87 -0
- data/examples/v201306/reporting/download_criteria_report_with_awql.rb +86 -0
- data/examples/v201306/reporting/get_campaign_stats.rb +113 -0
- data/examples/v201306/reporting/get_report_fields.rb +79 -0
- data/examples/v201306/reporting/parallel_report_download.rb +171 -0
- data/examples/v201306/targeting/add_campaign_targeting_criteria.rb +123 -0
- data/examples/v201306/targeting/add_demographic_targeting_criteria.rb +116 -0
- data/examples/v201306/targeting/get_campaign_targeting_criteria.rb +110 -0
- data/examples/v201306/targeting/get_targetable_languages_and_carriers.rb +94 -0
- data/examples/v201306/targeting/lookup_location.rb +112 -0
- data/lib/adwords_api/api_config.rb +80 -4
- data/lib/adwords_api/v201306/ad_extension_override_service.rb +38 -0
- data/lib/adwords_api/v201306/ad_extension_override_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/ad_group_ad_service.rb +42 -0
- data/lib/adwords_api/v201306/ad_group_ad_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/ad_group_bid_modifier_service.rb +38 -0
- data/lib/adwords_api/v201306/ad_group_bid_modifier_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/ad_group_criterion_service.rb +42 -0
- data/lib/adwords_api/v201306/ad_group_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/ad_group_feed_service.rb +38 -0
- data/lib/adwords_api/v201306/ad_group_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/ad_group_service.rb +42 -0
- data/lib/adwords_api/v201306/ad_group_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/ad_param_service.rb +38 -0
- data/lib/adwords_api/v201306/ad_param_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/adwords_user_list_service.rb +38 -0
- data/lib/adwords_api/v201306/adwords_user_list_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/alert_service.rb +34 -0
- data/lib/adwords_api/v201306/alert_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/bidding_strategy_service.rb +38 -0
- data/lib/adwords_api/v201306/bidding_strategy_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/budget_order_service.rb +42 -0
- data/lib/adwords_api/v201306/budget_order_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/budget_service.rb +38 -0
- data/lib/adwords_api/v201306/budget_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/campaign_ad_extension_service.rb +38 -0
- data/lib/adwords_api/v201306/campaign_ad_extension_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/campaign_criterion_service.rb +42 -0
- data/lib/adwords_api/v201306/campaign_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/campaign_feed_service.rb +38 -0
- data/lib/adwords_api/v201306/campaign_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/campaign_service.rb +42 -0
- data/lib/adwords_api/v201306/campaign_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/campaign_shared_set_service.rb +38 -0
- data/lib/adwords_api/v201306/campaign_shared_set_service_registry.rb +47 -0
- data/lib/adwords_api/v201306/constant_data_service.rb +62 -0
- data/lib/adwords_api/v201306/constant_data_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/conversion_tracker_service.rb +38 -0
- data/lib/adwords_api/v201306/conversion_tracker_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/customer_service.rb +34 -0
- data/lib/adwords_api/v201306/customer_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/customer_sync_service.rb +34 -0
- data/lib/adwords_api/v201306/customer_sync_service_registry.rb +47 -0
- data/lib/adwords_api/v201306/data_service.rb +38 -0
- data/lib/adwords_api/v201306/data_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/experiment_service.rb +38 -0
- data/lib/adwords_api/v201306/experiment_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/feed_item_service.rb +38 -0
- data/lib/adwords_api/v201306/feed_item_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/feed_mapping_service.rb +38 -0
- data/lib/adwords_api/v201306/feed_mapping_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/feed_service.rb +38 -0
- data/lib/adwords_api/v201306/feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/geo_location_service.rb +34 -0
- data/lib/adwords_api/v201306/geo_location_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/location_criterion_service.rb +34 -0
- data/lib/adwords_api/v201306/location_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/managed_customer_service.rb +50 -0
- data/lib/adwords_api/v201306/managed_customer_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/media_service.rb +38 -0
- data/lib/adwords_api/v201306/media_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/mutate_job_service.rb +42 -0
- data/lib/adwords_api/v201306/mutate_job_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/report_definition_service.rb +34 -0
- data/lib/adwords_api/v201306/report_definition_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/shared_criterion_service.rb +38 -0
- data/lib/adwords_api/v201306/shared_criterion_service_registry.rb +47 -0
- data/lib/adwords_api/v201306/shared_set_service.rb +38 -0
- data/lib/adwords_api/v201306/shared_set_service_registry.rb +47 -0
- data/lib/adwords_api/v201306/targeting_idea_service.rb +38 -0
- data/lib/adwords_api/v201306/targeting_idea_service_registry.rb +46 -0
- data/lib/adwords_api/v201306/traffic_estimator_service.rb +34 -0
- data/lib/adwords_api/v201306/traffic_estimator_service_registry.rb +46 -0
- 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/suite_exampletests_v201302.rb +1 -1
- data/test/suite_exampletests_v201306.rb +37 -0
- data/test/templates/v201209/basic_operations_get_campaigns.def +1 -1
- 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 +114 -0
- data/test/templates/v201306/misc_use_oauth2_jwt.def +131 -0
- metadata +142 -5
@@ -87,6 +87,14 @@ if __FILE__ == $0
|
|
87
87
|
begin
|
88
88
|
get_campaign_stats()
|
89
89
|
|
90
|
+
# Authorization error.
|
91
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
92
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
93
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
94
|
+
"to retrieve and store OAuth2 tokens."
|
95
|
+
puts "See this wiki page for more details:\n\n " +
|
96
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
97
|
+
|
90
98
|
# HTTP errors.
|
91
99
|
rescue AdsCommon::Errors::HttpError => e
|
92
100
|
puts "HTTP Error: %s" % e
|
@@ -53,6 +53,14 @@ if __FILE__ == $0
|
|
53
53
|
report_type = 'INSERT_REPORT_TYPE_HERE'
|
54
54
|
get_report_fields(report_type)
|
55
55
|
|
56
|
+
# Authorization error.
|
57
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
58
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
59
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
60
|
+
"to retrieve and store OAuth2 tokens."
|
61
|
+
puts "See this wiki page for more details:\n\n " +
|
62
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
63
|
+
|
56
64
|
# HTTP errors.
|
57
65
|
rescue AdsCommon::Errors::HttpError => e
|
58
66
|
puts "HTTP Error: %s" % e
|
@@ -152,6 +152,14 @@ if __FILE__ == $0
|
|
152
152
|
begin
|
153
153
|
parallel_report_download()
|
154
154
|
|
155
|
+
# Authorization error.
|
156
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
157
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
158
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
159
|
+
"to retrieve and store OAuth2 tokens."
|
160
|
+
puts "See this wiki page for more details:\n\n " +
|
161
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
162
|
+
|
155
163
|
# HTTP errors.
|
156
164
|
rescue AdsCommon::Errors::HttpError => e
|
157
165
|
puts 'HTTP Error: %s' % e
|
@@ -97,6 +97,14 @@ if __FILE__ == $0
|
|
97
97
|
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'
|
98
98
|
add_campaign_targeting_criteria(campaign_id)
|
99
99
|
|
100
|
+
# Authorization error.
|
101
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
102
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
103
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
104
|
+
"to retrieve and store OAuth2 tokens."
|
105
|
+
puts "See this wiki page for more details:\n\n " +
|
106
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
107
|
+
|
100
108
|
# HTTP errors.
|
101
109
|
rescue AdsCommon::Errors::HttpError => e
|
102
110
|
puts "HTTP Error: %s" % e
|
@@ -90,6 +90,14 @@ if __FILE__ == $0
|
|
90
90
|
ad_group_id = 'INSERT_AD_GROUP_ID_HERE'
|
91
91
|
add_demographic_targeting_criteria(ad_group_id)
|
92
92
|
|
93
|
+
# Authorization error.
|
94
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
95
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
96
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
97
|
+
"to retrieve and store OAuth2 tokens."
|
98
|
+
puts "See this wiki page for more details:\n\n " +
|
99
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
100
|
+
|
93
101
|
# HTTP errors.
|
94
102
|
rescue AdsCommon::Errors::HttpError => e
|
95
103
|
puts "HTTP Error: %s" % e
|
@@ -84,6 +84,14 @@ if __FILE__ == $0
|
|
84
84
|
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
|
85
85
|
get_campaign_targeting_criteria(campaign_id)
|
86
86
|
|
87
|
+
# Authorization error.
|
88
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
89
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
90
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
91
|
+
"to retrieve and store OAuth2 tokens."
|
92
|
+
puts "See this wiki page for more details:\n\n " +
|
93
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
94
|
+
|
87
95
|
# HTTP errors.
|
88
96
|
rescue AdsCommon::Errors::HttpError => e
|
89
97
|
puts "HTTP Error: %s" % e
|
@@ -68,6 +68,14 @@ if __FILE__ == $0
|
|
68
68
|
begin
|
69
69
|
get_targetable_languages_and_carriers()
|
70
70
|
|
71
|
+
# Authorization error.
|
72
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
73
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
74
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
75
|
+
"to retrieve and store OAuth2 tokens."
|
76
|
+
puts "See this wiki page for more details:\n\n " +
|
77
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
78
|
+
|
71
79
|
# HTTP errors.
|
72
80
|
rescue AdsCommon::Errors::HttpError => e
|
73
81
|
puts "HTTP Error: %s" % e
|
@@ -86,6 +86,14 @@ if __FILE__ == $0
|
|
86
86
|
begin
|
87
87
|
lookup_location()
|
88
88
|
|
89
|
+
# Authorization error.
|
90
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
91
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
92
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
93
|
+
"to retrieve and store OAuth2 tokens."
|
94
|
+
puts "See this wiki page for more details:\n\n " +
|
95
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
96
|
+
|
89
97
|
# HTTP errors.
|
90
98
|
rescue AdsCommon::Errors::HttpError => e
|
91
99
|
puts "HTTP Error: %s" % e
|
@@ -0,0 +1,95 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# Encoding: utf-8
|
3
|
+
#
|
4
|
+
# Author:: api.dklimkin@gmail.com (Danial Klimkin)
|
5
|
+
#
|
6
|
+
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
7
|
+
#
|
8
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
9
|
+
# you may not use this file except in compliance with the License.
|
10
|
+
# You may obtain a copy of the License at
|
11
|
+
#
|
12
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
13
|
+
#
|
14
|
+
# Unless required by applicable law or agreed to in writing, software
|
15
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
16
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
17
|
+
# implied.
|
18
|
+
# See the License for the specific language governing permissions and
|
19
|
+
# limitations under the License.
|
20
|
+
#
|
21
|
+
# This example illustrates how to create an account. Note by default this
|
22
|
+
# account will only be accessible via parent MCC.
|
23
|
+
#
|
24
|
+
# Note: This code example uses MCC-level calls and won't work with Test
|
25
|
+
# Accounts, see: https://developers.google.com/adwords/api/docs/test-accounts
|
26
|
+
#
|
27
|
+
# Tags: ManagedCustomerService.mutate
|
28
|
+
|
29
|
+
require 'adwords_api'
|
30
|
+
require 'adwords_api/utils'
|
31
|
+
|
32
|
+
def create_account()
|
33
|
+
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
34
|
+
# when called without parameters.
|
35
|
+
adwords = AdwordsApi::Api.new
|
36
|
+
|
37
|
+
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
38
|
+
# the configuration file or provide your own logger:
|
39
|
+
# adwords.logger = Logger.new('adwords_xml.log')
|
40
|
+
|
41
|
+
managed_customer_srv = adwords.service(:ManagedCustomerService, API_VERSION)
|
42
|
+
|
43
|
+
# Create a local Customer object.
|
44
|
+
customer = {
|
45
|
+
:name => 'Account created with ManagedCustomerService',
|
46
|
+
:currency_code => 'EUR',
|
47
|
+
:date_time_zone => 'Europe/London'
|
48
|
+
}
|
49
|
+
|
50
|
+
# Prepare operation to create an account.
|
51
|
+
operation = {
|
52
|
+
:operator => 'ADD',
|
53
|
+
:operand => customer
|
54
|
+
}
|
55
|
+
|
56
|
+
# Create the account. It is possible to create multiple accounts with one
|
57
|
+
# request by sending an array of operations.
|
58
|
+
response = managed_customer_srv.mutate([operation])
|
59
|
+
|
60
|
+
response[:value].each do |new_account|
|
61
|
+
puts "Account with customer ID '%s' was successfully created." %
|
62
|
+
AdwordsApi::Utils.format_id(new_account[:customer_id])
|
63
|
+
end
|
64
|
+
end
|
65
|
+
|
66
|
+
if __FILE__ == $0
|
67
|
+
API_VERSION = :v201306
|
68
|
+
|
69
|
+
begin
|
70
|
+
create_account()
|
71
|
+
|
72
|
+
# Authorization error.
|
73
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
74
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
75
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
76
|
+
"to retrieve and store OAuth2 tokens."
|
77
|
+
puts "See this wiki page for more details:\n\n " +
|
78
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
79
|
+
|
80
|
+
# HTTP errors.
|
81
|
+
rescue AdsCommon::Errors::HttpError => e
|
82
|
+
puts "HTTP Error: %s" % e
|
83
|
+
|
84
|
+
# API errors.
|
85
|
+
rescue AdwordsApi::Errors::ApiException => e
|
86
|
+
puts "Message: %s" % e.message
|
87
|
+
puts 'Errors:'
|
88
|
+
e.errors.each_with_index do |error, index|
|
89
|
+
puts "\tError [%d]:" % (index + 1)
|
90
|
+
error.each do |field, value|
|
91
|
+
puts "\t\t%s: %s" % [field, value]
|
92
|
+
end
|
93
|
+
end
|
94
|
+
end
|
95
|
+
end
|
@@ -0,0 +1,122 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# Encoding: utf-8
|
3
|
+
#
|
4
|
+
# Author:: api.dklimkin@gmail.com (Danial Klimkin)
|
5
|
+
#
|
6
|
+
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
7
|
+
#
|
8
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
9
|
+
# you may not use this file except in compliance with the License.
|
10
|
+
# You may obtain a copy of the License at
|
11
|
+
#
|
12
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
13
|
+
#
|
14
|
+
# Unless required by applicable law or agreed to in writing, software
|
15
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
16
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
17
|
+
# implied.
|
18
|
+
# See the License for the specific language governing permissions and
|
19
|
+
# limitations under the License.
|
20
|
+
#
|
21
|
+
# This example gets all alerts for all clients of an MCC account. The effective
|
22
|
+
# user (clientCustomerId, or authToken) must be an MCC user to get results.
|
23
|
+
#
|
24
|
+
# Note: This code example uses MCC-level calls and won't work with Test
|
25
|
+
# Accounts, see: https://developers.google.com/adwords/api/docs/test-accounts
|
26
|
+
#
|
27
|
+
# Tags: AlertService.get
|
28
|
+
|
29
|
+
require 'adwords_api'
|
30
|
+
require 'adwords_api/utils'
|
31
|
+
|
32
|
+
def get_account_alerts()
|
33
|
+
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
34
|
+
# when called without parameters.
|
35
|
+
adwords = AdwordsApi::Api.new
|
36
|
+
|
37
|
+
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
38
|
+
# the configuration file or provide your own logger:
|
39
|
+
# adwords.logger = Logger.new('adwords_xml.log')
|
40
|
+
|
41
|
+
alert_srv = adwords.service(:AlertService, API_VERSION)
|
42
|
+
|
43
|
+
# Create the selector.
|
44
|
+
selector = {
|
45
|
+
:query => {
|
46
|
+
:filter_spec => 'ALL',
|
47
|
+
:client_spec => 'ALL',
|
48
|
+
:trigger_time_spec => 'ALL_TIME',
|
49
|
+
:severities => ['GREEN', 'YELLOW', 'RED'],
|
50
|
+
:types => [
|
51
|
+
'ACCOUNT_BUDGET_BURN_RATE', 'ACCOUNT_BUDGET_ENDING',
|
52
|
+
'ACCOUNT_ON_TARGET', 'CAMPAIGN_ENDED', 'CAMPAIGN_ENDING',
|
53
|
+
'CREDIT_CARD_EXPIRING', 'DECLINED_PAYMENT', 'MANAGER_LINK_PENDING',
|
54
|
+
'MISSING_BANK_REFERENCE_NUMBER', 'PAYMENT_NOT_ENTERED',
|
55
|
+
'TV_ACCOUNT_BUDGET_ENDING', 'TV_ACCOUNT_ON_TARGET',
|
56
|
+
'TV_ZERO_DAILY_SPENDING_LIMIT', 'USER_INVITE_ACCEPTED',
|
57
|
+
'USER_INVITE_PENDING', 'ZERO_DAILY_SPENDING_LIMIT'
|
58
|
+
]
|
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
|
+
# Get alerts.
|
70
|
+
begin
|
71
|
+
page = alert_srv.get(selector)
|
72
|
+
if page[:entries]
|
73
|
+
page[:entries].each_with_index do |alert, index|
|
74
|
+
puts "%d) Customer ID is '%s', alert type is '%s', severity is '%s'."
|
75
|
+
[AdwordsApi::Utils.format_id(alert[:client_customer_id]),
|
76
|
+
alert[:alert_type], alert[:alert_severity]]
|
77
|
+
alert[:details].each do |detail|
|
78
|
+
puts "\t- triggered at %s" % detail[:trigger_time]
|
79
|
+
end
|
80
|
+
end
|
81
|
+
# Increment values to request the next page.
|
82
|
+
offset += PAGE_SIZE
|
83
|
+
selector[:paging][:start_index] = offset
|
84
|
+
end
|
85
|
+
end while page[:total_num_entries] > offset
|
86
|
+
|
87
|
+
if page.include?(:total_num_entries)
|
88
|
+
puts "\tTotal number of alerts: %d." % page[:total_num_entries]
|
89
|
+
end
|
90
|
+
end
|
91
|
+
|
92
|
+
if __FILE__ == $0
|
93
|
+
API_VERSION = :v201306
|
94
|
+
PAGE_SIZE = 500
|
95
|
+
|
96
|
+
begin
|
97
|
+
get_account_alerts()
|
98
|
+
|
99
|
+
# Authorization error.
|
100
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
101
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
102
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
103
|
+
"to retrieve and store OAuth2 tokens."
|
104
|
+
puts "See this wiki page for more details:\n\n " +
|
105
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
106
|
+
|
107
|
+
# HTTP errors.
|
108
|
+
rescue AdsCommon::Errors::HttpError => e
|
109
|
+
puts "HTTP Error: %s" % e
|
110
|
+
|
111
|
+
# API errors.
|
112
|
+
rescue AdwordsApi::Errors::ApiException => e
|
113
|
+
puts "Message: %s" % e.message
|
114
|
+
puts 'Errors:'
|
115
|
+
e.errors.each_with_index do |error, index|
|
116
|
+
puts "\tError [%d]:" % (index + 1)
|
117
|
+
error.each do |field, value|
|
118
|
+
puts "\t\t%s: %s" % [field, value]
|
119
|
+
end
|
120
|
+
end
|
121
|
+
end
|
122
|
+
end
|
@@ -0,0 +1,145 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# Encoding: utf-8
|
3
|
+
#
|
4
|
+
# Author:: api.dklimkin@gmail.com (Danial Klimkin)
|
5
|
+
#
|
6
|
+
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
7
|
+
#
|
8
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
9
|
+
# you may not use this file except in compliance with the License.
|
10
|
+
# You may obtain a copy of the License at
|
11
|
+
#
|
12
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
13
|
+
#
|
14
|
+
# Unless required by applicable law or agreed to in writing, software
|
15
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
16
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
17
|
+
# implied.
|
18
|
+
# See the License for the specific language governing permissions and
|
19
|
+
# limitations under the License.
|
20
|
+
#
|
21
|
+
# This example gets all account changes that happened within the last 24 hours,
|
22
|
+
# for all your campaigns.
|
23
|
+
#
|
24
|
+
# Tags: CustomerSyncService.get
|
25
|
+
|
26
|
+
require 'adwords_api'
|
27
|
+
require 'date'
|
28
|
+
require 'pp'
|
29
|
+
|
30
|
+
def get_account_changes()
|
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
|
+
campaign_srv = adwords.service(:CampaignService, API_VERSION)
|
40
|
+
customer_sync_srv = adwords.service(:CustomerSyncService, API_VERSION)
|
41
|
+
|
42
|
+
today_at_midnight = DateTime.parse(Date.today.to_s)
|
43
|
+
yesterday_at_midnight = DateTime.parse((Date.today - 1).to_s)
|
44
|
+
min_date_time = yesterday_at_midnight.strftime("%Y%m%d %H%M%S")
|
45
|
+
max_date_time = today_at_midnight.strftime("%Y%m%d %H%M%S")
|
46
|
+
|
47
|
+
# Get all the campaigns for this account.
|
48
|
+
selector = {
|
49
|
+
:fields => ['Id']
|
50
|
+
}
|
51
|
+
response = campaign_srv.get(selector)
|
52
|
+
|
53
|
+
campaign_ids = []
|
54
|
+
|
55
|
+
if response and response[:entries]
|
56
|
+
campaign_ids = response[:entries].map { |campaign| campaign[:id] }
|
57
|
+
else
|
58
|
+
raise StandardError, 'No campaigns were found.'
|
59
|
+
end
|
60
|
+
|
61
|
+
# Create a selector for CustomerSyncService.
|
62
|
+
selector = {
|
63
|
+
:campaign_ids => campaign_ids,
|
64
|
+
:date_time_range => {
|
65
|
+
:min => min_date_time,
|
66
|
+
:max => max_date_time
|
67
|
+
}
|
68
|
+
}
|
69
|
+
|
70
|
+
# Get all account changes for the campaigns.
|
71
|
+
campaign_changes = customer_sync_srv.get(selector)
|
72
|
+
|
73
|
+
# Display changes.
|
74
|
+
if campaign_changes
|
75
|
+
puts "Most recent change: %s" % campaign_changes[:last_change_timestamp]
|
76
|
+
campaign_changes[:changed_campaigns].each do |campaign|
|
77
|
+
puts "Campaign with ID %d was changed:" % campaign[:campaign_id]
|
78
|
+
puts "\tCampaign change status: '%s'" % campaign[:campaign_change_status]
|
79
|
+
unless ['NEW', 'FIELDS_UNCHANGED'].include?(
|
80
|
+
campaign[:campaign_change_status])
|
81
|
+
puts "\tAdded ad extensions: '%s'" %
|
82
|
+
campaign[:added_ad_extensions].pretty_inspect.chomp
|
83
|
+
puts "\tAdded campaign criteria: '%s'" %
|
84
|
+
campaign[:added_campaign_criteria].pretty_inspect.chomp
|
85
|
+
puts "\tAdded campaign targeting: '%s'" %
|
86
|
+
campaign[:campaign_targeting_changed].pretty_inspect.chomp
|
87
|
+
puts "\tDeleted ad extensions: '%s'" %
|
88
|
+
campaign[:deleted_ad_extensions].pretty_inspect.chomp
|
89
|
+
puts "\tDeleted campaign criteria: '%s'" %
|
90
|
+
campaign[:deleted_campaign_criteria].pretty_inspect.chomp
|
91
|
+
|
92
|
+
if campaign[:changed_ad_groups]
|
93
|
+
campaign[:changed_ad_groups].each do |ad_group|
|
94
|
+
puts "\tAd group with ID %d was changed:" % ad_group[:ad_group_id]
|
95
|
+
puts "\t\tAd group changed status: '%s'" %
|
96
|
+
ad_group[:ad_group_change_status]
|
97
|
+
unless ['NEW', 'FIELDS_UNCHANGED'].include?(
|
98
|
+
ad_group[:ad_group_change_status])
|
99
|
+
puts "\t\tAds changed: '%s'" %
|
100
|
+
ad_group[:changed_ads].pretty_inspect.chomp
|
101
|
+
puts "\t\tCriteria changed: '%s'" %
|
102
|
+
ad_group[:changed_criteria].pretty_inspect.chomp
|
103
|
+
puts "\t\tCriteria deleted: '%s'" %
|
104
|
+
ad_group[:deleted_criteria].pretty_inspect.chomp
|
105
|
+
end
|
106
|
+
end
|
107
|
+
end
|
108
|
+
end
|
109
|
+
puts
|
110
|
+
end
|
111
|
+
else
|
112
|
+
puts 'No account changes were found.'
|
113
|
+
end
|
114
|
+
end
|
115
|
+
|
116
|
+
if __FILE__ == $0
|
117
|
+
API_VERSION = :v201306
|
118
|
+
|
119
|
+
begin
|
120
|
+
get_account_changes()
|
121
|
+
|
122
|
+
# Authorization error.
|
123
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
124
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
125
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
126
|
+
"to retrieve and store OAuth2 tokens."
|
127
|
+
puts "See this wiki page for more details:\n\n " +
|
128
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
129
|
+
|
130
|
+
# HTTP errors.
|
131
|
+
rescue AdsCommon::Errors::HttpError => e
|
132
|
+
puts "HTTP Error: %s" % e
|
133
|
+
|
134
|
+
# API errors.
|
135
|
+
rescue AdwordsApi::Errors::ApiException => e
|
136
|
+
puts "Message: %s" % e.message
|
137
|
+
puts 'Errors:'
|
138
|
+
e.errors.each_with_index do |error, index|
|
139
|
+
puts "\tError [%d]:" % (index + 1)
|
140
|
+
error.each do |field, value|
|
141
|
+
puts "\t\t%s: %s" % [field, value]
|
142
|
+
end
|
143
|
+
end
|
144
|
+
end
|
145
|
+
end
|