google-dfp-api 0.8.1 → 0.9.0

data/examples/{v201211 → v201408}/inventory_service/update_ad_units.rb

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

data/examples/{v201211 → v201408}/label_service/create_labels.rb

@@ -27,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201211
+API_VERSION = :v201408
 # Number of labels to create.
 ITEM_COUNT = 5
 

data/examples/{v201302 → v201408}/label_service/deactivate_labels.rb

@@ -27,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201408
 PAGE_SIZE = 500
 
 def deactivate_labels()

data/examples/{v201211 → v201408}/label_service/get_all_labels.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201211
+API_VERSION = :v201408
 PAGE_SIZE = 500
 
 def get_all_labels()

data/examples/{v201211 → v201408}/label_service/get_labels_by_statement.rb

@@ -27,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201211
+API_VERSION = :v201408
 
 def get_labels_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201302 → v201408}/label_service/update_labels.rb

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

data/examples/{v201302 → v201408}/line_item_creative_association_service/create_licas.rb

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

data/examples/{v201211 → v201408}/line_item_creative_association_service/deactivate_licas.rb

@@ -27,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201211
+API_VERSION = :v201408
 PAGE_SIZE = 500
 
 def deactivate_licas()

data/examples/{v201211 → v201408}/line_item_creative_association_service/get_all_licas.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201211
+API_VERSION = :v201408
 PAGE_SIZE = 500
 
 def get_all_licas()

data/examples/{v201208 → v201408}/line_item_creative_association_service/get_licas_by_statement.rb

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

data/examples/{v201302 → v201408}/line_item_creative_association_service/update_licas.rb

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

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

@@ -30,7 +30,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201211
+API_VERSION = :v201408
 PAGE_SIZE = 500
 
 def activate_line_items()

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

@@ -29,7 +29,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201211
+API_VERSION = :v201408
 # Number of line items to create.
 ITEM_COUNT = 5
 
@@ -135,8 +135,11 @@ def create_line_items()
     }
 
     # Set the number of units bought to 500,000 so that the budget is $1,000.
-    line_item[:units_bought] = 500000
-    line_item[:unit_type] = 'IMPRESSIONS'
+    line_item[:primary_goal] = {:goal => {
+        :units => '500000',
+        :unit_type => 'IMPRESSIONS',
+        :goal_type => 'LIFETIME'}
+    }
 
     line_item
   end

data/examples/{v201302 → v201408}/line_item_service/create_video_line_item.rb

@@ -30,7 +30,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201408
 
 def create_video_line_item()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -108,7 +108,13 @@ def create_video_line_item()
       :cost_type => 'CPD',
       :cost_per_unit => {:currency_code => 'USD', :micro_amount => 1000000},
       # Set the percentage to be 100%.
-      :units_bought => 100
+      :primary_goal => {
+          :goal => {
+              :units => '100',
+              :unit_type => 'IMPRESSIONS',
+              :goal_type => 'DAILY'
+          }
+      }
   }
 
   # Create the master creative placeholder and companion creative placeholders.

data/examples/{v201302 → v201408}/line_item_service/get_all_line_items.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201408
 PAGE_SIZE = 500
 
 def get_all_line_items()

data/examples/{v201211 → v201408}/line_item_service/get_line_items_by_statement.rb

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+# Author:: api.nicholaschen@gmail.com (Nicholas Chen)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2014, 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.
@@ -18,16 +18,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# 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
+# This example gets all line items for a given order. 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'
+require 'dfp_api_statement'
 
-API_VERSION = :v201211
+API_VERSION = :v201408
 
 def get_line_items_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -43,26 +43,29 @@ 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 that need creatives from a
-  # given order.
-  statement = {
-      :query => 'WHERE orderId = :order_id AND status = :status LIMIT 500',
-      :values => [
+  # Create a statement to only select line items from a given order.
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE orderId = :order_id ORDER BY id ASC',
+      values=
+      [
           {:key => 'order_id',
-           :value => {:value => order_id, :xsi_type => 'NumberValue'}},
-          {:key => 'status',
-           :value => {:value => 'NEEDS_CREATIVES', :xsi_type => 'TextValue'}}
+           :value => {:value => order_id, :xsi_type => 'NumberValue'}}
       ]
-  }
+  )
+
 
   # Get line items by statement.
-  page = line_item_service.get_line_items_by_statement(statement)
+  page = line_item_service.get_line_items_by_statement(statement.toStatement())
 
-  if page and page[:results]
+  while page and page[:results] do
     page[:results].each_with_index do |line_item, index|
-      puts "%d) [%d] belongs to order ID %d, name: %s." % [index,
+      puts "%d) [%d] belongs to order ID %d, name: %s." % [
+          index + statement.offset,
           line_item[:id], line_item[:order_id], line_item[:name]]
     end
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+    page = line_item_service.get_line_items_by_statement(
+        statement.toStatement())
   end
 
   # Print a footer.

data/examples/{v201302 → v201408}/line_item_service/get_recently_updated_line_items.rb

@@ -28,7 +28,7 @@ require 'date'
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201408
 
 def get_recently_updated_line_items()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

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

@@ -23,13 +23,14 @@
 # which custom targeting keys and values exist, run
 # get_all_custom_targeting_keys_and_values.rb.
 #
-# Tags: LineItemService.getLineItem, LineItemService.updateLineItem
+# Tags: LineItemService.getLineItemsByStatement,
+#       LineItemService.updateLineItems
 
 require 'dfp_api'
 
 require 'pp'
 
-API_VERSION = :v201211
+API_VERSION = :v201408
 PAGE_SIZE = 500
 
 def target_custom_criteria()
@@ -88,22 +89,35 @@ def target_custom_criteria()
       :children => [custom_criteria[0], sub_custom_criteria_set]
   }
 
-  # Get the line item.
-  line_item = line_item_service.get_line_item(line_item_id)
 
-  # Set the custom criteria targeting on the line item.
-  line_item[:targeting] = {:custom_targeting => top_custom_criteria_set}
+  # Create a statement to only select a single line item.
+  statement = {
+      :query => 'WHERE id = :id ORDER BY id ASC LIMIT 1',
+      :values => [
+          {:key => 'id',
+           :value => {:value => line_item_id, :xsi_type => 'NumberValue'}}
+      ]
+  }
+
+  # Get line items by statement.
+  page = line_item_service.get_line_items_by_statement(statement)
+
+  if page[:results]
+    line_item = page[:results].first
 
-  # Update the line items on the server.
-  return_line_item = line_item_service.update_line_item(line_item)
+    line_item[:targeting] = {:custom_targeting => top_custom_criteria_set}
 
-  # Display the updated line item.
-  if return_line_item
-    puts "Line item ID: %d was updated with custom criteria targeting:" %
-        return_line_item[:id]
-    pp return_line_item[:targeting]
-  else
-    puts 'Line item update failed.'
+    # Update the line items on the server.
+    return_line_item = line_item_service.update_line_items([line_item])
+
+    # Display the updated line item.
+    if return_line_item
+      puts "Line item ID: %d was updated with custom criteria targeting:" %
+          return_line_item[:id]
+      pp return_line_item[:targeting]
+    else
+      puts 'Line item update failed.'
+    end
   end
 end
 

data/examples/{v201208 → v201408}/line_item_service/update_line_items.rb

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

data/examples/{v201208 → v201408}/network_service/get_all_networks.rb

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

data/examples/{v201208 → v201408}/network_service/get_current_network.rb

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

data/examples/{v201302 → v201408}/network_service/make_test_network.rb

@@ -35,7 +35,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201408
 
 def make_test_network()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201302 → v201408}/order_service/approve_orders.rb

@@ -27,7 +27,7 @@
 require 'date'
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201408
 PAGE_SIZE = 500
 
 def approve_orders()

data/examples/{v201211 → v201408}/order_service/create_orders.rb

@@ -27,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201211
+API_VERSION = :v201408
 # Number of orders to create.
 ITEM_COUNT = 5
 

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

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201211
+API_VERSION = :v201408
 PAGE_SIZE = 500
 
 def get_all_orders()

data/examples/{v201302 → v201408}/order_service/get_orders_by_statement.rb

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

data/examples/{v201302 → v201408}/order_service/update_orders.rb

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

data/examples/{v201302 → v201408}/placement_service/create_placements.rb

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

data/examples/{v201211 → v201408}/placement_service/deactivate_placements.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201211
+API_VERSION = :v201408
 PAGE_SIZE = 500
 
 def deactivate_placements()

data/examples/{v201211 → v201408}/placement_service/get_all_placements.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201211
+API_VERSION = :v201408
 PAGE_SIZE = 500
 
 def get_all_placements()

data/examples/{v201211 → v201408}/placement_service/get_placements_by_statement.rb

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