google-dfp-api 0.4.0 → 0.5.0

data/examples/v201108/line_item_service/get_line_item.rb

@@ -1,73 +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 line item by its ID. To determine which line items
-# exist, run get_all_line_items.rb.
-#
-# Tags: LineItemService.getLineItem
-
-require 'dfp_api'
-
-API_VERSION = :v201108
-
-def get_line_item()
-  # 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 LineItemService.
-  line_item_service = dfp.service(:LineItemService, API_VERSION)
-
-  # Set the ID of the line_item to get.
-  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
-
-  # Get the line item.
-  line_item = line_item_service.get_line_item(line_item_id)
-
-  if line_item
-    puts "Line item with ID: %d, name: %s and order id: %d was found." %
-        [line_item[:id], line_item[:name], line_item[:order_id]]
-  else
-    puts 'No line item found for this ID.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_line_item()
-
-  # 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/v201108/line_item_service/update_line_items.rb

@@ -1,108 +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 updates the delivery rate of all line items for an order up to
-# the first 500. To determine which line items exist, run get_all_line_items.rb.
-# To determine which order exist, run get_all_orders.rb.
-#
-# Tags: LineItemService.getLineItemsByStatement, LineItemService.updateLineItems
-
-require 'dfp_api'
-
-API_VERSION = :v201108
-
-def update_line_items()
-  # 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 LineItemService.
-  line_item_service = dfp.service(:LineItemService, API_VERSION)
-
-  # Set the ID of the order to get line items from.
-  order_id = 'INSERT_ORDER_ID_HERE'.to_i
-
-  # Create a statement to get line items with even delivery rates.
-  statement = {
-      :query => 'WHERE deliveryRateType = :delivery_rate_type AND ' +
-          'orderId = :order_id LIMIT 500',
-      :values => [
-          {:key => 'delivery_rate_type',
-           :value => {:value => 'EVENLY', :xsi_type => 'TextValue'}},
-          {:key => 'order_id',
-           :value => {:value => order_id, :xsi_type => 'NumberValue'}}
-      ]
-  }
-
-  # Get line items by statement.
-  page = line_item_service.get_line_items_by_statement(statement)
-
-  if page[:results]
-    line_items = page[:results]
-
-    # Update each local line item object by changing its delivery rate.
-    new_line_items = line_items.inject([]) do |new_line_items, line_item|
-      # Archived line items can not be updated.
-      if !line_item[:is_archived]
-        line_item[:delivery_rate_type] = 'AS_FAST_AS_POSSIBLE'
-        new_line_items << line_item
-      end
-      new_line_items
-    end
-
-    # Update the line items on the server.
-    return_line_items = line_item_service.update_line_items(line_items)
-
-    if return_line_items
-      return_line_items.each do |line_item|
-        puts ("Line item ID: %d, order ID: %d, name: %s was updated with " +
-              "delivery rate: %s") % [line_item[:id], line_item[:order_id],
-              line_item[:name], line_item[:delivery_rate_type]]
-      end
-    else
-      raise 'No line items were updated.'
-    end
-  else
-    puts 'No line items found to update.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_line_items()
-
-  # 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/v201108/order_service/approve_orders.rb

@@ -1,115 +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 approves and overbooks all draft orders. To determine which
-# orders exist, run get_all_orders.rb.
-#
-# Tags: OrderService.getOrdersByStatement,
-#       OrderService.performOrderAction
-
-require 'dfp_api'
-
-API_VERSION = :v201108
-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/v201108/order_service/get_order.rb

@@ -1,73 +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 an order by its ID. To determine which orders exist, run
-# get_all_orders.rb.
-#
-# Tags: OrderService.getOrder
-
-require 'dfp_api'
-
-API_VERSION = :v201108
-
-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/v201108/order_service/get_orders_by_statement.rb

@@ -1,89 +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 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 = :v201108
-
-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