google-dfp-api 0.8.0 → 0.8.1

data/examples/v201302/contact_service/get_all_contacts.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.davidtorres@gmail.com (David Torres)
+#
+# Copyright:: Copyright 2013, 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 gets all contacts. To create contacts, run create_contacts.rb.
+#
+# Tags: ContactService.getContactsByStatement.
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+PAGE_SIZE = 500
+
+def get_all_contacts()
+  # 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 ContactService.
+  contact_service = dfp.service(:ContactService, API_VERSION)
+
+  # Define initial values.
+  offset = 0
+  page = {}
+
+  begin
+    # Create statement for one page with current offset.
+    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
+
+    # Get contacts by statement.
+    page = contact_service.get_contacts_by_statement(statement)
+
+    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 |contact, index|
+        puts "%d) Contact ID: %d, name: %s." % [index + start_index,
+            contact[:id], contact[:name]]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Print a footer
+  if page.include?(:total_result_set_size)
+    puts "Total number of results: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_contacts()
+
+  # 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/contact_service/get_uninvited_contacts.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.davidtorres@gmail.com (David Torres)
+#
+# Copyright:: Copyright 2013, 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 gets uninvited contacts. To create contacts, run
+# create_contacts.rb.
+#
+# Tags: ContactService.getContactsByStatement.
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+PAGE_SIZE = 500
+
+def get_uninvited_contacts()
+  # 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 ContactService.
+  contact_service = dfp.service(:ContactService, API_VERSION)
+
+  # Define initial values.
+  offset = 0
+  page = {}
+  query_base = 'WHERE status = :status ORDER BY id LIMIT %d OFFSET %d'
+
+  # Create statement.
+  statement = {
+    :values => [
+      {:key => 'status',
+       :value => {:value => 'UNINVITED', :xsi_type => 'TextValue'}}
+    ]
+  }
+
+  begin
+    # Update statement for one page with current offset.
+    statement[:query] = query_base % [PAGE_SIZE, offset]
+
+    # Get contacts by statement.
+    page = contact_service.get_contacts_by_statement(statement)
+
+    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 |contact, index|
+        puts "%d) Contact ID: %d, name: %s." % [index + start_index,
+            contact[:id], contact[:name]]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Print a footer
+  if page.include?(:total_result_set_size)
+    puts "Total number of results: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_uninvited_contacts()
+
+  # 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/contact_service/update_contacts.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.davidtorres@gmail.com (David Torres)
+#
+# Copyright:: Copyright 2013, 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 contact comments. To determine which contacts exist,
+# run get_all_contacts.rb.
+#
+# Tags: ContactService.updateContacts
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+
+def update_contacts()
+  # 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 ContactService.
+  contact_service = dfp.service(:ContactService, API_VERSION)
+
+  contact_id = 'INSERT_CONTACT_ID_HERE'
+
+  # Get contact.
+  contact = contact_service.get_contact(contact_id)
+
+  # Update the comment of the contact.
+  contact[:address] = '123 New Street, New York, NY, 10011'
+
+  # 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
+
+if __FILE__ == $0
+  begin
+    update_contacts()
+
+  # 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

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2011, 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 gets all content.
+#
+# This feature is only available to DFP video publishers.
+#
+# Tags: ContentService.getContentByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+PAGE_SIZE = 500
+
+def get_all_content()
+  # 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 ContentService.
+  content_service = dfp.service(:ContentService, API_VERSION)
+
+  # Define initial values.
+  offset = 0
+  page = {}
+
+  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)
+
+    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,
+             content[:id], content[:name], content[:status]]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Print a footer
+  if page.include?(:total_result_set_size)
+    puts "Total number of results: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_content()
+
+  # 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_content_by_category.rb

@@ -0,0 +1,143 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2011, 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 gets all active content categorized as "comedy" using the
+# network's content browse custom targeting key.
+#
+# This feature is only available to DFP video publishers.
+#
+# Tags: NetworkService.getCurrentNetwork
+# Tags: ContentService.getContentByStatementAndCustomTargetingValue
+# Tags: CustomTargetingService.getCustomTargetingValuesByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+PAGE_SIZE = 500
+
+def get_content_by_statement()
+  # 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 NetworkService.
+  network_service = dfp.service(:NetworkService, API_VERSION)
+
+  # Get content browse custom targeting key ID.
+  current_network = network_service.get_current_network
+  content_browse_custom_targeting_key_id =
+      current_network[:content_browse_custom_targeting_key_id]
+
+  # Get the CustomTargetingService.
+  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 => [
+          {:key => 'targeting_key_id',
+           :value => {:value => content_browse_custom_targeting_key_id,
+                      :xsi_type => 'NumberValue'}},
+          {:key => 'category',
+           :value => {:value => 'comedy',
+                      :xsi_type => 'TextValue'}},
+      ]
+  }
+
+  # Get categories matching the filter statement.
+  page = custom_targeting_service.get_custom_targeting_values_by_statement(
+      statement)
+
+  # Get the custom targeting value ID for the comedy category.
+  if page[:results]
+    category_custom_targeting_value_id = page[:results].first()[:id]
+
+    # 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 => [
+            {: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)
+
+      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],
+               content[:status]]
+        end
+      end
+    end while offset < page[:total_result_set_size]
+
+    # Print a footer.
+    if page.include?(:total_result_set_size)
+      puts "Number of results found: %d" % page[:total_result_set_size]
+    end
+  else
+    puts "Category was not found for targeting key ID %d." %
+        content_browse_custom_targeting_key_id
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_content_by_statement()
+
+  # 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