google-adwords-api 0.6.2 → 0.6.3

data/examples/v201206/targeting/add_campaign_targeting_criteria.rb

@@ -0,0 +1,118 @@
+#!/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 adds various types of targeting criteria to a campaign. To get
+# campaigns list, run get_campaigns.rb.
+#
+# Tags: CampaignCriterionService.mutate
+
+require 'adwords_api'
+
+def add_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)
+
+  # Create campaign criteria.
+  campaign_criteria = [
+    # Location criteria. The IDs can be found in the documentation or retrieved
+    # with the LocationCriterionService.
+    {:xsi_type => 'Location', :id => 21137}, # California, USA
+    {:xsi_type => 'Location', :id => 2484},  # Mexico
+    # 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
+  ]
+
+  # Create operations.
+  operations = campaign_criteria.map do |criterion|
+    {:operator => 'ADD',
+     :operand => {
+         :campaign_id => campaign_id,
+         :criterion => criterion}
+    }
+  end
+
+  # Add negative campaign criterion.
+  operations << {
+    :operator => 'ADD',
+    :operand => {
+      # The 'xsi_type' field allows you to specify the xsi:type of the object
+      # being created. It's only necessary when you must provide an explicit
+      # type that the client library can't infer.
+      :xsi_type => 'NegativeCampaignCriterion',
+      :campaign_id => campaign_id,
+      :criterion => {
+        :xsi_type => 'Keyword',
+        :text => 'jupiter cruise',
+        :match_type => 'BROAD'
+      }
+    }
+  }
+
+  response = campaign_criterion_srv.mutate(operations)
+
+  if response and response[:value]
+    criteria = response[:value]
+    criteria.each do |campaign_criterion|
+      criterion = campaign_criterion[:criterion]
+      puts ("Campaign criterion with campaign ID %d, criterion ID %d and " +
+          "type '%s' was added.") % [campaign_criterion[:campaign_id],
+          criterion[:id], criterion[:criterion_type]]
+    end
+  else
+    puts 'No criteria were returned.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201206
+
+  begin
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'
+    add_campaign_targeting_criteria(campaign_id)
+
+  # 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/v201206/targeting/get_campaign_targeting_criteria.rb

@@ -0,0 +1,102 @@
+#!/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 = :v201206
+  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)
+
+  # 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/v201206/targeting/get_targetable_languages_and_carriers.rb

@@ -0,0 +1,86 @@
+#!/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 = :v201206
+
+  begin
+    get_targetable_languages_and_carriers()
+
+  # 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/v201206/targeting/lookup_location.rb

@@ -0,0 +1,104 @@
+#!/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 = :v201206
+
+  begin
+    lookup_location()
+
+  # 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/api_config.rb

@@ -35,9 +35,9 @@ module AdwordsApi
     end
 
     # Set defaults
-    DEFAULT_VERSION = :v201109
+    DEFAULT_VERSION = :v201206
     DEFAULT_ENVIRONMENT = :PRODUCTION
-    LATEST_VERSION = :v201109
+    LATEST_VERSION = :v201206
 
     # Set other constants
     API_NAME = 'AdwordsApi'
@@ -91,12 +91,14 @@ module AdwordsApi
           :ConstantDataService,
           :ConversionTrackerService,
           :CreateAccountService,
+          :CustomerService,
           :CustomerSyncService,
           :DataService,
           :ExperimentService,
           :GeoLocationService,
           :InfoService,
           :LocationCriterionService,
+          :ManagedCustomerService,
           :MediaService,
           :MutateJobService,
           :ReportDefinitionService,
@@ -104,6 +106,35 @@ module AdwordsApi
           :TargetingIdeaService,
           :TrafficEstimatorService,
           :UserListService
+      ],
+      :v201206 => [
+          :AdExtensionOverrideService,
+          :AdGroupAdService,
+          :AdGroupCriterionService,
+          :AdGroupService,
+          :AdParamService,
+          :AlertService,
+          :BudgetOrderService,
+          :BulkMutateJobService,
+          :CampaignAdExtensionService,
+          :CampaignCriterionService,
+          :CampaignService,
+          :ConstantDataService,
+          :ConversionTrackerService,
+          :CustomerService,
+          :CustomerSyncService,
+          :DataService,
+          :ExperimentService,
+          :GeoLocationService,
+          :InfoService,
+          :LocationCriterionService,
+          :ManagedCustomerService,
+          :MediaService,
+          :MutateJobService,
+          :ReportDefinitionService,
+          :TargetingIdeaService,
+          :TrafficEstimatorService,
+          :UserListService
       ]
     }
 
@@ -112,12 +143,14 @@ module AdwordsApi
       :PRODUCTION => {
         :oauth_scope => 'https://adwords.google.com/api/adwords/',
         :v201109 => 'https://adwords.google.com/api/adwords/',
-        :v201109_1 => 'https://adwords.google.com/api/adwords/'
+        :v201109_1 => 'https://adwords.google.com/api/adwords/',
+        :v201206 => 'https://adwords.google.com/api/adwords/'
       },
       :SANDBOX => {
         :oauth_scope => 'https://adwords-sandbox.google.com/api/adwords/',
         :v201109 => 'https://adwords-sandbox.google.com/api/adwords/',
-        :v201109_1 => 'https://adwords-sandbox.google.com/api/adwords/'
+        :v201109_1 => 'https://adwords-sandbox.google.com/api/adwords/',
+        :v201206 => 'https://adwords-sandbox.google.com/api/adwords/'
       }
     }
 
@@ -181,7 +214,38 @@ module AdwordsApi
       [:v201109_1, :ServicedAccountService] => 'mcm/',
       [:v201109_1, :TargetingIdeaService] => 'o/',
       [:v201109_1, :TrafficEstimatorService] => 'o/',
-      [:v201109_1, :UserListService] => 'cm/'
+      [:v201109_1, :UserListService] => 'cm/',
+      [:v201109_1, :ManagedCustomerService] => 'mcm/',
+      [:v201109_1, :CustomerService] => 'mcm/',
+      # v201206
+      [:v201206, :AdExtensionOverrideService] => 'cm/',
+      [:v201206, :AdGroupAdService] => 'cm/',
+      [:v201206, :AdGroupCriterionService] => 'cm/',
+      [:v201206, :AdGroupService] => 'cm/',
+      [:v201206, :AdParamService] => 'cm/',
+      [:v201206, :AlertService] => 'mcm/',
+      [:v201206, :BudgetOrderService] => 'billing/',
+      [:v201206, :BulkMutateJobService] => 'job/',
+      [:v201206, :CampaignAdExtensionService] => 'cm/',
+      [:v201206, :CampaignCriterionService] => 'cm/',
+      [:v201206, :CampaignService] => 'cm/',
+      [:v201206, :ConstantDataService] => 'cm/',
+      [:v201206, :ConversionTrackerService] => 'cm/',
+      [:v201206, :CustomerSyncService] => 'ch/',
+      [:v201206, :DataService] => 'cm/',
+      [:v201206, :ExperimentService] => 'cm/',
+      [:v201206, :GeoLocationService] => 'cm/',
+      [:v201206, :InfoService] => 'info/',
+      [:v201206, :LocationCriterionService] => 'cm/',
+      [:v201206, :MediaService] => 'cm/',
+      [:v201206, :MutateJobService] => 'cm/',
+      [:v201206, :ReportDefinitionService] => 'cm/',
+      [:v201206, :ServicedAccountService] => 'mcm/',
+      [:v201206, :TargetingIdeaService] => 'o/',
+      [:v201206, :TrafficEstimatorService] => 'o/',
+      [:v201206, :UserListService] => 'cm/',
+      [:v201206, :ManagedCustomerService] => 'mcm/',
+      [:v201206, :CustomerService] => 'mcm/'
     }
 
     # Auth constants for ClientLogin method.