google-dfp-api 0.2.8 → 0.3.0

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

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -17,9 +18,8 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all labels that are competitively excluded. The statement
-# retrieves up to the maximum page size limit of 500. To create labels, run
-# create_labels.rb.
+# This example gets all labels ordered by name. The statement retrieves up to
+# the maximum page size limit of 500. To create labels, run create_labels.rb.
 #
 # This feature is only available to DFP premium solution networks.
 #
@@ -27,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 
 def get_labels_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,25 +40,16 @@ def get_labels_by_statement()
   # Get the LabelService.
   label_service = dfp.service(:LabelService, API_VERSION)
 
-  # Create a statement to only select active labels.
-  statement = {
-      :query => 'WHERE type = :type ORDER BY name LIMIT 500',
-      :values => [
-          {:key => 'type',
-           :value => {
-               :value => 'COMPETITIVE_EXCLUSION',
-               :xsi_type => 'TextValue'}
-          }
-      ]
-  }
+  # Create a statement to select labels ordered by name.
+  statement = {:query => 'ORDER BY name LIMIT 500'}
 
   # Get labels by statement.
   page = label_service.get_labels_by_statement(statement)
 
   if page and page[:results]
     page[:results].each_with_index do |label, index|
-      puts "%d) Label ID: %d, name: %s, type: %s." % [index,
-          label[:id], label[:name], label[:type]]
+      puts "%d) Label ID: %d, name: '%s', types: '%s'." % [index,
+          label[:id], label[:name], label[:types].join(', ')]
     end
   end
 

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

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -17,9 +18,9 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example updates the descriptions of all labels that are competitive
-# exclusion by updating its description up to the first 500. To determine which
-# labels exist, run get_all_labels.rb.
+# This example updates the descriptions of all active labels by updating its
+# description, up to the first 500. To determine which labels exist, run
+# get_all_labels.rb.
 #
 # This feature is only available to DFP premium solution networks.
 #
@@ -27,7 +28,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 
 def update_labels()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,15 +41,14 @@ def update_labels()
   # Get the LabelService.
   label_service = dfp.service(:LabelService, API_VERSION)
 
-  # Create a statement to only select labels that are competitive exclusion and
-  # active.
+  # Create a statement to only select active labels.
   statement = {
-      :query => 'WHERE type = :type and isActive = true LIMIT 500',
+      :query => 'WHERE isActive = :is_active LIMIT 500',
       :values => [
-          {:key => 'type',
+          {:key => 'is_active',
            :value => {
-               :value => 'COMPETITIVE_EXCLUSION',
-               :xsi_type => 'TextValue'}
+               :value => 'true',
+               :xsi_type => 'BooleanValue'}
           }
       ]
   }
@@ -61,8 +61,7 @@ def update_labels()
 
     # Update each local label object by changing its description.
     labels.each do |label|
-      label[:description] =
-          'These labels are still competiting with each other'
+      label[:description] = 'This label was updated'
     end
 
     # Update the labels on the server.

data/examples/{v201107 → v201203}/line_item_creative_association_service/create_licas.rb

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

data/examples/{v201104 → v201203}/line_item_creative_association_service/deactivate_licas.rb

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

data/examples/{v201104 → v201203}/line_item_creative_association_service/get_all_licas.rb

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

data/examples/{v201104 → v201203}/line_item_creative_association_service/get_lica.rb

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

data/examples/{v201107 → v201203}/line_item_creative_association_service/get_licas_by_statement.rb

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

data/examples/{v201107 → v201203}/line_item_creative_association_service/update_licas.rb

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

data/examples/{v201103 → v201203}/line_item_service/activate_line_items.rb

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

data/examples/{v201107 → v201203}/line_item_service/create_line_items.rb

@@ -28,7 +28,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 # Number of line items to create.
 ITEM_COUNT = 5
 
@@ -55,10 +55,17 @@ def create_line_items()
 
   # Create geographical targeting.
   geo_targeting = {
-      # Include the US and Quebec, Canada.
-      :targeted_locations => [{:id => 2840}, {:id => 20123}],
-      # Exclude Chicago and the New York metro area.
-      :excluded_locations => [{:id => 1016367}, {:id => 200501}]
+      # Include targets.
+      :targeted_locations => [
+          {:id => 2840},    # USA.
+          {:id => 20123},   # Quebec, Canada.
+          {:id => 9000093}  # Postal code B3P (Canada).
+      ],
+      # Exclude targets.
+      :excluded_locations => [
+          {:id => 1016367}, # Chicago.
+          {:id => 200501}   # New York.
+      ]
   }
 
   # Create user domain targeting. Exclude domains that are not under the
@@ -99,7 +106,7 @@ def create_line_items()
 
   # Create an array to store local line item objects.
   line_items = (1..ITEM_COUNT).map do |index|
-    line_item = {:name => "Line item #%d" % index,
+    line_item = {:name => "Line item #%d-%d" % [Time.new.to_f * 1000, index],
                  :order_id => order_id,
                  :targeting => targeting,
                  :line_item_type => 'STANDARD',
@@ -107,10 +114,13 @@ def create_line_items()
     # Set the creative rotation type to even.
     line_item[:creative_rotation_type] = 'EVEN'
 
+    # Create the creative placeholder.
+    creative_placeholder = {
+        :size => {:width => 300, :height => 250, :is_aspect_ratio => false}
+    }
+
     # Set the size of creatives that can be associated with this line item.
-    line_item[:creative_sizes] = [
-        {:width => 300, :height => 250, :is_aspect_ratio => false}
-    ]
+    line_item[:creative_placeholders] = [creative_placeholder]
 
     # Set the length of the line item to run.
     line_item[:start_date_time_type] = 'IMMEDIATELY'

data/examples/v201203/line_item_service/create_mobile_line_item.rb

@@ -0,0 +1,134 @@
+#!/usr/bin/ruby
+#
+# 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 create a new line item to serve to the mobile platform. To
+# determine which line items exist, run get_all_line_items.rb. To determine
+# which orders exist, run get_all_orders.rb. To create a mobile ad unit, run
+# create_mobile_ad_unit.rb. To determine which placements exist, run
+# get_all_placements.rb.
+#
+# Mobile features needs to be enabled in your account to use mobile targeting.
+#
+# Tags: LineItemService.createLineItem
+
+require 'dfp_api'
+
+API_VERSION = :v201203
+
+def create_mobile_line_item()
+  # 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 LineItemService.
+  line_item_service = dfp.service(:LineItemService, API_VERSION)
+
+  # Set the order that all created line items will belong to and the
+  # placement containing ad units with a mobile target platform.
+  order_id = 'INSERT_ORDER_ID_HERE'.to_i
+  targeted_placement_id = 'INSERT_MOBILE_PLACEMENT_ID_HERE'.to_i
+
+  # Create inventory targeting.
+  inventory_targeting = {:targeted_placement_ids => [targeted_placement_id]}
+
+  # Create technology targeting.
+  technology_targeting = {
+      :device_manufacturer_targeting => {
+          # Target the Google device manufacturer (40100).
+          :device_manufacturers => [{:id => 40100}],
+          :is_targeted => true
+      },
+      :mobile_device_targeting => {
+          # Exclude the Nexus One device (604046).
+          :excluded_mobile_devices => [{:id => 604046}]
+      },
+      :mobile_device_submodel_targeting => {
+          # Target the iPhone 4 device submodel (640003).
+          :targeted_mobile_device_submodels => [{:id => 640003}]
+      }
+  }
+
+  # Create targeting.
+  targeting = {
+      :inventory_targeting => inventory_targeting,
+      :technology_targeting => technology_targeting
+  }
+
+  # Create local line item object.
+  line_item = {
+      :name => 'Mobile line item',
+      :order_id => order_id,
+      :targeting => targeting,
+      :line_item_type => 'STANDARD',
+      :allow_overbook => true,
+      # Set the target platform to mobile.
+      :target_platform => 'MOBILE',
+      # Set the creative rotation type to even.
+      :creative_rotation_type => 'EVEN',
+      # Set the size of creatives that can be associated with this line item.
+      :creative_placeholders => [
+          {:size => {:width => 300, :height => 250, :is_aspect_ratio => false}}
+      ],
+      # Set the length of the line item to run.
+      :start_date_time_type => 'IMMEDIATELY',
+      :end_date_time => Time.new + 60 * 60 * 24 * 7,
+      # Set the cost per day to $2.
+      :cost_type => 'CPM',
+      :cost_per_unit => {:currency_code => 'USD', :micro_amount => 2000000},
+      # Set the number of units bought to 500,000 so that the budget is $1,000.
+      :units_bought => 500000,
+      :unit_type => 'IMPRESSIONS'
+  }
+
+  # Create the line item on the server.
+  return_line_item = line_item_service.create_line_item(line_item)
+
+  if return_line_item
+    puts(("Line item with ID: %d, belonging to order ID: %d, " +
+        "and named: %s was created.") %
+        [return_line_item[:id], return_line_item[:order_id],
+         return_line_item[:name]])
+  else
+    raise 'No line items were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_mobile_line_item()
+
+  # 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/v201203/line_item_service/create_video_line_item.rb

@@ -0,0 +1,155 @@
+#!/usr/bin/ruby
+#
+# 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 create a new line item to serve to video content. To determine
+# which line items exist, run get_all_line_items.rb. To determine which orders
+# exist, run get_all_orders.rb. To create a video ad unit, run
+# create_video_ad_unit.rb. To create criteria for categories, run
+# create_custom_targeting_keys_and_values.rb.
+#
+# This feature is only available to DFP premium solution networks.
+#
+# Tags: LineItemService.createLineItem
+
+require 'dfp_api'
+
+API_VERSION = :v201203
+
+def create_video_line_item()
+  # 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 LineItemService.
+  line_item_service = dfp.service(:LineItemService, API_VERSION)
+
+  # Set the order that the created line item will belong to and the video ad
+  # unit ID to target.
+  order_id = 'INSERT_ORDER_ID_HERE'.to_i
+  targeted_video_ad_unit_id = 'INSERT_VIDEO_AD_UNIT_ID_HERE'.to_s
+
+  # Set the custom targeting key ID and value ID representing the metadata on
+  # the content to target. This would typically be a key representing a "genre"
+  # and a value representing something like "comedy".
+  content_custom_targeting_key_id =
+      'INSERT_CONTENT_CUSTOM_TARGETING_KEY_ID_HERE'.to_i
+  content_custom_targeting_value_id =
+      'INSERT_CONTENT_CUSTOM_TARGETING_VALUE_ID_HERE'.to_i
+
+  # Create custom criteria for the content metadata targeting.
+  content_custom_criteria = {
+      :xsi_type => 'CustomCriteria',
+      :key_id => content_custom_targeting_key_id,
+      :value_ids => [content_custom_targeting_value_id],
+      :operator => 'IS'
+  }
+
+  # Create custom criteria set.
+  custom_criteria_set = {
+      :children => [content_custom_criteria]
+  }
+
+  # Create inventory targeting.
+  inventory_targeting = {
+      :targeted_ad_units => [
+          {:ad_unit_id => targeted_video_ad_unit_id}
+      ]
+  }
+
+  # Create video position targeting.
+  video_position_targeting = {:targeted_video_positions => ['PREROLL']}
+
+  # Create targeting.
+  targeting = {
+      :custom_targeting => custom_criteria_set,
+      :inventory_targeting => inventory_targeting,
+      :video_position_targeting => video_position_targeting
+  }
+
+  # Create local line item object.
+  line_item = {
+      :name => 'Video line item',
+      :order_id => order_id,
+      :targeting => targeting,
+      :line_item_type => 'SPONSORSHIP',
+      :allow_overbook => true,
+      # Set the environment type to video.
+      :environment_type => 'VIDEO_PLAYER',
+      # Set the creative rotation type to optimized.
+      :creative_rotation_type => 'OPTIMIZED',
+      # Set delivery of video companions to optional.
+      :companion_delivery_option => 'OPTIONAL',
+      # Set the length of the line item to run.
+      :start_date_time_type => 'IMMEDIATELY',
+      :end_date_time => Time.new + 60 * 60 * 24 * 7,
+      # Set the cost per day to $1.
+      :cost_type => 'CPD',
+      :cost_per_unit => {:currency_code => 'USD', :micro_amount => 1000000},
+      # Set the percentage to be 100%.
+      :units_bought => 100
+  }
+
+  # Create the master creative placeholder and companion creative placeholders.
+  creative_master_placeholder = {
+      :size => {:width => 400, :height => 300, :is_aspect_ratio => false},
+      :companions => [
+          {:size => {:width => 300, :height => 250, :is_aspect_ratio => false}},
+          {:size => {:width => 728, :height => 90, :is_aspect_ratio => false}}
+      ]
+  }
+
+  # Set the size of creatives that can be associated with this line item.
+  line_item[:creative_placeholders] = [creative_master_placeholder]
+
+  # Create the line item on the server.
+  return_line_item = line_item_service.create_line_item(line_item)
+
+  if return_line_item
+    puts(("Line item with ID: %d, belonging to order ID: %d, " +
+        "and named: %s was created.") %
+        [return_line_item[:id], return_line_item[:order_id],
+         return_line_item[:name]])
+  else
+    raise 'No line items were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_video_line_item()
+
+  # 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