google-dfp-api 0.10.0 → 0.10.1

data/examples/{v201408 → v201508}/creative_wrapper_service/get_creative_wrappers_by_statement.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");
@@ -20,12 +18,11 @@
 #
 # This code example gets all active creative wrappers. To create creative
 # wrappers, run create_creative_wrappers.rb.
-#
-# Tags: CreativeWrapperService.getCreativeWrappersByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def get_creative_wrappers_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,25 +36,29 @@ def get_creative_wrappers_by_statement()
   creative_wrapper_service = dfp.service(:CreativeWrapperService, API_VERSION)
 
   # Create filter text to select active creative wrappers.
-  statement = {
-      :query => 'WHERE status = :status ORDER BY id ASC',
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE status = :status ORDER BY id ASC',
+      [
         {
           :key => 'status',
           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}
         }
       ]
-  }
+  )
 
-  # Get creative wrappers by statement.
-  page = creative_wrapper_service.get_creative_wrappers_by_statement(statement)
+  begin
+    # Get creative wrappers by statement.
+    page = creative_wrapper_service.get_creative_wrappers_by_statement(
+        statement.toStatement())
 
-  if page and page[:results]
-    page[:results].each_with_index do |creative_wrapper, index|
-      puts "%d) Creative wrapper ID: %d, label ID: %d, status: '%s'." %
-          [index, creative_wrapper[:id], creative_wrapper[:label_id],
-           creative_wrapper[:status]]
+    if page and page[:results]
+      page[:results].each_with_index do |creative_wrapper, index|
+        puts "%d) Creative wrapper ID: %d, label ID: %d, status: '%s'." %
+            [index + statement.offset, creative_wrapper[:id],
+             creative_wrapper[:label_id], creative_wrapper[:status]]
+      end
     end
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
   end
 
   # Print a footer.

data/examples/{v201408 → v201508}/creative_wrapper_service/update_creative_wrappers.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");
@@ -20,13 +18,11 @@
 #
 # This code example updates a creative wrapper to the 'OUTER' wrapping order. To
 # determine which creative wrappers exist, run get_all_creative_wrappers.rb.
-#
-# Tags: CreativeWrapperService.getCreativeWrappersByStatement
-# Tags: CreativeWrapperService.updateCreativeWrappers
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def update_creative_wrappers()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -43,17 +39,19 @@ def update_creative_wrappers()
   creative_wrapper_id = 'INSERT_CREATIVE_WRAPPER_ID_HERE'.to_i
 
   # Create a statement to only select a single creative wrapper.
-  statement = {
-      :query => "WHERE id = :id LIMIT 1",
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id',
+      [
           {:key => 'id',
            :value => {:value => creative_wrapper_id, :xsi_type => 'NumberValue'}
           }
-      ]
-  }
+      ],
+      1
+  )
 
   # Get creative wrappers by statement.
-  page = creative_wrapper_service.get_creative_wrappers_by_statement(statement)
+  page = creative_wrapper_service.get_creative_wrappers_by_statement(
+      statement.toStatement())
 
   if page[:results]
     creative_wrappers = page[:results]

data/examples/{v201408 → v201508}/custom_field_service/create_custom_field_options.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");
@@ -22,12 +20,10 @@
 # created, custom field options can be found under the options fields of the
 # drop-down custom field and they cannot be deleted. To determine which custom
 # fields exist, run get_all_custom_fields.rb.
-#
-# Tags: CustomFieldService.createCustomFieldOptions
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def create_custom_field_options()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201408 → v201508}/custom_field_service/create_custom_fields.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");
@@ -20,12 +18,10 @@
 #
 # This example creates custom fields. To determine which custom fields exist,
 # run get_all_custom_fields.rb.
-#
-# Tags: CustomFieldService.createCustomFields
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def create_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201408 → v201508}/custom_field_service/deactivate_all_line_item_custom_fields.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");
@@ -20,14 +18,11 @@
 #
 # This example deactivates all active line item custom fields. To determine
 # which custom fields exist, run get_all_custom_fields.rb.
-#
-# Tags: CustomFieldService.getCustomFieldsByStatement
-# Tags: CustomFieldService.performCustomFieldAction
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def deactivate_all_line_item_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -41,46 +36,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/{v201408 → v201508}/custom_field_service/get_all_custom_fields.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");
@@ -20,13 +18,11 @@
 #
 # This example gets all custom fields. To create custom fields, run
 # create_custom_fields.rb.
-#
-# Tags: CustomFieldService.getCustomFieldsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def get_all_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,41 +35,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 => "ORDER BY id ASC 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/{v201408 → v201508}/custom_field_service/get_all_line_item_custom_fields.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");
@@ -20,12 +18,11 @@
 #
 # This example gets all custom fields that apply to line items. To create custom
 # fields, run create_custom_fields.rb.
-#
-# Tags: CustomFieldService.getCustomFieldsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def get_all_line_item_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,24 +36,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 ORDER BY id ASC',
-     :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)
+  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, custom_field[:id], custom_field[:name]]
+    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/{v201408 → v201508}/custom_field_service/set_line_item_custom_field_value.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");
@@ -22,13 +20,11 @@
 # custom fields exist, run get_all_custom_fields.rb. To determine which line
 # items exist, run get_all_line_items.rb. To create custom field options, run
 # create_custom_field_options.rb.
-#
-# Tags: CustomFieldService.getCustomFieldsByStatement,
-#       LineItemService.getLineItemsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def set_line_item_custom_field_value()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -51,44 +47,48 @@ def set_line_item_custom_field_value()
   line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
 
   # Create a statement to only select a single custom field.
-  custom_field_statement = {
-      :query => 'WHERE id = :id ORDER BY id ASC LIMIT 1',
-      :values => [
+  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.
-  custom_field_statement = {
-      :query => 'WHERE id = :id ORDER BY id ASC LIMIT 1',
-      :values => [
+  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.
-  custom_field_statement = {
-      :query => 'WHERE id = :id ORDER BY id ASC LIMIT 1',
-      :values => [
+  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)
+      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))
+          drop_down_custom_field_statement.toStatement()))
 
   # Get line items by statement.
-  line_items_page = line_item_service.get_line_items_by_statement(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]