google-adx-buyer-api 0.4.3 → 0.4.4

data/examples/v201209/targeting/lookup_location.rb

@@ -0,0 +1,104 @@
+#!/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', '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 = :v201209
+
+  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

metadata

@@ -1,40 +1,48 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: google-adx-buyer-api
-version: !ruby/object:Gem::Version
-  version: 0.4.3
+version: !ruby/object:Gem::Version 
+  hash: 7
   prerelease: 
+  segments: 
+  - 0
+  - 4
+  - 4
+  version: 0.4.4
 platform: ruby
-authors:
+authors: 
 - Danial Klimkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-03 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-10-16 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: google-adwords-api
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.3
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.3
-description: AdWords API and DoubleClick Ad Exchange Buyer API client library for
-  Ruby
-email:
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 0
+        - 7
+        - 1
+        version: 0.7.1
+  type: :runtime
+  version_requirements: *id001
+description: AdWords API and DoubleClick Ad Exchange Buyer API client library for Ruby
+email: 
 - api.dklimkin@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - examples/v201109_1/reporting/download_criteria_report.rb
 - examples/v201109_1/reporting/download_defined_report.rb
 - examples/v201109_1/reporting/get_defined_reports.rb
@@ -113,9 +121,44 @@ files:
 - examples/v201109/misc/use_oauth.rb
 - examples/v201109/remarketing/add_conversion_tracker.rb
 - examples/v201109/remarketing/add_audience.rb
+- examples/v201209/reporting/download_criteria_report.rb
+- examples/v201209/reporting/get_campaign_stats.rb
+- examples/v201209/reporting/parallel_report_download.rb
+- examples/v201209/reporting/get_report_fields.rb
+- examples/v201209/error_handling/handle_policy_violation_error.rb
+- examples/v201209/error_handling/handle_two_factor_authorization_error.rb
+- examples/v201209/error_handling/handle_captcha_challenge.rb
+- examples/v201209/error_handling/handle_partial_failures.rb
+- examples/v201209/targeting/lookup_location.rb
+- examples/v201209/targeting/get_targetable_languages_and_carriers.rb
+- examples/v201209/targeting/add_campaign_targeting_criteria.rb
+- examples/v201209/targeting/get_campaign_targeting_criteria.rb
+- examples/v201209/campaign_management/add_placements_in_bulk.rb
+- examples/v201209/campaign_management/get_all_disapproved_ads.rb
+- examples/v201209/account_management/get_account_changes.rb
+- examples/v201209/optimization/get_placement_ideas.rb
+- examples/v201209/basic_operations/update_campaign.rb
+- examples/v201209/basic_operations/get_thirdparty_redirect_ads.rb
+- examples/v201209/basic_operations/get_campaigns.rb
+- examples/v201209/basic_operations/get_ad_groups.rb
+- examples/v201209/basic_operations/add_campaign.rb
+- examples/v201209/basic_operations/add_placements.rb
+- examples/v201209/basic_operations/add_ad_group.rb
+- examples/v201209/basic_operations/delete_ad_group.rb
+- examples/v201209/basic_operations/update_placement.rb
+- examples/v201209/basic_operations/delete_ad.rb
+- examples/v201209/basic_operations/add_thirdparty_redirect_ad.rb
+- examples/v201209/basic_operations/update_ad_group.rb
+- examples/v201209/basic_operations/delete_campaign.rb
+- examples/v201209/basic_operations/delete_placement.rb
+- examples/v201209/basic_operations/pause_ad.rb
+- examples/v201209/basic_operations/get_placements.rb
+- examples/v201209/misc/upload_image.rb
+- examples/v201209/misc/get_all_images_and_videos.rb
+- examples/v201209/misc/use_oauth.rb
+- examples/v201209/remarketing/add_conversion_tracker.rb
+- examples/v201209/remarketing/add_audience.rb
 - examples/v201206/reporting/download_criteria_report.rb
-- examples/v201206/reporting/download_defined_report.rb
-- examples/v201206/reporting/get_defined_reports.rb
 - examples/v201206/reporting/get_campaign_stats.rb
 - examples/v201206/reporting/parallel_report_download.rb
 - examples/v201206/reporting/get_report_fields.rb
@@ -157,26 +200,38 @@ files:
 - ChangeLog
 homepage: http://code.google.com/p/google-api-ads-ruby/
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
       version: 1.3.6
 requirements: []
+
 rubyforge_project: google-adx-buyer-api
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby examples for DoubleClick Ad Exchange Buyer API
 test_files: []
+