google-dfp-api 0.4.0 → 0.5.0

data/examples/{v201111 → v201211}/line_item_creative_association_service/get_lica.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 = :v201111
+API_VERSION = :v201211
 
 def get_lica()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201201 → v201211}/line_item_creative_association_service/get_licas_by_statement.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 = :v201201
+API_VERSION = :v201211
 
 def get_licas_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201201 → v201211}/line_item_creative_association_service/update_licas.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -20,13 +21,12 @@
 # This example updates the destination URL of all LICAs up to the first 500. To
 # determine which LICAs exist, run get_all_licas.rb.
 #
-# Tags:
-#   LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatement,
-#   LineItemCreativeAssociationService.updateLineItemCreativeAssociations
+# Tags: LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatement
+# Tags: LineItemCreativeAssociationService.updateLineItemCreativeAssociations
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def update_licas()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201111 → v201211}/line_item_service/activate_line_items.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -24,12 +25,12 @@
 # create_licas.rb. To determine which line items exist, run
 # get_all_line_items.rb. To determine which orders exist, run get_all_orders.rb.
 #
-# Tags: LineItemService.getLineItemsByStatement,
-#       LineItemService.performLineItemAction
+# Tags: LineItemService.getLineItemsByStatement
+# Tags: LineItemService.performLineItemAction
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def activate_line_items()

data/examples/{v201201 → v201211}/line_item_service/create_line_items.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -28,7 +29,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 # Number of line items to create.
 ITEM_COUNT = 5
 

data/examples/{v201201 → v201211}/line_item_service/create_mobile_line_item.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -29,7 +30,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def create_mobile_line_item()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201111 → v201211}/line_item_service/create_video_line_item.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -29,7 +30,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 
 def create_video_line_item()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201201 → v201211}/line_item_service/get_all_line_items.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -24,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def get_all_line_items()

data/examples/{v201201 → v201211}/line_item_service/get_line_item.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -24,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def get_line_item()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201201 → v201211}/line_item_service/get_line_items_by_statement.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 = :v201201
+API_VERSION = :v201211
 
 def get_line_items_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201201 → v201211}/line_item_service/get_recently_updated_line_items.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -27,7 +28,7 @@ require 'date'
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def get_recently_updated_line_items()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201108 → v201211}/line_item_service/target_custom_criteria.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -28,7 +29,7 @@ require 'dfp_api'
 
 require 'pp'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def target_custom_criteria()

data/examples/{v201201 → v201211}/line_item_service/update_line_items.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 = :v201201
+API_VERSION = :v201211
 
 def update_line_items()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -70,7 +71,7 @@ def update_line_items()
     end
 
     # Update the line items on the server.
-    return_line_items = line_item_service.update_line_items(line_items)
+    return_line_items = line_item_service.update_line_items(new_line_items)
 
     if return_line_items
       return_line_items.each do |line_item|

data/examples/{v201108 → v201211}/network_service/get_all_networks.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -23,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 
 def get_all_networks()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201108 → v201211}/network_service/get_current_network.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -23,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 
 def get_current_network()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201201/network_service/get_current_network.rb → v201211/network_service/make_test_network.rb}

@@ -1,8 +1,9 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2012, 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.
@@ -17,15 +18,26 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets the current network that you can make requests against.
+# This example creates a test network. You do not need to have a DFP account to
+# run this example, but you do need to have a Google account (created at
+# http://www.google.com/accounts/newaccount if you currently don't have one)
+# that is not associated with any other DFP test networks (including old sandbox
+# networks). Once this network is created, you can supply the network code in
+# your settings to make calls to other services.
 #
-# Tags: NetworkService.getCurrentNetwork
+# Please see the following URL for more information:
+#   https://developers.google.com/doubleclick-publishers/docs/signup
+#
+# Alternatively, if you do not wish to run this example, you can create a test
+# network at: https://dfp-playground.appspot.com
+#
+# Tags: NetworkService.makeTestNetwork
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
-def get_current_network()
+def make_test_network()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -36,16 +48,18 @@ def get_current_network()
   # Get the NetworkService.
   network_service = dfp.service(:NetworkService, API_VERSION)
 
-  # Get the current network.
-  network = network_service.get_current_network()
+  # Make a test network.
+  network = network_service.make_test_network()
 
-  puts "Current network has network code %d and display name %s." %
+  puts "Test network with network code %s and display name '%s' created." %
       [network[:network_code], network[:display_name]]
+  puts "You may now sign in at http://www.google.com/dfp/main?networkCode=%s" %
+      network[:network_code]
 end
 
 if __FILE__ == $0
   begin
-    get_current_network()
+    make_test_network()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201201 → v201211}/order_service/approve_orders.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 'date'
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def approve_orders()

data/examples/{v201108 → v201211}/order_service/create_orders.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 = :v201108
+API_VERSION = :v201211
 # Number of orders to create.
 ITEM_COUNT = 5
 

data/examples/{v201108 → v201211}/order_service/get_all_orders.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -23,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def get_all_orders()

data/examples/{v201201 → v201211}/order_service/get_order.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -24,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def get_order()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201201 → v201211}/order_service/get_orders_by_statement.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 = :v201201
+API_VERSION = :v201211
 
 def get_orders_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201201 → v201211}/order_service/update_orders.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -24,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def update_orders()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201201 → v201211}/placement_service/create_placements.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -20,12 +21,12 @@
 # This example creates new placements for various ad unit sizes. To determine
 # which placements exist, run get_all_placements.rb.
 #
-# Tags: PlacementService.createPlacements,
-#       InventoryService.getAdUnitsByStatement
+# Tags: PlacementService.createPlacements
+# Tags: InventoryService.getAdUnitsByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def create_placements()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -86,12 +87,14 @@ def create_placements()
     end
   end
 
+  # Only create placements with one or more ad units.
+  non_empty_placements = [
+      medium_square_ad_unit_placement,
+      skyscraper_ad_unit_placement,
+      banner_ad_unit_placement].delete_if {|plc| plc.empty?}
+
   # Create the placements on the server.
-  placements = placement_service.create_placements(
-      [medium_square_ad_unit_placement,
-       skyscraper_ad_unit_placement,
-       banner_ad_unit_placement]
-  )
+  placements = placement_service.create_placements(non_empty_placements)
 
   # Display results.
   if placements