google-dfp-api 0.2.0 → 0.2.1

data/examples/v201104/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 = :v201104
+
+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

data/examples/v201104/order_service/update_orders.rb

@@ -0,0 +1,95 @@
+#!/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 notes of each order up to the first 500.
+# To determine which orders exist, run get_all_orders.rb.
+#
+# Tags: OrderService.updateOrders
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201104
+
+def update_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 to get first 500 orders.
+  statement = {:query => 'LIMIT 500'}
+
+  # Get orders by statement.
+  page = order_service.get_orders_by_statement(statement)
+
+  if page[:results]
+    orders = page[:results]
+
+    new_orders = orders.inject([]) do |new_orders, order|
+      # Archived orders can not be updated.
+      if !order[:is_archived]
+        order[:notes] = 'Spoke to advertiser. All is well.'
+        new_orders << order
+      end
+      new_orders
+    end
+
+    # Update the orders on the server.
+    return_orders = order_service.update_orders(orders)
+
+    if return_orders
+      return_orders.each do |order|
+        puts ("Order ID: %d, advertiser ID: %d, name: %s was updated " +
+              "with notes %s") % [order[:id], order[:advertiser_id],
+                                  order[:name], order[:notes]]
+      end
+    else
+      raise 'No orders were updated.'
+    end
+  else
+    puts 'No orders found to update.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    update_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/v201104/placement_service/create_placements.rb

@@ -0,0 +1,128 @@
+#!/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 placements for various ad unit sizes. To determine
+# which placements exist, run get_all_placements.rb.
+
+# Tags: PlacementService.createPlacements,
+#       InventoryService.getAdUnitsByStatement
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201104
+
+def create_placements()
+  # 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 InventoryService.
+  inventory_service = dfp.service(:InventoryService, API_VERSION)
+
+  # Get the PlacementService.
+  placement_service = dfp.service(:PlacementService, API_VERSION)
+
+  # Create local placement object to store skyscraper ad units.
+  skyscraper_ad_unit_placement = {
+      :name => "Skyscraper AdUnit Placement #%d" % (Time.new.to_f * 1000),
+      :description => 'Contains ad units for creatives of size 120x600',
+      :targeted_ad_unit_ids => Array.new
+  }
+
+  # Create local placement object to store medium square ad units.
+  medium_square_ad_unit_placement = {
+      :name => "Medium Square AdUnit Placement #%d" % (Time.new.to_f * 1000),
+      :description => 'Contains ad units for creatives of size 300x250',
+      :targeted_ad_unit_ids => Array.new
+  }
+
+  # Create local placement object to store banner ad units.
+  banner_ad_unit_placement = {
+      :name => "Banner AdUnit Placement #%d" % (Time.new.to_f * 1000),
+      :description => 'Contains ad units for creatives of size 468x60',
+      :targeted_ad_unit_ids => Array.new
+  }
+
+  # Get the first 500 ad units.
+  page = inventory_service.get_ad_units_by_statement({:query => 'LIMIT 500'})
+
+  # Separate the ad units by size.
+  if page and page[:results]
+    page[:results].each do |ad_unit|
+      if ad_unit[:parent_id] and ad_unit[:sizes]
+        ad_unit[:sizes].each do |size|
+          receiver = case size[:width]
+            when 120
+              skyscraper_ad_unit_placement if size[:height] == 600
+            when 300
+              medium_square_ad_unit_placement if size[:height] == 250
+            when 468
+              banner_ad_unit_placement if size[:height] == 60
+            else nil
+          end
+          receiver[:targeted_ad_unit_ids] |= [ad_unit[:id]] if receiver
+        end
+      end
+    end
+  end
+
+  # Create the placements on the server.
+  placements = placement_service.create_placements(
+      [medium_square_ad_unit_placement,
+       skyscraper_ad_unit_placement,
+       banner_ad_unit_placement]
+  )
+
+  # Display results.
+  if placements
+    placements.each do |placement|
+      puts "Placement with ID: %d and name: %s created with ad units: [%s]" %
+          [placement[:id], placement[:name],
+           placement[:targeted_ad_unit_ids].join(', ')]
+    end
+  else
+    raise 'No placements created.'
+  end
+
+end
+
+if __FILE__ == $0
+  begin
+    create_placements()
+
+  # 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/v201104/placement_service/deactivate_placements.rb

@@ -0,0 +1,118 @@
+#!/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 deactivates all active placements. To determine which placements
+# exist, run get_all_placements.rb.
+#
+# Tags: PlacementService.getPlacementsByStatement,
+#       PlacementService.performPlacementAction
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201104
+PAGE_SIZE = 500
+
+def deactivate_placements()
+  # 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 PlacementService.
+  placement_service = dfp.service(:PlacementService, API_VERSION)
+
+  # Create statement text and statement to select active placements.
+  statement_text = 'WHERE status = :status'
+  statement = {
+      :values => [
+          {:key => 'status',
+           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
+      ]
+  }
+
+  # Define initial values.
+  offset = 0
+  page = Hash.new
+  placement_ids = Array.new
+
+  begin
+    # Modify the statement to get one page with current offset.
+    statement[:query] = statement_text +
+        " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
+
+    # Get placements by statement.
+    page = placement_service.get_placements_by_statement(statement)
+
+    if page[:results]
+      # Increase query offset by page size.
+      offset += PAGE_SIZE
+
+      page[:results].each do |placement|
+        puts ("%d) Placement ID: %d, name: %s and status: %s will be " +
+            "deactivated.") % [placement_ids.size, placement[:id],
+            placement[:name], placement[:status]]
+        placement_ids << placement[:id]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  puts "Number of placements to be deactivated: %d" % placement_ids.size
+
+  if !placement_ids.empty?
+    # Create a statement for action.
+    statement = {:query => "WHERE id IN (%s)" % placement_ids.join(', ')}
+
+    # Perform action.
+    result = placement_service.perform_placement_action(
+        {:xsi_type => 'DeactivatePlacements'}, statement)
+
+    # Display results.
+    if result and result[:num_changes] > 0
+      puts "Number of placements deactivated: %d" % result[:num_changes]
+    else
+      puts 'No placements were deactivated.'
+    end
+  else
+    puts 'No placements found to deactivate.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    deactivate_placements()
+
+  # 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/v201104/placement_service/get_all_placements.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 placements. To create placements, run
+# create_placements.rb
+#
+# Tags: PlacementService.getPlacementsByStatement
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201104
+PAGE_SIZE = 500
+
+def get_all_placements()
+  # 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 PlacementService.
+  placement_service = dfp.service(:PlacementService, API_VERSION)
+
+  # Define initial values.
+  offset = 0
+  page = Hash.new
+
+  begin
+    # Create statement for one page with current offset.
+    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
+
+    # Get placements by statement.
+    page = placement_service.get_placements_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 placement in results page.
+      page[:results].each_with_index do |placement, index|
+        puts "%d) Placement ID: %d, name: %s." %
+            [index + start_index, placement[:id], placement[:name]]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Print a footer
+  if page.include?(:total_result_set_size)
+    puts "Total number of placements: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_placements()
+
+  # 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