google-dfp-api 0.10.0 → 0.10.1

data/examples/{v201408 → v201508}/inventory_service/create_ad_units.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,10 @@
 # This example creates new ad units under a the effective root ad unit. To
 # determine which ad units exist, run get_inventory_tree.rb or
 # get_all_ad_units.rb.
-#
-# Tags: InventoryService.createAdUnits, NetworkService.getCurrentNetwork
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 # Number of ad units to create.
 ITEM_COUNT = 5
 

data/examples/{v201408 → v201508}/inventory_service/create_mobile_ad_unit.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");
@@ -23,12 +21,10 @@
 # get_all_ad_units.rb.
 #
 # Mobile features need to be enabled on your account to use mobile targeting.
-#
-# Tags: InventoryService.createAdUnits, NetworkService.getCurrentNetwork
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def create_mobile_ad_unit()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201408 → v201508}/inventory_service/create_video_ad_unit.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");
@@ -23,12 +21,10 @@
 # get_all_ad_units.rb.
 #
 # This feature is only available to DFP premium solution networks.
-#
-# Tags: InventoryService.createAdUnits, NetworkService.getCurrentNetwork
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def create_video_ad_unit()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201408 → v201508}/inventory_service/deactivate_ad_units.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 deactivates all active ad units. To determine which ad units
 # exist, run get_all_ad_units.rb or get_inventory_tree.rb.
-#
-# Tags: InventoryService.getLineItemsByStatement
-# Tags: InventoryService.performAdUnitAction
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def deactivate_ad_units()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -41,50 +36,46 @@ def deactivate_ad_units()
   inventory_service = dfp.service(:InventoryService, API_VERSION)
 
   # Create statement text to select active ad units.
-  statement_text = 'WHERE status = :status'
-  statement = {
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE status = :status',
+      [
           {:key => 'status',
            :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
       ]
-  }
+  )
 
-  # Define initial values.
-  offset = 0
-  page = {}
   ad_unit_ids = []
 
   begin
-    # Create a statement to get one page with the current offset.
-    statement[:query] = statement_text +
-        " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
-
     # Get ad units by statement.
-    page = inventory_service.get_ad_units_by_statement(statement)
+    page = inventory_service.get_ad_units_by_statement(statement.toStatement())
 
     if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      page[:results].each do |ad_unit|
+      page[:results].each_with_index do |ad_unit, index|
         puts ("%d) Ad unit with ID: %d, status: %s and name: %s will be " +
-              "deactivated.") % [ad_unit_ids.size, ad_unit[:id],
+              "deactivated.") % [index + statement.offset, ad_unit[:id],
               ad_unit[:status], ad_unit[:name]]
         ad_unit_ids << ad_unit[: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]
 
   puts "Number of ad units to be deactivated: %d" % ad_unit_ids.size
 
   if !ad_unit_ids.empty?
     # Modify statement for action. Note, the values are still present.
-    statement[:query] = statement_text + " AND id IN (%s)" %
-        ad_unit_ids.join(', ')
+    statement = DfpApiStatement::FilterStatement.new(
+        "WHERE status = :status AND id in (%s)" % ad_unit_ids.join(', '),
+        [
+            {:key => 'status',
+             :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
+        ]
+    )
 
     # Perform action.
     result = inventory_service.perform_ad_unit_action(
-        {:xsi_type => 'DeactivateAdUnits'}, statement)
+        {:xsi_type => 'DeactivateAdUnits'}, statement.toStatement())
 
     # Display results.
     if result and result[:num_changes] > 0

data/examples/{v201408 → v201508}/inventory_service/get_ad_unit_sizes.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");
@@ -18,13 +16,12 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This code example gets all web target platform ad unit sizes.
-#
-# Tags: InventoryService.getAdUnitSizesByStatement
+# This code example gets all ad unit sizes.
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def get_all_ad_unit_sizes()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -37,20 +34,12 @@ def get_all_ad_unit_sizes()
   # Get the InventoryService.
   inventory_service = dfp.service(:InventoryService, API_VERSION)
 
-  target_platform = 'WEB'
-
-  # Create statement object to only select web ad unit sizes.
-  statement = {
-     :query => 'WHERE targetPlatform = :target_platform ORDER BY id ASC',
-     :values => [
-         {:key => 'target_platform',
-          :value => {:value => target_platform,
-                     :xsi_type => 'TextValue'}}
-     ]
-  }
+  # Create statement select all ad unit sizes.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
   # Get ad unit sizes by statement.
-  ad_unit_sizes = inventory_service.get_ad_unit_sizes_by_statement(statement)
+  ad_unit_sizes = inventory_service.get_ad_unit_sizes_by_statement(
+      statement.toStatement())
 
   if ad_unit_sizes
     # Print details about each ad unit in results.

data/examples/{v201408 → v201508}/inventory_service/get_ad_units_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");
@@ -20,12 +18,11 @@
 #
 # This example gets first 500 children below the effective root ad unit. To
 # create ad units, run create_ad_units.rb.
-#
-# Tags: InventoryService.getAdUnitsByStatement, NetworkService.getCurrentNetwork
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def get_ad_units_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -48,25 +45,29 @@ def get_ad_units_by_statement()
   puts "Using effective root ad unit: %d" % effective_root_ad_unit_id
 
   # Create a statement to select the children of the effective root ad unit.
-  statement = {
-     :query => 'WHERE parentId = :id ORDER BY id ASC LIMIT 500',
-     :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+     'WHERE parentId = :id ORDER BY id',
+     [
          {:key => 'id',
           :value => {:value => effective_root_ad_unit_id,
                      :xsi_type => 'NumberValue'}}
      ]
-  }
+  )
 
-  # Get ad units by statement.
-  page = inventory_service.get_ad_units_by_statement(statement)
+  begin
+    # Get ad units by statement.
+    page = inventory_service.get_ad_units_by_statement(statement.toStatement())
 
-  if page[:results]
-    # Print details about each ad unit in results.
-    page[:results].each_with_index do |ad_unit, index|
-      puts "%d) Ad unit ID: %d, name: %s, status: %s." %
-          [index, ad_unit[:id], ad_unit[:name], ad_unit[:status]]
+    if page[:results]
+      # Print details about each ad unit in results.
+      page[:results].each_with_index do |ad_unit, index|
+        puts "%d) Ad unit ID: %d, name: %s, status: %s." %
+            [index + statement.offset, ad_unit[:id],
+             ad_unit[:name], ad_unit[:status]]
+      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}/inventory_service/get_all_ad_units.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");
@@ -19,13 +17,11 @@
 #           limitations under the License.
 #
 # This example gets all ad units. To create ad units, run create_ad_units.rb.
-#
-# Tags: InventoryService.getAdUnitsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def get_all_ad_units()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,33 +34,23 @@ def get_all_ad_units()
   # Get the InventoryService.
   inventory_service = dfp.service(:InventoryService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create a statement to get all ad units
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
   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 ad units by statement.
-    page = inventory_service.get_ad_units_by_statement(statement)
+    page = inventory_service.get_ad_units_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 ad unit in results.
       page[:results].each_with_index do |ad_unit, index|
         puts "%d) Ad unit ID: %d, name: %s, status: %s." %
-            [index + start_index, ad_unit[:id],
+            [index + statement.offset, ad_unit[:id],
              ad_unit[:name], ad_unit[: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/{v201408 → v201508}/inventory_service/update_ad_units.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");
@@ -18,15 +16,13 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example updates an ad unit by enabling AdSense to the first 500. To
+# This example adds a new 1x1 creative placeholder for a specific ad unit. To
 # determine which ad units exist, run get_all_ad_units.rb or
 # get_inventory_tree.rb.
-#
-# Tags: InventoryService.getAdUnitsByStatement, InventoryService.updateAdUnits
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def update_ad_units()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,19 +35,33 @@ def update_ad_units()
   # Get the InventoryService.
   inventory_service = dfp.service(:InventoryService, API_VERSION)
 
+  # Specify which ad unit to update.
+  ad_unit_id = 'INSERT_AD_UNIT_ID_HERE'.to_i
+
   # Create a statement to get first 500 ad units.
-  statement = {:query => "LIMIT 500"}
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id',
+      [
+          {:key => 'id',
+           :value => {:value => ad_unit_id, :xsi_type => 'NumberValue'}}
+      ],
+      1
+  }
 
   # Get ad units by statement.
-  page = inventory_service.get_ad_units_by_statement(statement)
+  page = inventory_service.get_ad_units_by_statement(statement.toStatement())
 
   if page[:results]
     ad_units = page[:results]
 
-    # Update each local ad unit object by enabling AdSense.
+    new_ad_unit_size = {
+        :size => {:width => 1, :height => 1, :is_aspect_ration => false},
+        :environment_type => 'BROWSER'
+    }
+
+    # Update local ad unit by adding a new size of 1x1.
     ad_units.each do |ad_unit|
-      ad_unit[:inherited_ad_sense_settings] =
-          {:value => {:ad_sense_enabled => true}}
+      ad_unit[:ad_unit_sizes] = ad_unit[:ad_unit_sizes] << new_ad_unit_size
       # Workaround for issue #94.
       ad_unit[:description] = "" if ad_unit[:description].nil?
     end
@@ -61,10 +71,8 @@ def update_ad_units()
 
     if return_ad_units
       return_ad_units.each do |ad_unit|
-        puts ("Ad unit with ID: %d, name: %s and status: %s was updated " +
-            "with AdSense enabled: %s") %
-            [ad_unit[:id], ad_unit[:name], ad_unit[:status],
-             ad_unit[:inherited_ad_sense_settings][:value][:ad_sense_enabled]]
+        puts ("Ad unit with ID: %d, name: %s and status: %s was updated") %
+            [ad_unit[:id], ad_unit[:name], ad_unit[:status]]
       end
     else
       raise 'No ad units were updated.'

data/examples/{v201408 → v201508}/label_service/create_labels.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,12 +20,10 @@
 # get_all_labels.rb.
 #
 # This feature is only available to DFP premium solution networks.
-#
-# Tags: LabelService.createLabels
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 # Number of labels to create.
 ITEM_COUNT = 5
 

data/examples/{v201408 → v201508}/label_service/deactivate_labels.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,11 @@
 # run get_all_labels.rb.
 #
 # This feature is only available to DFP premium solution networks.
-#
-# Tags: LabelService.getLabelsByStatement, LabelService.performLabelAction
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def deactivate_labels()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -41,49 +37,42 @@ def deactivate_labels()
   # Get the LabelService.
   label_service = dfp.service(:LabelService, API_VERSION)
 
-  # Create statement text and statement to select active labels.
-  statement_text = 'WHERE isActive = :is_active'
-  statement = {
-      :values => [
+  # Create statement to select active labels.
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE isActive = :is_active',
+      [
           {:key => 'is_active',
            :value => {:value => true, :xsi_type => 'BooleanValue'}}
       ]
-  }
+  )
 
   # Define initial values.
-  offset = 0
-  page = {}
   label_ids = []
 
   begin
-    # Modify the statement to get one page with current offset.
-    statement[:query] = statement_text +
-        " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
-
     # Get labels by statement.
-    page = label_service.get_labels_by_statement(statement)
+    page = label_service.get_labels_by_statement(statement.toStatement())
 
     if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      page[:results].each do |label|
+      page[:results].each_with_index do |label, index|
         puts ("%d) Label ID: %d, name: %s will be deactivated.") %
-            [label_ids.size, label[:id], label[:name]]
+            [index + statement.offset, label[:id], label[:name]]
         label_ids << 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]
 
   puts "Number of labels to be deactivated: %d" % label_ids.size
 
   if !label_ids.empty?
     # Create a statement for action.
-    statement = {:query => "WHERE id IN (%s)" % label_ids.join(', ')}
+    statement = DfpApiStatement::FilterStatement.new(
+        "WHERE id IN (%s)" % label_ids.join(', '))
 
     # Perform action.
     result = label_service.perform_label_action(
-        {:xsi_type => 'DeactivateLabels'}, statement)
+        {:xsi_type => 'DeactivateLabels'}, statement.toStatement())
 
     # Display results.
     if result and result[:num_changes] > 0