google-dfp-api 0.2.5 → 0.2.6

data/examples/v201111/company_service/get_companies_by_statement.rb

@@ -0,0 +1,88 @@
+#!/usr/bin/ruby
+#
+# 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 companies that are advertisers. The statement retrieves
+# up to the maximum page size limit of 500. To create companies, run
+# create_companies.rb.
+#
+# Tags: CompanyService.getCompaniesByStatement
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201111
+
+def get_companies_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 CompanyService.
+  company_service = dfp.service(:CompanyService, API_VERSION)
+
+  # Create a statement to only select companies that are advertisers, sorted by
+  # name.
+  statement = {
+     :query => 'WHERE type = :type ORDER BY name LIMIT 500',
+     :values => [
+         {:key => 'type',
+          :value => {:value => 'ADVERTISER', :xsi_type => 'TextValue'}}
+     ]
+  }
+
+  # Get companies by statement.
+  page = company_service.get_companies_by_statement(statement)
+
+  if page[:results]
+    # Print details about each company in results.
+    page[:results].each_with_index do |company, index|
+      puts "%d) [%d] name: %s, type: %s" %
+          [index, company[:id], company[:name], company[:type]]
+    end
+  end
+
+  # Print a footer.
+  if page.include?(:total_result_set_size)
+    puts "Total number of companies: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_companies_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

data/examples/v201111/company_service/get_company.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/ruby
+#
+# 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 a company by its ID. To determine which companies exist, run
+# get_all_companies.rb.
+#
+# Tags: CompanyService.getCompany
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201111
+
+def get_company()
+  # 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 CompanyService.
+  company_service = dfp.service(:CompanyService, API_VERSION)
+
+  # Set the ID of the company to get.
+  company_id = 'INSERT_COMPANY_ID_HERE'.to_i
+
+  # Get the company.
+  company = company_service.get_company(company_id)
+
+  if company
+    puts "Company with ID: %d, name: %s and type: %s was found." %
+        [company[:id], company[:name], company[:type]]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_company()
+
+  # 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/v201111/company_service/update_companies.rb

@@ -0,0 +1,95 @@
+#!/usr/bin/ruby
+#
+# 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 updates the names of all companies that are advertisers by
+# appending "LLC." up to the first 500. To determine which companies exist, run
+# get_all_companies.rb.
+#
+# Tags: CompanyService.getCompaniesByStatement, CompanyService.updateCompanies
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201111
+
+def update_companies()
+  # 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 CompanyService.
+  company_service = dfp.service(:CompanyService, API_VERSION)
+
+  # Create a statement to only select companies that are advertisers.
+  statement = {
+      :query => "WHERE type = :type LIMIT 500",
+      :values => [
+          {:key => 'type',
+           :value => {:value => 'ADVERTISER', :xsi_type => 'TextValue'}}
+      ]
+  }
+
+  # Get companies by statement.
+  page = company_service.get_companies_by_statement(statement)
+
+  if page[:results]
+    companies = page[:results]
+
+    # Update each local company object by appending ' LLC.' to its name.
+    companies.each {|company| company[:name] += ' LLC.'}
+
+    # Update the companies on the server.
+    return_companies = company_service.update_companies(companies)
+
+    if return_companies
+      return_companies.each do |company|
+        puts "A company with ID [%d], name: %s and type %s was updated." %
+            [company[:id], company[:name], company[:type]]
+      end
+    else
+      raise 'No companies were updated.'
+    end
+  else
+    puts 'No companies found to update.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    update_companies()
+
+  # 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/v201111/content_service/get_all_content.rb

@@ -0,0 +1,94 @@
+#!/usr/bin/ruby
+#
+# 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 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201111
+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/v201111/content_service/get_content_by_category.rb

@@ -0,0 +1,136 @@
+#!/usr/bin/ruby
+#
+# 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,
+#       ContentService.getContentByStatementAndCustomTargetingValue
+#       CustomTargetingService.getCustomTargetingValuesByStatement
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201111
+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.
+  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
+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