google-dfp-api 0.9.2 → 0.9.3

data/examples/{v201311 → v201411}/creative_wrapper_service/update_creative_wrappers.rb

@@ -25,8 +25,9 @@
 # Tags: CreativeWrapperService.updateCreativeWrappers
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def update_creative_wrappers()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -42,25 +43,42 @@ def update_creative_wrappers()
   # Set the ID of the creative wrapper to get.
   creative_wrapper_id = 'INSERT_CREATIVE_WRAPPER_ID_HERE'.to_i
 
-  # Get creative wrapper by ID.
-  creative_wrapper =
-      creative_wrapper_service.get_creative_wrapper(creative_wrapper_id)
+  # Create a statement to only select a single creative wrapper.
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id',
+      [
+          {:key => 'id',
+           :value => {:value => creative_wrapper_id, :xsi_type => 'NumberValue'}
+          }
+      ],
+      1
+  )
 
-  # Update local creative wrapper object by changing its ordering.
-  creative_wrapper[:ordering] = 'OUTER'
+  # Get creative wrappers by statement.
+  page = creative_wrapper_service.get_creative_wrappers_by_statement(
+      statement.toStatement())
 
-  # Update the creative wrapper on the server.
-  return_creative_wrappers =
-      creative_wrapper_service.update_creative_wrappers([creative_wrapper])
+  if page[:results]
+    creative_wrappers = page[:results]
 
-  if return_creative_wrappers
-    return_creative_wrappers.each do |creative_wrapper|
-      puts ("Creative wrapper ID: %d, label ID: %d was updated with ordering" +
-            " '%s'") % [creative_wrapper[:id], creative_wrapper[:label_id],
-                        creative_wrapper[:ordering]]
+    creative_wrappers.each do |creative_wrapper|
+      # Update local creative wrapper object by changing its ordering.
+      creative_wrapper[:ordering] = 'OUTER'
+    end
+
+    # Update the creative wrapper on the server.
+    return_creative_wrappers =
+        creative_wrapper_service.update_creative_wrappers([creative_wrapper])
+
+    if return_creative_wrappers
+      return_creative_wrappers.each do |creative_wrapper|
+        puts ("Creative wrapper ID: %d, label ID: %d was updated with order" +
+              " '%s'") % [creative_wrapper[:id], creative_wrapper[:label_id],
+                          creative_wrapper[:ordering]]
+      end
+    else
+      puts 'No creative wrappers found to update.'
     end
-  else
-    puts 'No creative wrappers found to update.'
   end
 end
 

data/examples/{v201311 → v201411}/custom_field_service/create_custom_field_options.rb

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

data/examples/{v201311 → v201411}/custom_field_service/create_custom_fields.rb

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

data/examples/{v201311 → v201411}/custom_field_service/deactivate_all_line_item_custom_fields.rb

@@ -25,9 +25,9 @@
 # Tags: CustomFieldService.performCustomFieldAction
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
-PAGE_SIZE = 500
+API_VERSION = :v201411
 
 def deactivate_all_line_item_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -41,46 +41,36 @@ def deactivate_all_line_item_custom_fields()
   custom_field_service = dfp.service(:CustomFieldService, API_VERSION)
 
   # Create statement text to select active ad units.
-  statement_text = 'WHERE entityType = :entity_type AND isActive = :is_active'
-  statement = {
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE entityType = :entity_type AND isActive = :is_active',
+      [
           {:key => 'entity_type',
            :value => {:value => 'LINE_ITEM', :xsi_type => 'TextValue'}},
           {:key => 'is_active',
            :value => {:value => true, :xsi_type => 'BooleanValue'}}
       ]
-  }
-
-  # Define initial values.
-  offset = 0
-  page = {}
+  )
 
   begin
-    # Create a statement to get one page with the current offset.
-    statement[:query] = statement_text +
-        " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
-
     # Get custom fields by statement.
-    page = custom_field_service.get_custom_fields_by_statement(statement)
+    page = custom_field_service.get_custom_fields_by_statement(
+        statement.toStatement())
 
     if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-      start_index = page[:start_index]
-
       page[:results].each_with_index do |custom_field, index|
         puts "%d) Custom field with ID: %d and name: '%s' will be deactivated" %
-            [index + start_index, custom_field[:id], custom_field[:name]]
+            [index + statement.offset, custom_field[:id], custom_field[: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]
 
   # Update statement for action.
-  statement[:query] = statement_text
+  statement.toStatementForAction()
 
   # Perform action.
   result = custom_field_service.perform_custom_field_action(
-        {:xsi_type => 'DeactivateCustomFields'}, statement)
+        {:xsi_type => 'DeactivateCustomFields'}, statement.toStatement())
 
   # Display results.
   if result and result[:num_changes] > 0

data/examples/{v201311 → v201411}/custom_field_service/get_all_custom_fields.rb

@@ -24,9 +24,9 @@
 # Tags: CustomFieldService.getCustomFieldsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
-PAGE_SIZE = 500
+API_VERSION = :v201411
 
 def get_all_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,40 +39,32 @@ def get_all_custom_fields()
   # Get the CustomFieldService.
   custom_field_service = dfp.service(:CustomFieldService, 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')
 
   begin
-    # Create a statement to get one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
-
     # Get custom fields by statement.
-    page = custom_field_service.get_custom_fields_by_statement(statement)
+    page = custom_field_service.get_custom_fields_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 custom field in results.
       page[:results].each_with_index do |custom_field, index|
         if custom_field[:custom_field_type].eql?('DropDownCustomField')
           drop_down_custom_field_strings = custom_field.include?(:options) ?
               custom_field[:options].map {|option| option[:display_name]} : []
-          print ("%d) Drop-down custom field with ID %d, name '%s', and " +
+          puts ("%d) Drop-down custom field with ID %d, name '%s', and " +
               "options [%s] was found.") %
-              [index + start_index, custom_field[:id], custom_field[:name],
+              [index + statement.offset, custom_field[:id], custom_field[:name],
                drop_down_custom_field_strings.join(', ')]
         else
           puts "%d) Custom field ID: %d and name: '%s' was found" %
-              [index + start_index, custom_field[:id], custom_field[:name]]
+              [index + statement.offset, custom_field[:id], custom_field[:name]]
         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]
 
   # Print a footer.
   if page.include?(:total_result_set_size)

data/examples/{v201311 → v201411}/custom_field_service/get_all_line_item_custom_fields.rb

@@ -24,8 +24,9 @@
 # Tags: CustomFieldService.getCustomFieldsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def get_all_line_item_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,24 +40,28 @@ def get_all_line_item_custom_fields()
   custom_field_service = dfp.service(:CustomFieldService, API_VERSION)
 
   # Create statement to select only custom fields that apply to line items.
-  statement = {
-     :query => 'WHERE entityType = :entity_type',
-     :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+     'WHERE entityType = :entity_type ORDER BY id ASC',
+     [
          {:key => 'entity_type',
           :value => {:value => 'LINE_ITEM', :xsi_type => 'TextValue'}}
      ]
-  }
+  )
 
-  # Get custom fields by statement.
-  page = custom_field_service.get_custom_fields_by_statement(statement)
-
-  if page[:results]
-    # Print details about each custom field in results.
-    page[:results].each_with_index do |custom_field, index|
-      puts "%d) Custom field with ID %d and name: '%s' was found." %
-          [index, custom_field[:id], custom_field[:name]]
+  begin
+    # Get custom fields by statement.
+    page = custom_field_service.get_custom_fields_by_statement(
+        statement.toStatement())
+  
+    if page[:results]
+      # Print details about each custom field in results.
+      page[:results].each_with_index do |custom_field, index|
+        puts "%d) Custom field with ID %d and name: '%s' was found." %
+            [index + statement.offset, custom_field[:id], custom_field[: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}/custom_field_service/set_line_item_custom_field_value.rb

@@ -23,11 +23,13 @@
 # items exist, run get_all_line_items.rb. To create custom field options, run
 # create_custom_field_options.rb.
 #
-# Tags: CustomFieldService.getCustomField, LineItemService.getLineItem
+# Tags: CustomFieldService.getCustomFieldsByStatement,
+#       LineItemService.getLineItemsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def set_line_item_custom_field_value()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -49,15 +51,61 @@ def set_line_item_custom_field_value()
   custom_field_option_id = 'INSERT_CUSTOM_FIELD_OPTION_ID_HERE'.to_i
   line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
 
-  # Get custom field.
-  custom_field = custom_field_service.get_custom_field(custom_field_id)
-
-  # Get drop-down custom field.
-  drop_down_custom_field = custom_field_service.get_custom_field(
-      drop_down_custom_field_id)
-
-  # Get line item.
-  line_item = line_item_service.get_line_item(line_item_id)
+  # Create a statement to only select a single custom field.
+  custom_field_statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id ORDER BY id ASC',
+      [
+          {:key => 'id',
+           :value => {:value => custom_field_id, :xsi_type => 'NumberValue'}}
+      ],
+      1
+  )
+
+  # Create a statement to only select a single drop down custom field.
+  drop_down_custom_field_statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id ORDER BY id ASC',
+      [
+          {:key => 'id',
+           :value => {:value => drop_down_custom_field_id,
+                      :xsi_type => 'NumberValue'}}
+      ],
+      1
+  )
+
+  # Create a statement to only select a single line item.
+  line_item_statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id ORDER BY id ASC',
+      [
+          {:key => 'id',
+           :value => {:value => line_item_id, :xsi_type => 'NumberValue'}}
+      ],
+      1
+  )
+
+  # Get custom fields by statement.
+  custom_fields_page = custom_field_service.get_custom_fields_by_statement(
+      custom_field_statement.toStatement())
+
+  # Get drop down custom fields by statement.
+  drop_down_custom_fields_page = (
+      custom_field_service.get_custom_fields_by_statement(
+          drop_down_custom_field_statement.toStatement()))
+
+  # Get line items by statement.
+  line_items_page = line_item_service.get_line_items_by_statement(
+      line_item_statement.toStatement())
+
+  # Get singular custom field.
+  if custom_field_page[:results]
+    custom_field = custom_fields_page[:results].first
+
+  # Get singular drop down custom field.
+  if drop_down_custom_field_page[:results]
+    drop_down_custom_field = drop_down_custom_fields_page[:results].first
+
+  # Get singular line item.
+  if line_item_page[:results]
+    line_item = line_items_page[:results].first
 
   if custom_field and drop_down_custom_field and line_item
     # Create custom field values.

data/examples/{v201311 → v201411}/custom_field_service/update_custom_fields.rb

@@ -24,8 +24,9 @@
 # Tags: CustomFieldService.updateCustomFields
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def update_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -41,24 +42,41 @@ def update_custom_fields()
   # Set the ID of the custom field to update.
   custom_field_id = 'INSERT_CUSTOM_FIELD_ID_HERE'.to_i
 
-  # Get custom field.
-  custom_field = custom_field_service.get_custom_field(custom_field_id)
+  # Create a statement to only select a single custom field.
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id',
+      [
+          {:key => 'id',
+           :value => {:value => custom_field_id, :xsi_type => 'NumberValue'}}
+      ],
+      1
+  )
 
-  if custom_field
-    # Update local custom field object.
-    custom_field[:description] = '' if custom_field[:description].nil?
-    custom_field[:description] +=' Updated.'
+  # Get custom fields by statement.
+  page = custom_field_service.get_custom_fields_by_statement(
+      statement.toStatement())
 
-    # Update the custom field on the server.
-    return_custom_fields =
-        custom_field_service.update_custom_fields([custom_field])
+  if page[:results]
+    custom_fields = page[:results]
 
-    return_custom_fields.each do |custom_field|
-      puts "Custom field ID: %d, name: '%s' and description '%s' was updated." %
-          [custom_field[:id], custom_field[:name], custom_field[:description]]
+    custom_fields.each do |custom_field|
+      # Update local custom field object.
+      custom_field[:description] = '' if custom_field[:description].nil?
+      custom_field[:description] +=' Updated.'
+
+      # Update the custom field on the server.
+      return_custom_fields =
+          custom_field_service.update_custom_fields([custom_field])
+
+      return_custom_fields.each do |custom_field|
+        puts "Custom field ID: " +
+            "%d, name: '%s' and description '%s' was updated." % [
+                custom_field[:id], custom_field[:name],
+                custom_field[:description]]
+      end
+    else
+      puts 'No custom fields were found to update.'
     end
-  else
-    puts 'No custom fields were found to update.'
   end
 end
 

data/examples/{v201311 → v201411}/custom_targeting_service/create_custom_targeting_keys_and_values.rb

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

data/examples/{v201311 → v201411}/custom_targeting_service/delete_custom_targeting_keys.rb

@@ -25,9 +25,9 @@
 # Tags: CustomTargetingService.performCustomTargetingKeyAction
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
-PAGE_SIZE = 500
+API_VERSION = :v201411
 
 def delete_custom_targeting_keys()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -43,39 +43,33 @@ def delete_custom_targeting_keys()
   # Set the name of the custom targeting key to delete.
   custom_targeting_key_name = 'INSERT_CUSTOM_TARGETING_KEY_NAME_HERE'
 
-  # Create statement to only select custom targeting key by the given name.
-  statement_text = 'WHERE name = :name'
 
   # Define initial values.
-  offset = 0
-  page = {}
   custom_target_key_ids = []
-  statement = {
-      :values => [
+
+  # Create statement to only select custom targeting key by the given name.
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE name = :name',
+      [
           {:key => 'name',
            :value => {:value => custom_targeting_key_name,
                       :xsi_type => 'TextValue'}
           }
       ]
-  }
+  )
 
   begin
-    # Create a statement to page through custom targeting keys.
-    statement[:query] = statement_text + " LIMIT %d OFFSET %d" %
-        [PAGE_SIZE, offset]
-
     page = custom_targeting_service.get_custom_targeting_keys_by_statement(
-        statement)
+        statement.toStatement())
 
     if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
       page[:results].each do |key|
         # Add key ID to the list for deletion.
         custom_target_key_ids << key[: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.
   puts "Number of custom targeting keys to be deleted: %d" %
@@ -83,12 +77,14 @@ def delete_custom_targeting_keys()
 
   if !(custom_target_key_ids.empty?)
     # Modify statement for action.
-    statement = {:query => "WHERE id IN (%s)" %
-        [custom_target_key_ids.join(', ')]}
+    statement = DfpApiStatement::FilterStatement.new(
+        "WHERE id IN (%s)" %
+        [custom_target_key_ids.join(', ')]
+    )
 
     # Perform action.
     result = custom_targeting_service.perform_custom_targeting_key_action(
-        {:xsi_type => 'DeleteCustomTargetingKeys'}, statement)
+        {:xsi_type => 'DeleteCustomTargetingKeys'}, statement.toStatement())
 
     # Display results.
     if result and result[:num_changes] > 0