google-dfp-api 0.10.0 → 0.10.1

data/examples/{v201408 → v201508}/line_item_creative_association_service/update_licas.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,12 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example updates the destination URL of all LICAs up to the first 500. To
-# determine which LICAs exist, run get_all_licas.rb.
-#
-# Tags: LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatement
-# Tags: LineItemCreativeAssociationService.updateLineItemCreativeAssociations
+# This example updates the destination URL of all LICAs belonging to a line item.
+# To determine which LICAs exist, run get_all_licas.rb.
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def update_licas()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,12 +34,21 @@ def update_licas()
   # Get the LineItemCreativeAssociationService.
   lica_service = dfp.service(:LineItemCreativeAssociationService, API_VERSION)
 
-  # Create a statement to get all LICAs.
-  statement = {:query => 'LIMIT 500'}
+  # Set the line item to get LICAs by.
+  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
+
+  # Create a statement to only select LICAs for the given line item ID.
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE lineItemId = :line_item_id ORDER BY lineItemId, creativeId ASC',
+      [
+          {:key => 'line_item_id',
+           :value => {:value => line_item_id, :xsi_type => 'NumberValue'}}
+      ]
+  )
 
   # Get LICAs by statement.
-  page =
-      lica_service.get_line_item_creative_associations_by_statement(statement)
+  page = lica_service.get_line_item_creative_associations_by_statement(
+      statement.toStatement())
 
   if page[:results]
     licas = page[:results]

data/examples/{v201408 → v201508}/line_item_service/activate_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");
@@ -24,14 +22,11 @@
 # order to which they belong by running approve_orders.rb. To create LICAs, run
 # create_licas.rb. To determine which line items exist, run
 # get_all_line_items.rb. To determine which orders exist, run get_all_orders.rb.
-#
-# Tags: LineItemService.getLineItemsByStatement
-# Tags: LineItemService.performLineItemAction
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def activate_line_items()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -49,33 +44,24 @@ def activate_line_items()
 
   # Create a statement to only select line items from the specified order that
   # are in the approved (needs creatives) state.
-  statement_text = 'WHERE orderID = :order_id AND status = :status'
-  statement = {
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE orderID = :order_id AND status = :status',
+      [
           {:key => 'order_id',
            :value => {:value => order_id, :xsi_type => 'NumberValue'}},
           {:key => 'status',
            :value => {:value => 'NEEDS_CREATIVES', :xsi_type => 'TextValue'}}
       ]
-  }
+  )
 
-  # Define initial values.
-  offset = 0
-  page = {}
   line_item_ids = []
 
   begin
-    # Create a statement to get one page with current offset.
-    statement[:query] = statement_text +
-        " 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
-
       page[:results].each do |line_item|
         if !line_item[:is_archived]
           puts ("%d) Line item with ID: %d, order ID: %d and name: %s will " +
@@ -85,18 +71,19 @@ def activate_line_items()
         end
       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 line items to be activated: %d" % line_item_ids.size
 
   if !line_item_ids.empty?
     # Modify statement for action. Note, the values are still present.
-    statement[:query] = statement_text + " AND id IN (%s)" %
-        line_item_ids.join(', ')
+    statement = DfpApiStatement::FilterStatement.new(
+        "WHERE id IN (%s)" % line_item_ids.join(', '))
 
     # Perform action.
     result = line_item_service.perform_line_item_action(
-        {:xsi_type => 'ActivateLineItems'}, statement)
+        {:xsi_type => 'ActivateLineItems'}, statement.toStatement())
 
     # Display results.
     if result and result[:num_changes] > 0

data/examples/{v201408 → v201508}/line_item_service/create_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");
@@ -24,12 +22,10 @@
 # get_all_placements.rb. To determine the IDs for locations, run
 # get_all_cities.rb, get_all_countries.rb, get_all_metros.rb and
 # get_all_regions.rb.
-#
-# Tags: LineItemService.createLineItems
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 # Number of line items to create.
 ITEM_COUNT = 5
 
@@ -125,7 +121,13 @@ def create_line_items()
 
     # Set the length of the line item to run.
     line_item[:start_date_time_type] = 'IMMEDIATELY'
-    line_item[:end_date_time] = Time.new + 60 * 60 * 24 * 7
+    line_item[:end_date_time] = {:date => {:year => Time.now.year + 1,
+                                           :month => 9,
+                                           :day => 30},
+                                 :hour => 0,
+                                 :minute => 0,
+                                 :second => 0,
+                                 :time_zone_id => 'America/Los_Angeles'}
 
     # Set the cost per unit to $2.
     line_item[:cost_type] = 'CPM'
@@ -135,10 +137,10 @@ def create_line_items()
     }
 
     # Set the number of units bought to 500,000 so that the budget is $1,000.
-    line_item[:primary_goal] = {:goal => {
+    line_item[:primary_goal] = {
         :units => '500000',
         :unit_type => 'IMPRESSIONS',
-        :goal_type => 'LIFETIME'}
+        :goal_type => 'LIFETIME'
     }
 
     line_item

data/examples/{v201408 → v201508}/line_item_service/create_video_line_item.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");
@@ -25,12 +23,10 @@
 # create_custom_targeting_keys_and_values.rb.
 #
 # This feature is only available to DFP premium solution networks.
-#
-# Tags: LineItemService.createLineItem
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def create_video_line_item()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -103,17 +99,21 @@ def create_video_line_item()
       :companion_delivery_option => 'OPTIONAL',
       # Set the length of the line item to run.
       :start_date_time_type => 'IMMEDIATELY',
-      :end_date_time => Time.new + 60 * 60 * 24 * 7,
+      line_item[:end_date_time] = {:date => {:year => Time.now.year + 1,
+                                       :month => 9,
+                                       :day => 30},
+                             :hour => 0,
+                             :minute => 0,
+                             :second => 0,
+                             :time_zone_id => 'America/Los_Angeles'}
       # Set the cost per day to $1.
       :cost_type => 'CPD',
       :cost_per_unit => {:currency_code => 'USD', :micro_amount => 1000000},
       # Set the percentage to be 100%.
       :primary_goal => {
-          :goal => {
-              :units => '100',
-              :unit_type => 'IMPRESSIONS',
-              :goal_type => 'DAILY'
-          }
+          :units => '100',
+          :unit_type => 'IMPRESSIONS',
+          :goal_type => 'DAILY'
       }
   }
 

data/examples/{v201408 → v201508}/line_item_service/get_all_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");
@@ -20,13 +18,11 @@
 #
 # This example gets all line items. To create line items, run
 # create_line_items.rb.
-#
-# Tags: LineItemService.getLineItemsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def get_all_line_items()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,33 +35,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 => "ORDER BY id ASC 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/{v201408 → v201508}/line_item_service/get_line_items_by_statement.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.nicholaschen@gmail.com (Nicholas Chen)
-#
 # Copyright:: Copyright 2014, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,13 +19,11 @@
 # 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 = :v201408
+API_VERSION = :v201508
 
 def get_line_items_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -46,7 +42,6 @@ def get_line_items_by_statement()
   # 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'}}

data/examples/{v201408 → v201508}/line_item_service/get_recently_updated_line_items.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");
@@ -21,14 +19,13 @@
 # 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'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def get_recently_updated_line_items()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -46,10 +43,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 ORDER BY id ASC 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 +55,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/{v201408 → v201508}/line_item_service/target_custom_criteria.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,15 +20,13 @@
 # determine which line items exist, run get_all_line_items.rb. To determine
 # which custom targeting keys and values exist, run
 # get_all_custom_targeting_keys_and_values.rb.
-#
-# Tags: LineItemService.getLineItemsByStatement,
-#       LineItemService.updateLineItems
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
 require 'pp'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 PAGE_SIZE = 500
 
 def target_custom_criteria()
@@ -91,16 +87,17 @@ def target_custom_criteria()
 
 
   # Create a statement to only select a single line item.
-  statement = {
-      :query => 'WHERE id = :id ORDER BY id ASC LIMIT 1',
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id ORDER BY id ASC',
+      [
           {:key => 'id',
            :value => {:value => line_item_id, :xsi_type => 'NumberValue'}}
-      ]
-  }
+      ],
+      1
+  )
 
   # 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_item = page[:results].first