google-dfp-api 0.7.1 → 0.8.0

data/examples/{v201302 → v201403}/company_service/create_companies.rb

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

data/examples/{v201208 → v201403}/company_service/get_all_companies.rb

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

data/examples/{v201302 → v201403}/company_service/get_companies_by_statement.rb

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

data/examples/{v201308 → v201403}/company_service/update_companies.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201308
+API_VERSION = :v201403
 
 def update_companies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,12 +39,15 @@ def update_companies()
   # Get the CompanyService.
   company_service = dfp.service(:CompanyService, API_VERSION)
 
-  # Create a statement to only select companies that are advertisers.
+  # Specify a single company to fetch.
+  company_id = 'INSERT_COMPANY_ID_HERE'
+
+  # Create a statement to only select a single company.
   statement = {
-      :query => "WHERE type = :type LIMIT 500",
+      :query => "WHERE id = :id LIMIT 1",
       :values => [
-          {:key => 'type',
-           :value => {:value => 'ADVERTISER', :xsi_type => 'TextValue'}}
+          {:key => 'id',
+           :value => {:value => company_id, :xsi_type => 'NumberValue'}}
       ]
   }
 

data/examples/{v201308 → v201403}/contact_service/create_contacts.rb

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

data/examples/{v201306 → v201403}/contact_service/get_all_contacts.rb

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

data/examples/{v201308 → v201403}/contact_service/get_uninvited_contacts.rb

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

data/examples/{v201302 → v201403}/contact_service/update_contacts.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201403
 
 def update_contacts()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,26 +40,40 @@ def update_contacts()
 
   contact_id = 'INSERT_CONTACT_ID_HERE'
 
-  # Get contact.
-  contact = contact_service.get_contact(contact_id)
+  # Create a statement to only select a single contact.
+  statement = {
+      :query => "WHERE id = :id LIMIT 1",
+      :values => [
+          {:key => 'id',
+           :value => {:value => contact_id, :xsi_type => 'NumberValue'}}
+      ]
+  }
 
-  # Update the comment of the contact.
-  contact[:address] = '123 New Street, New York, NY, 10011'
+  # Get contacts by statement.
+  page = contact_service.get_contacts_by_statement(statement)
 
-  # Update the contact on the server.
-  return_contacts = contact_service.update_contacts([contact])
+  if page[:results]
+    contacts = page[:results]
 
-  # Display results.
-  if return_contacts
-    return_contacts.each do |updated_contact|
-      puts "Contact with ID: %d, name: %s and comment: '%s' was updated." %
-          [updated_contact[:id], updated_contact[:name],
-           updated_contact[:comment]]
+    contacts.each do |contact|
+      # Update the comment of the contact.
+      contact[:address] = '123 New Street, New York, NY, 10011'
     end
-  else
-    raise 'No contacts were updated.'
-  end
 
+    # Update the contact on the server.
+    return_contacts = contact_service.update_contacts([contact])
+
+    # Display results.
+    if return_contacts
+      return_contacts.each do |updated_contact|
+        puts "Contact with ID: %d, name: %s and comment: '%s' was updated." %
+            [updated_contact[:id], updated_contact[:name],
+             updated_contact[:comment]]
+      end
+    else
+      raise 'No contacts were updated.'
+    end
+  end
 end
 
 if __FILE__ == $0

data/examples/v201403/content_metadata_key_hierarchy_service/create_content_metadata_key_hierarchies.rb

@@ -0,0 +1,96 @@
+#!/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 creates a content metadata key hierarchy.
+#
+# This feature is only available to DFP video publishers.
+#
+# Tags: ContentMetadataKeyHierarchyService.createContentMetadataKeyHierarchies
+
+require 'dfp_api'
+
+API_VERSION = :v201403
+
+def create_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 IDs of the custom targeting keys for the hierarchy.
+  hierarchy_level_one_key_id = 'INSERT_LEVEL_ONE_CUSTOM_TARGETING_KEY_ID_HERE'
+  hierarchy_level_two_key_id = 'INSERT_LEVEL_TWO_CUSTOM_TARGETING_KEY_ID_HERE'
+
+  hierarchy_level_1 = {
+    :custom_targeting_key_id => hierarchy_level_own_key_id,
+    :hierarchy_level => 1
+  }
+
+  hierarchy_level_2 = {
+    :custom_targeting_key_id => hierarchy_level_two_key_id,
+    :hierarchy_level => 2
+  }
+
+  hierarchy_levels = [hierarchy_level_1, hierarchy_level_2]
+
+  content_metadata_key_hierarchy = {
+    :name => 'Content Metadata Key Hierarchy #%d' % (Time.new.to_f * 1000),
+    :hierarchy_levels => hierarchy_levels
+  }
+
+  # Create the content metadata key hierarchy on the server.
+  content_metadata_key_hierarchies =
+      cmkh_service.create_content_metadata_key_hierarchies(
+          [content_metadata_key_hierarchy])
+
+  content_metadata_key_hierarchies.each do |content_metadata_key_hierarchy|
+    puts 'A content metadata key hierarchy with ID %d, name "%s", and %d ' +
+        'levels was created.' % [
+            content_metadata_key_hierarchy[:id],
+            content_metadata_key_hierarchy[:name],
+            content_metadata_key_hierarchy[:hierarchy_levels].length]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_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/v201403/content_metadata_key_hierarchy_service/delete_content_metadata_key_hierarchies.rb

@@ -0,0 +1,103 @@
+#!/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 deletes a single content metadata key hierarchy.
+#
+# This feature is only available to DFP video publishers.
+#
+# Tags: ContentMetadataKeyHierarchyService.getContentMetadataKeyHierarchiesByStatement
+# Tags: ContentMetadataKeyHierarchyService.performContentMetadataKeyHierarchyAction
+
+require 'dfp_api'
+
+API_VERSION = :v201403
+
+def delete_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 = 'CONTENT_METADATA_KEY_HIERARCHY_ID'
+
+  # Create a statement to only select a single content metadata key hierarchy.
+  statement = {
+      :query => 'WHERE id = :id ORDER BY id ASC LIMIT 1',
+      :values => [
+          {:key => 'id',
+           :value => {:value => content_metadata_key_hierarchy_id,
+                      :xsi_type => 'NumberValue'}},
+      ]
+  }
+
+  # Get content metadata key hierarchies by statement.
+  page = cmkh_service.get_content_metadata_key_hierarchies_by_statement(
+      statement)
+
+  if page[:results]
+    content_metadata_key_hierarchy = page[:results].first
+  end
+
+  if content_metadata_key_hierarchy
+    puts 'Content metadata key hierarchy with ID ' +
+        '"%d" will be deleted.' % content_metadata_key_hierarchy[:id]
+
+    # Perform action.
+    result = cmkh_service.perform_content_metadata_key_hierarchy_action(
+        {:xsi_type => 'DeleteContentMetadataKeyHierarchy'}, statement)
+
+    # Display results.
+    if result and result[:num_changes] > 0
+      puts 'Number of content metadata key hierarchies deleted: %d' %
+          result[:num_changes]
+    else
+      puts 'No content metadata key hierarchies were deleted.'
+    end
+  else
+    puts 'No content metadata key hierarchy found to delete.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    delete_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/{v201302/content_service/get_all_content.rb → v201403/content_metadata_key_hierarchy_service/get_all_content_metadata_key_hierarchies.rb}

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+# Author:: api.nicholaschen@gmail.com (Nicholas Chen)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# 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.
@@ -18,18 +18,18 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all content.
+# This example gets all content metadata key hierarchies.
 #
 # This feature is only available to DFP video publishers.
 #
-# Tags: ContentService.getContentByStatement
+# Tags: ContentMetadataKeyHierarchyService.getContentMetadataKeyHierarchiesByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201403
 PAGE_SIZE = 500
 
-def get_all_content()
+def get_all_content_metadata_key_hierarchies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -37,8 +37,8 @@ def get_all_content()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the ContentService.
-  content_service = dfp.service(:ContentService, API_VERSION)
+  # Get the ContentMetadataKeyHierarchyService.
+  cmkh_service = dfp.service(:ContentMetadataKeyHierarchyService, API_VERSION)
 
   # Define initial values.
   offset = 0
@@ -46,10 +46,12 @@ def get_all_content()
 
   begin
     # Create statement for one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
+    statement = {:query => 'ORDER BY id ASC LIMIT ' +
+        '%d OFFSET %d' % [PAGE_SIZE, offset]}
 
-    # Get content by statement.
-    page = content_service.get_content_by_statement(statement)
+    # Get content metadata key hierarchies by statement.
+    page = cmkh_service.get_content_metadata_key_hierarchies_by_statement(
+        statement)
 
     if page[:results]
       # Increase query offset by page size.
@@ -58,10 +60,13 @@ def get_all_content()
       # 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,
-             content[:id], content[:name], content[:status]]
+      # Print details about each content metadata key hierarchy object.
+      page[:results].each_with_index do |content_metadata_key_hierarchy, index|
+        puts ("%d) Content Metadata Key Hierarchy ID: " +
+            "%d and name: %s was found.") % [
+                index + start_index,
+                content_metadata_key_hierarchy[:id],
+                content_metadata_key_hierarchy[:name]]
       end
     end
   end while offset < page[:total_result_set_size]
@@ -74,7 +79,7 @@ end
 
 if __FILE__ == $0
   begin
-    get_all_content()
+    get_all_content_metadata_key_hierarchies()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201403/content_metadata_key_hierarchy_service/update_content_metadata_key_hierarchies.rb

@@ -0,0 +1,113 @@
+#!/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'
+
+API_VERSION = :v201403
+
+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 = {
+      :query => 'WHERE id = :id ORDER BY id ASC LIMIT 1',
+      :values => [
+          {:key => 'id',
+           :value => {:value => content_metadata_key_hierarchy_id,
+                      :xsi_type => 'NumberValue'}},
+      ]
+  }
+
+  # Get content metadata key hierarchies by statement.
+  page =
+      cmkh_service.get_content_metadata_key_hierarchies_by_statement(statement)
+
+  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