google-dfp-api 0.4.0 → 0.5.0

data/examples/{v201201 → v201211}/inventory_service/create_video_ad_unit.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -27,7 +28,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def create_video_ad_unit()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201111 → v201211}/inventory_service/deactivate_ad_units.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -20,12 +21,12 @@
 # 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,
-#       InventoryService.performAdUnitAction
+# Tags: InventoryService.getLineItemsByStatement
+# Tags: InventoryService.performAdUnitAction
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def deactivate_ad_units()
@@ -54,7 +55,7 @@ def deactivate_ad_units()
   ad_unit_ids = []
 
   begin
-    # Create a statement to get one page with current offset.
+    # Create a statement to get one page with the current offset.
     statement[:query] = statement_text +
         " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
 

data/examples/{v201108 → v201211}/inventory_service/get_ad_unit.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -24,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 
 def get_ad_unit()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201201 → v201211}/inventory_service/get_ad_unit_sizes.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -17,13 +18,13 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all ad unit sizes in the network.
+# This code example gets all web target platform ad unit sizes.
 #
-# Tags: InventoryService.getAdUnitSizes
+# Tags: InventoryService.getAdUnitSizesByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def get_all_ad_unit_sizes()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -36,14 +37,26 @@ def get_all_ad_unit_sizes()
   # Get the InventoryService.
   inventory_service = dfp.service(:InventoryService, API_VERSION)
 
-  # Get all ad unit sizes.
-  ad_unit_sizes = inventory_service.get_ad_unit_sizes()
+  target_platform = 'WEB'
+
+  # Create statement object to only select web ad unit sizes.
+  statement = {
+     :query => 'WHERE targetPlatform = :target_platform',
+     :values => [
+         {:key => 'target_platform',
+          :value => {:value => target_platform,
+                     :xsi_type => 'TextValue'}}
+     ]
+  }
+
+  # Get ad unit sizes by statement.
+  ad_unit_sizes = inventory_service.get_ad_unit_sizes_by_statement(statement)
 
   if ad_unit_sizes
     # Print details about each ad unit in results.
     ad_unit_sizes.each_with_index do |ad_unit_size, index|
-      puts "%d) Ad unit size %dx%d was found." % [index,
-          ad_unit_size[:size][:width], ad_unit_size[:size][:height]]
+      puts "%d) Web ad unit size of dimensions %s was found." %
+          [index, ad_unit_size[:full_display_string]]
     end
   else
     puts 'No ad unit sizes found.'

data/examples/{v201108 → v201211}/inventory_service/get_ad_units_by_statement.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -24,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 
 def get_ad_units_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201201 → v201211}/inventory_service/get_all_ad_units.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -23,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def get_all_ad_units()

data/examples/{v201111 → v201211}/inventory_service/update_ad_units.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -25,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 
 def update_ad_units()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201111 → v201211}/label_service/create_labels.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -26,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 # Number of labels to create.
 ITEM_COUNT = 5
 
@@ -43,7 +44,7 @@ def create_labels()
 
   # Create an array to store local label objects.
   labels = (1..ITEM_COUNT).map do |index|
-    {:name => "Label #%d" % index, :type => 'COMPETITIVE_EXCLUSION'}
+    {:name => "Label #%d" % index, :types => ['COMPETITIVE_EXCLUSION']}
   end
 
   # Create the labels on the server.
@@ -51,8 +52,8 @@ def create_labels()
 
   if return_labels
     return_labels.each do |label|
-      puts "Label with ID: %d, name: %s and type: %s was created." %
-          [label[:id], label[:name], label[:type]]
+      puts "Label with ID: %d, name: '%s' and types: '%s' was created." %
+          [label[:id], label[:name], label[:types].join(', ')]
     end
   else
     raise 'No labels were created.'

data/examples/{v201108 → v201211}/label_service/deactivate_labels.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -26,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def deactivate_labels()

data/examples/{v201201 → v201211}/label_service/get_all_labels.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -25,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def get_all_labels()
@@ -59,8 +60,9 @@ def get_all_labels()
 
       # Print details about each label in results page.
       page[:results].each_with_index do |label, index|
-        puts "%d) Label ID: %d, name: %s, type: %s." %
-            [index + start_index, label[:id], label[:name], label[:type]]
+        puts "%d) Label ID: %d, name: '%s', types: '%s'." %
+            [index + start_index, label[:id], label[:name],
+             label[:types].join(', ')]
       end
     end
   end while offset < page[:total_result_set_size]

data/examples/{v201201 → v201211}/label_service/get_label.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -26,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def get_label()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -46,8 +47,8 @@ def get_label()
   label = label_service.get_label(label_id)
 
   if label
-    puts "Label with ID: %d, name: %s and type %s was found." %
-        [label[:id], label[:name], label[:type]]
+    puts "Label with ID: %d, name: '%s' and types '%s' was found." %
+        [label[:id], label[:name], label[:types].join(', ')]
   else
     puts 'No label found for this ID.'
   end

data/examples/{v201201 → v201211}/label_service/get_labels_by_statement.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -17,9 +18,8 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all labels that are competitively excluded. The statement
-# retrieves up to the maximum page size limit of 500. To create labels, run
-# create_labels.rb.
+# This example gets all labels ordered by name. The statement retrieves up to
+# the maximum page size limit of 500. To create labels, run create_labels.rb.
 #
 # This feature is only available to DFP premium solution networks.
 #
@@ -27,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def get_labels_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,25 +40,16 @@ def get_labels_by_statement()
   # Get the LabelService.
   label_service = dfp.service(:LabelService, API_VERSION)
 
-  # Create a statement to only select active labels.
-  statement = {
-      :query => 'WHERE type = :type ORDER BY name LIMIT 500',
-      :values => [
-          {:key => 'type',
-           :value => {
-               :value => 'COMPETITIVE_EXCLUSION',
-               :xsi_type => 'TextValue'}
-          }
-      ]
-  }
+  # Create a statement to select labels ordered by name.
+  statement = {:query => 'ORDER BY name LIMIT 500'}
 
   # Get labels by statement.
   page = label_service.get_labels_by_statement(statement)
 
   if page and page[:results]
     page[:results].each_with_index do |label, index|
-      puts "%d) Label ID: %d, name: %s, type: %s." % [index,
-          label[:id], label[:name], label[:type]]
+      puts "%d) Label ID: %d, name: '%s', types: '%s'." % [index,
+          label[:id], label[:name], label[:types].join(', ')]
     end
   end
 

data/examples/{v201108 → v201211}/label_service/update_labels.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -17,9 +18,9 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example updates the descriptions of all labels that are competitive
-# exclusion by updating its description up to the first 500. To determine which
-# labels exist, run get_all_labels.rb.
+# This example updates the descriptions of all active labels by updating its
+# description, up to the first 500. To determine which labels exist, run
+# get_all_labels.rb.
 #
 # This feature is only available to DFP premium solution networks.
 #
@@ -27,7 +28,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 
 def update_labels()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,15 +41,14 @@ def update_labels()
   # Get the LabelService.
   label_service = dfp.service(:LabelService, API_VERSION)
 
-  # Create a statement to only select labels that are competitive exclusion and
-  # active.
+  # Create a statement to only select active labels.
   statement = {
-      :query => 'WHERE type = :type and isActive = true LIMIT 500',
+      :query => 'WHERE isActive = :is_active LIMIT 500',
       :values => [
-          {:key => 'type',
+          {:key => 'is_active',
            :value => {
-               :value => 'COMPETITIVE_EXCLUSION',
-               :xsi_type => 'TextValue'}
+               :value => 'true',
+               :xsi_type => 'BooleanValue'}
           }
       ]
   }
@@ -61,8 +61,7 @@ def update_labels()
 
     # Update each local label object by changing its description.
     labels.each do |label|
-      label[:description] =
-          'These labels are still competiting with each other'
+      label[:description] = 'This label was updated'
     end
 
     # Update the labels on the server.

data/examples/{v201201 → v201211}/line_item_creative_association_service/create_licas.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -28,7 +29,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def create_licas()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201108 → v201211}/line_item_creative_association_service/deactivate_licas.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -21,12 +22,12 @@
 # exist, run get_all_licas.rb. To determine which line items exist, run
 # get_all_line_items.rb.
 #
-# Tags: InventoryService.getLineItemsByStatement,
-#       InventoryService.performAdUnitAction
+# Tags: InventoryService.getLineItemsByStatement
+# Tags: InventoryService.performAdUnitAction
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def deactivate_licas()

data/examples/{v201201 → v201211}/line_item_creative_association_service/get_all_licas.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -18,13 +19,13 @@
 #           limitations under the License.
 #
 # This example gets all line item creative associations (LICA). To create LICAs,
-# run create_licas.rb.
+# run create_licas.rb or associate_creative_set_to_line_item.rb.
 #
 # Tags: LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def get_all_licas()
@@ -44,7 +45,7 @@ def get_all_licas()
 
   begin
     # Create statement for one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
+    statement = {:query => 'LIMIT %d OFFSET %d' % [PAGE_SIZE, offset]}
 
     # Get LICAs by statement.
     page =
@@ -59,8 +60,11 @@ def get_all_licas()
 
       # Print details about each LICA in results page.
       page[:results].each_with_index do |lica, index|
-        puts "%d) LICA with line item ID: %d, creative ID: %d and status: %s" %
-            [index + start_index, lica[:line_item_id], lica[:creative_id],
+        creative_text = (lica[:creative_set_id] != nil) ?
+            'creative set ID %d' % lica[:creative_set_id] :
+            'creative ID %d' % lica[:creative_id]
+        puts '%d) LICA with line item ID: %d, %s and status: %s' %
+            [index + start_index, lica[:line_item_id], creative_text,
              lica[:status]]
       end
     end
@@ -68,7 +72,7 @@ def get_all_licas()
 
   # Print a footer
   if page.include?(:total_result_set_size)
-    puts "Total number of LICAs: %d" % page[:total_result_set_size]
+    puts 'Total number of LICAs: %d' % page[:total_result_set_size]
   end
 end
 
@@ -78,11 +82,11 @@ if __FILE__ == $0
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
+    puts 'HTTP Error: %s' % e
 
   # API errors.
   rescue DfpApi::Errors::ApiException => e
-    puts "Message: %s" % e.message
+    puts 'Message: %s' % e.message
     puts 'Errors:'
     e.errors.each_with_index do |error, index|
       puts "\tError [%d]:" % (index + 1)