google-dfp-api 0.9.3 → 0.9.4

data/examples/{v201403 → v201502}/creative_service/update_creatives.rb

@@ -18,14 +18,15 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example updates the destination URL of all image creatives up to the
-# first 500. To determine which image creatives exist, run get_all_creatives.rb.
+# This example updates the destination URL of a single creative searching by ID.
+# To determine which image creatives exist, run get_all_creatives.rb.
 #
 # Tags: CreativeService.getCreativesByStatement, CreativeService.updateCreatives
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
+API_VERSION = :v201502
 
 def update_creatives()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,17 +39,21 @@ def update_creatives()
   # Get the CreativeService.
   creative_service = dfp.service(:CreativeService, API_VERSION)
 
+  # Specify creative ID to update.
+  creative_id = 'INSERT_CREATIVE_ID_HERE'.to_i
+
   # Create a statement to get first 500 image creatives.
-  statement = {
-      :query => "WHERE creativeType = :creative_type LIMIT 500",
-      :values => [
-          {:key => 'creative_type',
-           :value => {:value => 'ImageCreative', :xsi_type => 'TextValue'}}
-      ]
-  }
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id ORDER BY id ASC',
+      [
+          {:key => 'id',
+           :value => {:value =>  creative_id, :xsi_type => 'NumberValue'}}
+      ],
+      1
+  )
 
   # 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]

data/examples/{v201403 → v201502}/creative_set_service/associate_creative_set_to_line_item.rb

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

data/examples/{v201403 → v201502}/creative_set_service/create_creative_set.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201403
+API_VERSION = :v201502
 
 def create_creative_set()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201403 → v201502}/creative_set_service/get_all_creative_sets.rb

@@ -24,9 +24,9 @@
 # Tags: CreativeSetService.getCreativeSetsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
-PAGE_SIZE = 500
+API_VERSION = :v201502
 
 def get_all_creative_sets()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,32 +39,24 @@ def get_all_creative_sets()
   # Get the CreativeSetService.
   creative_set_service = dfp.service(:CreativeSetService, 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 creative sets by statement.
-    page = creative_set_service.get_creative_sets_by_statement(statement)
+    page = creative_set_service.get_creative_sets_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 creative set in results page.
       page[:results].each_with_index do |set, index|
         puts ('%d) Creative set ID: %d, master creative ID: %d and companion ' +
-            'creative IDs: [%s]') % [index + start_index, set[:id],
+            'creative IDs: [%s]') % [index + statement.offset, set[:id],
             set[:master_creative_id], set[:companion_creative_ids].join(', ')]
       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/{v201403 → v201502}/creative_set_service/get_creative_sets_by_statement.rb

@@ -24,8 +24,9 @@
 # Tags: CreativeSetService.getCreativeSetsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
+API_VERSION = :v201502
 
 def get_creative_sets_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -42,25 +43,30 @@ def get_creative_sets_by_statement()
 
   # Create a statement to get all creative sets that have the given master
   # creative.
-  statement = {
-      :query => 'WHERE masterCreativeId = :master_creative_id',
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE masterCreativeId = :master_creative_id ORDER BY id ASC',
+      [
           {:key => 'master_creative_id',
            :value => {:value => master_creative_id, :xsi_type => 'NumberValue'}}
       ]
-  }
+  )
 
-  # Get creative sets by statement.
-  page = creative_set_service.get_creative_sets_by_statement(statement)
+  begin
+    # Get creative sets by statement.
+    page = creative_set_service.get_creative_sets_by_statement(
+        statement.toStatement())
 
-  if page and page[:results]
-    page[:results].each_with_index do |creative_set, index|
-      puts ('%d) Creative set ID: %d, master creative ID: %d and companion ' +
-          'creative IDs: [%s]') %
-          [index, creative_set[:id], creative_set[:master_creative_id],
-           creative_set[:companion_creative_ids].join(', ')]
+    if page and page[:results]
+      page[:results].each_with_index do |creative_set, index|
+        puts ('%d) Creative set ID: %d, master creative ID: %d and companion ' +
+            'creative IDs: [%s]') %
+            [index + statement.offset, creative_set[:id],
+             creative_set[:master_creative_id],
+             creative_set[:companion_creative_ids].join(', ')]
+      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/{v201403 → v201502}/creative_set_service/update_creative_sets.rb

@@ -25,8 +25,9 @@
 # Tags: CreativeSetService.updateCreativeSet
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
+API_VERSION = :v201502
 
 def update_creative_sets()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -44,16 +45,18 @@ def update_creative_sets()
   creative_set_service = dfp.service(:CreativeSetService, API_VERSION)
 
   # Create a statement to only select a single creative set.
-  statement = {
-      :query => "WHERE id = :id LIMIT 1",
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id'
+      [
           {:key => 'id',
            :value => {:value => creative_set_id, :xsi_type => 'NumberValue'}}
-      ]
-  }
+      ],
+      1
+  )
 
   # Get creative sets by statement.
-  page = creative_set_service.get_creative_sets_by_statement(statement)
+  page = creative_set_service.get_creative_sets_by_statement(
+      statement.toStatement())
 
   if page[:results]
     creative_sets = page[:results]

data/examples/{v201403 → v201502}/creative_template_service/get_all_creative_templates.rb

@@ -23,9 +23,9 @@
 # Tags: CreativeTemplateService.getCreativeTemplatesByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
-PAGE_SIZE = 500
+API_VERSION = :v201502
 
 def get_all_creative_templates()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,33 +38,25 @@ def get_all_creative_templates()
   # Get the CreativeTemplateService.
   creative_template_service = dfp.service(:CreativeTemplateService, 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 ASC)
 
   begin
-    # Create a statement to get one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
 
     # Get creative templates by statement.
-    page =
-        creative_template_service.get_creative_templates_by_statement(statement)
+    page = creative_template_service.get_creative_templates_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 creative template in results.
       page[:results].each_with_index do |template, index|
         puts "%d) Creative template ID: %d, name: %s, type: %s" %
-            [index + start_index, template[:id],
+            [index + statement.offset, template[:id],
              template[:name], template[:type]]
       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/{v201403/creative_template_service/get_creative_templates_by_statement.rb → v201502/creative_template_service/get_system_defined_creative_templates.rb}

@@ -18,13 +18,14 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets up to 500 system defined creative templates.
+# This example gets system defined creative templates.
 #
 # Tags: CreativeTemplateService.getCreativeTemplatesByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
+API_VERSION = :v201502
 
 def get_creative_templates_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -37,20 +38,30 @@ def get_creative_templates_by_statement()
   # Get the CreativeTemplateService.
   creative_template_service = dfp.service(:CreativeTemplateService, API_VERSION)
 
-  # Create a statement to only select image creative_templates.
-  statement = {:query => 'LIMIT 500'}
+  # Create a statement to only select system defined creative_templates.
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE type = :type ORDER BY id ASC',
+      [
+          {:key => 'type',
+           :value => {:value => 'SYSTEM_DEFINED', :xsi_type => 'TextValue'}}
+      ]
+  )
 
-  # Get creative templates by statement.
-  page =
-      creative_template_service.get_creative_templates_by_statement(statement)
+  begin
+    # Get creative templates by statement.
+    page = creative_template_service.get_creative_templates_by_statement(
+        statement.toStatement())
 
-  if page[:results]
-    # Print details about each creative template in results.
-    page[:results].each_with_index do |template, index|
-      puts "%d) Creative template ID: %d, name: %s, type: %s" %
-          [index, template[:id], template[:name], template[:type]]
+    if page[:results]
+      # Print details about each creative template in results.
+      page[:results].each_with_index do |template, index|
+        puts "%d) Creative template ID: %d, name: %s, type: %s" %
+            [index + statement.offset,
+             template[:id], template[:name], template[: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)

data/examples/{v201403 → v201502}/creative_wrapper_service/create_creative_wrappers.rb

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

data/examples/{v201403 → v201502}/creative_wrapper_service/deactivate_creative_wrapper.rb

@@ -24,8 +24,9 @@
 # Tags: CreativeWrapperService.performCreativeWrapperAction
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
+API_VERSION = :v201502
 
 def deactivate_creative_wrappers()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -42,9 +43,9 @@ def deactivate_creative_wrappers()
   label_id = 'INSERT_CREATIVE_WRAPPER_LABEL_ID_HERE'.to_i
 
   # Create statement to select creative wrappers by label id and status.
-  statement = {
-      :query => 'WHERE labelId = :label_id AND status = :status',
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE labelId = :label_id AND status = :status',
+      [
         {
           :key => 'label_id',
           :value => {:value => label_id, :xsi_type => 'NumberValue'}
@@ -54,10 +55,11 @@ def deactivate_creative_wrappers()
           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}
         }
       ]
-  }
+  )
 
   # 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]
     page[:results].each do |creative_wrapper|
@@ -67,7 +69,7 @@ def deactivate_creative_wrappers()
 
     # Perform action.
     result = creative_wrapper_service.perform_creative_wrapper_action(
-        {:xsi_type => 'DeactivateCreativeWrappers'}, statement)
+        {:xsi_type => 'DeactivateCreativeWrappers'}, statement.toStatement())
 
     # Display results.
     if result and result[:num_changes] > 0

data/examples/{v201403 → v201502}/creative_wrapper_service/get_all_creative_wrappers.rb

@@ -24,9 +24,9 @@
 # Tags: CreativeWrapperService.getCreativeWrappersByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
-PAGE_SIZE = 500
+API_VERSION = :v201502
 
 def get_all_creative_wrappers()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,32 +39,24 @@ def get_all_creative_wrappers()
   # Get the CreativeWrapperService.
   creative_wrapper_service = dfp.service(:CreativeWrapperService, 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 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]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      # Get the start index for printout.
-      start_index = page[:start_index]
-
       # Print details about each creative wrapper in results page.
       page[:results].each_with_index do |creative_wrapper, index|
-        puts "%d) Creative wrapper ID: %d, label ID: %d" % [index + start_index,
+        puts "%d) Creative wrapper ID: %d, label ID: %d" %
+            [index + statement.offset,
             creative_wrapper[:id], creative_wrapper[:label_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
   if page.include?(:total_result_set_size)

data/examples/{v201403 → v201502}/creative_wrapper_service/get_creative_wrappers_by_statement.rb

@@ -24,8 +24,9 @@
 # Tags: CreativeWrapperService.getCreativeWrappersByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
+API_VERSION = :v201502
 
 def get_creative_wrappers_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,25 +40,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',
-      :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.