google-adx-buyer-api 0.2.0 → 0.4.0

data/examples/v201109/get_bulk_mutate_job.rb

@@ -0,0 +1,106 @@
+#!/usr/bin/ruby
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# 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 a bulk mutate job and prints out its stats information.
+# To add a bulk mutate job, run perform_bulk_mutate_job.rb.
+#
+# Tags: BulkMutateJobService.get
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+def get_all_bulk_mutate_jobs()
+  # 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')
+
+  bulk_mutate_job_srv = adwords.service(:BulkMutateJobService, API_VERSION)
+
+  # Replace with valid values of your account.
+  bulk_mutate_job_id = "INSERT_BULK_MUTATE_JOB_ID_HERE"
+
+  # Get all the bulk mutate jobs.
+  selector = {
+    :include_stats => true,
+    :job_ids => [bulk_mutate_job_id]
+  }
+  jobs = bulk_mutate_job_srv.get(selector)
+
+  if jobs
+    jobs.each do |job|
+      puts "Bulk mutate job with id %d and status '%s' was found." %
+          [job[:id], job[:status]]
+
+      case job[:status]
+      when 'PENDING'
+        puts "  Total parts: %d, parts received: %d." %
+            [job[:num_request_parts], job[:num_request_parts_received]]
+      when 'PROCESSING'
+        if job[:stats]
+          puts "  Percent complete: %d." % job[:stats][:progress_percent]
+        end
+      when 'COMPLETED'
+        if job[:stats]
+          puts "  Total operations: %d, failed: %d, unprocessed %d." %
+              [job[:stats][:num_operations],
+               job[:stats][:num_failed_operations],
+               job[:stats][:num_unprocessed_operations]]
+        end
+      end
+    end
+  else
+    puts "No bulk mutate jobs were found."
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_bulk_mutate_jobs()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts 'API Exception caught.'
+    puts 'Message: %s' % e.message
+    puts 'Code: %d' % e.code if e.code
+    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts 'Errors:'
+    if e.errors
+      e.errors.each_with_index do |error, index|
+        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
+        error.each_pair do |field, value|
+          if field != :xsi_type
+            puts '     %s: %s' % [field, value]
+          end
+        end
+      end
+    end
+  end
+end

data/examples/v201109/get_campaign_alerts.rb

@@ -0,0 +1,103 @@
+#!/usr/bin/ruby
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# 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 code example illustrates how to retrieve campaign alerts for a user.
+# The alerts are restricted to a maximum of 10 entries.
+#
+# Tags: AlertService.get
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+def get_campaign_alerts()
+  # 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')
+
+  alert_srv = adwords.service(:AlertService, API_VERSION)
+
+  # Create the selector.
+  selector = {
+    :query => {
+      :filter_spec => 'ALL',
+      :client_spec => 'ALL',
+      :trigger_time_spec => 'ALL_TIME',
+      :severities => ['GREEN', 'YELLOW', 'RED'],
+      :types => ['CAMPAIGN_ENDING', 'CAMPAIGN_ENDED']
+    },
+    :paging => {
+      :start_index => 0,
+      :number_results => 10
+    }
+  }
+
+  # Get alerts.
+  response = alert_srv.get(selector)
+
+  if response and response[:entries]
+    alerts = response[:entries]
+    alerts.each_with_index do |alert, index|
+      puts "{index}) Customer Id is " +
+          "#{AdwordsApi::Utils.format_id(alert[:client_customer_id])}, " +
+          "alert type is '#{alert[:alert_type]}', severity is " +
+          "#{alert[:alert_severity]}."
+      alert[:details].each do |detail|
+        puts "  - triggered at #{detail[:trigger_time]}"
+      end
+    end
+  else
+    puts "No alerts were found."
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_campaign_alerts()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts 'API Exception caught.'
+    puts 'Message: %s' % e.message
+    puts 'Code: %d' % e.code if e.code
+    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts 'Errors:'
+    if e.errors
+      e.errors.each_with_index do |error, index|
+        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
+        error.each_pair do |field, value|
+          if field != :xsi_type
+            puts '     %s: %s' % [field, value]
+          end
+        end
+      end
+    end
+  end
+end

data/examples/v201109/get_client_customer_id.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/ruby
+#
+# 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 find a client customer ID for a client email.
+# We recommend to use this script as a one off to convert your identifiers to
+# IDs and store them for future use.
+#
+# Tags: InfoService.get
+
+require 'rubygems'
+require 'adwords_api'
+require 'adwords_api/utils'
+
+API_VERSION = :v201109
+
+def get_client_customer_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')
+
+  info_srv = adwords.service(:InfoService, API_VERSION)
+
+  # Email address to find ID for.
+  client_email = 'INSERT_EMAIL_ADDRESS_HERE'
+
+  today = Time.new.strftime('%Y%m%d')
+
+  selector = {
+    :client_emails => [client_email],
+    :api_usage_type => 'UNIT_COUNT_FOR_CLIENTS',
+    :include_sub_accounts => true,
+    :date_range => {:min => today, :max => today}
+  }
+
+  # Get the information for client email address.
+  info = adwords.use_mcc() {info_srv.get(selector)}
+
+  if info and info[:api_usage_records]
+    api_usage_records = info[:api_usage_records]
+    api_usage_records.each do |record|
+      puts "Found record with client email '%s' and ID %s." %
+          [record[:client_email],
+           AdwordsApi::Utils.format_id(record[:client_customer_id])]
+    end
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_client_customer_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/get_criterion_bid_landscape.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/ruby
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# 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 a bid landscapes for a criterion. To get criteria, run
+# get_all_ad_group_criteria.rb.
+#
+# Tags: DataService.getCriterionBidLandscape
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+def get_criterion_bid_landscapes()
+  # 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')
+
+  data_srv = adwords.service(:DataService, API_VERSION)
+
+  ad_group_id = 'INSERT_ADGROUP_ID_HERE'.to_i
+  criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
+
+  # Get criterion bid landscape.
+  selector = {
+    :fields => ["AdGroupId", "CriterionId", "StartDate", "EndDate", "Bid",
+        "LocalClicks", "LocalCost", "MarginalCpc", "LocalImpressions"],
+    :predicates => [
+      {:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]},
+      {:field => 'CriterionId', :operator => 'IN', :values => [criterion_id]},
+    ]
+  }
+  page = data_srv.get_criterion_bid_landscape(selector)
+  if page and page[:entries]
+    puts "#{page[:entries].length} bid landscape(s) retrieved."
+    page[:entries].each do |bid_landscape|
+      puts "Retrieved criterion bid landscape with ad group id " +
+          "'#{bid_landscape[:ad_group_id]}', criterion id " +
+          "'#{bid_landscape[:criterion_id]}', start date " +
+          "'#{bid_landscape[:start_date]}', end date "+
+          "'#{bid_landscape[:end_date]}', with landscape points:"
+      bid_landscape[:landscape_points].each do |point|
+        puts "  #{point[:bid][:micro_amount]} => clicks: #{point.clicks}, " +
+            "cost: #{point[:cost][:micro_amount]}, marginalCpc: " +
+            "#{point[:marginal_cpc][:micro_amount]}, impressions: " +
+            "#{point[:impressions]}"
+      end
+    end
+  else
+    puts "No bid landscapes retrieved."
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_criterion_bid_landscapes()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts 'API Exception caught.'
+    puts 'Message: %s' % e.message
+    puts 'Code: %d' % e.code if e.code
+    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts 'Errors:'
+    if e.errors
+      e.errors.each_with_index do |error, index|
+        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
+        error.each_pair do |field, value|
+          if field != :xsi_type
+            puts '     %s: %s' % [field, value]
+          end
+        end
+      end
+    end
+  end
+end

data/examples/v201109/get_geo_location_info.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/ruby
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# 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 geo location information for
+# addresses.
+#
+# Tags: GeoLocationService.get
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+def get_geo_location_info()
+  # 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')
+
+  geo_location_srv = adwords.service(:GeoLocationService, API_VERSION)
+
+  selector = {
+    :addresses => [
+      {
+        :street_address => '1600 Amphitheatre Parkway',
+        :city_name => 'Mountain View',
+        :province_code => 'US-CA',
+        :province_name => 'California',
+        :postal_code => '94043',
+        :country_code => 'US'
+      },
+      {
+        :street_address => '76 Ninth Avenue',
+        :city_name => 'New York',
+        :province_code => 'US-NY',
+        :province_name => 'New York',
+        :postal_code => '10011',
+        :country_code => 'US'
+      },
+      {
+        :street_address => '五四大街1号, Beijing东城区',
+        :country_code => 'CN'
+      }
+    ]
+  }
+
+  # Get the geo location info for the various addresses.
+  locations = geo_location_srv.get(selector)
+
+  if locations
+    locations.each do |location|
+      puts "Address \"#{location[:address][:street_address]}\" has latitude " +
+          "#{location[:geo_point][:latitude_in_micro_degrees]} and " +
+          "longitude #{location[:geo_point][:longitude_in_micro_degrees]}."
+    end
+  else
+    puts "No geo locations were returned."
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_geo_location_info()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts 'API Exception caught.'
+    puts 'Message: %s' % e.message
+    puts 'Code: %d' % e.code if e.code
+    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts 'Errors:'
+    if e.errors
+      e.errors.each_with_index do |error, index|
+        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
+        error.each_pair do |field, value|
+          if field != :xsi_type
+            puts '     %s: %s' % [field, value]
+          end
+        end
+      end
+    end
+  end
+end