google-dfp-api 0.9.4 → 0.9.5

data/examples/{v201405 → v201505}/contact_service/get_all_contacts.rb

@@ -23,9 +23,9 @@
 # Tags: ContactService.getContactsByStatement.
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201405
-PAGE_SIZE = 500
+API_VERSION = :v201505
 
 def get_all_contacts()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,31 +38,23 @@ def get_all_contacts()
   # Get the ContactService.
   contact_service = dfp.service(:ContactService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create statement for one page with current offset.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
   begin
-    # Create statement for one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
-
     # Get contacts by statement.
-    page = contact_service.get_contacts_by_statement(statement)
+    page = contact_service.get_contacts_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 content object in results page.
       page[:results].each_with_index do |contact, index|
-        puts "%d) Contact ID: %d, name: %s." % [index + start_index,
-            contact[:id], contact[:name]]
+        puts "%d) Contact ID: %d, name: '%s'" %
+            [index + statement.offset,
+             contact[:id], contact[: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/{v201405 → v201505}/contact_service/get_uninvited_contacts.rb

@@ -24,8 +24,9 @@
 # Tags: ContactService.getContactsByStatement.
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201405
+API_VERSION = :v201505
 PAGE_SIZE = 500
 
 def get_uninvited_contacts()
@@ -42,37 +43,32 @@ def get_uninvited_contacts()
   # Define initial values.
   offset = 0
   page = {}
-  query_base = 'WHERE status = :status ORDER BY id LIMIT %d OFFSET %d'
+  query_base = 'WHERE status = :status ORDER BY id ASC LIMIT %d OFFSET %d'
 
   # Create statement.
-  statement = {
-    :values => [
-      {:key => 'status',
-       :value => {:value => 'UNINVITED', :xsi_type => 'TextValue'}}
-    ]
-  }
 
-  begin
-    # Update statement for one page with current offset.
-    statement[:query] = query_base % [PAGE_SIZE, offset]
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE status = :status ORDER BY id ASC',
+      [
+          {:key => 'status',
+           :value => {:value => 'UNINVITED', :xsi_type => 'TextValue'}}
+      ]
+  )
 
+  begin
     # Get contacts by statement.
-    page = contact_service.get_contacts_by_statement(statement)
+    page = contact_service.get_contacts_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 content object in results page.
       page[:results].each_with_index do |contact, index|
-        puts "%d) Contact ID: %d, name: %s." % [index + start_index,
-            contact[:id], contact[:name]]
+        puts "%d) Contact ID: %d, name: '%s'" %
+            [index + statement.offset,
+             contact[:id], contact[: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/{v201405 → v201505}/contact_service/update_contacts.rb

@@ -24,8 +24,9 @@
 # Tags: ContactService.updateContacts
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201405
+API_VERSION = :v201505
 
 def update_contacts()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,19 +39,20 @@ def update_contacts()
   # Get the ContactService.
   contact_service = dfp.service(:ContactService, API_VERSION)
 
-  contact_id = 'INSERT_CONTACT_ID_HERE'
+  contact_id = 'INSERT_CONTACT_ID_HERE'.to_i
 
   # Create a statement to only select a single contact.
-  statement = {
-      :query => "WHERE id = :id LIMIT 1",
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id',
+      [
           {:key => 'id',
            :value => {:value => contact_id, :xsi_type => 'NumberValue'}}
-      ]
+      ],
+      1
   }
 
   # Get contacts by statement.
-  page = contact_service.get_contacts_by_statement(statement)
+  page = contact_service.get_contacts_by_statement(statement.toStatement())
 
   if page[:results]
     contacts = page[:results]

data/examples/{v201405 → v201505}/content_metadata_key_hierarchy_service/create_content_metadata_key_hierarchies.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201405
+API_VERSION = :v201505
 
 def create_content_metadata_key_hierarchies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201405 → v201505}/content_metadata_key_hierarchy_service/delete_content_metadata_key_hierarchies.rb

@@ -26,8 +26,9 @@
 # Tags: ContentMetadataKeyHierarchyService.performContentMetadataKeyHierarchyAction
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201405
+API_VERSION = :v201505
 
 def delete_content_metadata_key_hierarchies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -44,18 +45,19 @@ def delete_content_metadata_key_hierarchies()
   content_metadata_key_hierarchy_id = 'CONTENT_METADATA_KEY_HIERARCHY_ID'
 
   # Create a statement to only select a single content metadata key hierarchy.
-  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 => content_metadata_key_hierarchy_id,
                       :xsi_type => 'NumberValue'}},
-      ]
-  }
+      ],
+      1
+  )
 
   # Get content metadata key hierarchies by statement.
   page = cmkh_service.get_content_metadata_key_hierarchies_by_statement(
-      statement)
+      statement.toStatement())
 
   if page[:results]
     content_metadata_key_hierarchy = page[:results].first
@@ -67,7 +69,8 @@ def delete_content_metadata_key_hierarchies()
 
     # Perform action.
     result = cmkh_service.perform_content_metadata_key_hierarchy_action(
-        {:xsi_type => 'DeleteContentMetadataKeyHierarchy'}, statement)
+        {:xsi_type => 'DeleteContentMetadataKeyHierarchy'},
+        statement.toStatement())
 
     # Display results.
     if result and result[:num_changes] > 0

data/examples/{v201405 → v201505}/content_metadata_key_hierarchy_service/get_all_content_metadata_key_hierarchies.rb

@@ -25,9 +25,9 @@
 # Tags: ContentMetadataKeyHierarchyService.getContentMetadataKeyHierarchiesByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201405
-PAGE_SIZE = 500
+API_VERSION = :v201505
 
 def get_all_content_metadata_key_hierarchies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,36 +40,26 @@ def get_all_content_metadata_key_hierarchies()
   # Get the ContentMetadataKeyHierarchyService.
   cmkh_service = dfp.service(:ContentMetadataKeyHierarchyService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create statement for one page with current offset.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
   begin
-    # Create statement for one page with current offset.
-    statement = {:query => 'ORDER BY id ASC LIMIT ' +
-        '%d OFFSET %d' % [PAGE_SIZE, offset]}
 
     # Get content metadata key hierarchies by statement.
     page = cmkh_service.get_content_metadata_key_hierarchies_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 content metadata key hierarchy object.
       page[:results].each_with_index do |content_metadata_key_hierarchy, index|
         puts ("%d) Content Metadata Key Hierarchy ID: " +
             "%d and name: %s was found.") % [
-                index + start_index,
+                index + statement.offset,
                 content_metadata_key_hierarchy[:id],
                 content_metadata_key_hierarchy[: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/{v201405 → v201505}/content_metadata_key_hierarchy_service/update_content_metadata_key_hierarchies.rb

@@ -26,8 +26,9 @@
 # Tags: ContentMetadataKeyHierarchyService.updateContentMetadataKeyHierarchies
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201405
+API_VERSION = :v201505
 
 def update_content_metadata_key_hierarchies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -48,18 +49,19 @@ def update_content_metadata_key_hierarchies()
   custom_targeting_key_id = "INSERT_CUSTOM_TARGETING_KEY_ID_HERE"
 
   # Create a statement to only select a single content metadata key hierarchy.
-  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 => content_metadata_key_hierarchy_id,
                       :xsi_type => 'NumberValue'}},
-      ]
+      ],
+      1
   }
 
   # Get content metadata key hierarchies by statement.
-  page =
-      cmkh_service.get_content_metadata_key_hierarchies_by_statement(statement)
+  page = cmkh_service.get_content_metadata_key_hierarchies_by_statement(
+      statement.toStatement())
 
   if page[:results]
     content_metadata_key_hierarchy = page[:results].first

data/examples/{v201405 → v201505}/content_service/get_all_content.rb

@@ -25,9 +25,9 @@
 # Tags: ContentService.getContentByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201405
-PAGE_SIZE = 500
+API_VERSION = :v201505
 
 def get_all_content()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,31 +40,22 @@ def get_all_content()
   # Get the ContentService.
   content_service = dfp.service(:ContentService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create statement for one page with current offset.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
   begin
-    # Create statement for one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
-
     # Get content by statement.
-    page = content_service.get_content_by_statement(statement)
+    page = content_service.get_content_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 content object in results page.
       page[:results].each_with_index do |content, index|
-        puts "%d) Content ID: %d, name: %s, status: %s." % [index + start_index,
+        puts "%d) Content ID: %d, name: %s, status: %s." % [
+             index + statement.offset,
              content[:id], content[:name], content[: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/{v201405 → v201505}/content_service/get_content_by_category.rb

@@ -28,9 +28,9 @@
 # Tags: CustomTargetingService.getCustomTargetingValuesByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201405
-PAGE_SIZE = 500
+API_VERSION = :v201505
 
 def get_content_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -52,22 +52,23 @@ def get_content_by_statement()
   custom_targeting_service = dfp.service(:CustomTargetingService, API_VERSION)
 
   # Create a statement to select the categories matching the name comedy.
-  statement = {
-      :query => 'WHERE customTargetingKeyId = :targeting_key_id' +
-          ' and name = :category LIMIT 1',
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new( 
+      'WHERE customTargetingKeyId = :targeting_key_id' +
+      ' and name = :category ORDER BY id ASC',
+      [
           {:key => 'targeting_key_id',
            :value => {:value => content_browse_custom_targeting_key_id,
                       :xsi_type => 'NumberValue'}},
           {:key => 'category',
            :value => {:value => 'comedy',
                       :xsi_type => 'TextValue'}},
-      ]
-  }
+      ],
+      1
+  )
 
   # Get categories matching the filter statement.
   page = custom_targeting_service.get_custom_targeting_values_by_statement(
-      statement)
+      statement.toStatement())
 
   # Get the custom targeting value ID for the comedy category.
   if page[:results]
@@ -76,40 +77,29 @@ def get_content_by_statement()
     # Get the ContentService.
     content_service = dfp.service(:ContentService, API_VERSION)
 
-    # Define initial values.
-    offset = 0
-    page = {}
-
-    statement_text = 'WHERE status = :status'
-    statement = {
-        :query => statement_text,
-        :values => [
+    statement = DfpApiStatement::FilterStatement.new(
+        'WHERE status = :status ORDER BY id ASC',
+        [
             {:key => 'status',
              :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
         ]
-    }
+    )
 
     begin
-      # Create a statement to get one page with current offset.
-      statement[:query] = statement_text +
-          " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
-
       # Get content by statement.
       page =
           content_service.get_content_by_statement_and_custom_targeting_value(
-              statement, category_custom_targeting_value_id)
+              statement.toStatement(), category_custom_targeting_value_id)
 
       if page[:results]
-        # Increase query offset by page size.
-        offset += PAGE_SIZE
-
         page[:results].each_with_index do |content, index|
           puts "%d) Content ID: %d, name: %s, status: %s." %
-              [index + start_index, content[:id], content[:name],
+              [index + statement.offset, content[:id], content[:name],
                content[: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/{v201405 → v201505}/creative_service/copy_image_creatives.rb

@@ -25,10 +25,10 @@
 # Tags: CreativeService.getCreativesByStatement, CreativeService.createCreatives
 
 require 'dfp_api'
-
+require 'dfp_api_statement'
 require 'base64'
 
-API_VERSION = :v201405
+API_VERSION = :v201505
 
 def copy_image_creatives()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -50,17 +50,17 @@ def copy_image_creatives()
   ]
 
   # Create the statement to filter image creatives by ID.
-  statement = {
-      :query => "WHERE id IN (%s) AND creativeType = :creative_type" %
+  statement = DfpApiStatement::FilterStatement.new(
+      "WHERE id IN (%s) AND creativeType = :creative_type" %
           image_creative_ids.join(', '),
-      :values => [
+      [
           {:key => 'creative_type',
            :value => {:value => 'ImageCreative', :xsi_type => 'TextValue'}}
       ]
-  }
+  )
 
   # Get creatives by statement.
-  page = creative_service.get_creatives_by_statement(statement)
+  page = creative_service.get_creatives_by_statement(statement.toStatement())
 
   if page[:results]
     creatives = page[:results]