google-dfp-api 0.8.1 → 0.9.0

data/examples/{v201302 → v201408}/creative_wrapper_service/get_creative_wrappers_by_statement.rb

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

data/examples/{v201302 → v201408}/creative_wrapper_service/update_creative_wrappers.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201408
 
 def update_creative_wrappers()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -42,25 +42,40 @@ def update_creative_wrappers()
   # Set the ID of the creative wrapper to get.
   creative_wrapper_id = 'INSERT_CREATIVE_WRAPPER_ID_HERE'.to_i
 
-  # Get creative wrapper by ID.
-  creative_wrapper =
-      creative_wrapper_service.get_creative_wrapper(creative_wrapper_id)
+  # Create a statement to only select a single creative wrapper.
+  statement = {
+      :query => "WHERE id = :id LIMIT 1",
+      :values => [
+          {:key => 'id',
+           :value => {:value => creative_wrapper_id, :xsi_type => 'NumberValue'}
+          }
+      ]
+  }
 
-  # Update local creative wrapper object by changing its ordering.
-  creative_wrapper[:ordering] = 'OUTER'
+  # Get creative wrappers by statement.
+  page = creative_wrapper_service.get_creative_wrappers_by_statement(statement)
 
-  # Update the creative wrapper on the server.
-  return_creative_wrappers =
-      creative_wrapper_service.update_creative_wrappers([creative_wrapper])
+  if page[:results]
+    creative_wrappers = page[:results]
 
-  if return_creative_wrappers
-    return_creative_wrappers.each do |creative_wrapper|
-      puts ("Creative wrapper ID: %d, label ID: %d was updated with ordering" +
-            " '%s'") % [creative_wrapper[:id], creative_wrapper[:label_id],
-                        creative_wrapper[:ordering]]
+    creative_wrappers.each do |creative_wrapper|
+      # Update local creative wrapper object by changing its ordering.
+      creative_wrapper[:ordering] = 'OUTER'
+    end
+
+    # Update the creative wrapper on the server.
+    return_creative_wrappers =
+        creative_wrapper_service.update_creative_wrappers([creative_wrapper])
+
+    if return_creative_wrappers
+      return_creative_wrappers.each do |creative_wrapper|
+        puts ("Creative wrapper ID: %d, label ID: %d was updated with order" +
+              " '%s'") % [creative_wrapper[:id], creative_wrapper[:label_id],
+                          creative_wrapper[:ordering]]
+      end
+    else
+      puts 'No creative wrappers found to update.'
     end
-  else
-    puts 'No creative wrappers found to update.'
   end
 end
 

data/examples/{v201302 → v201408}/custom_field_service/create_custom_field_options.rb

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

data/examples/{v201302 → v201408}/custom_field_service/create_custom_fields.rb

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

data/examples/{v201302 → v201408}/custom_field_service/deactivate_all_line_item_custom_fields.rb

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

data/examples/{v201308 → v201408}/custom_field_service/get_all_custom_fields.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201308
+API_VERSION = :v201408
 PAGE_SIZE = 500
 
 def get_all_custom_fields()

data/examples/{v201302 → v201408}/custom_field_service/get_all_line_item_custom_fields.rb

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

data/examples/{v201302 → v201408}/custom_field_service/set_line_item_custom_field_value.rb

@@ -23,11 +23,12 @@
 # items exist, run get_all_line_items.rb. To create custom field options, run
 # create_custom_field_options.rb.
 #
-# Tags: CustomFieldService.getCustomField, LineItemService.getLineItem
+# Tags: CustomFieldService.getCustomFieldsByStatement,
+#       LineItemService.getLineItemsByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201408
 
 def set_line_item_custom_field_value()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -49,15 +50,57 @@ def set_line_item_custom_field_value()
   custom_field_option_id = 'INSERT_CUSTOM_FIELD_OPTION_ID_HERE'.to_i
   line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
 
-  # Get custom field.
-  custom_field = custom_field_service.get_custom_field(custom_field_id)
-
-  # Get drop-down custom field.
-  drop_down_custom_field = custom_field_service.get_custom_field(
-      drop_down_custom_field_id)
-
-  # Get line item.
-  line_item = line_item_service.get_line_item(line_item_id)
+  # Create a statement to only select a single custom field.
+  custom_field_statement = {
+      :query => 'WHERE id = :id ORDER BY id ASC LIMIT 1',
+      :values => [
+          {:key => 'id',
+           :value => {:value => custom_field_id, :xsi_type => 'NumberValue'}}
+      ]
+  }
+
+  # Create a statement to only select a single drop down custom field.
+  custom_field_statement = {
+      :query => 'WHERE id = :id ORDER BY id ASC LIMIT 1',
+      :values => [
+          {:key => 'id',
+           :value => {:value => drop_down_custom_field_id,
+                      :xsi_type => 'NumberValue'}}
+      ]
+  }
+
+  # Create a statement to only select a single line item.
+  custom_field_statement = {
+      :query => 'WHERE id = :id ORDER BY id ASC LIMIT 1',
+      :values => [
+          {:key => 'id',
+           :value => {:value => line_item_id, :xsi_type => 'NumberValue'}}
+      ]
+  }
+
+  # Get custom fields by statement.
+  custom_fields_page = custom_field_service.get_custom_fields_by_statement(
+      custom_field_statement)
+
+  # Get drop down custom fields by statement.
+  drop_down_custom_fields_page = (
+      custom_field_service.get_custom_fields_by_statement(
+          drop_down_custom_field_statement))
+
+  # Get line items by statement.
+  line_items_page = line_item_service.get_line_items_by_statement(statement)
+
+  # Get singular custom field.
+  if custom_field_page[:results]
+    custom_field = custom_fields_page[:results].first
+
+  # Get singular drop down custom field.
+  if drop_down_custom_field_page[:results]
+    drop_down_custom_field = drop_down_custom_fields_page[:results].first
+
+  # Get singular line item.
+  if line_item_page[:results]
+    line_item = line_items_page[:results].first
 
   if custom_field and drop_down_custom_field and line_item
     # Create custom field values.

data/examples/{v201208 → v201408}/custom_field_service/update_custom_fields.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201208
+API_VERSION = :v201408
 
 def update_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -41,23 +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] += ' 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 → v201408}/custom_targeting_service/create_custom_targeting_keys_and_values.rb

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

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

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

data/examples/{v201211 → v201408}/custom_targeting_service/delete_custom_targeting_values.rb

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

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

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

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

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

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

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

data/examples/{v201211 → v201408}/custom_targeting_service/update_custom_targeting_keys.rb

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

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

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

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

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201308
+API_VERSION = :v201408
 
 def get_forecast()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -62,8 +62,11 @@ def get_forecast()
     :start_date_time_type => 'IMMEDIATELY',
     :end_date_time => Time.utc(2014, 01, 01),
     # Set the line item to use 50% of the impressions.
-    :unit_type => 'IMPRESSIONS',
-    :units_bought => 50,
+    :primary_goal => {:goal => {
+        :units => '50',
+        :unit_type => 'IMPRESSIONS',
+        :goal_type => 'DAILY'}
+    }
     # Set the cost type to match the unit type.
     :cost_type => 'CPM'
   }

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

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

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

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

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

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

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

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

data/examples/{v201208 → v201408}/inventory_service/deactivate_ad_units.rb

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

data/examples/{v201302 → v201408}/inventory_service/get_ad_unit_sizes.rb

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

data/examples/{v201302 → v201408}/inventory_service/get_ad_units_by_statement.rb

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

data/examples/{v201208 → v201408}/inventory_service/get_all_ad_units.rb

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