google-adx-buyer-api 0.4.0 → 0.4.1

data/examples/v201109/{add_campaign_targeting_criteria.rb → targeting/add_campaign_targeting_criteria.rb}

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -18,16 +19,13 @@
 #           limitations under the License.
 #
 # This example adds various types of targeting criteria to a campaign. To get
-# campaigns list, run get_all_campaigns.rb.
+# campaigns list, run get_campaigns.rb.
 #
 # Tags: CampaignCriterionService.mutate
 
-require 'rubygems'
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def get_location_criteria()
+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
@@ -39,8 +37,6 @@ def get_location_criteria()
   campaign_criterion_srv =
       adwords.service(:CampaignCriterionService, API_VERSION)
 
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'
-
   # Create campaign criteria.
   campaign_criteria = [
     # Location criteria. The IDs can be found in the documentation or retrieved
@@ -65,24 +61,36 @@ def get_location_criteria()
     }
   end
 
+  # Create operation to add a placement.
+  operations << {
+    :operator => 'ADD',
+    :operand => {
+      :xsi_type => 'CampaignCriterion',
+      :campaign_id => campaign_id,
+      :criterion => {
+        :xsi_type => 'Placement',
+        :url => 'http://mars.google.com'
+      }
+    }
+  }
+
   response = campaign_criterion_srv.mutate(operations)
 
-  if response and response[:value]
-    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
-  else
-    puts 'No criteria were returned.'
+  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
+
   begin
-    get_location_criteria()
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'
+    add_campaign_targeting_criteria(campaign_id)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/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
+  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/{get_all_languages.rb → targeting/get_targetable_languages_and_carriers.rb}

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -17,17 +18,15 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example illustrates how to retrieve all languages available for
-# targeting.
+# This example illustrates how to retrieve all languages and carriers available
+# for targeting.
 #
 # Tags: ConstantDataService.getLanguageCriterion
+# Tags: ConstantDataService.getCarrierCriterion
 
-require 'rubygems'
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def get_all_languages()
+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
@@ -47,13 +46,23 @@ def get_all_languages()
           [language[:name], language[:id], language[:code]]
     end
   else
-    puts "No languages were found."
+    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
+
   begin
-    get_all_languages()
+    get_targetable_languages_and_carriers()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/{get_location_criteria.rb → targeting/lookup_location.rb}

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -21,12 +22,9 @@
 #
 # Tags: LocationCriterionService.get
 
-require 'rubygems'
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def get_location_criteria()
+def lookup_location()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -53,7 +51,7 @@ def get_location_criteria()
            :operator => 'IN',
            :values => location_names},
           # Set the locale of the returned location names.
-          {:field => 'Locale', :operator => 'EQUALS', :values => locale}
+          {:field => 'Locale', :operator => 'EQUALS', :values => [locale]}
     ]
   }
   criteria = location_criterion_srv.get(selector)
@@ -82,8 +80,10 @@ def get_location_criteria()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    get_location_criteria()
+    lookup_location()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: google-adx-buyer-api
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Danial Klimkin
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-27 00:00:00 +04:00
+date: 2012-03-20 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,199 +26,65 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 9
         segments: 
         - 0
-        - 4
+        - 5
         - 1
-        version: 0.4.1
+        version: 0.5.1
   type: :runtime
   version_requirements: *id001
-description: google-adx-buyer-api is a DoubleClick Ad Exchange API Buyer API client library for Ruby
-email: api.dklimkin@gmail.com
+description: AdWords API and DoubleClick Ad Exchange Buyer API client library for Ruby
+email: 
+- api.dklimkin@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README
-- COPYING
-- ChangeLog
+extra_rdoc_files: []
+
 files: 
-- examples/v201003/get_all_ad_group_criteria.rb
-- examples/v201003/delete_ad.rb
-- examples/v201003/add_negative_campaign_criterion.rb
-- examples/v201003/get_criterion_bid_landscape.rb
-- examples/v201003/get_all_disapproved_ads.rb
-- examples/v201003/get_all_active_ad_group_criteria.rb
-- examples/v201003/add_ad_group.rb
-- examples/v201003/update_ad.rb
-- examples/v201003/get_geo_location_info.rb
-- examples/v201003/delete_ad_group.rb
-- examples/v201003/set_campaign_targets.rb
-- examples/v201003/download_report.rb
-- examples/v201003/get_all_images.rb
-- examples/v201003/check_campaigns.rb
-- examples/v201003/get_all_ads.rb
-- examples/v201003/get_all_report_definitions.rb
-- examples/v201003/get_all_campaigns.rb
-- examples/v201003/upload_image.rb
-- examples/v201003/update_ad_group_criterion.rb
-- examples/v201003/update_ad_group.rb
-- examples/v201003/add_placement_performance_report_definition.rb
-- examples/v201003/get_related_placements.rb
-- examples/v201003/get_all_paused_campaigns.rb
-- examples/v201003/add_ads.rb
-- examples/v201003/delete_ad_group_criterion.rb
-- examples/v201003/get_all_ad_groups.rb
-- examples/v201003/add_campaign.rb
-- examples/v201003/add_ad_group_criteria.rb
-- examples/v201003/delete_campaign.rb
-- examples/v201003/get_report_fields.rb
-- examples/v201003/get_all_campaign_targets.rb
-- examples/v201003/perform_bulk_mutate_job.rb
-- examples/v201003/update_campaign.rb
-- examples/v201008/get_all_ad_group_criteria.rb
-- examples/v201008/get_all_account_changes.rb
-- examples/v201008/delete_ad.rb
-- examples/v201008/add_negative_campaign_criterion.rb
-- examples/v201008/get_criterion_bid_landscape.rb
-- examples/v201008/get_all_disapproved_ads.rb
-- examples/v201008/get_all_active_ad_group_criteria.rb
-- examples/v201008/delete_bulk_mutate_job.rb
-- examples/v201008/add_ad_group.rb
-- examples/v201008/update_ad.rb
-- examples/v201008/get_geo_location_info.rb
-- examples/v201008/delete_ad_group.rb
-- examples/v201008/set_campaign_targets.rb
-- examples/v201008/download_report.rb
-- examples/v201008/get_all_images.rb
-- examples/v201008/check_campaigns.rb
-- examples/v201008/get_all_ads.rb
-- examples/v201008/get_all_report_definitions.rb
-- examples/v201008/get_all_campaigns.rb
-- examples/v201008/upload_image.rb
-- examples/v201008/update_ad_group_criterion.rb
-- examples/v201008/get_all_user_lists.rb
-- examples/v201008/update_ad_group.rb
-- examples/v201008/get_bulk_mutate_job.rb
-- examples/v201008/add_placement_performance_report_definition.rb
-- examples/v201008/get_related_placements.rb
-- examples/v201008/get_all_paused_campaigns.rb
-- examples/v201008/add_ads.rb
-- examples/v201008/get_campaign_alerts.rb
-- examples/v201008/delete_user_list.rb
-- examples/v201008/delete_ad_group_criterion.rb
-- examples/v201008/get_all_ad_groups.rb
-- examples/v201008/add_campaign.rb
-- examples/v201008/update_user_list.rb
-- examples/v201008/add_user_list.rb
-- examples/v201008/add_ad_group_criteria.rb
-- examples/v201008/delete_campaign.rb
-- examples/v201008/get_report_fields.rb
-- examples/v201008/get_all_campaign_targets.rb
-- examples/v201008/perform_bulk_mutate_job.rb
-- examples/v201008/update_campaign.rb
-- examples/v201101/get_ad_group_bid_landscape.rb
-- examples/v201101/get_all_ad_group_criteria.rb
-- examples/v201101/get_all_account_changes.rb
-- examples/v201101/delete_ad.rb
-- examples/v201101/add_negative_campaign_criterion.rb
-- examples/v201101/get_criterion_bid_landscape.rb
-- examples/v201101/get_all_disapproved_ads.rb
-- examples/v201101/get_all_active_ad_group_criteria.rb
-- examples/v201101/delete_bulk_mutate_job.rb
-- examples/v201101/add_ad_group.rb
-- examples/v201101/update_ad.rb
-- examples/v201101/get_geo_location_info.rb
-- examples/v201101/delete_ad_group.rb
-- examples/v201101/set_campaign_targets.rb
-- examples/v201101/download_report.rb
-- examples/v201101/get_all_images.rb
-- examples/v201101/check_campaigns.rb
-- examples/v201101/get_all_ads.rb
-- examples/v201101/get_all_report_definitions.rb
-- examples/v201101/get_all_campaigns.rb
-- examples/v201101/upload_image.rb
-- examples/v201101/update_ad_group_criterion.rb
-- examples/v201101/get_all_user_lists.rb
-- examples/v201101/update_ad_group.rb
-- examples/v201101/get_bulk_mutate_job.rb
-- examples/v201101/add_placement_performance_report_definition.rb
-- examples/v201101/add_rtb_campaign.rb
-- examples/v201101/get_related_placements.rb
-- examples/v201101/get_all_paused_campaigns.rb
-- examples/v201101/add_ads.rb
-- examples/v201101/get_campaign_alerts.rb
-- examples/v201101/delete_user_list.rb
-- examples/v201101/delete_ad_group_criterion.rb
-- examples/v201101/get_all_ad_groups.rb
-- examples/v201101/add_campaign.rb
-- examples/v201101/update_user_list.rb
-- examples/v201101/add_user_list.rb
-- examples/v201101/add_ad_group_criteria.rb
-- examples/v201101/delete_campaign.rb
-- examples/v201101/get_all_conversions.rb
-- examples/v201101/update_conversion.rb
-- examples/v201101/get_report_fields.rb
-- examples/v201101/get_all_campaign_targets.rb
-- examples/v201101/perform_bulk_mutate_job.rb
-- examples/v201101/add_conversion.rb
-- examples/v201101/update_campaign.rb
-- examples/v201109/get_ad_group_bid_landscape.rb
-- examples/v201109/get_all_ad_group_criteria.rb
-- examples/v201109/get_all_account_changes.rb
-- examples/v201109/delete_ad.rb
-- examples/v201109/add_negative_campaign_criterion.rb
-- examples/v201109/get_criterion_bid_landscape.rb
-- examples/v201109/get_all_disapproved_ads.rb
-- examples/v201109/get_all_active_ad_group_criteria.rb
-- examples/v201109/get_all_carriers.rb
-- examples/v201109/delete_bulk_mutate_job.rb
-- examples/v201109/perform_mutate_job.rb
-- examples/v201109/add_ad_group.rb
-- examples/v201109/update_ad.rb
-- examples/v201109/get_geo_location_info.rb
-- examples/v201109/get_all_languages.rb
-- examples/v201109/delete_ad_group.rb
-- examples/v201109/download_report.rb
-- examples/v201109/get_all_images.rb
-- examples/v201109/check_campaigns.rb
-- examples/v201109/get_all_ads.rb
-- examples/v201109/get_all_report_definitions.rb
-- examples/v201109/get_all_campaigns.rb
-- examples/v201109/upload_image.rb
-- examples/v201109/update_ad_group_criterion.rb
-- examples/v201109/get_all_user_lists.rb
-- examples/v201109/update_ad_group.rb
-- examples/v201109/get_location_criteria.rb
-- examples/v201109/get_bulk_mutate_job.rb
-- examples/v201109/add_campaign_targeting_criteria.rb
-- examples/v201109/add_rtb_campaign.rb
-- examples/v201109/get_related_placements.rb
-- examples/v201109/get_all_paused_campaigns.rb
-- examples/v201109/add_ads.rb
-- examples/v201109/get_campaign_alerts.rb
-- examples/v201109/delete_user_list.rb
-- examples/v201109/delete_ad_group_criterion.rb
-- examples/v201109/get_all_ad_groups.rb
-- examples/v201109/add_campaign.rb
-- examples/v201109/update_user_list.rb
-- examples/v201109/add_user_list.rb
-- examples/v201109/download_adhoc_report.rb
-- examples/v201109/add_ad_group_criteria.rb
-- examples/v201109/delete_campaign.rb
-- examples/v201109/get_all_conversions.rb
-- examples/v201109/get_client_customer_id.rb
-- examples/v201109/update_conversion.rb
-- examples/v201109/get_report_fields.rb
-- examples/v201109/get_all_campaign_targets.rb
-- examples/v201109/perform_bulk_mutate_job.rb
-- examples/v201109/add_conversion.rb
-- examples/v201109/update_campaign.rb
-- Rakefile
-- README
+- examples/v201109/reporting/download_criteria_report.rb
+- examples/v201109/reporting/download_defined_report.rb
+- examples/v201109/reporting/get_defined_reports.rb
+- examples/v201109/reporting/get_campaign_stats.rb
+- examples/v201109/reporting/parallel_report_download.rb
+- examples/v201109/reporting/get_report_fields.rb
+- examples/v201109/error_handling/handle_policy_violation_error.rb
+- examples/v201109/error_handling/handle_two_factor_authorization_error.rb
+- examples/v201109/error_handling/handle_captcha_challenge.rb
+- examples/v201109/error_handling/handle_partial_failures.rb
+- examples/v201109/targeting/lookup_location.rb
+- examples/v201109/targeting/get_targetable_languages_and_carriers.rb
+- examples/v201109/targeting/add_campaign_targeting_criteria.rb
+- examples/v201109/targeting/get_campaign_targeting_criteria.rb
+- examples/v201109/campaign_management/add_placements_in_bulk.rb
+- examples/v201109/campaign_management/get_all_disapproved_ads.rb
+- examples/v201109/account_management/get_account_changes.rb
+- examples/v201109/optimization/get_placement_ideas.rb
+- examples/v201109/basic_operations/update_campaign.rb
+- examples/v201109/basic_operations/get_thirdparty_redirect_ads.rb
+- examples/v201109/basic_operations/get_campaigns.rb
+- examples/v201109/basic_operations/get_ad_groups.rb
+- examples/v201109/basic_operations/add_campaign.rb
+- examples/v201109/basic_operations/add_placements.rb
+- examples/v201109/basic_operations/add_ad_group.rb
+- examples/v201109/basic_operations/delete_ad_group.rb
+- examples/v201109/basic_operations/update_placement.rb
+- examples/v201109/basic_operations/delete_ad.rb
+- examples/v201109/basic_operations/add_thirdparty_redirect_ad.rb
+- examples/v201109/basic_operations/update_ad_group.rb
+- examples/v201109/basic_operations/delete_campaign.rb
+- examples/v201109/basic_operations/delete_placement.rb
+- examples/v201109/basic_operations/pause_ad.rb
+- examples/v201109/basic_operations/get_placements.rb
+- examples/v201109/misc/upload_image.rb
+- examples/v201109/misc/get_all_images_and_videos.rb
+- examples/v201109/misc/use_oauth.rb
+- examples/v201109/remarketing/add_conversion_tracker.rb
+- examples/v201109/remarketing/add_audience.rb
 - COPYING
+- README
 - ChangeLog
 has_rdoc: true
 homepage: http://code.google.com/p/google-api-ads-ruby/
@@ -243,16 +109,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 23
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: google-adx-buyer-api
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Ruby Client libraries for DoubleClick Ad Exchange Buyer API
+summary: Ruby examples for DoubleClick Ad Exchange Buyer API
 test_files: []