google-adwords-api 0.18.0 → 0.18.1

data/examples/v201601/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 = :v201601
+  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/v201601/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 = :v201601
+
+  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/v201601/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 = :v201601
+
+  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/api_config.rb

@@ -33,9 +33,9 @@ module AdwordsApi
     end
 
     # Set defaults
-    DEFAULT_VERSION = :v201509
+    DEFAULT_VERSION = :v201601
     DEFAULT_ENVIRONMENT = :PRODUCTION
-    LATEST_VERSION = :v201509
+    LATEST_VERSION = :v201601
 
     # Set other constants
     API_NAME = 'AdwordsApi'
@@ -128,6 +128,49 @@ module AdwordsApi
           :SharedSetService,
           :TargetingIdeaService,
           :TrafficEstimatorService
+      ],
+      :v201601 => [
+          :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,
+          :ExperimentService,
+          :FeedItemService,
+          :FeedMappingService,
+          :FeedService,
+          :LabelService,
+          :LocationCriterionService,
+          :ManagedCustomerService,
+          :MediaService,
+          :MutateJobService,
+          :OfflineConversionFeedService,
+          :ReportDefinitionService,
+          :SharedCriterionService,
+          :SharedSetService,
+          :TargetingIdeaService,
+          :TrafficEstimatorService
       ]
     }
 
@@ -137,7 +180,8 @@ module AdwordsApi
         :oauth_scope => 'https://www.googleapis.com/auth/adwords',
         :header_ns => 'https://adwords.google.com/api/adwords/cm/',
         :v201506 => 'https://adwords.google.com/api/adwords/',
-        :v201509 => 'https://adwords.google.com/api/adwords/'
+        :v201509 => 'https://adwords.google.com/api/adwords/',
+        :v201601 => 'https://adwords.google.com/api/adwords/'
       }
     }
 
@@ -227,7 +271,49 @@ module AdwordsApi
       [:v201509, :BudgetService] => 'cm/',
       [:v201509, :BiddingStrategyService] => 'cm/',
       [:v201509, :AdwordsUserListService] => 'rm/',
-      [:v201509, :LabelService] => 'cm/'
+      [:v201509, :LabelService] => 'cm/',
+      # v201601
+      [:v201601, :AccountLabelService] => 'mcm/',
+      [:v201601, :AdCustomizerFeedService] => 'cm/',
+      [:v201601, :AdGroupAdService] => 'cm/',
+      [:v201601, :AdGroupBidModifierService] => 'cm/',
+      [:v201601, :AdGroupCriterionService] => 'cm/',
+      [:v201601, :AdGroupExtensionSettingService] => 'cm/',
+      [:v201601, :AdGroupFeedService] => 'cm/',
+      [:v201601, :AdGroupService] => 'cm/',
+      [:v201601, :AdParamService] => 'cm/',
+      [:v201601, :BatchJobService] => 'cm/',
+      [:v201601, :BudgetOrderService] => 'billing/',
+      [:v201601, :CampaignCriterionService] => 'cm/',
+      [:v201601, :CampaignExtensionSettingService] => 'cm/',
+      [:v201601, :CampaignFeedService] => 'cm/',
+      [:v201601, :CampaignService] => 'cm/',
+      [:v201601, :CampaignSharedSetService] => 'cm/',
+      [:v201601, :ConstantDataService] => 'cm/',
+      [:v201601, :ConversionTrackerService] => 'cm/',
+      [:v201601, :CustomerExtensionSettingService] => 'cm/',
+      [:v201601, :CustomerSyncService] => 'ch/',
+      [:v201601, :DataService] => 'cm/',
+      [:v201601, :ExperimentService] => 'cm/',
+      [:v201601, :FeedItemService] => 'cm/',
+      [:v201601, :FeedMappingService] => 'cm/',
+      [:v201601, :FeedService] => 'cm/',
+      [:v201601, :LocationCriterionService] => 'cm/',
+      [:v201601, :MediaService] => 'cm/',
+      [:v201601, :MutateJobService] => 'cm/',
+      [:v201601, :OfflineConversionFeedService] => 'cm/',
+      [:v201601, :ReportDefinitionService] => 'cm/',
+      [:v201601, :SharedCriterionService] => 'cm/',
+      [:v201601, :SharedSetService] => 'cm/',
+      [:v201601, :TargetingIdeaService] => 'o/',
+      [:v201601, :TrafficEstimatorService] => 'o/',
+      [:v201601, :ManagedCustomerService] => 'mcm/',
+      [:v201601, :CustomerService] => 'mcm/',
+      [:v201601, :CustomerFeedService] => 'cm/',
+      [:v201601, :BudgetService] => 'cm/',
+      [:v201601, :BiddingStrategyService] => 'cm/',
+      [:v201601, :AdwordsUserListService] => 'rm/',
+      [:v201601, :LabelService] => 'cm/'
     }
 
     public

data/lib/adwords_api/batch_job_utils.rb

@@ -44,23 +44,22 @@ module AdwordsApi
     #   posting them to the provided URL
     # - service_name: The name of the AdwordsApi service as a symbol that would
     #   normally make this request
-    # - batch_job_url: The URL provided by BatchjobService to post the provided
-    #   operations to
+    # - batch_job_url: The UploadURL provided by BatchJobService
     #
     # Raises:
     # - InvalidBatchJobOperationError: If there is a problem converting the
     # given operations to SOAP.
     #
     def upload_operations(operations, batch_job_url)
-      soap_operations = generate_soap_operations(operations)
-      post_soap_operations(soap_operations, batch_job_url)
+      helper = start_incremental_upload(batch_job_url)
+      helper.upload(operations, true)
     end
 
     # Provides a helper to manage incremental uploads.
     #
     # Args:
-    # - batch_job_url: The URL provided by BatchJobService to put the provided
-    # operations to.
+    # - batch_job_url: The UploadURL provided by BatchJobService for new jobs,
+    # or the upload_url from IncrementalUploadHelper for continued jobs.
     # - uploaded_bytes: The number of bytes already uploaded for this
     # incremental batch job. Can be retrieved from the IncrementalUploadHelper
     # using uploaded_bytes.
@@ -74,14 +73,36 @@ module AdwordsApi
           self, uploaded_bytes, batch_job_url)
     end
 
+    # Initializes an upload URL to get the actual URL to which to upload
+    # operations.
+    #
+    # Args:
+    # - batch_job_url: The UploadURL provided by BatchJobService
+    #
+    # Returns:
+    # - The URL that should actually be used to upload operations.
+    #
+    def initialize_url(batch_job_url)
+      # Initialization is only necessary for v201601 or higher.
+      return batch_job_url if [:v201506, :v201509].include?(@version)
+
+      headers = DEFAULT_HEADERS
+      headers['Content-Length'] = 0
+      headers['x-goog-resumable'] = 'start'
+
+      response = AdsCommon::Http.post_response(
+          batch_job_url, '', @api.config, headers)
+
+      return response.headers['Location']
+    end
+
     # Puts the provided operations to the provided URL, allowing
     # for incremental followup puts.
     #
     # Args:
     # - soap_operations: An array including SOAP operations provided by
     #   generate_soap_operations
-    # - batch_job_url: The URL provided by BatchJobService to post the provided
-    #   operations to
+    # - batch_job_url: The UploadURL provided by BatchJobService
     # - total_content_length: The total number of bytes already uploaded
     #   incrementally. Set this to 0 the first time you call the method.
     # - is_last_request: Whether or not this set of uploads will conclude the
@@ -217,15 +238,6 @@ module AdwordsApi
       end
     end
 
-    def post_soap_operations(soap_operations, batch_job_url)
-      headers = DEFAULT_HEADERS
-      request_body = (UPLOAD_XML_PREFIX % [@version]) + soap_operations.join +
-          UPLOAD_XML_SUFFIX
-      log_request(batch_job_url, headers, request_body)
-      response = AdsCommon::Http.post_response(
-          batch_job_url, request_body, @api.config, headers)
-    end
-
     # Given a full SOAP xml string, extract just the operations element
     # from the SOAP body as a string.
     def extract_soap_operations(full_soap_xml)