google-dfp-api 0.2.0 → 0.2.1

data/ChangeLog

@@ -1,5 +1,11 @@
+0.2.1:
+  - Ruby1.9 compatible.
+  - Fixed issue #16 (deep arrays nesting).
+  - Support for v201103 and v201104.
+  - Require google-ads-common 0.4.0 or later from now on.
+
 0.2.0:
-  - Require google-ads-common 0.3.0 or later from now on;
+  - Require google-ads-common 0.3.0 or later from now on.
   - Support for Savon backend 0.9.1.
 
 0.1.1:

data/README

@@ -3,12 +3,12 @@
 Google's DoubleClick For Publishers API service lets developers design computer
 programs that interact directly with the DFP platform. With these applications,
 advertisers and third parties can more efficiently -- and creatively -- manage
-their large or complex Publisher Display Ads accounts.
+their large or complex DoubleClick for Publishers accounts.
 
 The DFP API Ruby Client Library makes it easy to write Ruby clients to
-programmatically access Publisher Display Ads accounts. The client library is
-available as a Ruby gem or gzipped tarball. It depends on the google-ads-common
-library which is base for all Google Ads APIs for Ruby.
+programmatically access DoubleClick for Publishers accounts. The client library
+is available as a Ruby gem or gzipped tarball. It depends on the
+google-ads-common library which is base for all Google Ads APIs for Ruby.
 
 
 == What's in the client library?
@@ -58,7 +58,7 @@ or if you downloaded the gem package manually, use:
 == Using the library
 
 In order to use the library you need to include its modules:
-  require 'google-dfp-api'
+  require 'dfp_api'
 
 Depending on your configuration you might also need to explicitely require
 the rubygems library first:
@@ -78,7 +78,7 @@ constructor:
          :password => 'PASSWORD'
      },
      :service => {
-       :environment => 'Sandbox'
+       :environment => 'SANDBOX'
      }
    })
 
@@ -91,7 +91,7 @@ Once the library object is created you can request services with a 'service'
 method:
   user_service = dfp.service(:UserService, <API_VERSION>)
 
-where <API_VERSION> is required version of DFP API, e.g. :v201101.
+where <API_VERSION> is required version of DFP API as symbol, e.g. :v201104.
 
 Then you should be able to execute service methods:
 
@@ -124,11 +124,11 @@ Examples can be run by executing by running:
 
 from the "examples/<version>/<service_name>" directory i.e.
 
-  $ cd examples/v201101/user_service
+  $ cd examples/v201104/user_service
   $ ruby get_all_users.rb
 
 Some examples require modification to be functional, like create_order example
-needs Advertiser, Trafficker and Salesperson ids to be filled in.
+needs Advertiser, Trafficker and Salesperson IDs to be filled in.
 
 
 == How do I enable logging?
@@ -168,8 +168,8 @@ is planned for next releases.
 External dependencies should be pulled automatically on gem install. Here is the
 list though:
 
-  - Google Ads Common library (google-ads-common-0.3.0);
-  - Savon 'the heavy metal Ruby SOAP client' (savon-0.9.1).
+  - Google Ads Common library (google-ads-common-0.4.0);
+  - Savon 'the heavy metal Ruby SOAP client' (savon-0.9.1 or later).
 
 
 = Where do I submit bug reports and feature requests?

data/Rakefile

@@ -17,21 +17,21 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# DFP API Rakefile
-#
+# DFP API Rakefile.
 
 require 'rubygems'
-require 'rake/gempackagetask'
+require 'rubygems/package_task'
 require 'rake/testtask'
-require 'lib/dfp_api/api_config'
+require './lib/dfp_api/api_config'
 
-# Google common ads library used for wrapper code generation
+# Google common ads library used for wrapper code generation.
 gem 'google-ads-common'
 require 'ads_common/build/savon_generator'
 
-files = FileList["{lib,examples}/**/*", "Rakefile"].to_a
-tests = FileList["{test}/**/Test*.rb"].to_a
+files = FileList['{lib,examples}/**/*', 'Rakefile'].to_a
+tests = FileList['test/**/test*.rb']
 docs = ['README', 'COPYING', 'ChangeLog']
+extra_files = ['dfp_api.yml', 'test/dfp_api/test_config.yml']
 
 spec = Gem::Specification.new do |s|
   s.name = 'google-dfp-api'
@@ -47,16 +47,17 @@ spec = Gem::Specification.new do |s|
   s.test_files = tests
   s.has_rdoc = true
   s.extra_rdoc_files = docs
-  s.add_dependency('google-ads-common', '~> 0.3.0')
+  s.add_dependency('google-ads-common', '~> 0.4.0')
   s.add_dependency('savon', '~> 0.9.1')
 end
 
-Rake::GemPackageTask.new(spec) do |pkg|
+package_task = Gem::PackageTask.new(spec) do |pkg|
   pkg.need_tar = true
+  pkg.package_files.include(extra_files)
 end
 
 Rake::TestTask.new do |t|
-  t.test_files = FileList["test/**/test*.rb"]
+  t.test_files = tests
 end
 
 desc 'Default target - build'
@@ -70,7 +71,7 @@ task :generate do
   versions = api_config.versions()
   versions.each do |version|
     code_path = "lib/%s/%s" % [api_config.api_path, version]
-    wsdls = DfpApi::ApiConfig.get_wsdls( version )
+    wsdls = DfpApi::ApiConfig.get_wsdls(version)
     wsdls.each do |service_name, wsdl_url|
       logger.info("Processing %s at [%s]..." % [service_name, wsdl_url])
       module_name = "%s::%s::%s" % [api_config.api_name, version.to_s.upcase,
@@ -79,5 +80,6 @@ task :generate do
                       service_name, module_name)
       generator.process_wsdl()
     end
+    package_task.package_files.include(FileList[code_path + '/*'].to_a)
   end
 end

data/examples/v201103/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 = :v201103
+
+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/v201103/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 = :v201103
+# 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/v201103/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 = :v201103
+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/v201103/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 = :v201103
+
+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