google-dfp-api 0.9.2 → 0.9.3

data/examples/{v201311 → v201411}/line_item_service/create_video_line_item.rb

@@ -30,7 +30,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 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/{v201311 → v201411}/line_item_service/get_all_line_items.rb

@@ -24,9 +24,9 @@
 # Tags: LineItemService.getLineItemsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
-PAGE_SIZE = 500
+API_VERSION = :v201411
 
 def get_all_line_items()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,32 +39,24 @@ def get_all_line_items()
   # Get the LineItemService.
   line_item_service = dfp.service(:LineItemService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create a statement to get one page with current offset.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
   begin
-    # Create a statement to get one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
-
     # 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[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      # Get the start index for printout.
-      start_index = page[:start_index]
-
       # Print details about each line item in results.
       page[:results].each_with_index do |line_item, index|
         puts "%d) Line item ID: %d, order ID: %d, name: %s" %
-            [index + start_index, line_item[:id],
+            [index + statement.offset, line_item[:id],
              line_item[:order_id], line_item[:name]]
       end
     end
-  end while offset < page[:total_result_set_size]
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+  end while statement.offset < page[:total_result_set_size]
 
   # Print a footer.
   if page.include?(:total_result_set_size)

data/examples/{v201311 → v201411}/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 = :v201311
+API_VERSION = :v201411
 
 def get_line_items_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -43,26 +43,28 @@ 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',
+      [
           {: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/{v201311 → v201411}/line_item_service/get_recently_updated_line_items.rb

@@ -27,8 +27,9 @@
 require 'date'
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def get_recently_updated_line_items()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -46,10 +47,10 @@ def get_recently_updated_line_items()
 
   # Create statement object to only select line items belonging to the order and
   # have been modified in the last 3 days.
-  statement = {
-    :query => 'WHERE lastModifiedDateTime >= :date_time_string AND ' +
-        'orderId = :order_id LIMIT 500',
-    :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+    'WHERE lastModifiedDateTime >= :date_time_string AND ' +
+    'orderId = :order_id ORDER BY id ASC',
+    [
       {:key => 'order_id',
        :value => {:value => order_id, :xsi_type => 'NumberValue'}},
       {:key => 'date_time_string',
@@ -58,17 +59,22 @@ def get_recently_updated_line_items()
            :xsi_type => 'TextValue'
       }},
     ]
-  }
+  )
 
-  # Get line items by statement.
-  page = line_item_service.get_line_items_by_statement(statement)
+  begin
+    # Get line items by statement.
+    page = line_item_service.get_line_items_by_statement(
+        statement.toStatement())
 
-  if page and page[:results]
-    page[:results].each_with_index do |line_item, index|
-      puts "%d) [%d] belongs to order ID %d, name: %s." % [index,
-          line_item[:id], line_item[:order_id], line_item[:name]]
+    if page and page[:results]
+      page[:results].each_with_index do |line_item, 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
     end
-  end
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+  end while statement.offset < page[:total_result_set_size]
 
   # Print a footer.
   if page.include?(:total_result_set_size)

data/examples/{v201311 → v201411}/line_item_service/target_custom_criteria.rb

@@ -23,13 +23,15 @@
 # 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 'dfp_api_statement'
 
 require 'pp'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 PAGE_SIZE = 500
 
 def target_custom_criteria()
@@ -88,22 +90,36 @@ 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 = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id ORDER BY id ASC',
+      [
+          {:key => 'id',
+           :value => {:value => line_item_id, :xsi_type => 'NumberValue'}}
+      ],
+      1
+  )
 
-  # Update the line items on the server.
-  return_line_item = line_item_service.update_line_item(line_item)
+  # Get line items by statement.
+  page = line_item_service.get_line_items_by_statement(statement.toStatement())
 
-  # 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.'
+  if page[:results]
+    line_item = page[:results].first
+
+    line_item[:targeting] = {:custom_targeting => top_custom_criteria_set}
+
+    # 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/{v201311 → v201411}/line_item_service/update_line_items.rb

@@ -18,15 +18,15 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example updates the delivery rate of all line items for an order up to
-# the first 500. To determine which line items exist, run get_all_line_items.rb.
+# This example updates the delivery rate of all line items for an order.
+# To determine which line items exist, run get_all_line_items.rb.
 # To determine which order exist, run get_all_orders.rb.
 #
 # Tags: LineItemService.getLineItemsByStatement, LineItemService.updateLineItems
 
 require 'dfp_api'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def update_line_items()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -43,19 +43,19 @@ def update_line_items()
   order_id = 'INSERT_ORDER_ID_HERE'.to_i
 
   # Create a statement to get line items with even delivery rates.
-  statement = {
-      :query => 'WHERE deliveryRateType = :delivery_rate_type AND ' +
-          'orderId = :order_id LIMIT 500',
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE deliveryRateType = :delivery_rate_type AND ' +
+      'orderId = :order_id ',
+      [
           {:key => 'delivery_rate_type',
            :value => {:value => 'EVENLY', :xsi_type => 'TextValue'}},
           {:key => 'order_id',
            :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[:results]
     line_items = page[:results]

data/examples/{v201311 → v201411}/network_service/get_all_networks.rb

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

data/examples/{v201311 → v201411}/network_service/get_current_network.rb

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

data/examples/{v201311 → v201411}/network_service/make_test_network.rb

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

data/examples/{v201311 → v201411}/order_service/approve_orders.rb

@@ -27,7 +27,7 @@
 require 'date'
 require 'dfp_api'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 PAGE_SIZE = 500
 
 def approve_orders()
@@ -42,52 +42,44 @@ def approve_orders()
   order_service = dfp.service(:OrderService, API_VERSION)
 
   # 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 => [
+  statement = DfpApiStatement::FilterStatement.new(
+      "WHERE status IN ('DRAFT', 'PENDING_APPROVAL') " +
+      "AND endDateTime >= :today AND isArchived = FALSE",
+      [
          {:key => 'today',
           :value => {:value => Date.today.strftime('%Y-%m-%dT%H:%M:%S'),
                      :xsi_type => 'TextValue'}}
-     ]
-  }
+      ]
+  )
 
-  # Define initial values.
-  offset = 0
-  page = {}
   order_ids = []
 
   begin
-    # 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)
+    page = order_service.get_orders_by_statement(statement.toStatement())
 
     if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      page[:results].each do |order|
+      page[:results].each_with_index do |order, index|
         puts ("%d) Order ID: %d, status: %s and name: %s will be " +
-            "approved.") % [order_ids.size, order[:id], order[:status],
+            "approved.") % [index + statement.offset,
+                            order[:id], order[:status],
                             order[:name]]
         order_ids << order[:id]
       end
     end
-  end while offset < page[:total_result_set_size]
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+  end while statement.offset < page[:total_result_set_size]
 
   puts "Number of orders to be approved: %d" % order_ids.size
 
   if !order_ids.empty?
     # Create statement for action.
-    statement = {:query => "WHERE id IN (%s)" % order_ids.join(', ')}
+    statement = DfpApiStatement::FilterStatement.new(
+        "WHERE id IN (%s)" % order_ids.join(', '))
 
     # Perform action.
     result = order_service.perform_order_action(
-        {:xsi_type => 'ApproveAndOverbookOrders'}, statement)
+        {:xsi_type => 'ApproveAndOverbookOrders'}, statement.toStatement())
 
     # Display results.
     if result and result[:num_changes] > 0

data/examples/{v201311 → v201411}/order_service/create_orders.rb

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

data/examples/{v201311 → v201411}/order_service/get_all_orders.rb

@@ -23,9 +23,9 @@
 # Tags: OrderService.getOrdersByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
-PAGE_SIZE = 500
+API_VERSION = :v201411
 
 def get_all_orders()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,32 +38,23 @@ def get_all_orders()
   # Get the OrderService.
   order_service = dfp.service(:OrderService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create statement for one page with current offset.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
   begin
-    # Create statement for one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
-
     # Get orders by statement.
-    page = order_service.get_orders_by_statement(statement)
+    page = order_service.get_orders_by_statement(statement.toStatement())
 
     if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      # Get the start index for printout.
-      start_index = page[:start_index]
-
       # Print details about each order in results page.
       page[:results].each_with_index do |order, index|
         puts "%d) Order ID: %d, name: %s, advertiser ID: %d" %
-            [index + start_index, order[:id], order[:name],
+            [index + statement.offset, order[:id], order[:name],
              order[:advertiser_id]]
       end
     end
-  end while offset < page[:total_result_set_size]
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+  end while statement.offset < page[:total_result_set_size]
 
   # Print a footer
   if page.include?(:total_result_set_size)