google-dfp-api 0.2.0

data/examples/v201101/common/error_handling.rb

@@ -0,0 +1,76 @@
+#!/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 runs incorrect query and demonstrates how to handle errors.
+#
+# Tags: UserService.updateUser
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201101
+
+def produce_api_error()
+  # 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 UserService.
+  user_service = dfp.service(:UserService, API_VERSION)
+
+  # Omitting "id" field here to produce an error.
+  user = {:preferred_locale => 'en_UK', :name => 'foo_bar'}
+
+  # Execute request and get the response, this should raise an exception.
+  user = user_service.update_user(user)
+
+  # Output retrieved data.
+  puts "User ID: %d, name: %s, email: %s" %
+      [user[:id], user[:name], user[:email]]
+end
+
+if __FILE__ == $0
+  begin
+    # This function should produce an exception for demo.
+    produce_api_error()
+
+  # One of two kinds of exception might occur, general HTTP error like 403 or
+  # 404 and DFP API error defined in WSDL and described in documentation.
+
+  # Handling HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # Handling API errors.
+  rescue DfpApi::Errors::ApiException => e
+    # Standard DFP API error includes message and array of errors occured.
+    puts "Message: %s" % e.message
+    puts 'Errors:'
+    # Print out each of the 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/v201101/company_service/create_companies.rb

@@ -0,0 +1,82 @@
+#!/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 creates new companies. To determine which companies exist, run
+# get_all_companies.java.
+
+# Tags: CompanyService.createCompanies
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201101
+# Number of companies to create.
+ITEM_COUNT = 5
+
+def create_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 an array to store local company objects.
+  companies = Array.new
+  ITEM_COUNT.times do |index|
+    companies << {:name => "Advertiser #%d" % index, :type => 'ADVERTISER'}
+  end
+
+  # Create the companies on the server.
+  return_companies = company_service.create_companies(companies)
+
+  if return_companies
+    return_companies.each do |company|
+      puts "Company with ID: %d, name: %s and type: %s was created." %
+          [company[:id], company[:name], company[:type]]
+    end
+  else
+    raise 'No companies were created.'
+  end
+
+end
+
+if __FILE__ == $0
+  begin
+    create_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/v201101/company_service/get_all_companies.rb

@@ -0,0 +1,92 @@
+#!/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. To create companies, run create_companies.rb.
+#
+# Tags: CompanyService.getCompaniesByStatement
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201101
+PAGE_SIZE = 500
+
+def get_all_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)
+
+  # Define initial values.
+  offset = 0
+  page = Hash.new
+
+  begin
+    # Create a statement to get one page with current offset.
+    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
+
+    # Get companies by statement.
+    page = company_service.get_companies_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 company in results.
+      page[:results].each_with_index do |company, index|
+        puts "%d) Company ID: %d, name: %s, type: %s" %
+            [index + start_index, company[:id], company[:name], company[:type]]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # 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_all_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/v201101/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 = :v201101
+
+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/v201101/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 = :v201101
+
+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/v201101/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.updateCompanies
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201101
+
+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