google-dfp-api 0.3.2 → 0.3.3

data/examples/v201206/inventory_service/create_mobile_ad_unit.rb

@@ -0,0 +1,100 @@
+#!/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 a new mobile ad unit under a the effective root ad unit.
+# To determine which ad units exist, run get_inventory_tree.rb or
+# get_all_ad_units.rb.
+#
+# Mobile features need to be enabled on your account to use mobile targeting.
+#
+# Tags: InventoryService.createAdUnits, NetworkService.getCurrentNetwork
+
+require 'dfp_api'
+
+API_VERSION = :v201206
+
+def create_mobile_ad_unit()
+  # 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: %s" % effective_root_ad_unit_id.to_s
+
+  # Create ad unit size.
+  ad_unit_size = {
+      :size => {:width => 400, :height => 300, :is_aspect_ratio => false},
+      :environment_type => 'BROWSER'
+  }
+
+  # Create local ad unit object.
+  ad_unit = {
+     :name => "Mobile_Ad_Unit_%d" % (Time.new.to_f * 1000).to_i,
+     :parent_id => effective_root_ad_unit_id,
+     :description => 'Mobile Ad unit description',
+     :target_window => 'BLANK',
+     :target_platform => 'MOBILE',
+     # Set the size of possible creatives that can match this ad unit.
+     :ad_unit_sizes => [ad_unit_size]
+  }
+
+  # Create the ad unit on the server.
+  return_ad_unit = inventory_service.create_ad_unit(ad_unit)
+
+  if return_ad_unit
+    puts "Ad unit with ID: %d, name: %s and status: %s was created." %
+        [return_ad_unit[:id], return_ad_unit[:name], return_ad_unit[:status]]
+  else
+    raise 'No ad units were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_mobile_ad_unit()
+
+  # 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/v201206/inventory_service/create_video_ad_unit.rb

@@ -0,0 +1,108 @@
+#!/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 a new video ad unit under a the effective root ad unit.
+# To determine which ad units exist, run get_inventory_tree.rb or
+# get_all_ad_units.rb.
+#
+# This feature is only available to DFP premium solution networks.
+#
+# Tags: InventoryService.createAdUnits, NetworkService.getCurrentNetwork
+
+require 'dfp_api'
+
+API_VERSION = :v201206
+
+def create_video_ad_unit()
+  # 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: %s" % effective_root_ad_unit_id.to_s
+
+  # Create master ad unit size.
+  master_ad_unit_size = {
+      :size => {:width => 400, :height => 300, :is_aspect_ratio => false},
+      :environment_type => 'VIDEO_PLAYER',
+      # Add companions to master ad unit size.
+      :companions => [
+          {:size => {:width => 300, :height => 250, :is_aspect_ratio => false},
+           :environment_type => 'BROWSER'},
+          {:size => {:width => 728, :height => 90, :is_aspect_ratio => false},
+           :environment_type => 'BROWSER'}
+      ]
+  }
+
+  # Create local ad unit object.
+  ad_unit = {
+     :name => "Video_Ad_Unit_%d" % (Time.new.to_f * 1000).to_i,
+     :parent_id => effective_root_ad_unit_id,
+     :description => 'Video Ad unit description',
+     :target_window => 'BLANK',
+     :explicitly_targeted => true,
+     :target_platform => 'WEB',
+     # Set the size of possible creatives that can match this ad unit.
+     :ad_unit_sizes => [master_ad_unit_size]
+  }
+
+  # Create the ad unit on the server.
+  return_ad_unit = inventory_service.create_ad_unit(ad_unit)
+
+  if return_ad_unit
+    puts "Ad unit with ID: %d, name: %s and status: %s was created." %
+        [return_ad_unit[:id], return_ad_unit[:name], return_ad_unit[:status]]
+  else
+    raise 'No ad units were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_video_ad_unit()
+
+  # 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/v201206/inventory_service/deactivate_ad_units.rb

@@ -0,0 +1,119 @@
+#!/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 deactivates all active ad units. To determine which ad units
+# exist, run get_all_ad_units.rb or get_inventory_tree.rb.
+#
+# Tags: InventoryService.getLineItemsByStatement
+# Tags: InventoryService.performAdUnitAction
+
+require 'dfp_api'
+
+API_VERSION = :v201206
+PAGE_SIZE = 500
+
+def deactivate_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 statement text to select active ad units.
+  statement_text = 'WHERE status = :status'
+  statement = {
+      :values => [
+          {:key => 'status',
+           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
+      ]
+  }
+
+  # Define initial values.
+  offset = 0
+  page = {}
+  ad_unit_ids = []
+
+  begin
+    # Create a statement to get one page with the current offset.
+    statement[:query] = statement_text +
+        " 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
+
+      page[:results].each do |ad_unit|
+        puts ("%d) Ad unit with ID: %d, status: %s and name: %s will be " +
+              "deactivated.") % [ad_unit_ids.size, ad_unit[:id],
+              ad_unit[:status], ad_unit[:name]]
+        ad_unit_ids << ad_unit[:id]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  puts "Number of ad units to be deactivated: %d" % ad_unit_ids.size
+
+  if !ad_unit_ids.empty?
+    # Modify statement for action. Note, the values are still present.
+    statement[:query] = statement_text + " AND id IN (%s)" %
+        ad_unit_ids.join(', ')
+
+    # Perform action.
+    result = inventory_service.perform_ad_unit_action(
+        {:xsi_type => 'DeactivateAdUnits'}, statement)
+
+    # Display results.
+    if result and result[:num_changes] > 0
+      puts "Number of ad units deactivated: %d" % result[:num_changes]
+    else
+      puts 'No ad units were deactivated.'
+    end
+  else
+    puts 'No ad units found to deactivate.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    deactivate_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/v201206/inventory_service/get_ad_unit.rb

@@ -0,0 +1,72 @@
+#!/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 an ad unit by its ID. To determine which ad units
+# exist, run get_inventory_tree.rb or get_all_ad_units.rb.
+#
+# Tags: InventoryService.getAdUnit
+
+require 'dfp_api'
+
+API_VERSION = :v201206
+
+def get_ad_unit()
+  # 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)
+
+  # Set the ID of the ad unit to get.
+  ad_unit_id = 'INSERT_AD_UNIT_ID_HERE'.to_i
+
+  # Get the ad unit.
+  ad_unit = inventory_service.get_ad_unit(ad_unit_id)
+
+  if ad_unit
+    puts "Ad unit with ID: %d, name: %s and status: %s was found." %
+        [ad_unit[:id], ad_unit[:name], ad_unit[:status]]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_ad_unit()
+
+  # 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/v201206/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 = :v201206
+
+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 %d x %d was found." % [index,
+          ad_unit_size[:size][:width], ad_unit_size[:size][:height]]
+    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