google-dfp-api 0.2.8 → 0.3.0

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

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

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

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

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

@@ -17,15 +17,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all line items for the given order. The statement retrieves
-# up to the maximum page size limit of 500. To create line items, run
-# create_line_items.rb. To determine which orders exist, run get_all_orders.rb.
+# This example gets all line items that need creatves for the given order. The
+# statement retrieves up to the maximum page size limit of 500. To create line
+# items, run create_line_items.rb. To determine which orders exist, run
+# get_all_orders.rb.
 #
 # Tags: LineItemService.getLineItemsByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 
 def get_line_items_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -41,12 +42,15 @@ def get_line_items_by_statement()
   # Set the ID of the order to get line items from.
   order_id = 'INSERT_ORDER_ID_HERE'.to_i
 
-  # Create a statement to only select line items from a given order.
+  # Create a statement to only select line items that need creatives from a
+  # given order.
   statement = {
-      :query => 'WHERE orderId = :order_id LIMIT 500',
+      :query => 'WHERE orderId = :order_id AND status = :status LIMIT 500',
       :values => [
           {:key => 'order_id',
-           :value => {:value => order_id, :xsi_type => 'NumberValue'}}
+           :value => {:value => order_id, :xsi_type => 'NumberValue'}},
+          {:key => 'status',
+           :value => {:value => 'NEEDS_CREATIVES', :xsi_type => 'TextValue'}}
       ]
   }
 

data/examples/{v201103/line_item_service/get_line_items_by_statement.rb → v201203/line_item_service/get_recently_updated_line_items.rb}

@@ -1,8 +1,8 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 #
 # 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,17 +17,19 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all line items for the given order. The statement retrieves
-# up to the maximum page size limit of 500. To create line items, run
-# create_line_items.rb. To determine which orders exist, run get_all_orders.rb.
+# This code example shows how to get recently updated line items. To create line
+# items, run create_line_items.rb. To determine which orders exist, run
+# get_all_orders.rb.
 #
 # Tags: LineItemService.getLineItemsByStatement
 
+require 'date'
+
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
 
-def get_line_items_by_statement()
+def get_recently_updated_line_items()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -41,13 +43,20 @@ def get_line_items_by_statement()
   # Set the ID of the order to get line items from.
   order_id = 'INSERT_ORDER_ID_HERE'.to_i
 
-  # Create a statement to only select line items from a given order.
+  # Create statement object to only select line items belonging to the order and
+  # have been modified in the last 3 days.
   statement = {
-      :query => 'WHERE orderId = :order_id LIMIT 500',
-      :values => [
-          {:key => 'order_id',
-           :value => {:value => order_id, :xsi_type => 'NumberValue'}}
-      ]
+    :query => 'WHERE lastModifiedDateTime >= :date_time_string AND ' +
+        'orderId = :order_id LIMIT 500',
+    :values => [
+      {:key => 'order_id',
+       :value => {:value => order_id, :xsi_type => 'NumberValue'}},
+      {:key => 'date_time_string',
+       :value => {
+           :value => (DateTime.now - 3).strftime('%Y-%m-%dT%H:%M:%S'),
+           :xsi_type => 'TextValue'
+      }},
+    ]
   }
 
   # Get line items by statement.
@@ -68,7 +77,7 @@ end
 
 if __FILE__ == $0
   begin
-    get_line_items_by_statement()
+    get_recently_updated_line_items()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

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

@@ -28,7 +28,7 @@ require 'dfp_api'
 
 require 'pp'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 PAGE_SIZE = 500
 
 def target_custom_criteria()

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

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

data/examples/{v201103 → v201203}/network_service/get_all_networks.rb

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

data/examples/{v201103 → v201203}/network_service/get_current_network.rb

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

data/examples/{v201107/network_service/get_current_network.rb → v201203/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,23 @@
 #           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 new Google account (created at
+# http://www.google.com/accounts/newaccount) that is not associated with any
+# other DFP 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
+#
+# Tags: NetworkService.makeTestNetwork
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 
-def get_current_network()
+def make_test_network()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -36,16 +45,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/{v201104 → v201203}/order_service/approve_orders.rb

@@ -17,15 +17,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example approves and overbooks all draft orders. To determine which
-# orders exist, run get_all_orders.rb.
+# This example approves and overbooks all eligible draft or pending orders. To
+# determine which orders exist, run get_all_orders.rb.
 #
-# Tags: OrderService.getOrdersByStatement,
-#       OrderService.performOrderAction
+# Tags: OrderService.getOrdersByStatement
+# Tags: OrderService.performOrderAction
 
+require 'date'
 require 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 PAGE_SIZE = 500
 
 def approve_orders()
@@ -39,8 +40,17 @@ def approve_orders()
   # Get the OrderService.
   order_service = dfp.service(:OrderService, API_VERSION)
 
-  # Create statement text to select all draft orders.
-  statement_text = "WHERE status IN ('DRAFT', 'PENDING_APPROVAL')"
+  # Create a statement text to select all eligible draft or pending orders.
+  statement_text = "WHERE status IN ('DRAFT', 'PENDING_APPROVAL') " +
+      "AND endDateTime >= :today AND isArchived = FALSE"
+  statement = {
+      :query => statement_text,
+      :values => [
+         {:key => 'today',
+          :value => {:value => Date.today.strftime('%Y-%m-%dT%H:%M:%S'),
+                     :xsi_type => 'TextValue'}}
+     ]
+  }
 
   # Define initial values.
   offset = 0
@@ -48,10 +58,9 @@ def approve_orders()
   order_ids = []
 
   begin
-    # Create a statement to get one page with current offset.
-    statement = {
-        :query => statement_text + " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
-    }
+    # Update the statement to get one page with current offset.
+    statement[:query] =
+        statement_text + " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
 
     # Get orders by statement.
     page = order_service.get_orders_by_statement(statement)
@@ -61,13 +70,10 @@ def approve_orders()
       offset += PAGE_SIZE
 
       page[:results].each do |order|
-        # Archived orders cannot be approved.
-        if !order[:is_archived]
-          puts ("%d) Order ID: %d, status: %s and name: %s will be " +
-              "approved.") % [order_ids.size, order[:id], order[:status],
-                              order[:name]]
-          order_ids << order[:id]
-        end
+        puts ("%d) Order ID: %d, status: %s and name: %s will be " +
+            "approved.") % [order_ids.size, order[:id], order[:status],
+                            order[:name]]
+        order_ids << order[:id]
       end
     end
   end while offset < page[:total_result_set_size]

data/examples/{v201107 → v201203}/order_service/create_orders.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 # Number of orders to create.
 ITEM_COUNT = 5
 

data/examples/{v201107 → v201203}/order_service/get_all_orders.rb

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

data/examples/{v201103 → v201203}/order_service/get_order.rb

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

data/examples/{v201103 → v201203}/order_service/get_orders_by_statement.rb

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

data/examples/{v201107 → v201203}/order_service/update_orders.rb

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

data/examples/{v201103 → v201203}/placement_service/create_placements.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
 
 def create_placements()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -69,7 +69,8 @@ def create_placements()
   if page and page[:results]
     page[:results].each do |ad_unit|
       if ad_unit[:parent_id] and ad_unit[:sizes]
-        ad_unit[:sizes].each do |size|
+        ad_unit[:ad_unit_sizes].each do |ad_unit_size|
+          size = ad_unit_size[:size]
           receiver = case size[:width]
             when 120
               skyscraper_ad_unit_placement if size[:height] == 600

data/examples/{v201107 → v201203}/placement_service/deactivate_placements.rb

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

data/examples/{v201103 → v201203}/placement_service/get_all_placements.rb

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

data/examples/{v201104 → v201203}/placement_service/get_placement.rb

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

data/examples/{v201107 → v201203}/placement_service/get_placements_by_statement.rb

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

data/examples/{v201103 → v201203}/placement_service/update_placements.rb

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

data/examples/{v201104 → v201203}/publisher_query_language_service/get_all_cities.rb

@@ -17,13 +17,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets first 500 cities available to target.
+# This example gets first 500 cities available to target. A full list of
+# available tables can be found at:
+#
+# https://developers.google.com/doubleclick-publishers/docs/reference/v201203/PublisherQueryLanguageService
 #
 # Tags: PublisherQueryLanguageService.select
 
 require 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 # A string to separate columns in output. Use "," to get CSV.
 COLUMN_SEPARATOR = "\t"
 
@@ -39,6 +42,8 @@ def get_all_cities()
   pql_service = dfp.service(:PublisherQueryLanguageService, API_VERSION)
 
   # Create statement to select all targetable cities.
+  # For criteria that do not have a "targetable" property, the predicate may be
+  # left off.
   statement = {:query => 'SELECT * FROM City WHERE targetable = true LIMIT 500'}
 
   # Get all cities.