google-dfp-api 0.2.8 → 0.3.0

data/examples/{v201103 → v201203}/custom_targeting_service/update_custom_targeting_values.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
 
 def update_custom_targeting_values()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201104 → v201203}/forecast_service/get_forecast.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 
 def get_forecast()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,7 +38,7 @@ def get_forecast()
   forecast_service = dfp.service(:ForecastService, API_VERSION)
 
   # Set the placement that the prospective line item will target.
-  targeted_placement_ids = ["INSERT_PLACEMENT_ID_HERE".to_i]
+  targeted_placement_ids = ['INSERT_PLACEMENT_ID_HERE'.to_i]
 
   # Create targeting.
   targeting = {
@@ -46,13 +46,17 @@ def get_forecast()
           {:targeted_placement_ids => targeted_placement_ids}
   }
 
+  # Create the creative placeholder.
+  creative_placeholder = {
+      :size => {:width => 300, :height => 250, :is_aspect_ratio => false}
+  }
+
   # Create prospective line item.
   line_item = {
     :line_item_type => 'SPONSORSHIP',
     :targeting => targeting,
     # Set the size of creatives that can be associated with this line item.
-    :creative_sizes =>
-        {:width => 300, :height => 250, :is_aspect_ratio => false},
+    :creative_placeholders => [creative_placeholder],
     # Set the line item's time to be now until the projected end date time.
     :start_date_time_type => 'IMMEDIATELY',
     :end_date_time => Time.utc(2012, 01, 01),

data/examples/{v201107 → v201203}/forecast_service/get_forecast_by_id.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 
 def get_forecast_by_id()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201107 → v201203}/inventory_service/create_ad_units.rb

@@ -21,11 +21,11 @@
 # determine which ad units exist, run get_inventory_tree.rb or
 # get_all_ad_units.rb.
 #
-# Tags: InventoryService.createAdUnits
+# Tags: InventoryService.createAdUnits, NetworkService.getCurrentNetwork
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 # Number of ad units to create.
 ITEM_COUNT = 5
 
@@ -49,6 +49,12 @@ def create_ad_units()
 
   puts "Using effective root ad unit: %d" % effective_root_ad_unit_id
 
+  # Create the creative placeholder.
+  creative_placeholder = {
+      :size => {:width => 300, :height => 250, :is_aspect_ratio => false},
+      :environment_type => 'BROWSER'
+  }
+
   # Create an array to store local ad unit objects.
   ad_units = (1..ITEM_COUNT).map do |index|
     {:name => "Ad_Unit_%d" % index,
@@ -56,7 +62,7 @@ def create_ad_units()
      :description => 'Ad unit description.',
      :target_window => 'BLANK',
      # Set the size of possible creatives that can match this ad unit.
-     :sizes => [{:width => 300, :height => 250, :is_aspect_ratio => false}]}
+     :ad_unit_sizes => [creative_placeholder]}
   end
 
   # Create the ad units on the server.

data/examples/{v201103/inventory_service/create_ad_units.rb → v201203/inventory_service/create_mobile_ad_unit.rb}

@@ -17,19 +17,19 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example creates new ad units under a the effective root ad unit. To
-# determine which ad units exist, run get_inventory_tree.rb or
+# 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.
 #
-# Tags: InventoryService.createAdUnits
+# Mobile features need to be enabled on your account to use mobile targeting.
+#
+# Tags: InventoryService.createAdUnits, NetworkService.getCurrentNetwork
 
 require 'dfp_api'
 
-API_VERSION = :v201103
-# Number of ad units to create.
-ITEM_COUNT = 5
+API_VERSION = :v201203
 
-def create_ad_units()
+def create_mobile_ad_unit()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -47,26 +47,31 @@ def create_ad_units()
   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
+  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 an array to store local ad unit objects.
-  ad_units = (1..ITEM_COUNT).map do |index|
-    {:name => "Ad_Unit_%d" % index,
+  # 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 => 'Ad unit description.',
+     :description => 'Mobile Ad unit description',
      :target_window => 'BLANK',
+     :target_platform => 'MOBILE',
      # Set the size of possible creatives that can match this ad unit.
-     :sizes => [{:width => 300, :height => 250, :is_aspect_ratio => false}]}
-  end
+     :ad_unit_sizes => [ad_unit_size]
+  }
 
-  # Create the ad units on the server.
-  return_ad_units = inventory_service.create_ad_units(ad_units)
+  # Create the ad unit on the server.
+  return_ad_unit = inventory_service.create_ad_unit(ad_unit)
 
-  if return_ad_units
-    return_ad_units.each do |ad_unit|
-      puts "Ad unit with ID: %d, name: %s and status: %s was created." %
-          [ad_unit[:id], ad_unit[:name], ad_unit[:status]]
-    end
+  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
@@ -74,7 +79,7 @@ end
 
 if __FILE__ == $0
   begin
-    create_ad_units()
+    create_mobile_ad_unit()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201104/inventory_service/create_ad_units.rb → v201203/inventory_service/create_video_ad_unit.rb}

@@ -17,19 +17,19 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example creates new ad units under a the effective root ad unit. To
-# determine which ad units exist, run get_inventory_tree.rb or
+# 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.
 #
-# Tags: InventoryService.createAdUnits
+# This feature is only available to DFP premium solution networks.
+#
+# Tags: InventoryService.createAdUnits, NetworkService.getCurrentNetwork
 
 require 'dfp_api'
 
-API_VERSION = :v201104
-# Number of ad units to create.
-ITEM_COUNT = 5
+API_VERSION = :v201203
 
-def create_ad_units()
+def create_video_ad_unit()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -47,26 +47,39 @@ def create_ad_units()
   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
+  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 an array to store local ad unit objects.
-  ad_units = (1..ITEM_COUNT).map do |index|
-    {:name => "Ad_Unit_%d" % index,
+  # 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 => 'Ad unit description.',
+     :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.
-     :sizes => [{:width => 300, :height => 250, :is_aspect_ratio => false}]}
-  end
+     :ad_unit_sizes => [master_ad_unit_size]
+  }
 
-  # Create the ad units on the server.
-  return_ad_units = inventory_service.create_ad_units(ad_units)
+  # Create the ad unit on the server.
+  return_ad_unit = inventory_service.create_ad_unit(ad_unit)
 
-  if return_ad_units
-    return_ad_units.each do |ad_unit|
-      puts "Ad unit with ID: %d, name: %s and status: %s was created." %
-          [ad_unit[:id], ad_unit[:name], ad_unit[:status]]
-    end
+  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
@@ -74,7 +87,7 @@ end
 
 if __FILE__ == $0
   begin
-    create_ad_units()
+    create_video_ad_unit()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201103 → v201203}/inventory_service/deactivate_ad_units.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
 PAGE_SIZE = 500
 
 def deactivate_ad_units()

data/examples/{v201103 → v201203}/inventory_service/get_ad_unit.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
 
 def get_ad_unit()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201107 → v201203}/inventory_service/get_ad_unit_sizes.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -17,13 +18,13 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all ad unit sizes in the network.
+# This code example gets all web target platform ad unit sizes.
 #
-# Tags: InventoryService.getAdUnitSizes
+# Tags: InventoryService.getAdUnitSizesByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 
 def get_all_ad_unit_sizes()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -36,13 +37,25 @@ def get_all_ad_unit_sizes()
   # Get the InventoryService.
   inventory_service = dfp.service(:InventoryService, API_VERSION)
 
-  # Get all ad unit sizes.
-  ad_unit_sizes = inventory_service.get_ad_unit_sizes()
+  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) Ad unit size %dx%d was found." % [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

data/examples/{v201104 → v201203}/inventory_service/get_ad_units_by_statement.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 
 def get_ad_units_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201104 → v201203}/inventory_service/get_all_ad_units.rb

@@ -23,7 +23,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 PAGE_SIZE = 500
 
 def get_all_ad_units()

data/examples/{v201104 → v201203}/inventory_service/update_ad_units.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 
 def update_ad_units()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201107 → v201203}/label_service/create_labels.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -26,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 # Number of labels to create.
 ITEM_COUNT = 5
 
@@ -43,7 +44,7 @@ def create_labels()
 
   # Create an array to store local label objects.
   labels = (1..ITEM_COUNT).map do |index|
-    {:name => "Label #%d" % index, :type => 'COMPETITIVE_EXCLUSION'}
+    {:name => "Label #%d" % index, :types => ['COMPETITIVE_EXCLUSION']}
   end
 
   # Create the labels on the server.
@@ -51,8 +52,8 @@ def create_labels()
 
   if return_labels
     return_labels.each do |label|
-      puts "Label with ID: %d, name: %s and type: %s was created." %
-          [label[:id], label[:name], label[:type]]
+      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.'

data/examples/{v201107 → v201203}/label_service/deactivate_labels.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 PAGE_SIZE = 500
 
 def deactivate_labels()

data/examples/{v201107 → v201203}/label_service/get_all_labels.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -25,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 PAGE_SIZE = 500
 
 def get_all_labels()
@@ -59,8 +60,9 @@ def get_all_labels()
 
       # Print details about each label in results page.
       page[:results].each_with_index do |label, index|
-        puts "%d) Label ID: %d, name: %s, type: %s." %
-            [index + start_index, label[:id], label[:name], label[:type]]
+        puts "%d) Label ID: %d, name: '%s', types: '%s'." %
+            [index + start_index, label[:id], label[:name],
+             label[:types].join(', ')]
       end
     end
   end while offset < page[:total_result_set_size]

data/examples/{v201107 → v201203}/label_service/get_label.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -26,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 
 def get_label()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -46,8 +47,8 @@ def get_label()
   label = label_service.get_label(label_id)
 
   if label
-    puts "Label with ID: %d, name: %s and type %s was found." %
-        [label[:id], label[:name], label[:type]]
+    puts "Label with ID: %d, name: '%s' and types '%s' was found." %
+        [label[:id], label[:name], label[:types].join(', ')]
   else
     puts 'No label found for this ID.'
   end