google-dfp-api 0.6.1 → 0.6.2

data/examples/v201302/inventory_service/get_ad_unit_sizes.rb

@@ -0,0 +1,85 @@
+#!/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 code example gets all web target platform ad unit sizes.
+#
+# Tags: InventoryService.getAdUnitSizesByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+
+def get_all_ad_unit_sizes()
+  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
+  dfp = DfpApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # dfp.logger = Logger.new('dfp_xml.log')
+
+  # Get the InventoryService.
+  inventory_service = dfp.service(:InventoryService, API_VERSION)
+
+  target_platform = 'WEB'
+
+  # Create statement object to only select web ad unit sizes.
+  statement = {
+     :query => 'WHERE targetPlatform = :target_platform',
+     :values => [
+         {:key => 'target_platform',
+          :value => {:value => target_platform,
+                     :xsi_type => 'TextValue'}}
+     ]
+  }
+
+  # Get ad unit sizes by statement.
+  ad_unit_sizes = inventory_service.get_ad_unit_sizes_by_statement(statement)
+
+  if ad_unit_sizes
+    # Print details about each ad unit in results.
+    ad_unit_sizes.each_with_index do |ad_unit_size, index|
+      puts "%d) Web ad unit size of dimensions %s was found." %
+          [index, ad_unit_size[:full_display_string]]
+    end
+  else
+    puts 'No ad unit sizes found.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_ad_unit_sizes()
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue DfpApi::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/v201302/inventory_service/get_ad_units_by_statement.rb

@@ -0,0 +1,96 @@
+#!/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 first 500 children below the effective root ad unit. To
+# create ad units, run create_ad_units.rb.
+#
+# Tags: InventoryService.getAdUnitsByStatement, NetworkService.getCurrentNetwork
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+
+def get_ad_units_by_statement()
+  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
+  dfp = DfpApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # dfp.logger = Logger.new('dfp_xml.log')
+
+  # Get the InventoryService.
+  inventory_service = dfp.service(:InventoryService, API_VERSION)
+
+  # Get the NetworkService.
+  network_service = dfp.service(:NetworkService, API_VERSION)
+
+  # Get the effective root ad unit ID of the network.
+  effective_root_ad_unit_id =
+      network_service.get_current_network[:effective_root_ad_unit_id]
+
+  puts "Using effective root ad unit: %d" % effective_root_ad_unit_id
+
+  # Create a statement to select the children of the effective root ad unit.
+  statement = {
+     :query => 'WHERE parentId = :id LIMIT 500',
+     :values => [
+         {:key => 'id',
+          :value => {:value => effective_root_ad_unit_id,
+                     :xsi_type => 'NumberValue'}}
+     ]
+  }
+
+  # Get ad units by statement.
+  page = inventory_service.get_ad_units_by_statement(statement)
+
+  if page[:results]
+    # Print details about each ad unit in results.
+    page[:results].each_with_index do |ad_unit, index|
+      puts "%d) Ad unit ID: %d, name: %s, status: %s." %
+          [index, ad_unit[:id], ad_unit[:name], ad_unit[:status]]
+    end
+  end
+
+  # Print a footer.
+  if page.include?(:total_result_set_size)
+    puts "Total number of ad units: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_ad_units_by_statement()
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue DfpApi::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/v201302/inventory_service/get_all_ad_units.rb

@@ -0,0 +1,93 @@
+#!/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 all ad units. To create ad units, run create_ad_units.rb.
+#
+# Tags: InventoryService.getAdUnitsByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+PAGE_SIZE = 500
+
+def get_all_ad_units()
+  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
+  dfp = DfpApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # dfp.logger = Logger.new('dfp_xml.log')
+
+  # Get the InventoryService.
+  inventory_service = dfp.service(:InventoryService, API_VERSION)
+
+  # Define initial values.
+  offset = 0
+  page = {}
+
+  begin
+    # Create a statement to get one page with current offset.
+    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
+
+    # Get ad units by statement.
+    page = inventory_service.get_ad_units_by_statement(statement)
+
+    if page[:results]
+      # Increase query offset by page size.
+      offset += PAGE_SIZE
+
+      # Get the start index for printout.
+      start_index = page[:start_index]
+
+      # Print details about each ad unit in results.
+      page[:results].each_with_index do |ad_unit, index|
+        puts "%d) Ad unit ID: %d, name: %s, status: %s." %
+            [index + start_index, ad_unit[:id],
+             ad_unit[:name], ad_unit[:status]]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Print a footer.
+  if page.include?(:total_result_set_size)
+    puts "Total number of ad units: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_ad_units()
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue DfpApi::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/v201302/inventory_service/update_ad_units.rb

@@ -0,0 +1,96 @@
+#!/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 updates an ad unit by enabling AdSense to the first 500. To
+# determine which ad units exist, run get_all_ad_units.rb or
+# get_inventory_tree.rb.
+#
+# Tags: InventoryService.getAdUnitsByStatement, InventoryService.updateAdUnits
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+
+def update_ad_units()
+  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
+  dfp = DfpApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # dfp.logger = Logger.new('dfp_xml.log')
+
+  # Get the InventoryService.
+  inventory_service = dfp.service(:InventoryService, API_VERSION)
+
+  # Create a statement to get first 500 ad units.
+  statement = {:query => "LIMIT 500"}
+
+  # Get ad units by statement.
+  page = inventory_service.get_ad_units_by_statement(statement)
+
+  if page[:results]
+    ad_units = page[:results]
+
+    # Update each local ad unit object by enabling AdSense.
+    ad_units.each do |ad_unit|
+      ad_unit[:inherited_ad_sense_settings] =
+          {:value => {:ad_sense_enabled => true}}
+      # Workaround for issue #94.
+      ad_unit[:description] = "" if ad_unit[:description].nil?
+    end
+
+    # Update the ad units on the server.
+    return_ad_units = inventory_service.update_ad_units(ad_units)
+
+    if return_ad_units
+      return_ad_units.each do |ad_unit|
+        puts ("Ad unit with ID: %d, name: %s and status: %s was updated " +
+            "with AdSense enabled: %s") %
+            [ad_unit[:id], ad_unit[:name], ad_unit[:status],
+             ad_unit[:inherited_ad_sense_settings][:value][:ad_sense_enabled]]
+      end
+    else
+      raise 'No ad units were updated.'
+    end
+  else
+    puts 'No ad units found to update.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    update_ad_units()
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue DfpApi::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/v201302/label_service/create_labels.rb

@@ -0,0 +1,83 @@
+#!/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 creates new labels. To determine which labels exist, run
+# get_all_labels.rb.
+#
+# This feature is only available to DFP premium solution networks.
+#
+# Tags: LabelService.createLabels
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+# Number of labels to create.
+ITEM_COUNT = 5
+
+def create_labels()
+  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
+  dfp = DfpApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # dfp.logger = Logger.new('dfp_xml.log')
+
+  # Get the LabelService.
+  label_service = dfp.service(:LabelService, API_VERSION)
+
+  # Create an array to store local label objects.
+  labels = (1..ITEM_COUNT).map do |index|
+    {:name => "Label #%d" % index, :types => ['COMPETITIVE_EXCLUSION']}
+  end
+
+  # Create the labels on the server.
+  return_labels = label_service.create_labels(labels)
+
+  if return_labels
+    return_labels.each do |label|
+      puts "Label with ID: %d, name: '%s' and types: '%s' was created." %
+          [label[:id], label[:name], label[:types].join(', ')]
+    end
+  else
+    raise 'No labels were created.'
+  end
+
+end
+
+if __FILE__ == $0
+  begin
+    create_labels()
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue DfpApi::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