google-dfp-api 0.10.0 → 0.10.1

data/examples/{v201408 → v201508}/custom_field_service/update_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 updates custom field descriptions. To determine which custom
 # fields exist, run get_all_custom_fields.rb.
-#
-# Tags: CustomFieldService.updateCustomFields
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def update_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -42,16 +39,18 @@ def update_custom_fields()
   custom_field_id = 'INSERT_CUSTOM_FIELD_ID_HERE'.to_i
 
   # Create a statement to only select a single custom field.
-  statement = {
-      :query => "WHERE id = :id LIMIT 1",
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id',
+      [
           {:key => 'id',
            :value => {:value => custom_field_id, :xsi_type => 'NumberValue'}}
-      ]
-  }
+      ],
+      1
+  )
 
   # 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]
     custom_fields = page[:results]

data/examples/{v201408 → v201508}/custom_targeting_service/create_custom_targeting_keys_and_values.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,13 +20,10 @@
 # custom targeting keys and values exist, run
 # get_all_custom_targeting_keys_and_values.rb. To target these custom targeting
 # keys and values, run target_custom_criteria.rb.
-#
-# Tags: CustomTargetingService.createCustomTargetingKeys
-# Tags: CustomTargetingService.createCustomTargetingValues
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def create_custom_targeting_keys_and_values()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201408 → v201508}/custom_targeting_service/delete_custom_targeting_keys.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,14 +18,11 @@
 #
 # This example deletes custom targeting key by its name. To determine which
 # custom targeting keys exist, run get_all_custom_targeting_keys_and_values.rb.
-#
-# Tags: CustomTargetingService.getCustomTargetingKeysByStatement
-# Tags: CustomTargetingService.performCustomTargetingKeyAction
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def delete_custom_targeting_keys()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -43,39 +38,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 +72,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

data/examples/{v201408 → v201508}/custom_targeting_service/delete_custom_targeting_values.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");
@@ -21,14 +19,11 @@
 # This example deletes custom targeting values for a given custom targeting key.
 # To determine which custom targeting keys and values exist, run
 # get_all_custom_targeting_keys_and_values.rb.
-#
-# Tags: CustomTargetingService.getCustomTargetingValuesByStatement
-# Tags: CustomTargetingService.performCustomTargetingValueAction
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def delete_custom_targeting_values()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -44,41 +39,35 @@ def delete_custom_targeting_values()
   # Set ID of the custom targeting key to delete values from.
   custom_targeting_key_id = 'INSERT_CUSTOM_TARGETING_KEY_ID_HERE'.to_i
 
-  # Create statement to only select custom values by the given custom targeting
-  # key ID.
-  statement_text = 'WHERE customTargetingKeyId = :key_id'
-
   # Define initial values.
-  offset = 0
-  page = {}
   custom_target_value_ids = []
-  statement = {
-      :values => [
+
+  # Create statement to only select custom values by the given custom targeting
+  # key ID.
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE customTargetingKeyId = :key_id',
+      [
           {:key => 'key_id',
            :value => {:value => custom_targeting_key_id,
                       :xsi_type => 'NumberValue'}
           }
       ]
-  }
+  )
 
   begin
-    # Create a statement to page through custom targeting values.
-    statement[:query] = statement_text + " LIMIT %d OFFSET %d" %
-        [PAGE_SIZE, offset]
-
     # Get custom targeting values by statement.
     page = custom_targeting_service.get_custom_targeting_values_by_statement(
-        statement)
+        statement.toStatement())
 
     if page[:results]
       # Increase query offset by page size.
-      offset += PAGE_SIZE
       page[:results].each do |value|
         # Add value ID to the list for deletion.
         custom_target_value_ids << value[: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 value to be deleted: %d" %
@@ -86,12 +75,20 @@ def delete_custom_targeting_values()
 
   if !(custom_target_value_ids.empty?)
     # Modify statement for action, note, values are still present.
-    statement[:query] = statement_text + " AND id IN (%s)" %
-        [custom_target_value_ids.join(', ')]
+    statement = DfpApiStatement::FilterStatement.new(
+        "WHERE customTargetingKeyId = :key_id AND id IN (%s)" %
+        [custom_target_value_ids.join(', ')],
+        [
+          {:key => 'key_id',
+           :value => {:value => custom_targeting_key_id,
+                      :xsi_type => 'NumberValue'}
+          }
+        ]
+    )
 
     # Perform action.
     result = custom_targeting_service.perform_custom_targeting_value_action(
-        {:xsi_type => 'DeleteCustomTargetingValues'}, statement)
+        {:xsi_type => 'DeleteCustomTargetingValues'}, statement.toStatement())
 
     # Display results.
     if result and result[:num_changes] > 0

data/examples/{v201408 → v201508}/custom_targeting_service/get_all_custom_targeting_keys_and_values.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,14 +18,11 @@
 #
 # This example gets all custom targeting keys and the values. To create custom
 # targeting keys and values, run create_custom_targeting_keys_and_values.rb.
-#
-# Tags: CustomTargetingService.getCustomTargetingKeysByStatement
-# Tags: CustomTargetingService.getCustomTargetingValuesByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def get_all_custom_targeting_keys_and_values()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,30 +35,19 @@ def get_all_custom_targeting_keys_and_values()
   # Get the CustomTargetingService.
   custom_targeting_service = dfp.service(:CustomTargetingService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
-
   begin
     # Create a statement to get one page with current offset.
-    statement = {:query => "ORDER BY id ASC LIMIT %d OFFSET %d" %
-        [PAGE_SIZE, offset]}
+    statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
     # Get custom targeting keys by statement.
     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
-
-      # Get the start index for printout.
-      start_index = page[:start_index]
-
       # Print details about each key in results.
       page[:results].each_with_index do |custom_targeting_key, index|
         puts ("%d) Custom targeting key ID: %d, name: %s,  displayName: %s, " +
-              "type: %s") % [index + start_index,
+              "type: %s") % [index + statement.offset,
                              custom_targeting_key[:id],
                              custom_targeting_key[:name],
                              custom_targeting_key[:display_name],
@@ -71,7 +55,8 @@ def get_all_custom_targeting_keys_and_values()
         print_all_values_for_key(custom_targeting_service, custom_targeting_key)
       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)
@@ -81,45 +66,33 @@ def get_all_custom_targeting_keys_and_values()
 end
 
 def print_all_values_for_key(custom_targeting_service, custom_targeting_key)
-  # Define initial values.
-  offset = 0
-  page = {}
-
   # Create a statement to get values for given key.
-  statement_text = "WHERE customTargetingKeyId = :key_id LIMIT %d" % PAGE_SIZE
-  statement = {
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE customTargetingKeyId = :key_id',
+      [
           {:key => 'key_id',
            :value => {:value => custom_targeting_key[:id],
                       :xsi_type => 'NumberValue'}}
       ]
-  }
+  )
 
   begin
-    # Modify statement to get the next page.
-    statement[:query] = statement_text + " OFFSET %d" % offset
-
     # Get custom targeting values by statement.
     page = custom_targeting_service.get_custom_targeting_values_by_statement(
-        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 value in results.
       page[:results].each_with_index do |custom_targeting_value, index|
         puts ("\t%d) Custom targeting value ID: %d, name: %s, displayName: %s") %
-            [index + start_index,
+            [index + statement.offset,
              custom_targeting_value[:id],
              custom_targeting_value[:name],
              custom_targeting_value[:display_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}/custom_targeting_service/get_custom_targeting_keys_by_statement.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");
@@ -21,12 +19,11 @@
 # This example gets all predefined custom targeting keys. The statement
 # retrieves up to the maximum page size limit of 500. To create custom
 # targeting keys, run create_custom_targeting_keys_and_values.rb.
-#
-# Tags: CustomTargetingService.getCustomTargetingKeysByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def get_custom_targeting_keys_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,29 +37,32 @@ def get_custom_targeting_keys_by_statement()
   custom_targeting_service = dfp.service(:CustomTargetingService, API_VERSION)
 
   # Create a statement to only select predefined custom targeting keys.
-  statement = {
-      :query => 'WHERE type = :type ORDER BY id ASC LIMIT 500',
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE type = :type ORDER BY id ASC',
+      [
           {:key => 'type',
            :value => {:value => 'PREDEFINED', :xsi_type => 'TextValue'}}
       ]
-  }
+  )
 
   # Get custom targeting keys by statement.
   page = custom_targeting_service.get_custom_targeting_keys_by_statement(
-      statement)
+      statement.toStatement())
 
-  if page[:results]
-    # Print details about each key in results.
-    page[:results].each_with_index do |custom_targeting_key, index|
-      puts ("%d) Custom targeting key with ID [%d], name: %s," +
-          " displayName: %s type: %s") % [index,
-                                          custom_targeting_key[:id],
-                                          custom_targeting_key[:name],
-                                          custom_targeting_key[:display_name],
-                                          custom_targeting_key[:type]]
+  begin
+    if page[:results]
+      # Print details about each key in results.
+      page[:results].each_with_index do |custom_targeting_key, index|
+        puts ("%d) Custom targeting key with ID [%d], name: %s," +
+            " displayName: %s type: %s") % [index + statement.offset,
+                                            custom_targeting_key[:id],
+                                            custom_targeting_key[:name],
+                                            custom_targeting_key[:display_name],
+                                            custom_targeting_key[:type]]
+      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)