google-dfp-api 0.17.0 → 0.18.0

data/examples/v201508/common/error_handling.rb

@@ -1,72 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-API_VERSION = :v201508
-
-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/v201508/common/setup_oauth2.rb

@@ -1,85 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2012, 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 shows how to use OAuth2 authorization method. It is designed to
-# be run from console and requires user input.
-
-require 'dfp_api'
-
-API_VERSION = :v201508
-
-def setup_oauth2()
-  # DfpApi::Api will read a config file from ENV['HOME']/dfp_api.yml
-  # when called without parameters.
-  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')
-
-  # You can call authorize explicitly to obtain the access token. Otherwise, it
-  # will be invoked automatically on the first API call.
-  # There are two ways to provide verification code, first one is via the block:
-  token = dfp.authorize() do |auth_url|
-    puts "Hit Auth error, please navigate to URL:\n\t%s" % auth_url
-    print 'log in and type the verification code: '
-    verification_code = gets.chomp
-    verification_code
-  end
-  if token
-    print "\nWould you like to update your dfp_api.yml to save " +
-        "OAuth2 credentials? (y/N): "
-    response = gets.chomp
-    if ('y'.casecmp(response) == 0) or ('yes'.casecmp(response) == 0)
-      dfp.save_oauth2_token(token)
-      puts 'OAuth2 token is now saved to ~/dfp_api.yml and will be ' +
-          'automatically used by the library.'
-    end
-  end
-
-  # Alternatively, you can provide one within the parameters:
-  # token = dfp.authorize({:oauth2_verification_code => verification_code})
-
-  # Note, 'token' is a Hash. Its value is not used in this example. If you need
-  # to be able to access the API in offline mode, with no user present, you
-  # should persist it to be used in subsequent invocations like this:
-  # dfp.authorize({:oauth2_token => token})
-
-  # No exception thrown - we are good to make a request.
-end
-
-if __FILE__ == $0
-  begin
-    setup_oauth2()
-
-  # 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/v201508/company_service/create_companies.rb

@@ -1,78 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-API_VERSION = :v201508
-# 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-%d" % [Time.new.to_f * 1000, 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/v201508/company_service/get_companies_by_statement.rb

@@ -1,89 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-
-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 = DfpApi::FilterStatement.new(
-      'WHERE type = :type ORDER BY id ASC',
-      [
-          {:key => 'type',
-           :value => {:value => 'ADVERTISER', :xsi_type => 'TextValue'}}
-      ]
-  )
-
-  begin
-    # Get companies by statement.
-    page = company_service.get_companies_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      page[:results].each_with_index do |company, index|
-        puts "%d) [%d] name: %s, type: %s" %
-            [index + statement.offset,
-             company[:id], company[:name], company[:type]]
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.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_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/v201508/company_service/update_companies.rb

@@ -1,104 +0,0 @@
-# !/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-
-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)
-
-  # Specify a single company to fetch.
-  company_id = 'INSERT_COMPANY_ID_HERE'
-
-  # Create a statement to only select a single company.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE id = :company_id ORDER BY id ASC',
-      [
-          {:key => 'company_id',
-           :value => {:value => company_id, :xsi_type => 'NumberValue'}
-          }
-      ],
-      1
-  )
-
-  # Get companies by statement.
-  page = company_service.get_companies_by_statement(statement.toStatement())
-
-  if page[:results]
-    companies = page[:results]
-
-    # Update each local company object by appending ' LLC.' to its name.
-    companies.each do |company|
-      company[:name] += ' LLC.'
-      # Workaround for issue #94.
-      [:address, :email, :fax_phone, :primary_phone,
-          :external_id, :comment].each do |item|
-        company[item] = "" if company[item].nil?
-      end
-    end
-
-    # 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/v201508/contact_service/get_all_contacts.rb

@@ -1,80 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-
-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)
-
-  # Create statement for one page with current offset.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  begin
-    # Get contacts by statement.
-    page = contact_service.get_contacts_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      page[:results].each_with_index do |contact, index|
-        puts "%d) Contact ID: %d, name: '%s'" %
-            [index + statement.offset,
-             contact[:id], contact[:name]]
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.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