google-adwords-api 0.13.1 → 0.13.2

data/examples/v201409/targeting/get_campaign_targeting_criteria.rb

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+# This example illustrates how to retrieve all the campaign targets. To set
+# campaign targets, run add_campaign_targeting_criteria.rb.
+#
+# Tags: CampaignCriterionService.get
+
+require 'adwords_api'
+
+def get_campaign_targeting_criteria(campaign_id)
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
+  campaign_criterion_srv =
+      adwords.service(:CampaignCriterionService, API_VERSION)
+
+  # Selector to get all the targeting for this campaign.
+  selector = {
+    :fields => ['Id', 'CriteriaType', 'KeywordText'],
+    :predicates => [
+      {:field => 'CampaignId', :operator => 'EQUALS', :values => [campaign_id]}
+    ],
+    :paging => {
+      :start_index => 0,
+      :number_results => PAGE_SIZE
+    }
+  }
+
+  # Set initial values.
+  offset, page = 0, {}
+
+  begin
+    page = campaign_criterion_srv.get(selector)
+    if page[:entries]
+      page[:entries].each do |typed_criterion|
+        negative = typed_criterion[:xsi_type] == 'NegativeCampaignCriterion' ?
+           ' (negative)' : ''
+        criterion = typed_criterion[:criterion]
+        puts ("Campaign criterion%s with ID %d, type '%s' and text '%s'" +
+            " was found.") %
+            [negative, criterion[:id], criterion[:type], criterion[:text]]
+      end
+      # Increment values to request the next page.
+      offset += PAGE_SIZE
+      selector[:paging][:start_index] = offset
+    end
+  end while page[:total_num_entries] > offset
+
+  if page.include?(:total_num_entries)
+    puts "\tCampaign ID %d has %d criteria." %
+        [campaign_id, page[:total_num_entries]]
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201409
+  PAGE_SIZE = 500
+
+  begin
+    # Specify campaign ID to get targeting for.
+    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
+
+  # API errors.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts "Message: %s" % e.message
+    puts 'Errors:'
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
+      end
+    end
+  end
+end

data/examples/v201409/targeting/get_targetable_languages_and_carriers.rb

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+# This example illustrates how to retrieve all languages and carriers available
+# for targeting.
+#
+# Tags: ConstantDataService.getLanguageCriterion
+# Tags: ConstantDataService.getCarrierCriterion
+
+require 'adwords_api'
+
+def get_targetable_languages_and_carriers()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
+  constant_data_srv = adwords.service(:ConstantDataService, API_VERSION)
+
+  # Get all languages from ConstantDataService.
+  languages = constant_data_srv.get_language_criterion()
+
+  if languages
+    languages.each do |language|
+      puts "Language name is '%s', ID is %d and code is '%s'." %
+          [language[:name], language[:id], language[:code]]
+    end
+  else
+    puts 'No languages were found.'
+  end
+
+  # Get all carriers from ConstantDataService.
+  carriers = constant_data_srv.get_carrier_criterion()
+
+  if carriers
+    carriers.each do |carrier|
+      puts "Carrier name is '%s', ID is %d and country code is '%s'." %
+          [carrier[:name], carrier[:id], carrier[:country_code]]
+    end
+  else
+    puts 'No carriers were retrieved.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201409
+
+  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
+
+  # API errors.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts "Message: %s" % e.message
+    puts 'Errors:'
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
+      end
+    end
+  end
+end

data/examples/v201409/targeting/lookup_location.rb

@@ -0,0 +1,112 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+# This example gets location criteria by name.
+#
+# Tags: LocationCriterionService.get
+
+require 'adwords_api'
+
+def lookup_location()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
+  location_criterion_srv =
+      adwords.service(:LocationCriterionService, API_VERSION)
+
+  # List of locations to look up.
+  location_names = ['Paris', 'Quebec', 'Spain', 'Deutschland']
+  # Locale to retrieve names in.
+  locale = 'en'
+
+  # Get the criteria by names.
+  selector = {
+      :fields => ['Id', 'LocationName', 'CanonicalName', 'DisplayType',
+          'ParentLocations', 'Reach', 'TargetingStatus'],
+      :predicates => [
+          # Location names must match exactly, only EQUALS and IN are supported.
+          {:field => 'LocationName',
+           :operator => 'IN',
+           :values => location_names},
+          # Set the locale of the returned location names.
+          {:field => 'Locale', :operator => 'EQUALS', :values => [locale]}
+    ]
+  }
+  criteria = location_criterion_srv.get(selector)
+
+  if criteria
+    criteria.each do |criterion|
+      # Extract all parent location names as one comma-separated string.
+      parent_location = if criterion[:location][:parent_locations] and
+          !criterion[:location][:parent_locations].empty?
+        locations_array = criterion[:location][:parent_locations].map do |loc|
+          loc[:location_name]
+        end
+        locations_array.join(', ')
+      else
+        'N/A'
+      end
+      puts ("The search term '%s' returned the location '%s' of type '%s' " +
+          "with ID %d, parent locations '%s' and reach %d (%s)") %
+          [criterion[:search_term], criterion[:location][:location_name],
+           criterion[:location][:criterion_type], criterion[:location][:id],
+           parent_location, criterion[:reach],
+           criterion[:location][:targeting_status]]
+    end
+  else
+    puts 'No criteria were returned.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201409
+
+  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
+
+  # API errors.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts "Message: %s" % e.message
+    puts 'Errors:'
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
+      end
+    end
+  end
+end

data/lib/adwords_api.rb

@@ -130,6 +130,24 @@ module AdwordsApi
       @credential_handler.validate_only = value
     end
 
+    # Helper method to skip the report header when downloading reports.
+    #
+    # Args:
+    # - value: whether to skip the report header (boolean)
+    #
+    def skip_report_header=(value)
+      @config.set('library.skip_report_header', value)
+    end
+
+    # Helper method to skip the report summary when downloading reports.
+    #
+    # Args:
+    # - value: whether to skip the report summary (boolean)
+    #
+    def skip_report_summary=(value)
+      @config.set('library.skip_report_summary', value)
+    end
+
     # Helper method to provide a simple way of performing requests with support
     # for partial failures. Executes a block of code with partial failures
     # enabled and/or returns the current status of the property.

data/lib/adwords_api/api_config.rb

@@ -35,9 +35,9 @@ module AdwordsApi
     end
 
     # Set defaults
-    DEFAULT_VERSION = :v201406
+    DEFAULT_VERSION = :v201409
     DEFAULT_ENVIRONMENT = :PRODUCTION
-    LATEST_VERSION = :v201406
+    LATEST_VERSION = :v201409
 
     # Set other constants
     API_NAME = 'AdwordsApi'
@@ -123,6 +123,45 @@ module AdwordsApi
           :SharedSetService,
           :TargetingIdeaService,
           :TrafficEstimatorService
+      ],
+      :v201409 => [
+          :AdGroupAdService,
+          :AdGroupBidModifierService,
+          :AdGroupCriterionService,
+          :AdGroupFeedService,
+          :AdGroupService,
+          :AdParamService,
+          :AdwordsUserListService,
+          :BiddingStrategyService,
+          :BudgetOrderService,
+          :BudgetService,
+          :CampaignAdExtensionService,
+          :CampaignCriterionService,
+          :CampaignFeedService,
+          :CampaignService,
+          :CampaignSharedSetService,
+          :ConstantDataService,
+          :ConversionTrackerService,
+          :CustomerFeedService,
+          :CustomerService,
+          :CustomerSyncService,
+          :DataService,
+          :ExperimentService,
+          :FeedItemService,
+          :FeedMappingService,
+          :FeedService,
+          :GeoLocationService,
+          :LabelService,
+          :LocationCriterionService,
+          :ManagedCustomerService,
+          :MediaService,
+          :MutateJobService,
+          :OfflineConversionFeedService,
+          :ReportDefinitionService,
+          :SharedCriterionService,
+          :SharedSetService,
+          :TargetingIdeaService,
+          :TrafficEstimatorService
       ]
     }
 
@@ -132,7 +171,8 @@ module AdwordsApi
         :oauth_scope => 'https://www.googleapis.com/auth/adwords',
         :header_ns => 'https://adwords.google.com/api/adwords/cm/',
         :v201402 => 'https://adwords.google.com/api/adwords/',
-        :v201406 => 'https://adwords.google.com/api/adwords/'
+        :v201406 => 'https://adwords.google.com/api/adwords/',
+        :v201409 => 'https://adwords.google.com/api/adwords/'
       }
     }
 
@@ -215,7 +255,45 @@ module AdwordsApi
       [:v201406, :BudgetService] => 'cm/',
       [:v201406, :BiddingStrategyService] => 'cm/',
       [:v201406, :AdwordsUserListService] => 'rm/',
-      [:v201406, :LabelService] => 'cm/'
+      [:v201406, :LabelService] => 'cm/',
+      # v201409
+      [:v201409, :AdGroupAdService] => 'cm/',
+      [:v201409, :AdGroupBidModifierService] => 'cm/',
+      [:v201409, :AdGroupCriterionService] => 'cm/',
+      [:v201409, :AdGroupFeedService] => 'cm/',
+      [:v201409, :AdGroupService] => 'cm/',
+      [:v201409, :AdParamService] => 'cm/',
+      [:v201409, :BudgetOrderService] => 'billing/',
+      [:v201409, :CampaignAdExtensionService] => 'cm/',
+      [:v201409, :CampaignCriterionService] => 'cm/',
+      [:v201409, :CampaignFeedService] => 'cm/',
+      [:v201409, :CampaignService] => 'cm/',
+      [:v201409, :CampaignSharedSetService] => 'cm/',
+      [:v201409, :ConstantDataService] => 'cm/',
+      [:v201409, :ConversionTrackerService] => 'cm/',
+      [:v201409, :CustomerSyncService] => 'ch/',
+      [:v201409, :DataService] => 'cm/',
+      [:v201409, :ExperimentService] => 'cm/',
+      [:v201409, :FeedItemService] => 'cm/',
+      [:v201409, :FeedMappingService] => 'cm/',
+      [:v201409, :FeedService] => 'cm/',
+      [:v201409, :GeoLocationService] => 'cm/',
+      [:v201409, :LocationCriterionService] => 'cm/',
+      [:v201409, :MediaService] => 'cm/',
+      [:v201409, :MutateJobService] => 'cm/',
+      [:v201409, :OfflineConversionFeedService] => 'cm/',
+      [:v201409, :ReportDefinitionService] => 'cm/',
+      [:v201409, :SharedCriterionService] => 'cm/',
+      [:v201409, :SharedSetService] => 'cm/',
+      [:v201409, :TargetingIdeaService] => 'o/',
+      [:v201409, :TrafficEstimatorService] => 'o/',
+      [:v201409, :ManagedCustomerService] => 'mcm/',
+      [:v201409, :CustomerService] => 'mcm/',
+      [:v201409, :CustomerFeedService] => 'cm/',
+      [:v201409, :BudgetService] => 'cm/',
+      [:v201409, :BiddingStrategyService] => 'cm/',
+      [:v201409, :AdwordsUserListService] => 'rm/',
+      [:v201409, :LabelService] => 'cm/'
     }
 
     public