google-adwords-api 0.9.3 → 0.10.0

data/examples/{v201209 → v201309}/remarketing/add_conversion_tracker.rb

@@ -47,7 +47,6 @@ def add_conversion_tracker()
           (Time.new.to_f * 1000).to_i,
       :category => 'DEFAULT',
       :markup_language => 'HTML',
-      :http_protocol => 'HTTP',
       :text_format => 'HIDDEN',
       # Optional fields:
       :status => 'ENABLED',
@@ -74,11 +73,19 @@ def add_conversion_tracker()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     add_conversion_tracker()
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201209 → v201309}/reporting/download_criteria_report.rb

@@ -61,13 +61,21 @@ def download_criteria_report(file_name)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     # File name to write report to.
     file_name = 'INSERT_OUTPUT_FILE_NAME_HERE'
     download_criteria_report(file_name)
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201209 → v201309}/reporting/download_criteria_report_with_awql.rb

@@ -59,7 +59,7 @@ def download_criteria_report_with_awql(file_name, report_format)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     # File name to write report to.
@@ -67,6 +67,14 @@ if __FILE__ == $0
     report_format = 'CSV'
     download_criteria_report_with_awql(file_name, report_format)
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts 'HTTP Error: %s' % e

data/examples/{v201209 → v201309}/reporting/get_campaign_stats.rb

@@ -81,12 +81,20 @@ def get_campaign_stats()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
   PAGE_SIZE = 500
 
   begin
     get_campaign_stats()
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201209 → v201309}/reporting/get_report_fields.rb

@@ -47,12 +47,20 @@ def get_report_fields(report_type)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     report_type = 'INSERT_REPORT_TYPE_HERE'
     get_report_fields(report_type)
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201209 → v201309}/reporting/parallel_report_download.rb

@@ -141,7 +141,7 @@ def parallel_report_download()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
   # Number of parallel threads to spawn.
   THREADS = 10
   # Maximum number of retries for 500 errors.
@@ -152,6 +152,14 @@ if __FILE__ == $0
   begin
     parallel_report_download()
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts 'HTTP Error: %s' % e

data/examples/{v201209 → v201309}/targeting/add_campaign_targeting_criteria.rb

@@ -46,10 +46,7 @@ def add_campaign_targeting_criteria(campaign_id)
     # Language criteria. The IDs can be found in the documentation or retrieved
     # with the ConstantDataService.
     {:xsi_type => 'Language', :id => 1000},  # English
-    {:xsi_type => 'Language', :id => 1003},  # Spanish
-    # Platform criteria. The IDs can be found in the documentation.
-    {:xsi_type => 'Platform', :id => 30001}, # Mobile
-    {:xsi_type => 'Platform', :id => 30002}  # Tablets
+    {:xsi_type => 'Language', :id => 1003}   # Spanish
   ]
 
   # Create operations.
@@ -94,12 +91,20 @@ def add_campaign_targeting_criteria(campaign_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     campaign_id = 'INSERT_CAMPAIGN_ID_HERE'
     add_campaign_targeting_criteria(campaign_id)
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201209 → v201309}/targeting/add_demographic_targeting_criteria.rb

@@ -84,12 +84,20 @@ def add_demographic_targeting_criteria(ad_group_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'
     add_demographic_targeting_criteria(ad_group_id)
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201209 → v201309}/targeting/get_campaign_targeting_criteria.rb

@@ -76,7 +76,7 @@ def get_campaign_targeting_criteria(campaign_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
   PAGE_SIZE = 500
 
   begin
@@ -84,6 +84,14 @@ if __FILE__ == $0
     campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
     get_campaign_targeting_criteria(campaign_id)
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201209 → v201309}/targeting/get_targetable_languages_and_carriers.rb

@@ -63,11 +63,19 @@ def get_targetable_languages_and_carriers()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     get_targetable_languages_and_carriers()
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201209 → v201309}/targeting/lookup_location.rb

@@ -81,11 +81,19 @@ def lookup_location()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     lookup_location()
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/lib/adwords_api/api_config.rb

@@ -35,9 +35,9 @@ module AdwordsApi
     end
 
     # Set defaults
-    DEFAULT_VERSION = :v201306
+    DEFAULT_VERSION = :v201309
     DEFAULT_ENVIRONMENT = :PRODUCTION
-    LATEST_VERSION = :v201306
+    LATEST_VERSION = :v201309
 
     # Set other constants
     API_NAME = 'AdwordsApi'
@@ -45,11 +45,12 @@ module AdwordsApi
 
     # Configure the services available to each version
     @@service_config = {
-      :v201209 => [
+      :v201302 => [
           :AdExtensionOverrideService,
           :AdGroupAdService,
           :AdGroupBidModifierService,
           :AdGroupCriterionService,
+          :AdGroupFeedService,
           :AdGroupService,
           :AdParamService,
           :AlertService,
@@ -57,20 +58,26 @@ module AdwordsApi
           :BudgetService,
           :CampaignAdExtensionService,
           :CampaignCriterionService,
+          :CampaignFeedService,
           :CampaignService,
+          :CampaignSharedSetService,
           :ConstantDataService,
           :ConversionTrackerService,
           :CustomerService,
           :CustomerSyncService,
           :DataService,
           :ExperimentService,
+          :FeedItemService,
+          :FeedMappingService,
+          :FeedService,
           :GeoLocationService,
-          :InfoService,
           :LocationCriterionService,
           :ManagedCustomerService,
           :MediaService,
           :MutateJobService,
           :ReportDefinitionService,
+          :SharedCriterionService,
+          :SharedSetService,
           :TargetingIdeaService,
           :TrafficEstimatorService,
           :UserListService,
@@ -82,7 +89,7 @@ module AdwordsApi
           :VideoTargetingGroupCriterionService,
           :VideoTargetingGroupService
       ],
-      :v201302 => [
+      :v201306 => [
           :AdExtensionOverrideService,
           :AdGroupAdService,
           :AdGroupBidModifierService,
@@ -90,7 +97,9 @@ module AdwordsApi
           :AdGroupFeedService,
           :AdGroupService,
           :AdParamService,
+          :AdwordsUserListService,
           :AlertService,
+          :BiddingStrategyService,
           :BudgetOrderService,
           :BudgetService,
           :CampaignAdExtensionService,
@@ -116,18 +125,9 @@ module AdwordsApi
           :SharedCriterionService,
           :SharedSetService,
           :TargetingIdeaService,
-          :TrafficEstimatorService,
-          :UserListService,
-          # AdWords for Video API Beta services.
-          :VideoAdService,
-          :VideoCampaignCriterionService,
-          :VideoCampaignService,
-          :VideoService,
-          :VideoTargetingGroupCriterionService,
-          :VideoTargetingGroupService
+          :TrafficEstimatorService
       ],
-      :v201306 => [
-          :AdExtensionOverrideService,
+      :v201309 => [
           :AdGroupAdService,
           :AdGroupBidModifierService,
           :AdGroupCriterionService,
@@ -158,6 +158,7 @@ module AdwordsApi
           :ManagedCustomerService,
           :MediaService,
           :MutateJobService,
+          :OfflineConversionFeedService,
           :ReportDefinitionService,
           :SharedCriterionService,
           :SharedSetService,
@@ -171,51 +172,15 @@ module AdwordsApi
       :PRODUCTION => {
         :oauth_scope => 'https://adwords.google.com/api/adwords/',
         :header_ns => 'https://adwords.google.com/api/adwords/cm/',
-        :v201209 => 'https://adwords.google.com/api/adwords/',
         :v201302 => 'https://adwords.google.com/api/adwords/',
-        :v201306 => 'https://adwords.google.com/api/adwords/'
+        :v201306 => 'https://adwords.google.com/api/adwords/',
+        :v201309 => 'https://adwords.google.com/api/adwords/'
       }
     }
 
     # Configure the subdirectories for each version / service pair.
     # A missing pair means that only the base URL is used.
     @@subdir_config = {
-      # v201209
-      [:v201209, :AdExtensionOverrideService] => 'cm/',
-      [:v201209, :AdGroupAdService] => 'cm/',
-      [:v201209, :AdGroupBidModifierService] => 'cm/',
-      [:v201209, :AdGroupCriterionService] => 'cm/',
-      [:v201209, :AdGroupService] => 'cm/',
-      [:v201209, :AdParamService] => 'cm/',
-      [:v201209, :AlertService] => 'mcm/',
-      [:v201209, :BudgetOrderService] => 'billing/',
-      [:v201209, :CampaignAdExtensionService] => 'cm/',
-      [:v201209, :CampaignCriterionService] => 'cm/',
-      [:v201209, :CampaignService] => 'cm/',
-      [:v201209, :ConstantDataService] => 'cm/',
-      [:v201209, :ConversionTrackerService] => 'cm/',
-      [:v201209, :CustomerSyncService] => 'ch/',
-      [:v201209, :DataService] => 'cm/',
-      [:v201209, :ExperimentService] => 'cm/',
-      [:v201209, :GeoLocationService] => 'cm/',
-      [:v201209, :InfoService] => 'info/',
-      [:v201209, :LocationCriterionService] => 'cm/',
-      [:v201209, :MediaService] => 'cm/',
-      [:v201209, :MutateJobService] => 'cm/',
-      [:v201209, :ReportDefinitionService] => 'cm/',
-      [:v201209, :TargetingIdeaService] => 'o/',
-      [:v201209, :TrafficEstimatorService] => 'o/',
-      [:v201209, :UserListService] => 'cm/',
-      [:v201209, :ManagedCustomerService] => 'mcm/',
-      [:v201209, :CustomerService] => 'mcm/',
-      [:v201209, :BudgetService] => 'cm/',
-      # AdWords for Video API Beta services.
-      [:v201209, :VideoAdService] => 'video/',
-      [:v201209, :VideoCampaignCriterionService] => 'video/',
-      [:v201209, :VideoCampaignService] => 'video/',
-      [:v201209, :VideoService] => 'video/',
-      [:v201209, :VideoTargetingGroupCriterionService] => 'video/',
-      [:v201209, :VideoTargetingGroupService] => 'video/',
       # v201302
       [:v201302, :AdExtensionOverrideService] => 'cm/',
       [:v201302, :AdGroupAdService] => 'cm/',
@@ -295,7 +260,44 @@ module AdwordsApi
       [:v201306, :CustomerService] => 'mcm/',
       [:v201306, :BudgetService] => 'cm/',
       [:v201306, :BiddingStrategyService] => 'cm/',
-      [:v201306, :AdwordsUserListService] => 'rm/'
+      [:v201306, :AdwordsUserListService] => 'rm/',
+      # v201309
+      [:v201309, :AdGroupAdService] => 'cm/',
+      [:v201309, :AdGroupBidModifierService] => 'cm/',
+      [:v201309, :AdGroupCriterionService] => 'cm/',
+      [:v201309, :AdGroupFeedService] => 'cm/',
+      [:v201309, :AdGroupService] => 'cm/',
+      [:v201309, :AdParamService] => 'cm/',
+      [:v201309, :AlertService] => 'mcm/',
+      [:v201309, :BudgetOrderService] => 'billing/',
+      [:v201309, :CampaignAdExtensionService] => 'cm/',
+      [:v201309, :CampaignCriterionService] => 'cm/',
+      [:v201309, :CampaignFeedService] => 'cm/',
+      [:v201309, :CampaignService] => 'cm/',
+      [:v201309, :CampaignSharedSetService] => 'cm/',
+      [:v201309, :ConstantDataService] => 'cm/',
+      [:v201309, :ConversionTrackerService] => 'cm/',
+      [:v201309, :CustomerSyncService] => 'ch/',
+      [:v201309, :DataService] => 'cm/',
+      [:v201309, :ExperimentService] => 'cm/',
+      [:v201309, :FeedItemService] => 'cm/',
+      [:v201309, :FeedMappingService] => 'cm/',
+      [:v201309, :FeedService] => 'cm/',
+      [:v201309, :GeoLocationService] => 'cm/',
+      [:v201309, :LocationCriterionService] => 'cm/',
+      [:v201309, :MediaService] => 'cm/',
+      [:v201309, :MutateJobService] => 'cm/',
+      [:v201309, :OfflineConversionFeedService] => 'cm/',
+      [:v201309, :ReportDefinitionService] => 'cm/',
+      [:v201309, :SharedCriterionService] => 'cm/',
+      [:v201309, :SharedSetService] => 'cm/',
+      [:v201309, :TargetingIdeaService] => 'o/',
+      [:v201309, :TrafficEstimatorService] => 'o/',
+      [:v201309, :ManagedCustomerService] => 'mcm/',
+      [:v201309, :CustomerService] => 'mcm/',
+      [:v201309, :BudgetService] => 'cm/',
+      [:v201309, :BiddingStrategyService] => 'cm/',
+      [:v201309, :AdwordsUserListService] => 'rm/'
     }
 
     # Auth constants for ClientLogin method.