google-dfp-api 0.7.1 → 0.8.0

data/examples/{v201211 → v201403}/content_service/get_all_content.rb

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

data/examples/{v201308 → v201403}/content_service/get_content_by_category.rb

@@ -29,7 +29,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201308
+API_VERSION = :v201403
 PAGE_SIZE = 500
 
 def get_content_by_statement()

data/examples/{v201308 → v201403}/creative_service/copy_image_creatives.rb

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

data/examples/{v201302 → v201403}/creative_service/create_creative_from_template.rb

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

data/examples/{v201306 → v201403}/creative_service/create_creatives.rb

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

data/examples/{v201211 → v201403}/creative_service/create_custom_creative.rb

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

data/examples/{v201302 → v201403}/creative_service/get_all_creatives.rb

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

data/examples/{v201208 → v201403}/creative_service/get_creatives_by_statement.rb

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

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

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

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

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

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

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

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

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

data/examples/{v201302 → v201403}/creative_set_service/get_creative_sets_by_statement.rb

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

data/examples/{v201302 → v201403}/creative_set_service/update_creative_sets.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201403
 
 def update_creative_sets()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -43,23 +43,38 @@ def update_creative_sets()
   # Get the CreativeSetService.
   creative_set_service = dfp.service(:CreativeSetService, API_VERSION)
 
-  # Get creative set.
-  creative_set = creative_set_service.get_creative_set(creative_set_id)
+  # Create a statement to only select a single creative set.
+  statement = {
+      :query => "WHERE id = :id LIMIT 1",
+      :values => [
+          {:key => 'id',
+           :value => {:value => creative_set_id, :xsi_type => 'NumberValue'}}
+      ]
+  }
 
-  # Update the creative set locally.
-  creative_set[:companion_creative_ids] << companion_creative_id
+  # Get creative sets by statement.
+  page = creative_set_service.get_creative_sets_by_statement(statement)
 
-  # Update the creative set on the server.
-  return_creative_set = creative_set_service.update_creative_set(creative_set)
+  if page[:results]
+    creative_sets = page[:results]
 
-  if return_creative_set
-     puts ('Creative set ID: %d, master creative ID: %d was updated with ' +
-         'companion creative IDs: [%s]') %
-         [creative_set[:id],
-          creative_set[:master_creative_id],
-          creative_set[:companion_creative_ids].join(', ')]
-  else
-    raise 'No creative sets were updated.'
+    creative_sets.each do |creative_set|
+      # Update the creative set locally.
+      creative_set[:companion_creative_ids] << companion_creative_id
+    end
+
+    # Update the creative set on the server.
+    return_creative_set = creative_set_service.update_creative_set(creative_set)
+
+    if return_creative_set
+       puts ('Creative set ID: %d, master creative ID: %d was updated with ' +
+           'companion creative IDs: [%s]') %
+           [creative_set[:id],
+            creative_set[:master_creative_id],
+            creative_set[:companion_creative_ids].join(', ')]
+    else
+      raise 'No creative sets were updated.'
+    end
   end
 end
 

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

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

data/examples/{v201211 → v201403}/creative_template_service/get_creative_template.rb

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

data/examples/{v201302 → v201403}/creative_template_service/get_creative_templates_by_statement.rb

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

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

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

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

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

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

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

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

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

data/examples/{v201306 → v201403}/creative_wrapper_service/update_creative_wrappers.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201306
+API_VERSION = :v201403
 
 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 → v201403}/custom_field_service/create_custom_field_options.rb

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

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

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

data/examples/{v201208 → v201403}/custom_field_service/deactivate_all_line_item_custom_fields.rb

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

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

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

data/examples/{v201211 → v201403}/custom_field_service/get_all_line_item_custom_fields.rb

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

data/examples/{v201302 → v201403}/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 = :v201403
 
 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.