google-dfp-api 0.9.2 → 0.9.3

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

@@ -18,16 +18,16 @@
 #           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 = :v201311
+API_VERSION = :v201411
 
 def get_orders_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -44,23 +44,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 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/{v201311 → v201411}/order_service/update_orders.rb

@@ -18,14 +18,15 @@
 #           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 = :v201311
+API_VERSION = :v201411
 
 def update_orders()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,24 +39,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/{v201311 → v201411}/placement_service/create_placements.rb

@@ -25,8 +25,9 @@
 # Tags: InventoryService.getAdUnitsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def create_placements()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -64,7 +65,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]

data/examples/{v201311 → v201411}/placement_service/deactivate_placements.rb

@@ -26,8 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201311
-PAGE_SIZE = 500
+API_VERSION = :v201411
 
 def deactivate_placements()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,50 +39,43 @@ def deactivate_placements()
   # Get the PlacementService.
   placement_service = dfp.service(:PlacementService, API_VERSION)
 
-  # Create statement text and statement to select active placements.
-  statement_text = 'WHERE status = :status'
-  statement = {
-      :values => [
+  # Create statement to select active placements.
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE status = :status',
+      [
           {:key => 'status',
            :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
       ]
-  }
+  )
 
   # Define initial values.
-  offset = 0
-  page = {}
   placement_ids = []
 
   begin
-    # Modify the statement to get one page with current offset.
-    statement[:query] = statement_text +
-        " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
-
     # Get placements by statement.
-    page = placement_service.get_placements_by_statement(statement)
+    page = placement_service.get_placements_by_statement(
+        statement.toStatement())
 
     if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      page[:results].each do |placement|
+      page[:results].each_with_index do |placement, index|
         puts ("%d) Placement ID: %d, name: %s and status: %s will be " +
-            "deactivated.") % [placement_ids.size, placement[:id],
+            "deactivated.") % [index + statement.offset, placement[:id],
             placement[:name], placement[:status]]
         placement_ids << placement[:id]
       end
     end
-  end while offset < page[:total_result_set_size]
+  end while statement.offset < page[:total_result_set_size]
 
   puts "Number of placements to be deactivated: %d" % placement_ids.size
 
   if !placement_ids.empty?
     # Create a statement for action.
-    statement = {:query => "WHERE id IN (%s)" % placement_ids.join(', ')}
+    statement = DfpApiStatement::FilterStatement.new(
+        "WHERE id IN (%s)" % placement_ids.join(', '))
 
     # Perform action.
     result = placement_service.perform_placement_action(
-        {:xsi_type => 'DeactivatePlacements'}, statement)
+        {:xsi_type => 'DeactivatePlacements'}, statement.toStatement())
 
     # Display results.
     if result and result[:num_changes] > 0

data/examples/{v201311 → v201411}/placement_service/get_all_placements.rb

@@ -24,9 +24,9 @@
 # Tags: PlacementService.getPlacementsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
-PAGE_SIZE = 500
+API_VERSION = :v201411
 
 def get_all_placements()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,31 +39,23 @@ def get_all_placements()
   # Get the PlacementService.
   placement_service = dfp.service(:PlacementService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create statement for placements ordered by ID.
+  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 placements by statement.
-    page = placement_service.get_placements_by_statement(statement)
+    page = placement_service.get_placements_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 placement in results page.
       page[:results].each_with_index do |placement, index|
         puts "%d) Placement ID: %d, name: %s." %
-            [index + start_index, placement[:id], placement[:name]]
+            [index + statement.offset, placement[:id], placement[: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}/placement_service/get_placements_by_statement.rb

@@ -18,15 +18,15 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all active placements. The statement retrieves up to the
-# maximum page size limit of 500. To create a placement, run
+# This example gets all active placements. To create a placement, run
 # create_placements.rb.
 #
 # Tags: PlacementService.getPlacementsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def get_placements_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,23 +40,28 @@ def get_placements_by_statement()
   placement_service = dfp.service(:PlacementService, API_VERSION)
 
   # Create a statement to only select active placements.
-  statement = {
-      :query => 'WHERE status = :status LIMIT 500',
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE status = :status ORDER BY id ASC',
+      [
           {:key => 'status',
            :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
       ]
   }
 
-  # Get placements by statement.
-  page = placement_service.get_placements_by_statement(statement)
+  begin
+    # Get placements by statement.
+    page = placement_service.get_placements_by_statement(
+        statement.toStatement())
 
-  if page and page[:results]
-    page[:results].each_with_index do |placement, index|
-      puts "%d) Placement ID: %d, name: %s, status: %s." % [index,
-          placement[:id], placement[:name], placement[:status]]
+    if page and page[:results]
+      page[:results].each_with_index do |placement, index|
+        puts "%d) Placement ID: %d, name: %s, status: %s." % [
+            index + statement.offset,
+            placement[:id], placement[:name], placement[:status]]
+      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}/placement_service/update_placements.rb

@@ -18,15 +18,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example updates all placements to allow for AdSense targeting up to the
-# first 500. To determine which placements exist, run get_all_placements.rb.
+# This example updates a single placement to allow for AdSense targeting.
+# To determine which placements exist, run get_all_placements.rb.
 #
 # Tags: PlacementService.getPlacementsByStatement
 # Tags: PlacementService.updatePlacements
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def update_placements()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,11 +40,20 @@ def update_placements()
   # Get the PlacementService.
   placement_service = dfp.service(:PlacementService, API_VERSION)
 
-  # Create a statement to get first 500 placements.
-  statement = {:query => 'LIMIT 500'}
+  placement_id = 'INSERT_PLACEMENT_ID_HERE'.to_i
+
+  # Create a statement to get a single placement by ID.
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id ORDER BY id ASC',
+      [
+         {:key => 'id',
+          :value => {:value => placement_id, :xsi_type => 'NumberValue'}}
+      ],
+      1
+  )
 
   # Get placements by statement.
-  page = placement_service.get_placements_by_statement(statement)
+  page = placement_service.get_placements_by_statement(statement.toStatement())
 
   if page[:results]
     placements = page[:results]

data/examples/{v201311 → v201411}/publisher_query_language_service/fetch_match_tables.rb

@@ -22,18 +22,19 @@
 # Ad_Unit tables. This example may take a while to run.
 #
 # A full list of available tables can be found at:
-# https://developers.google.com/doubleclick-publishers/docs/reference/v201311/PublisherQueryLanguageService
+#
+#   https://developers.google.com/doubleclick-publishers/docs/reference/v201411/PublisherQueryLanguageService
 #
 # Tags: PublisherQueryLanguageService.select
 
 require 'tempfile'
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 # A string to separate columns in output. Use "," to get CSV.
 COLUMN_SEPARATOR = ','
-PAGE_SIZE = 500
 
 def fetch_match_tables()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -58,19 +59,16 @@ end
 # Fetches a match table from a PQL statement and writes it to a file.
 def fetch_match_table(table_name, pql_service)
   # Create a statement to select all items for the table.
-  statement_text = ('SELECT Id, Name, Status FROM %s ' % table_name) +
-      'ORDER BY Id ASC LIMIT %d OFFSET %d'
+  statement = DfpApiStatement::FilterStatement.new(
+      'SELECT Id, Name, Status FROM %s ' % table_name + 'ORDER BY Id ASC')
 
   # Set initial values.
-  offset = 0
   file_path = '%s.csv' % table_name
 
   open(file_path, 'wb') do |file|
     file_path = file.path()
     begin
-      # Create statement for a page.
-      statement = {:query => statement_text % [PAGE_SIZE, offset]}
-      result_set = pql_service.select(statement)
+      result_set = pql_service.select(statement.toStatement())
 
       if result_set
         # Only write column names if the first page.
@@ -85,8 +83,8 @@ def fetch_match_table(table_name, pql_service)
         end
       end
       # Update the counters.
-      offset += PAGE_SIZE
-    end while result_set[:rows].size == PAGE_SIZE
+      statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+    end while result_set[:rows].size == DfpApiStatement::SUGGESTED_PAGE_LIMIT
   end
   return file_path
 end

data/examples/{v201311 → v201411}/publisher_query_language_service/get_all_line_items.rb

@@ -26,11 +26,11 @@
 # Tags: PublisherQueryLanguageService.select
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 # A string to separate columns in output. Use "," to get CSV.
 COLUMN_SEPARATOR = "\t"
-PAGE_SIZE = 500
 
 def get_all_line_items()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -44,16 +44,15 @@ def get_all_line_items()
   pql_service = dfp.service(:PublisherQueryLanguageService, API_VERSION)
 
   # Statement parts to help build a statement to select all line items.
-  statement_text = 'SELECT Id, Name, Status FROM Line_Item LIMIT %d OFFSET %d'
+  statement = DfpApiStatement::FilterStatement.new(
+      'SELECT Id, Name, Status FROM Line_Item ORDER BY Id ASC')
 
   # Set initial values for paging.
-  offset, result_set, all_rows = 0, nil, 0
+  result_set, all_rows = nil, 0
 
   # Get all line items with paging.
   begin
-    # Create statement for a page.
-    statement = {:query => statement_text % [PAGE_SIZE, offset]}
-    result_set = pql_service.select(statement)
+    result_set = pql_service.select(statement.toStatement())
 
     if result_set
       # Print out columns header.
@@ -68,9 +67,9 @@ def get_all_line_items()
     end
 
     # Update the counters.
-    offset += PAGE_SIZE
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
     all_rows += result_set[:rows].size
-  end while result_set[:rows].size == PAGE_SIZE
+  end while result_set[:rows].size == DfpApiStatement::SUGGESTED_PAGE_LIMIT
 
   # Print a footer.
   if result_set[:rows]