google-adwords-api 0.4.5 → 0.5.0

data/examples/v201003/get_conversion_optimizer_eligibility.rb

@@ -1,103 +0,0 @@
-#!/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 shows how to check for conversion optimizer eligibility by
-# attempting to set the bidding transition with the validate only header set to
-# true.
-#
-# Tags: CampaignService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201003
-
-def get_conversion_optimizer_eligibility()
-  # 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_srv = adwords.service(:CampaignService, API_VERSION)
-
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-  # Enable 'validate only'
-  adwords.validate_only = true
-
-  # Prepare for "updating" campaign.
-  operation = {
-    :operator => 'SET',
-    :operand => {
-      :id => campaign_id
-    },
-    # Bidding transition.
-    :bidding_transition => {
-      :xsi_type => 'ConversionOptimizerBiddingTransition',
-      :target_bidding_strategy => {
-        :xsi_type => 'ConversionOptimizer',
-        :pricing_model => 'CONVERSIONS'
-      },
-      # Ad group bids.
-      :explicit_ad_group_bids => {
-        :xsi_type => 'ConversionOptimizerAdGroupBids'
-      }
-    }
-  }
-
-  # Check that campaign is eligible for conversion optimization.
-  begin
-    response = campaign_srv.mutate([operation])
-    puts 'Campaign id %d is eligible to use conversion optimizer.' %
-        campaign[:id]
-  rescue AdwordsApi::Errors::ApiException => e
-    errors = e.errors
-    error = errors.find { |err| err[:xsi_type] == 'BiddingTransitionError'}
-    if error
-      puts "Campaign id #{campaign_id} is not eligible to use conversion " +
-          "optimizer due to reason: #{error[:reason]}"
-    else
-      raise e
-    end
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_conversion_optimizer_eligibility()
-
-  # 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/v201003/get_criterion_bid_landscape.rb

@@ -1,96 +0,0 @@
-#!/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 landscape for an ad group and a criterion. To get ad
-# groups, run get_all_ad_groups.rb. To get criteria, run
-# get_all_ad_group_criteria.rb.
-#
-# Tags: BidLandscapeService.getBidLandscape
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201003
-
-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')
-
-  bid_landscape_srv = adwords.service(:BidLandscapeService, API_VERSION)
-
-  ad_group_id = 'INSERT_ADGROUP_ID_HERE'.to_i
-  criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
-
-  # Get criterion bid landscape.
-  selector = {
-    # 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 => 'CriterionBidLandscapeSelector',
-    :id_filters => [{
-      :ad_group_id => ad_group_id,
-      :criterion_id => criterion_id
-    }]
-  }
-  bid_landscapes = bid_landscape_srv.get_bid_landscape(selector)
-  if bid_landscapes
-    puts "#{bid_landscapes.length} bid landscape(s) retrieved."
-    bid_landscapes.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()
-
-  # 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/v201003/get_geo_location_info.rb

@@ -1,99 +0,0 @@
-#!/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'
-require 'adwords_api'
-
-API_VERSION = :v201003
-
-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()
-
-  # 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/v201003/get_method_cost.rb

@@ -1,87 +0,0 @@
-#!/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 the cost, in API units of operation,
-# of the given method, on a specified date.
-#
-# Tags: InfoService.get
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201003
-
-def get_method_cost()
-  # 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)
-
-  date = Time.now
-  service_name = 'AdGroupService'
-  method_name = 'mutate'
-  operator = 'SET'
-
-  selector = {
-    :api_usage_type => 'METHOD_COST',
-    :service_name => service_name,
-    :method_name => method_name,
-    :operator => operator,
-    :date_range => {
-      :min => date.strftime('%Y%m%d'),
-      :max => date.strftime('%Y%m%d')
-    }
-  }
-
-  # Get the unit info.
-  adwords.use_mcc do
-    info = info_srv.get(selector)
-    if info
-      puts 'The cost of the %s.%s %s method during %s is %d.' %
-          [service_name, method_name, operator, selector[:date_range][:min],
-           info[:cost]]
-    end
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_method_cost()
-
-  # 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/v201003/get_operation_count.rb

@@ -1,79 +0,0 @@
-#!/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 the number of operations recorded for
-# the developer token being used to make this call over the given date range.
-#
-# Tags: InfoService.get
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201003
-
-def get_operation_count()
-  # 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)
-
-  selector = {
-    :api_usage_type => 'OPERATION_COUNT',
-    :date_range => {
-      :min => Time.now.strftime('%Y%m01'),
-      :max => Time.now.strftime('%Y%m%d')
-    }
-  }
-
-  # Get the operation info.
-  adwords.use_mcc do
-    info = info_srv.get(selector)
-    if info
-      puts 'The total number of operations performed from %s to %s is %d.' %
-          [selector[:date_range][:min], selector[:date_range][:max],
-          info[:cost]]
-    end
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_operation_count()
-
-  # 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