google-adx-buyer-api 0.4.1 → 0.4.2

data/examples/v201109_1/targeting/get_campaign_targeting_criteria.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 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

@@ -0,0 +1,82 @@
+#!/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

@@ -0,0 +1,103 @@
+#!/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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: google-adx-buyer-api
 version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: false
+  hash: 11
+  prerelease: 
   segments: 
   - 0
   - 4
-  - 1
-  version: 0.4.1
+  - 2
+  version: 0.4.2
 platform: ruby
 authors: 
 - Danial Klimkin
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-20 00:00:00 +04:00
-default_executable: 
+date: 2012-06-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: google-adwords-api
@@ -26,12 +25,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 9
+        hash: 5
         segments: 
         - 0
-        - 5
+        - 6
         - 1
-        version: 0.5.1
+        version: 0.6.1
   type: :runtime
   version_requirements: *id001
 description: AdWords API and DoubleClick Ad Exchange Buyer API client library for Ruby
@@ -44,6 +43,45 @@ extensions: []
 extra_rdoc_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
+- examples/v201109_1/reporting/get_campaign_stats.rb
+- examples/v201109_1/reporting/parallel_report_download.rb
+- examples/v201109_1/reporting/get_report_fields.rb
+- examples/v201109_1/error_handling/handle_policy_violation_error.rb
+- examples/v201109_1/error_handling/handle_two_factor_authorization_error.rb
+- examples/v201109_1/error_handling/handle_captcha_challenge.rb
+- examples/v201109_1/error_handling/handle_partial_failures.rb
+- examples/v201109_1/targeting/lookup_location.rb
+- examples/v201109_1/targeting/get_targetable_languages_and_carriers.rb
+- examples/v201109_1/targeting/add_campaign_targeting_criteria.rb
+- examples/v201109_1/targeting/get_campaign_targeting_criteria.rb
+- examples/v201109_1/campaign_management/add_placements_in_bulk.rb
+- examples/v201109_1/campaign_management/get_all_disapproved_ads.rb
+- examples/v201109_1/account_management/get_account_changes.rb
+- examples/v201109_1/optimization/get_placement_ideas.rb
+- examples/v201109_1/basic_operations/update_campaign.rb
+- examples/v201109_1/basic_operations/get_thirdparty_redirect_ads.rb
+- examples/v201109_1/basic_operations/get_campaigns.rb
+- examples/v201109_1/basic_operations/get_ad_groups.rb
+- examples/v201109_1/basic_operations/add_campaign.rb
+- examples/v201109_1/basic_operations/add_placements.rb
+- examples/v201109_1/basic_operations/add_ad_group.rb
+- examples/v201109_1/basic_operations/delete_ad_group.rb
+- examples/v201109_1/basic_operations/update_placement.rb
+- examples/v201109_1/basic_operations/delete_ad.rb
+- examples/v201109_1/basic_operations/add_thirdparty_redirect_ad.rb
+- examples/v201109_1/basic_operations/update_ad_group.rb
+- examples/v201109_1/basic_operations/delete_campaign.rb
+- examples/v201109_1/basic_operations/delete_placement.rb
+- examples/v201109_1/basic_operations/pause_ad.rb
+- examples/v201109_1/basic_operations/get_placements.rb
+- examples/v201109_1/misc/upload_image.rb
+- examples/v201109_1/misc/get_all_images_and_videos.rb
+- examples/v201109_1/misc/use_oauth.rb
+- examples/v201109_1/remarketing/add_conversion_tracker.rb
+- examples/v201109_1/remarketing/add_audience.rb
 - examples/v201109/reporting/download_criteria_report.rb
 - examples/v201109/reporting/download_defined_report.rb
 - examples/v201109/reporting/get_defined_reports.rb
@@ -86,7 +124,6 @@ files:
 - COPYING
 - README
 - ChangeLog
-has_rdoc: true
 homepage: http://code.google.com/p/google-api-ads-ruby/
 licenses: []
 
@@ -118,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: google-adx-buyer-api
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby examples for DoubleClick Ad Exchange Buyer API