google-dfp-api 0.6.3 → 0.7.0

data/examples/v201204/network_service/get_current_network.rb

@@ -1,66 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 the current network that you can make requests against.
-#
-# Tags: NetworkService.getCurrentNetwork
-
-require 'dfp_api'
-
-API_VERSION = :v201204
-
-def get_current_network()
-  # 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 NetworkService.
-  network_service = dfp.service(:NetworkService, API_VERSION)
-
-  # Get the current network.
-  network = network_service.get_current_network()
-
-  puts "Current network has network code %d and display name %s." %
-      [network[:network_code], network[:display_name]]
-end
-
-if __FILE__ == $0
-  begin
-    get_current_network()
-
-  # 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/v201204/order_service/approve_orders.rb

@@ -1,122 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 eligible draft or pending orders. To
-# determine which orders exist, run get_all_orders.rb.
-#
-# Tags: OrderService.getOrdersByStatement
-# Tags: OrderService.performOrderAction
-
-require 'date'
-require 'dfp_api'
-
-API_VERSION = :v201204
-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 a statement text to select all eligible draft or pending orders.
-  statement_text = "WHERE status IN ('DRAFT', 'PENDING_APPROVAL') " +
-      "AND endDateTime >= :today AND isArchived = FALSE"
-  statement = {
-      :query => statement_text,
-      :values => [
-         {:key => 'today',
-          :value => {:value => Date.today.strftime('%Y-%m-%dT%H:%M:%S'),
-                     :xsi_type => 'TextValue'}}
-     ]
-  }
-
-  # Define initial values.
-  offset = 0
-  page = {}
-  order_ids = []
-
-  begin
-    # Update the 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|
-        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 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/v201204/order_service/create_orders.rb

@@ -1,92 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 'dfp_api'
-
-API_VERSION = :v201204
-# 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/v201204/order_service/get_all_orders.rb

@@ -1,93 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 'dfp_api'
-
-API_VERSION = :v201204
-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/v201204/order_service/get_orders_by_statement.rb

@@ -1,90 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 'dfp_api'
-
-API_VERSION = :v201204
-
-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