google-dfp-api 0.10.0 → 0.10.1

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

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# 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");
@@ -18,15 +16,13 @@
 #           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 = :v201408
+API_VERSION = :v201508
 
 def update_line_items()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -43,19 +39,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/{v201408 → v201508}/network_service/get_all_networks.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# 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");
@@ -19,12 +17,10 @@
 #           limitations under the License.
 #
 # This example gets all Networks to which the current login has access.
-#
-# Tags: NetworkService.getAllNetworks
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def get_all_networks()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

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

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# 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");
@@ -19,12 +17,10 @@
 #           limitations under the License.
 #
 # This example gets the current network that you can make requests against.
-#
-# Tags: NetworkService.getCurrentNetwork
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def get_current_network()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

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

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
@@ -30,12 +28,10 @@
 #
 # 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 = :v201408
+API_VERSION = :v201508
 
 def make_test_network()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

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

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# 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");
@@ -20,14 +18,11 @@
 #
 # This example approves and overbooks all eligible draft or pending orders. To
 # determine which orders exist, run get_all_orders.rb.
-#
-# Tags: OrderService.getOrdersByStatement
-# Tags: OrderService.performOrderAction
 
 require 'date'
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 PAGE_SIZE = 500
 
 def approve_orders()
@@ -42,52 +37,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/{v201408 → v201508}/order_service/create_orders.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# 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");
@@ -22,12 +20,10 @@
 # get_all_orders.rb. To determine which companies are advertisers, run
 # get_companies_by_statement.rb. To get salespeople and traffickers, run
 # get_all_users.rb.
-#
-# Tags: OrderService.createOrders
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 # Number of orders to create.
 ITEM_COUNT = 5
 

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

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# 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");
@@ -19,13 +17,11 @@
 #           limitations under the License.
 #
 # This example gets all orders. To create orders, run create_orders.rb.
-#
-# Tags: OrderService.getOrdersByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def get_all_orders()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,33 +34,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 => "ORDER BY id ASC 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)

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

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# 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");
@@ -18,16 +16,14 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all orders for a given advertiser. The statement retrieves
-# up to the maximum page size limit of 500. To create orders, run
+# This example gets all orders for a given advertiser. To create orders, run
 # create_orders.rb. To determine which companies are advertisers, run
 # get_companies_by_statement.rb.
-#
-# Tags: OrderService.getOrdersByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def get_orders_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -44,23 +40,27 @@ def get_orders_by_statement()
   advertiser_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'.to_i
 
   # Create a statement to only select orders for a given advertiser.
-  statement = {
-      :query => 'WHERE advertiserId = :advertiser_id ORDER BY id ASC LIMIT 500',
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE advertiserId = :advertiser_id ORDER BY id ASC',
+      [
           {:key => 'advertiser_id',
            :value => {:value => advertiser_id, :xsi_type => 'NumberValue'}}
       ]
-  }
+  )
 
-  # Get orders by statement.
-  page = order_service.get_orders_by_statement(statement)
+  begin
+    # Get orders by statement.
+    page = order_service.get_orders_by_statement(statement.toStatement())
 
-  if page and page[:results]
-    page[:results].each_with_index do |order, index|
-      puts "%d) Order ID: %d, belongs to advertiser ID: %d, name: %s." % [index,
-          order[:id], order[:advertiser_id], order[:name]]
+    if page and page[:results]
+      page[:results].each_with_index do |order, index|
+        puts "%d) Order ID: %d, belongs to advertiser ID: %d, name: %s." % [
+            index + statement.offset,
+            order[:id], order[:advertiser_id], order[: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/{v201408 → v201508}/order_service/update_orders.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# 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");
@@ -18,14 +16,13 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example updates the notes of each order up to the first 500.
+# This example updates the notes of a specific order.
 # To determine which orders exist, run get_all_orders.rb.
-#
-# Tags: OrderService.getOrdersByStatement, OrderService.updateOrders
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def update_orders()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,24 +35,31 @@ def update_orders()
   # Get the OrderService.
   order_service = dfp.service(:OrderService, API_VERSION)
 
+  order_id = 'INSERT_ORDER_ID_HERE'.to_i
+
   # Create a statement to get first 500 orders.
-  statement = {:query => 'LIMIT 500'}
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id ORDER BY id ASC',
+      [
+          {:key => 'id',
+          :value => {:value => order_id, :xsi_type => 'NumberValue'}}
+      ],
+      1
+  )
 
   # Get orders by statement.
-  page = order_service.get_orders_by_statement(statement)
+  page = order_service.get_orders_by_statement(statement.toStatement())
 
   if page[:results]
     orders = page[:results]
 
-    new_orders = orders.inject([]) do |new_orders, order|
+    orders.each do |order|
       # Archived orders can not be updated.
       if !order[:is_archived]
         order[:notes] = 'Spoke to advertiser. All is well.'
         # Workaround for issue #94.
         order[:po_number] = "" if order[:po_number].nil?
-        new_orders << order
       end
-      new_orders
     end
 
     # Update the orders on the server.

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

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# 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");
@@ -20,13 +18,11 @@
 #
 # This example creates new placements for various ad unit sizes. To determine
 # which placements exist, run get_all_placements.rb.
-#
-# Tags: PlacementService.createPlacements
-# Tags: InventoryService.getAdUnitsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def create_placements()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -64,7 +60,8 @@ def create_placements()
   }
 
   # Get the first 500 ad units.
-  page = inventory_service.get_ad_units_by_statement({:query => 'LIMIT 500'})
+  page = inventory_service.get_ad_units_by_statement(
+      DfpApiStatement::FilterStatement.new('ORDER BY id ASC').toStatement())
 
   # Separate the ad units by size.
   if page and page[:results]