google-dfp-api 0.2.5 → 0.2.6

data/examples/v201111/order_service/approve_orders.rb

@@ -0,0 +1,116 @@
+#!/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 approves and overbooks all draft orders. To determine which
+# orders exist, run get_all_orders.rb.
+#
+# Tags: OrderService.getOrdersByStatement,
+#       OrderService.performOrderAction
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201111
+PAGE_SIZE = 500
+
+def approve_orders()
+  # 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 OrderService.
+  order_service = dfp.service(:OrderService, API_VERSION)
+
+  # Create statement text to select all draft orders.
+  statement_text = "WHERE status IN ('DRAFT', 'PENDING_APPROVAL')"
+
+  # Define initial values.
+  offset = 0
+  page = {}
+  order_ids = []
+
+  begin
+    # Create a statement to get one page with current offset.
+    statement = {
+        :query => statement_text + " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
+    }
+
+    # Get orders by statement.
+    page = order_service.get_orders_by_statement(statement)
+
+    if page[:results]
+      # Increase query offset by page size.
+      offset += PAGE_SIZE
+
+      page[:results].each do |order|
+        # Archived orders cannot be approved.
+        if !order[:is_archived]
+          puts ("%d) Order ID: %d, status: %s and name: %s will be " +
+              "approved.") % [order_ids.size, order[:id], order[:status],
+                              order[:name]]
+          order_ids << order[:id]
+        end
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  puts "Number of orders to be approved: %d" % order_ids.size
+
+  if !order_ids.empty?
+    # Create statement for action.
+    statement = {:query => "WHERE id IN (%s)" % order_ids.join(', ')}
+
+    # Perform action.
+    result = order_service.perform_order_action(
+        {:xsi_type => 'ApproveAndOverbookOrders'}, statement)
+
+    # Display results.
+    if result and result[:num_changes] > 0
+      puts "Number of orders approved: %d" % result[:num_changes]
+    else
+      puts 'No orders were approved.'
+    end
+  else
+    puts 'No order found to approve.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    approve_orders()
+
+  # 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/order_service/create_orders.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 creates new orders. To determine which orders exist, run
+# get_all_orders.rb. To determine which companies are advertisers, run
+# get_companies_by_statement.rb. To get salespeople and traffickers, run
+# get_all_users.rb.
+#
+# Tags: OrderService.createOrders
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201111
+# Number of orders to create.
+ITEM_COUNT = 5
+
+def create_orders()
+  # 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 OrderService.
+  order_service = dfp.service(:OrderService, API_VERSION)
+
+  # Set the advertiser (company), salesperson, and trafficker to assign to each
+  # order.
+  advertiser_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'.to_i
+  salesperson_id = 'INSERT_SALESPERSON_ID_HERE'.to_i
+  trafficker_id = 'INSERT_TRAFFICKER_ID_HERE'.to_i
+
+  # Create an array to store local order objects.
+  orders = (1..ITEM_COUNT).map do |index|
+    {:name => "Order #%d" % index,
+     :advertiser_id => advertiser_id,
+     :salesperson_id => salesperson_id,
+     :trafficker_id => trafficker_id}
+  end
+
+  # Create the orders on the server.
+  return_orders = order_service.create_orders(orders)
+
+  if return_orders
+    return_orders.each do |order|
+      puts "Order with ID: %d and name: %s was created." %
+          [order[:id], order[:name]]
+    end
+  else
+    raise 'No orders were created.'
+  end
+
+end
+
+if __FILE__ == $0
+  begin
+    create_orders()
+
+  # 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/order_service/get_all_orders.rb

@@ -0,0 +1,93 @@
+#!/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 orders. To create orders, run create_orders.rb.
+#
+# Tags: OrderService.getOrdersByStatement
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201111
+PAGE_SIZE = 500
+
+def get_all_orders()
+  # 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 OrderService.
+  order_service = dfp.service(:OrderService, 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 orders by statement.
+    page = order_service.get_orders_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 order in results page.
+      page[:results].each_with_index do |order, index|
+        puts "%d) Order ID: %d, name: %s, advertiser ID: %d" %
+            [index + start_index, order[:id], order[:name],
+             order[:advertiser_id]]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Print a footer
+  if page.include?(:total_result_set_size)
+    puts "Total number of orders: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_orders()
+
+  # 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/order_service/get_order.rb

@@ -0,0 +1,74 @@
+#!/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 an order by its ID. To determine which orders exist, run
+# get_all_orders.rb.
+#
+# Tags: OrderService.getOrder
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201111
+
+def get_order()
+  # 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 OrderService.
+  order_service = dfp.service(:OrderService, API_VERSION)
+
+  # Set the ID of the order to get.
+  order_id = 'INSERT_ORDER_ID_HERE'.to_i
+
+  # Get the order.
+  order = order_service.get_order(order_id)
+
+  if order
+    puts "Order with ID: %d, advertiser ID: %d and name %s was found." %
+        [order[:id], order[:advertiser_id], order[:name]]
+  else
+    puts 'No order found for this ID.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_order()
+
+  # 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/order_service/get_orders_by_statement.rb

@@ -0,0 +1,90 @@
+#!/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 orders for a given advertiser. The statement retrieves
+# up to the maximum page size limit of 500. To create orders, run
+# create_orders.rb. To determine which companies are advertisers, run
+# get_companies_by_statement.rb.
+#
+# Tags: OrderService.getOrdersByStatement
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201111
+
+def get_orders_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 OrderService.
+  order_service = dfp.service(:OrderService, API_VERSION)
+
+  # Set the ID of the advertiser (company) to get orders for.
+  advertiser_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'.to_i
+
+  # Create a statement to only select orders for a given advertiser.
+  statement = {
+      :query => 'WHERE advertiserId = :advertiser_id LIMIT 500',
+      :values => [
+          {:key => 'advertiser_id',
+           :value => {:value => advertiser_id, :xsi_type => 'NumberValue'}}
+      ]
+  }
+
+  # Get orders by statement.
+  page = order_service.get_orders_by_statement(statement)
+
+  if page and page[:results]
+    page[:results].each_with_index do |order, index|
+      puts "%d) Order ID: %d, belongs to advertiser ID: %d, name: %s." % [index,
+          order[:id], order[:advertiser_id], order[:name]]
+    end
+  end
+
+  # 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_orders_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