google-dfp-api 0.9.2 → 0.9.3

data/examples/{v201311 → v201411}/label_service/get_labels_by_statement.rb

@@ -18,16 +18,17 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all labels ordered by name. The statement retrieves up to
-# the maximum page size limit of 500. To create labels, run create_labels.rb.
+# This example gets all labels ordered by name. To create labels,
+# run create_labels.rb.
 #
 # This feature is only available to DFP premium solution networks.
 #
 # Tags: LabelService.getLabelsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def get_labels_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -41,17 +42,21 @@ def get_labels_by_statement()
   label_service = dfp.service(:LabelService, API_VERSION)
 
   # Create a statement to select labels ordered by name.
-  statement = {:query => 'ORDER BY name LIMIT 500'}
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
-  # Get labels by statement.
-  page = label_service.get_labels_by_statement(statement)
+  begin
+    # Get labels by statement.
+    page = label_service.get_labels_by_statement(statement.toStatement())
 
-  if page and page[:results]
-    page[:results].each_with_index do |label, index|
-      puts "%d) Label ID: %d, name: '%s', types: '%s'." % [index,
-          label[:id], label[:name], label[:types].join(', ')]
+    if page and page[:results]
+      page[:results].each_with_index do |label, index|
+        puts "%d) Label ID: %d, name: '%s'." % [
+            index + statement.offset,
+            label[:id], label[: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}/label_service/update_labels.rb

@@ -19,16 +19,16 @@
 #           limitations under the License.
 #
 # This example updates the descriptions of all active labels by updating its
-# description, up to the first 500. To determine which labels exist, run
-# get_all_labels.rb.
+# description. To determine which labels exist, run get_all_labels.rb.
 #
 # This feature is only available to DFP premium solution networks.
 #
 # Tags: LabelService.getLabelsByStatement, LabelService.updateLabels
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def update_labels()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -42,41 +42,39 @@ def update_labels()
   label_service = dfp.service(:LabelService, API_VERSION)
 
   # Create a statement to only select active labels.
-  statement = {
-      :query => 'WHERE isActive = :is_active LIMIT 500',
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE isActive = :is_active',
+      [
           {:key => 'is_active',
            :value => {
                :value => 'true',
                :xsi_type => 'BooleanValue'}
           }
       ]
-  }
+  )
 
-  # Get labels by statement.
-  page = label_service.get_labels_by_statement(statement)
-
-  if page[:results]
-    labels = page[:results]
+  begin
+    # Get labels by statement.
+    page = label_service.get_labels_by_statement(statement.toStatement())
 
-    # Update each local label object by changing its description.
-    labels.each do |label|
-      label[:description] = 'This label was updated'
-    end
+    if page[:results]
+      # Update each local label object by changing its description.
+      page[:results].each do |label|
+        label[:description] = 'This label was updated'
+      end
 
-    # Update the labels on the server.
-    return_labels = label_service.update_labels(labels)
+      # Update the labels on the server.
+      return_labels = label_service.update_labels(labels)
 
-    if return_labels
-      return_labels.each do |label|
-        puts("Label ID: %d, name: %s was updated with description: %s.") %
-            [label[:id], label[:name], label[:description]]
+      if return_labels
+        return_labels.each do |label|
+          puts("Label ID: %d, name: %s was updated with description: %s.") %
+              [label[:id], label[:name], label[:description]]
+        end
+      else
+        raise 'No labels were updated.'
       end
-    else
-      raise 'No labels were updated.'
     end
-  else
-    puts 'No labels found to update.'
   end
 end
 

data/examples/{v201311 → v201411}/line_item_creative_association_service/create_licas.rb

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

data/examples/{v201311 → v201411}/line_item_creative_association_service/deactivate_licas.rb

@@ -26,9 +26,9 @@
 # Tags: InventoryService.performAdUnitAction
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
-PAGE_SIZE = 500
+API_VERSION = :v201411
 
 def deactivate_licas()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -44,36 +44,25 @@ def deactivate_licas()
   # Set the line item to get LICAs by.
   line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
 
-  # Create statement text to select active LICAs for a given line item.
-  statement_text = 'WHERE lineItemId = :line_item_id AND status = :status'
-
-  statement = {
-      :values => [
+  # Create statement to select active LICAs for a given line item.
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE lineItemId = :line_item_id AND status = :status',
+      [
           {:key => 'line_item_id',
            :value => {:value => line_item_id, :xsi_type => 'NumberValue'}},
           {:key => 'status',
            :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
       ]
-  }
+  )
 
-  # Define initial values.
-  offset = 0
-  page = {}
   creative_ids = []
 
   begin
-    # Create a statement to get one page with current offset.
-    statement[:query] = statement_text +
-        " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
-
     # 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]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
       page[:results].each do |lica|
         puts ("%d) LICA with line item ID: %d, creative ID: %d and status: %s" +
             " will be deactivated.") % [creative_ids.size, lica[:line_item_id],
@@ -81,18 +70,20 @@ def deactivate_licas()
         creative_ids << lica[:creative_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 LICAs to be deactivated: %d" % creative_ids.size
 
   if !creative_ids.empty?
     # Modify statement for action. Note, the values are still present.
-    statement[:query] = statement_text + " AND creativeId IN (%s)" %
-        creative_ids.join(', ')
+    statement = DfpApiStatement::FilterStatement.new(
+        "WHERE creativeId IN (%s)" % creative_ids.join(', '))
 
     # Perform action.
     result = lica_service.perform_line_item_creative_association_action(
-        {:xsi_type => 'DeactivateLineItemCreativeAssociations'}, statement)
+        {:xsi_type => 'DeactivateLineItemCreativeAssociations'},
+        statement.toStatement())
 
     # Display results.
     if result and result[:num_changes] > 0

data/examples/{v201311 → v201411}/line_item_creative_association_service/get_all_licas.rb

@@ -24,9 +24,9 @@
 # Tags: LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
-PAGE_SIZE = 500
+API_VERSION = :v201411
 
 def get_all_licas()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,36 +39,27 @@ def get_all_licas()
   # Get the LineItemCreativeAssociationService.
   lica_service = dfp.service(:LineItemCreativeAssociationService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
-
   begin
     # Create statement for one page with current offset.
-    statement = {:query => 'LIMIT %d OFFSET %d' % [PAGE_SIZE, offset]}
+    statement = DfpApiStatement::FilterStatement.new('ORDER BY lineItemId ASC')
 
     # 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]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      # Get the start index for printout.
-      start_index = page[:start_index]
-
       # Print details about each LICA in results page.
       page[:results].each_with_index do |lica, index|
         creative_text = (lica[:creative_set_id] != nil) ?
             'creative set ID %d' % lica[:creative_set_id] :
             'creative ID %d' % lica[:creative_id]
         puts '%d) LICA with line item ID: %d, %s and status: %s' %
-            [index + start_index, lica[:line_item_id], creative_text,
+            [index + statement.offset, lica[:line_item_id], creative_text,
              lica[:status]]
       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_creative_association_service/get_licas_by_statement.rb

@@ -26,8 +26,9 @@
 # Tags: LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def get_licas_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -44,22 +45,23 @@ def get_licas_by_statement()
   line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
 
   # Create a statement to only select LICAs for the given line item ID.
-  statement = {
-      :query => 'WHERE lineItemId = :line_item_id LIMIT 500',
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE lineItemId = :line_item_id ORDER BY lineItemId, orderId 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 and page[:results]
     page[:results].each_with_index do |lica, index|
       puts "%d) LICA with line item ID: %d, creative ID: %d and status: %s." %
-          [index, lica[:line_item_id], lica[:creative_id], lica[:status]]
+          [index + statement.offset,
+           lica[:line_item_id], lica[:creative_id], lica[:status]]
     end
   end
 

data/examples/{v201311 → v201411}/line_item_creative_association_service/update_licas.rb

@@ -18,15 +18,15 @@
 #           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.
+# This example updates the destination URL of all LICAs belonging to a line item.
+# To determine which LICAs exist, run get_all_licas.rb.
 #
 # Tags: LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatement
 # Tags: LineItemCreativeAssociationService.updateLineItemCreativeAssociations
 
 require 'dfp_api'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def update_licas()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,12 +39,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/{v201311 → v201411}/line_item_service/activate_line_items.rb

@@ -29,9 +29,9 @@
 # Tags: LineItemService.performLineItemAction
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
-PAGE_SIZE = 500
+API_VERSION = :v201411
 
 def activate_line_items()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -49,33 +49,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 +76,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/{v201311 → v201411}/line_item_service/create_line_items.rb

@@ -29,7 +29,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 # 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