google-dfp-api 0.7.1 → 0.8.0

data/examples/{v201302 → v201403}/custom_field_service/update_custom_fields.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201403
 
 def update_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -41,24 +41,39 @@ def update_custom_fields()
   # Set the ID of the custom field to update.
   custom_field_id = 'INSERT_CUSTOM_FIELD_ID_HERE'.to_i
 
-  # Get custom field.
-  custom_field = custom_field_service.get_custom_field(custom_field_id)
+  # Create a statement to only select a single custom field.
+  statement = {
+      :query => "WHERE id = :id LIMIT 1",
+      :values => [
+          {:key => 'id',
+           :value => {:value => custom_field_id, :xsi_type => 'NumberValue'}}
+      ]
+  }
 
-  if custom_field
-    # Update local custom field object.
-    custom_field[:description] = '' if custom_field[:description].nil?
-    custom_field[:description] +=' Updated.'
+  # Get custom fields by statement.
+  page = custom_field_service.get_custom_fields_by_statement(statement)
 
-    # Update the custom field on the server.
-    return_custom_fields =
-        custom_field_service.update_custom_fields([custom_field])
+  if page[:results]
+    custom_fields = page[:results]
 
-    return_custom_fields.each do |custom_field|
-      puts "Custom field ID: %d, name: '%s' and description '%s' was updated." %
-          [custom_field[:id], custom_field[:name], custom_field[:description]]
+    custom_fields.each do |custom_field|
+      # Update local custom field object.
+      custom_field[:description] = '' if custom_field[:description].nil?
+      custom_field[:description] +=' Updated.'
+
+      # Update the custom field on the server.
+      return_custom_fields =
+          custom_field_service.update_custom_fields([custom_field])
+
+      return_custom_fields.each do |custom_field|
+        puts "Custom field ID: " +
+            "%d, name: '%s' and description '%s' was updated." % [
+                custom_field[:id], custom_field[:name],
+                custom_field[:description]]
+      end
+    else
+      puts 'No custom fields were found to update.'
     end
-  else
-    puts 'No custom fields were found to update.'
   end
 end
 

data/examples/{v201211 → v201403}/custom_targeting_service/create_custom_targeting_keys_and_values.rb

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

data/examples/{v201302 → v201403}/custom_targeting_service/delete_custom_targeting_keys.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201403
 PAGE_SIZE = 500
 
 def delete_custom_targeting_keys()

data/examples/{v201208 → v201403}/custom_targeting_service/delete_custom_targeting_values.rb

@@ -27,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201208
+API_VERSION = :v201403
 PAGE_SIZE = 500
 
 def delete_custom_targeting_values()

data/examples/{v201302 → v201403}/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201403
 PAGE_SIZE = 500
 
 def get_all_custom_targeting_keys_and_values()

data/examples/{v201302 → v201403}/custom_targeting_service/get_custom_targeting_keys_by_statement.rb

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

data/examples/{v201208 → v201403}/custom_targeting_service/get_custom_targeting_values_by_statement.rb

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

data/examples/{v201208 → v201403}/custom_targeting_service/update_custom_targeting_keys.rb

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

data/examples/{v201302 → v201403}/custom_targeting_service/update_custom_targeting_values.rb

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

data/examples/{v201308 → v201403}/forecast_service/get_forecast.rb

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

data/examples/{v201308 → v201403}/forecast_service/get_forecast_by_id.rb

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

data/examples/{v201302 → v201403}/inventory_service/create_ad_units.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201403
 # Number of ad units to create.
 ITEM_COUNT = 5
 

data/examples/{v201211 → v201403}/inventory_service/create_mobile_ad_unit.rb

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

data/examples/{v201302 → v201403}/inventory_service/create_video_ad_unit.rb

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

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

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201211
+API_VERSION = :v201403
 PAGE_SIZE = 500
 
 def deactivate_ad_units()

data/examples/{v201208 → v201403}/inventory_service/get_ad_unit_sizes.rb

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

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

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

data/examples/{v201302 → v201403}/inventory_service/get_all_ad_units.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201403
 PAGE_SIZE = 500
 
 def get_all_ad_units()

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

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

data/examples/{v201208 → v201403}/label_service/create_labels.rb

@@ -27,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201208
+API_VERSION = :v201403
 # Number of labels to create.
 ITEM_COUNT = 5
 

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

@@ -27,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201211
+API_VERSION = :v201403
 PAGE_SIZE = 500
 
 def deactivate_labels()

data/examples/{v201208 → v201403}/label_service/get_all_labels.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201208
+API_VERSION = :v201403
 PAGE_SIZE = 500
 
 def get_all_labels()

data/examples/{v201208 → v201403}/label_service/get_labels_by_statement.rb

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

data/examples/{v201302 → v201403}/label_service/update_labels.rb

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

data/examples/{v201208 → v201403}/line_item_creative_association_service/create_licas.rb

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

data/examples/{v201208 → v201403}/line_item_creative_association_service/deactivate_licas.rb

@@ -27,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201208
+API_VERSION = :v201403
 PAGE_SIZE = 500
 
 def deactivate_licas()

data/examples/{v201302 → v201403}/line_item_creative_association_service/get_all_licas.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201403
 PAGE_SIZE = 500
 
 def get_all_licas()

data/examples/{v201208 → v201403}/line_item_creative_association_service/get_licas_by_statement.rb

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

data/examples/{v201302 → v201403}/line_item_creative_association_service/update_licas.rb

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

data/examples/{v201208 → v201403}/line_item_service/activate_line_items.rb

@@ -30,7 +30,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201208
+API_VERSION = :v201403
 PAGE_SIZE = 500
 
 def activate_line_items()

data/examples/{v201302 → v201403}/line_item_service/create_line_items.rb

@@ -29,7 +29,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201403
 # Number of line items to create.
 ITEM_COUNT = 5
 

data/examples/{v201302 → v201403}/line_item_service/create_mobile_line_item.rb

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

data/examples/{v201302 → v201403}/line_item_service/create_video_line_item.rb

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

data/examples/{v201302 → v201403}/line_item_service/get_all_line_items.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201403
 PAGE_SIZE = 500
 
 def get_all_line_items()

data/examples/{v201302 → v201403}/line_item_service/get_line_items_by_statement.rb

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

data/examples/{v201208 → v201403}/line_item_service/get_recently_updated_line_items.rb

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

data/examples/{v201211 → v201403}/line_item_service/target_custom_criteria.rb

@@ -23,13 +23,14 @@
 # which custom targeting keys and values exist, run
 # get_all_custom_targeting_keys_and_values.rb.
 #
-# Tags: LineItemService.getLineItem, LineItemService.updateLineItem
+# Tags: LineItemService.getLineItemsByStatement,
+#       LineItemService.updateLineItems
 
 require 'dfp_api'
 
 require 'pp'
 
-API_VERSION = :v201211
+API_VERSION = :v201403
 PAGE_SIZE = 500
 
 def target_custom_criteria()
@@ -88,22 +89,35 @@ def target_custom_criteria()
       :children => [custom_criteria[0], sub_custom_criteria_set]
   }
 
-  # Get the line item.
-  line_item = line_item_service.get_line_item(line_item_id)
 
-  # Set the custom criteria targeting on the line item.
-  line_item[:targeting] = {:custom_targeting => top_custom_criteria_set}
+  # Create a statement to only select a single line item.
+  statement = {
+      :query => 'WHERE id = :id ORDER BY id ASC LIMIT 1',
+      :values => [
+          {:key => 'id',
+           :value => {:value => line_item_id, :xsi_type => 'NumberValue'}}
+      ]
+  }
+
+  # Get line items by statement.
+  page = line_item_service.get_line_items_by_statement(statement)
+
+  if page[:results]
+    line_item = page[:results].first
 
-  # Update the line items on the server.
-  return_line_item = line_item_service.update_line_item(line_item)
+    line_item[:targeting] = {:custom_targeting => top_custom_criteria_set}
 
-  # Display the updated line item.
-  if return_line_item
-    puts "Line item ID: %d was updated with custom criteria targeting:" %
-        return_line_item[:id]
-    pp return_line_item[:targeting]
-  else
-    puts 'Line item update failed.'
+    # Update the line items on the server.
+    return_line_item = line_item_service.update_line_items([line_item])
+
+    # Display the updated line item.
+    if return_line_item
+      puts "Line item ID: %d was updated with custom criteria targeting:" %
+          return_line_item[:id]
+      pp return_line_item[:targeting]
+    else
+      puts 'Line item update failed.'
+    end
   end
 end