google-dfp-api 0.9.2 → 0.9.3

data/examples/v201411/content_metadata_key_hierarchy_service/update_content_metadata_key_hierarchies.rb

@@ -0,0 +1,115 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.nicholaschen@gmail.com (Nicholas Chen)
+#
+# Copyright:: Copyright 2014, Google Inc. All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+# This example updates a single content metadata key hierarchy.
+#
+# This feature is only available to DFP video publishers.
+#
+# Tags: ContentMetadataKeyHierarchyService.getContentMetadataKeyHierarchiesByStatement
+# Tags: ContentMetadataKeyHierarchyService.updateContentMetadataKeyHierarchies
+
+require 'dfp_api'
+require 'dfp_api_statement'
+
+API_VERSION = :v201411
+
+def update_content_metadata_key_hierarchies()
+  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
+  dfp = DfpApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # dfp.logger = Logger.new('dfp_xml.log')
+
+  # Get the ContentMetadataKeyHierarchyService.
+  cmkh_service = dfp.service(:ContentMetadataKeyHierarchyService, API_VERSION)
+
+  # Set the ID of the content metadata key hierarchy.
+  content_metadata_key_hierarchy_id =
+      'INSERT_CONTENT_METADATA_KEY_HIERARCHY_ID_HERE'
+
+  # Set the ID of the custom targeting key to be added as a hierarchy level.
+  custom_targeting_key_id = "INSERT_CUSTOM_TARGETING_KEY_ID_HERE"
+
+  # Create a statement to only select a single content metadata key hierarchy.
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id ORDER BY id ASC',
+      [
+          {:key => 'id',
+           :value => {:value => content_metadata_key_hierarchy_id,
+                      :xsi_type => 'NumberValue'}},
+      ],
+      1
+  }
+
+  # Get content metadata key hierarchies by statement.
+  page = cmkh_service.get_content_metadata_key_hierarchies_by_statement(
+      statement.toStatement())
+
+  if page[:results]
+    content_metadata_key_hierarchy = page[:results].first
+
+    # Update the content metadata key hierarchy by adding a hierarchy level.
+    hierarchy_levels = content_metadata_key_hierarchy[:hierarchy_levels]
+
+    hierarchy_level = {
+      :custom_targeting_key_id => custom_targeting_key_id,
+      :hierarchy_level => hierarchy_levels.length + 1
+    }
+
+    content_metadata_key_hierarchy[:hierarchy_levels] =
+        hierarchy_levels.concat([hierarchy_level])
+
+    # Update content metadata key hierarchy.
+    content_metadata_key_hierarchies =
+        cmkh_service.update_content_metadata_key_hierarchies(
+            [content_metadata_key_hierarchy])
+
+    content_metadata_key_hierarchies.each do |content_metadata_key_hierarchy|
+      puts 'Content metadata key hierarchy with ID ' +
+           '%d, name "%s" was updated.' % [
+               content_metadata_key_hierarchy[:id],
+               content_metadata_key_hierarchy[:name]]
+    end
+  else
+    puts 'No content metadata key hierarchy found to update.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    update_content_metadata_key_hierarchies()
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue DfpApi::Errors::ApiException => e
+    puts "Message: %s" % e.message
+    puts 'Errors:'
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
+      end
+    end
+  end
+end

data/examples/{v201311 → v201411}/content_service/get_all_content.rb

@@ -25,9 +25,9 @@
 # Tags: ContentService.getContentByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
-PAGE_SIZE = 500
+API_VERSION = :v201411
 
 def get_all_content()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,31 +40,22 @@ def get_all_content()
   # Get the ContentService.
   content_service = dfp.service(:ContentService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create statement for one page with current offset.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
   begin
-    # Create statement for one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
-
     # Get content by statement.
-    page = content_service.get_content_by_statement(statement)
+    page = content_service.get_content_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 content object in results page.
       page[:results].each_with_index do |content, index|
-        puts "%d) Content ID: %d, name: %s, status: %s." % [index + start_index,
+        puts "%d) Content ID: %d, name: %s, status: %s." % [
+             index + statement.offset,
              content[:id], content[:name], content[: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/{v201311 → v201411}/content_service/get_content_by_category.rb

@@ -28,9 +28,9 @@
 # Tags: CustomTargetingService.getCustomTargetingValuesByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
-PAGE_SIZE = 500
+API_VERSION = :v201411
 
 def get_content_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -52,22 +52,23 @@ def get_content_by_statement()
   custom_targeting_service = dfp.service(:CustomTargetingService, API_VERSION)
 
   # Create a statement to select the categories matching the name comedy.
-  statement = {
-      :query => 'WHERE customTargetingKeyId = :targeting_key_id' +
-          ' and name = :category LIMIT 1',
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new( 
+      'WHERE customTargetingKeyId = :targeting_key_id' +
+      ' and name = :category ORDER BY id ASC',
+      [
           {:key => 'targeting_key_id',
            :value => {:value => content_browse_custom_targeting_key_id,
                       :xsi_type => 'NumberValue'}},
           {:key => 'category',
            :value => {:value => 'comedy',
                       :xsi_type => 'TextValue'}},
-      ]
-  }
+      ],
+      1
+  )
 
   # Get categories matching the filter statement.
   page = custom_targeting_service.get_custom_targeting_values_by_statement(
-      statement)
+      statement.toStatement())
 
   # Get the custom targeting value ID for the comedy category.
   if page[:results]
@@ -76,40 +77,29 @@ def get_content_by_statement()
     # Get the ContentService.
     content_service = dfp.service(:ContentService, API_VERSION)
 
-    # Define initial values.
-    offset = 0
-    page = {}
-
-    statement_text = 'WHERE status = :status'
-    statement = {
-        :query => statement_text,
-        :values => [
+    statement = DfpApiStatement::FilterStatement.new(
+        'WHERE status = :status ORDER BY id ASC',
+        [
             {:key => 'status',
              :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
         ]
-    }
+    )
 
     begin
-      # Create a statement to get one page with current offset.
-      statement[:query] = statement_text +
-          " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
-
       # Get content by statement.
       page =
           content_service.get_content_by_statement_and_custom_targeting_value(
-              statement, category_custom_targeting_value_id)
+              statement.toStatement(), category_custom_targeting_value_id)
 
       if page[:results]
-        # Increase query offset by page size.
-        offset += PAGE_SIZE
-
         page[:results].each_with_index do |content, index|
           puts "%d) Content ID: %d, name: %s, status: %s." %
-              [index + start_index, content[:id], content[:name],
+              [index + statement.offset, content[:id], content[:name],
                content[: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/{v201311 → v201411}/creative_service/copy_image_creatives.rb

@@ -25,10 +25,10 @@
 # Tags: CreativeService.getCreativesByStatement, CreativeService.createCreatives
 
 require 'dfp_api'
-
+require 'dfp_api_statement'
 require 'base64'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def copy_image_creatives()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -50,17 +50,17 @@ def copy_image_creatives()
   ]
 
   # Create the statement to filter image creatives by ID.
-  statement = {
-      :query => "WHERE id IN (%s) AND creativeType = :creative_type" %
+  statement = DfpApiStatement::FilterStatement.new(
+      "WHERE id IN (%s) AND creativeType = :creative_type" %
           image_creative_ids.join(', '),
-      :values => [
+      [
           {:key => 'creative_type',
            :value => {:value => 'ImageCreative', :xsi_type => 'TextValue'}}
       ]
-  }
+  )
 
   # Get creatives by statement.
-  page = creative_service.get_creatives_by_statement(statement)
+  page = creative_service.get_creatives_by_statement(statement.toStatement())
 
   if page[:results]
     creatives = page[:results]

data/examples/{v201311 → v201411}/creative_service/create_creative_from_template.rb

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

data/examples/{v201311 → v201411}/creative_service/create_creatives.rb

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

data/examples/{v201311 → v201411}/creative_service/create_custom_creative.rb

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

data/examples/{v201311 → v201411}/creative_service/get_all_creatives.rb

@@ -23,9 +23,9 @@
 # Tags: CreativeService.getCreativesByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
-PAGE_SIZE = 500
+API_VERSION = :v201411
 
 def get_all_creatives()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,32 +38,23 @@ def get_all_creatives()
   # Get the CreativeService.
   creative_service = dfp.service(:CreativeService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create a statement to get one page with current offset.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
   begin
-    # Create a statement to get one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
-
     # Get creatives by statement.
-    page = creative_service.get_creatives_by_statement(statement)
+    page = creative_service.get_creatives_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 creative in results.
       page[:results].each_with_index do |creative, index|
         puts "%d) Creative ID: %d, name: %s, type: %s" %
-            [index + start_index, creative[:id],
+            [index + statement.offset, creative[:id],
              creative[:name], creative[:creative_type]]
       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/{v201311 → v201411}/creative_service/get_creatives_by_statement.rb

@@ -25,8 +25,9 @@
 # Tags: CreativeService.getCreativesByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def get_creatives_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,24 +41,28 @@ def get_creatives_by_statement()
   creative_service = dfp.service(:CreativeService, API_VERSION)
 
   # Create a statement to only select image creatives.
-  statement = {
-     :query => 'WHERE creativeType = :creative_type LIMIT 500',
-     :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+     'WHERE creativeType = :creative_type ORDER BY id ASC',
+     [
          {:key => 'creative_type',
           :value => {:value => 'ImageCreative', :xsi_type => 'TextValue'}}
      ]
-  }
+  )
 
-  # Get creatives by statement.
-  page = creative_service.get_creatives_by_statement(statement)
+  begin
+    # Get creatives by statement.
+    page = creative_service.get_creatives_by_statement(statement.toStatement())
 
-  if page[:results]
-    # Print details about each creative in results.
-    page[:results].each_with_index do |creative, index|
-      puts "%d) Creative ID: %d, name: %s, type: %s" %
-          [index, creative[:id], creative[:name], creative[:creative_type]]
+    if page[:results]
+      # Print details about each creative in results.
+      page[:results].each_with_index do |creative, index|
+        puts "%d) Creative ID: %d, name: %s, type: %s" %
+            [index + statement.offset,
+             creative[:id], creative[:name], creative[:creative_type]]
+      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/{v201311 → v201411}/creative_service/update_creatives.rb

@@ -18,14 +18,15 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example updates the destination URL of all image creatives up to the
-# first 500. To determine which image creatives exist, run get_all_creatives.rb.
+# This example updates the destination URL of a single creative searching by ID.
+# To determine which image creatives exist, run get_all_creatives.rb.
 #
 # Tags: CreativeService.getCreativesByStatement, CreativeService.updateCreatives
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def update_creatives()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,17 +39,21 @@ def update_creatives()
   # Get the CreativeService.
   creative_service = dfp.service(:CreativeService, API_VERSION)
 
+  # Specify creative ID to update.
+  creative_id = 'INSERT_CREATIVE_ID_HERE'.to_i
+
   # Create a statement to get first 500 image creatives.
-  statement = {
-      :query => "WHERE creativeType = :creative_type LIMIT 500",
-      :values => [
-          {:key => 'creative_type',
-           :value => {:value => 'ImageCreative', :xsi_type => 'TextValue'}}
-      ]
-  }
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id ORDER BY id ASC',
+      [
+          {:key => 'id',
+           :value => {:value =>  creative_id, :xsi_type => 'NumberValue'}}
+      ],
+      1
+  )
 
   # Get creatives by statement.
-  page = creative_service.get_creatives_by_statement(statement)
+  page = creative_service.get_creatives_by_statement(statement.toStatement())
 
   if page[:results]
     creatives = page[:results]