google-adx-buyer-api 0.4.4 → 0.4.5

data/examples/v201109_1/targeting/add_campaign_targeting_criteria.rb

@@ -1,110 +0,0 @@
-#!/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
-
-  # Create operation to add a negative campaign placement.
-  operations << {
-    :operator => 'ADD',
-    :operand => {
-      :xsi_type => 'NegativeCampaignCriterion',
-      :campaign_id => campaign_id,
-      :criterion => {
-        :xsi_type => 'Placement',
-        :url => 'http://mars.google.com'
-      }
-    }
-  }
-
-  response = campaign_criterion_srv.mutate(operations)
-
-  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
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201109_1
-
-  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/v201109_1/targeting/get_campaign_targeting_criteria.rb

@@ -1,104 +0,0 @@
-#!/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', 'PlacementUrl'],
-    :predicates => [
-      {:field => 'CampaignId', :operator => 'EQUALS', :values => [campaign_id]},
-      {
-        :field => 'CriteriaType',
-        :operator => 'EQUALS',
-        :values => ['PLACEMENT']
-      }
-    ],
-    :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 |criterion|
-        placement = criterion[:criterion]
-        puts "Placement with ID %d, type '%s' and URL '%s' was found." %
-            [placement[:id], placement[:type], placement[:url]]
-      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 placements." %
-        [campaign_id, page[:total_num_entries]]
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201109_1
-  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/v201109_1/targeting/get_targetable_languages_and_carriers.rb

@@ -1,82 +0,0 @@
-#!/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()
-
-  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
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201109_1
-
-  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/v201109_1/targeting/lookup_location.rb

@@ -1,103 +0,0 @@
-#!/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'],
-      :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") %
-          [criterion[:search_term], criterion[:location][:location_name],
-           criterion[:location][:criterion_type], criterion[:location][:id],
-           parent_location, criterion[:reach]]
-    end
-  else
-    puts 'No criteria were returned.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201109_1
-
-  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/examples/v201209/reporting/parallel_report_download.rb

@@ -1,159 +0,0 @@
-#!/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 and downloads an Ad Hoc report from a XML report definition.
-
-require 'thread'
-
-require 'adwords_api'
-require 'adwords_api/utils'
-
-def parallel_report_download()
-  # 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')
-
-  # Determine list of customer IDs to retrieve report for. For this example we
-  # will use ServicedAccountService to get all IDs in hierarchy.
-
-  serviced_account_srv = adwords.service(:ServicedAccountService, API_VERSION)
-
-  # Get the account hierarchy for this account.
-  selector = {:enable_paging => false}
-
-  # Run the request at the MCC level.
-  graph = adwords.use_mcc() {serviced_account_srv.get(selector)}
-
-  # Using queue to balance load between threads.
-  queue = Queue.new()
-
-  if graph and graph[:accounts] and !graph[:accounts].empty?
-    graph[:accounts].each {|account| queue << account[:customer_id]}
-  else
-    raise StandardError, 'Can not retrieve any customer ID'
-  end
-
-  # Get report utilities for the version.
-  report_utils = adwords.report_utils(API_VERSION)
-
-  # Define report definition. You can also pass your own XML text as a string.
-  report_definition = {
-    :selector => {
-        :fields => ['CampaignId', 'Id', 'Impressions', 'Clicks', 'Cost'],
-        # Predicates are optional.
-        :predicates => {
-          :field => 'Status',
-          :operator => 'IN',
-          :values => ['ENABLED', 'PAUSED']
-        }
-      },
-      :report_name => 'Custom ADGROUP_PERFORMANCE_REPORT',
-      :report_type => 'ADGROUP_PERFORMANCE_REPORT',
-      :download_format => 'CSV',
-      :date_range_type => 'LAST_7_DAYS',
-      # Enable to get rows with zero impressions.
-      :include_zero_impressions => false
-  }
-
-  puts "Retrieving %d reports with %d threads:" % [queue.size, THREADS]
-
-  reports_succeeded = Queue.new()
-  reports_failed = Queue.new()
-
-  # Creating a mutex to control access to the queue.
-  queue_mutex = Mutex.new
-
-  # Start all the threads.
-  threads = (1..THREADS).map do |thread_id|
-    Thread.new(report_definition) do |local_def|
-      cid = nil
-      begin
-        cid = queue_mutex.synchronize {(queue.empty?) ? nil : queue.pop(true)}
-        if cid
-          retry_count = 0
-          file_name = "adgroup_%010d.csv" % cid
-          puts "[%2d/%d] Loading report for customer ID %s into '%s'..." %
-              [thread_id, retry_count,
-               AdwordsApi::Utils.format_id(cid), file_name]
-          begin
-            report_utils.download_report_as_file(local_def, file_name, cid)
-            reports_succeeded << {:cid => cid, :file_name => file_name}
-          rescue AdwordsApi::Errors::ReportError => e
-            if e.http_code == 500 && retry_count < MAX_RETRIES
-              retry_count += 1
-              sleep(retry_count * BACKOFF_FACTOR)
-              retry
-            else
-              puts(("Report failed for customer ID %s with code %d after %d " +
-                  "retries.") % [cid, e.http_code, retry_count + 1])
-              reports_failed <<
-                {:cid => cid, :http_code => e.http_code, :message => e.message}
-            end
-          end
-        end
-      end while (cid != nil)
-    end
-  end
-
-  # Wait for all threads to finish.
-  threads.each { |aThread|  aThread.join }
-
-  puts 'Download completed, results:'
-  puts 'Successful reports:'
-  while !reports_succeeded.empty? do
-    result = reports_succeeded.pop()
-    puts "\tClient ID %s => '%s'" %
-        [AdwordsApi::Utils.format_id(result[:cid]), result[:file_name]]
-  end
-  puts 'Failed reports:'
-  while !reports_failed.empty? do
-    result = reports_failed.pop()
-    puts "\tClient ID %s => Code: %d, Message: '%s'" %
-        [AdwordsApi::Utils.format_id(result[:cid]),
-         result[:http_code], result[:message]]
-  end
-  puts 'End of results.'
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201209
-  # Number of parallel threads to spawn.
-  THREADS = 10
-  # Maximum number of retries for 500 errors.
-  MAX_RETRIES = 5
-  # Timeout between retries in seconds.
-  BACKOFF_FACTOR = 5
-
-  begin
-    parallel_report_download()
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
-
-  # API errors.
-  rescue AdwordsApi::Errors::ReportError => e
-    puts "Reporting Error: %s" % e.message
-  end
-end