google-dfp-api 0.4.0 → 0.5.0

data/examples/v201111/user_service/get_all_users.rb

@@ -1,92 +0,0 @@
-#!/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 users for an account. To create users run
-# create_users.rb.
-#
-# Tags: UserService.getUsersByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201111
-PAGE_SIZE = 500
-
-def get_all_users()
-  # 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)
-
-  # 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 users by statement.
-    page = user_service.get_users_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 user in results page.
-      page[:results].each_with_index do |user, index|
-        puts "%d) User ID: %d, name: %s, email: %s" %
-            [index + start_index, user[:id], user[:name], user[:email]]
-      end
-    end
-  end while offset < page[:total_result_set_size]
-
-  # Print a footer
-  if page.include?(:total_result_set_size)
-    puts "Total number of users: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_users()
-
-  # 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/user_service/get_user.rb

@@ -1,72 +0,0 @@
-#!/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 user by its ID. To create users, run create_users.rb.
-#
-# Tags: UserService.getUser
-
-require 'dfp_api'
-
-API_VERSION = :v201111
-
-def get_user()
-  # 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)
-
-  # Set the ID of the user to get.
-  user_id = 'INSERT_USER_ID_HERE'.to_i
-
-  # Get the user.
-  user = user_service.get_user(user_id)
-
-  if user
-    puts "User with ID: %d, name: %s, email: %s and role: %s was found." %
-        [user[:id], user[:name], user[:email], user[:role_name]]
-  else
-    puts 'No user found for this ID.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_user()
-
-  # 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/v201201/common/error_handling.rb

@@ -1,75 +0,0 @@
-#!/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 'dfp_api'
-
-API_VERSION = :v201201
-
-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/v201201/company_service/create_companies.rb

@@ -1,80 +0,0 @@
-#!/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.rb.
-
-# Tags: CompanyService.createCompanies
-
-require 'dfp_api'
-
-API_VERSION = :v201201
-# 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 = (1..ITEM_COUNT).map do |index|
-    {: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/v201201/company_service/get_companies_by_statement.rb

@@ -1,87 +0,0 @@
-#!/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 'dfp_api'
-
-API_VERSION = :v201201
-
-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/v201201/company_service/get_company.rb

@@ -1,71 +0,0 @@
-#!/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 'dfp_api'
-
-API_VERSION = :v201201
-
-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