google-adwords-api 0.18.1 → 0.18.3

data/examples/v201603/targeting/add_demographic_targeting_criteria.rb

@@ -0,0 +1,112 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Copyright:: Copyright 2012, 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 demographic criteria to an ad group. To get ad groups list,
+# run get_ad_groups.rb.
+
+require 'adwords_api'
+
+def add_demographic_targeting_criteria(ad_group_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')
+
+  ad_group_criterion_srv =
+      adwords.service(:AdGroupCriterionService, API_VERSION)
+
+  # Create ad group criteria.
+  ad_group_criteria = [
+    # Targeting criterion.
+    {
+      :xsi_type => 'BiddableAdGroupCriterion',
+      :ad_group_id => ad_group_id,
+      :criterion => {
+        :xsi_type => 'Gender',
+        # See system codes section for IDs:
+        # https://developers.google.com/adwords/api/docs/appendix/genders
+        :id => 11
+      }
+    },
+    # Exclusion criterion.
+    {
+      :xsi_type => 'NegativeAdGroupCriterion',
+      :ad_group_id => ad_group_id,
+      :criterion => {
+        :xsi_type => 'AgeRange',
+        # See system codes section for IDs:
+        # https://developers.google.com/adwords/api/docs/appendix/ages
+        :id => 503999
+      }
+    }
+  ]
+
+  # Create operations.
+  operations = ad_group_criteria.map do |criterion|
+    {:operator => 'ADD', :operand => criterion}
+  end
+
+  response = ad_group_criterion_srv.mutate(operations)
+
+  if response and response[:value]
+    criteria = response[:value]
+    criteria.each do |ad_group_criterion|
+      criterion = ad_group_criterion[:criterion]
+      puts ("Ad group criterion with ad group ID %d, criterion ID %d and " +
+          "type '%s' was added.") % [ad_group_criterion[:ad_group_id],
+          criterion[:id], criterion[:criterion_type]]
+    end
+  else
+    puts 'No criteria were returned.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201603
+
+  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  " +
+        'https://github.com/googleads/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/v201603/targeting/get_campaign_targeting_criteria.rb

@@ -0,0 +1,106 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# 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.
+
+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 = :v201603
+  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  " +
+        'https://github.com/googleads/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/v201603/targeting/get_targetable_languages_and_carriers.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# 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.
+
+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 = :v201603
+
+  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  " +
+        'https://github.com/googleads/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/v201603/targeting/lookup_location.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# 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.
+
+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 = :v201603
+
+  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  " +
+        'https://github.com/googleads/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

@@ -24,6 +24,7 @@ require 'adwords_api/credential_handler'
 require 'adwords_api/errors'
 require 'adwords_api/report_utils'
 require 'adwords_api/batch_job_utils'
+require 'adwords_api/utils_reporter'
 
 # Main namespace for all the client library's modules and classes.
 module AdwordsApi
@@ -34,10 +35,13 @@ module AdwordsApi
   #
   class Api < AdsCommon::Api
 
+    attr_reader :utils_reporter
+
     # Constructor for API.
     def initialize(provided_config = nil)
       super(provided_config)
       @credential_handler = AdwordsApi::CredentialHandler.new(@config)
+      @utils_reporter = AdwordsApi::UtilsReporter.new(@credential_handler)
     end
 
     # Getter for the API service configurations

data/lib/adwords_api/api_config.rb

@@ -33,9 +33,9 @@ module AdwordsApi
     end
 
     # Set defaults
-    DEFAULT_VERSION = :v201601
+    DEFAULT_VERSION = :v201603
     DEFAULT_ENVIRONMENT = :PRODUCTION
-    LATEST_VERSION = :v201601
+    LATEST_VERSION = :v201603
 
     # Set other constants
     API_NAME = 'AdwordsApi'
@@ -171,6 +171,52 @@ module AdwordsApi
           :SharedSetService,
           :TargetingIdeaService,
           :TrafficEstimatorService
+      ],
+      :v201603 => [
+          :AccountLabelService,
+          :AdCustomizerFeedService,
+          :AdGroupAdService,
+          :AdGroupBidModifierService,
+          :AdGroupCriterionService,
+          :AdGroupExtensionSettingService,
+          :AdGroupFeedService,
+          :AdGroupService,
+          :AdParamService,
+          :AdwordsUserListService,
+          :BatchJobService,
+          :BiddingStrategyService,
+          :BudgetOrderService,
+          :BudgetService,
+          :CampaignCriterionService,
+          :CampaignExtensionSettingService,
+          :CampaignFeedService,
+          :CampaignService,
+          :CampaignSharedSetService,
+          :ConstantDataService,
+          :ConversionTrackerService,
+          :CustomerExtensionSettingService,
+          :CustomerFeedService,
+          :CustomerService,
+          :CustomerSyncService,
+          :DataService,
+          :DraftService,
+          :DraftAsyncErrorService,
+          :ExperimentService,
+          :FeedItemService,
+          :FeedMappingService,
+          :FeedService,
+          :LabelService,
+          :LocationCriterionService,
+          :ManagedCustomerService,
+          :MediaService,
+          :OfflineConversionFeedService,
+          :ReportDefinitionService,
+          :SharedCriterionService,
+          :SharedSetService,
+          :TargetingIdeaService,
+          :TrafficEstimatorService,
+          :TrialService,
+          :TrialAsyncErrorService
       ]
     }
 
@@ -181,7 +227,8 @@ module AdwordsApi
         :header_ns => 'https://adwords.google.com/api/adwords/cm/',
         :v201506 => 'https://adwords.google.com/api/adwords/',
         :v201509 => 'https://adwords.google.com/api/adwords/',
-        :v201601 => 'https://adwords.google.com/api/adwords/'
+        :v201601 => 'https://adwords.google.com/api/adwords/',
+        :v201603 => 'https://adwords.google.com/api/adwords/'
       }
     }
 
@@ -313,7 +360,52 @@ module AdwordsApi
       [:v201601, :BudgetService] => 'cm/',
       [:v201601, :BiddingStrategyService] => 'cm/',
       [:v201601, :AdwordsUserListService] => 'rm/',
-      [:v201601, :LabelService] => 'cm/'
+      [:v201601, :LabelService] => 'cm/',
+      # v201603
+      [:v201603, :AccountLabelService] => 'mcm/',
+      [:v201603, :AdCustomizerFeedService] => 'cm/',
+      [:v201603, :AdGroupAdService] => 'cm/',
+      [:v201603, :AdGroupBidModifierService] => 'cm/',
+      [:v201603, :AdGroupCriterionService] => 'cm/',
+      [:v201603, :AdGroupExtensionSettingService] => 'cm/',
+      [:v201603, :AdGroupFeedService] => 'cm/',
+      [:v201603, :AdGroupService] => 'cm/',
+      [:v201603, :AdParamService] => 'cm/',
+      [:v201603, :BatchJobService] => 'cm/',
+      [:v201603, :BudgetOrderService] => 'billing/',
+      [:v201603, :CampaignCriterionService] => 'cm/',
+      [:v201603, :CampaignExtensionSettingService] => 'cm/',
+      [:v201603, :CampaignFeedService] => 'cm/',
+      [:v201603, :CampaignService] => 'cm/',
+      [:v201603, :CampaignSharedSetService] => 'cm/',
+      [:v201603, :ConstantDataService] => 'cm/',
+      [:v201603, :ConversionTrackerService] => 'cm/',
+      [:v201603, :CustomerExtensionSettingService] => 'cm/',
+      [:v201603, :CustomerSyncService] => 'ch/',
+      [:v201603, :DataService] => 'cm/',
+      [:v201603, :ExperimentService] => 'cm/',
+      [:v201603, :FeedItemService] => 'cm/',
+      [:v201603, :FeedMappingService] => 'cm/',
+      [:v201603, :FeedService] => 'cm/',
+      [:v201603, :LocationCriterionService] => 'cm/',
+      [:v201603, :MediaService] => 'cm/',
+      [:v201603, :OfflineConversionFeedService] => 'cm/',
+      [:v201603, :ReportDefinitionService] => 'cm/',
+      [:v201603, :SharedCriterionService] => 'cm/',
+      [:v201603, :SharedSetService] => 'cm/',
+      [:v201603, :TargetingIdeaService] => 'o/',
+      [:v201603, :TrafficEstimatorService] => 'o/',
+      [:v201603, :ManagedCustomerService] => 'mcm/',
+      [:v201603, :CustomerService] => 'mcm/',
+      [:v201603, :CustomerFeedService] => 'cm/',
+      [:v201603, :BudgetService] => 'cm/',
+      [:v201603, :BiddingStrategyService] => 'cm/',
+      [:v201603, :AdwordsUserListService] => 'rm/',
+      [:v201603, :LabelService] => 'cm/',
+      [:v201603, :DraftService] => 'cm/',
+      [:v201603, :DraftAsyncErrorService] => 'cm/',
+      [:v201603, :TrialService] => 'cm/',
+      [:v201603, :TrialAsyncErrorService] => 'cm/'
     }
 
     public