google-dfp-api 0.2.2 → 0.2.3

data/examples/v201107/line_item_service/create_line_items.rb

@@ -0,0 +1,167 @@
+#!/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 line items. To determine which line items exist, run
+# get_all_line_items.rb. To determine which orders exist, run
+# get_all_orders.rb. To determine which placements exist, run
+# get_all_placements.rb. To determine the IDs for locations, run
+# get_all_cities.rb, get_all_countries.rb, get_all_metros.rb and
+# get_all_regions.rb.
+#
+# Tags: LineItemService.createLineItems
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201107
+# Number of line items to create.
+ITEM_COUNT = 5
+
+def create_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 order that all created line items will belong to and the placement
+  # ID to target.
+  order_id = 'INSERT_ORDER_ID_HERE'.to_i
+  targeted_placement_ids = Array.new(ITEM_COUNT) do
+    'INSERT_PLACEMENT_ID_HERE'.to_i
+  end
+
+  # Create inventory targeting.
+  inventory_targeting = {:targeted_placement_ids => targeted_placement_ids}
+
+  # Create geographical targeting.
+  geo_targeting = {
+      # Include the US and Quebec, Canada.
+      :targeted_locations => [{:id => 2840}, {:id => 20123}],
+      # Exclude Chicago and the New York metro area.
+      :excluded_locations => [{:id => 1016367}, {:id => 200501}]
+  }
+
+  # Create user domain targeting. Exclude domains that are not under the
+  # network's control.
+  user_domain_targeting = {:domains => ['usa.gov'], :targeted => false}
+
+  # Create day-part targeting.
+  day_part_targeting = {
+      # Target only the weekend in the browser's timezone.
+      :time_zone => 'BROWSER',
+      :day_parts => [
+          {:day_of_week => 'SATURDAY',
+           :start_time => {:hour => 0, :minute => 'ZERO'},
+           :end_time => {:hour => 24, :minute => 'ZERO'}},
+          {:day_of_week => 'SUNDAY',
+           :start_time => {:hour => 0, :minute => 'ZERO'},
+           :end_time => {:hour => 24, :minute => 'ZERO'}}
+      ]
+  }
+
+  # Create technology targeting.
+  technology_targeting = {
+      # Create browser targeting.
+      :browser_targeting => {
+        :is_targeted => true,
+        # Target just the Chrome browser.
+        :browsers => [{:id => 500072}]
+      }
+  }
+
+  # Create targeting.
+  targeting = {:geo_targeting => geo_targeting,
+               :inventory_targeting => inventory_targeting,
+               :user_domain_targeting => user_domain_targeting,
+               :day_part_targeting => day_part_targeting,
+               :technology_targeting => technology_targeting
+  }
+
+  # Create an array to store local line item objects.
+  line_items = (1..ITEM_COUNT).map do |index|
+    line_item = {:name => "Line item #%d" % index,
+                 :order_id => order_id,
+                 :targeting => targeting,
+                 :line_item_type => 'STANDARD',
+                 :allow_overbook => true}
+    # Set the creative rotation type to even.
+    line_item[:creative_rotation_type] = 'EVEN'
+
+    # Set the size of creatives that can be associated with this line item.
+    line_item[:creative_sizes] = [
+        {:width => 300, :height => 250, :is_aspect_ratio => false}
+    ]
+
+    # Set the length of the line item to run.
+    line_item[:start_date_time_type] = 'IMMEDIATELY'
+    line_item[:end_date_time] = Time.new + 60 * 60 * 24 * 7
+
+    # Set the cost per unit to $2.
+    line_item[:cost_type] = 'CPM'
+    line_item[:cost_per_unit] = {
+        :currency_code => 'USD',
+        :micro_amount => 2000000
+    }
+
+    # Set the number of units bought to 500,000 so that the budget is $1,000.
+    line_item[:units_bought] = 500000
+    line_item[:unit_type] = 'IMPRESSIONS'
+
+    line_item
+  end
+
+  # Create the line items on the server.
+  return_line_items = line_item_service.create_line_items(line_items)
+
+  if return_line_items
+    return_line_items.each do |line_item|
+      puts ("Line item with ID: %d, belonging to order ID: %d, " +
+          "and named: %s was created.") %
+          [line_item[:id], line_item[:order_id], line_item[:name]]
+    end
+  else
+    raise 'No line items were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_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/v201107/line_item_service/get_all_line_items.rb

@@ -0,0 +1,94 @@
+#!/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 line items. To create line items, run
+# create_line_items.rb.
+#
+# Tags: LineItemService.getLineItemsByStatement
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201107
+PAGE_SIZE = 500
+
+def get_all_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)
+
+  # Define initial values.
+  offset = 0
+  page = {}
+
+  begin
+    # Create a statement to get one page with current offset.
+    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
+
+    # Get line items by statement.
+    page = line_item_service.get_line_items_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 line item in results.
+      page[:results].each_with_index do |line_item, index|
+        puts "%d) Line item ID: %d, order ID: %d, name: %s" %
+            [index + start_index, line_item[:id],
+             line_item[:order_id], line_item[: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 line items: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_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/v201107/line_item_service/get_line_item.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 a line item by its ID. To determine which line items
+# exist, run get_all_line_items.rb.
+#
+# Tags: LineItemService.getLineItem
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201107
+
+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/v201107/line_item_service/get_line_items_by_statement.rb

@@ -0,0 +1,89 @@
+#!/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 line items for the given order. The statement retrieves
+# up to the maximum page size limit of 500. To create line items, run
+# create_line_items.rb. To determine which orders exist, run get_all_orders.rb.
+#
+# Tags: LineItemService.getLineItemsByStatement
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201107
+
+def get_line_items_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 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 only select line items from a given order.
+  statement = {
+      :query => 'WHERE orderId = :order_id LIMIT 500',
+      :values => [
+          {: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 and page[:results]
+    page[:results].each_with_index do |line_item, index|
+      puts "%d) [%d] belongs to order ID %d, name: %s." % [index,
+          line_item[:id], line_item[:order_id], line_item[: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_line_items_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/v201107/line_item_service/target_custom_criteria.rb

@@ -0,0 +1,129 @@
+#!/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 a line item to add custom criteria targeting. To
+# determine which line items exist, run get_all_line_items.rb. To determine
+# which custom targeting keys and values exist, run
+# get_all_custom_targeting_keys_and_values.rb.
+#
+# Tags: LineItemService.getLineItem, LineItemService.updateLineItem
+
+require 'rubygems'
+require 'dfp_api'
+
+require 'pp'
+
+API_VERSION = :v201107
+PAGE_SIZE = 500
+
+def target_custom_criteria()
+  # 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 update targeting.
+  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
+
+  # Set the IDs of the custom targeting keys.
+  custom_criteria_ids = [
+      {:key => 'INSERT_CUSTOM_TARGETING_KEY_ID_HERE'.to_i,
+       :values => ['INSERT_CUSTOM_TARGETING_VALUE_IDS_HERE'.to_i]},
+      {:key => 'INSERT_CUSTOM_TARGETING_KEY_ID_HERE'.to_i,
+       :values => ['INSERT_CUSTOM_TARGETING_VALUE_IDS_HERE'.to_i]},
+      {:key => 'INSERT_CUSTOM_TARGETING_KEY_ID_HERE'.to_i,
+       :values => ['INSERT_CUSTOM_TARGETING_VALUE_IDS_HERE'.to_i]}
+  ]
+
+  # Create custom criteria.
+  custom_criteria = [
+      {:xsi_type => 'CustomCriteria',
+       :key_id => custom_criteria_ids[0][:key],
+       :value_ids => custom_criteria_ids[0][:values],
+       :operator => 'IS'},
+      {:xsi_type => 'CustomCriteria',
+       :key_id => custom_criteria_ids[1][:key],
+       :value_ids => custom_criteria_ids[1][:values],
+       :operator => 'IS_NOT'},
+      {:xsi_type => 'CustomCriteria',
+       :key_id => custom_criteria_ids[2][:key],
+       :value_ids => custom_criteria_ids[2][:values],
+       :operator => 'IS'}
+  ]
+
+  # Create the custom criteria set that will resemble:
+  #
+  # (custom_criteria[0].key == custom_criteria[0].values OR
+  #     (custom_criteria[1].key != custom_criteria[1].values AND
+  #         custom_criteria[2].key == custom_criteria[2].values))
+  sub_custom_criteria_set = {
+      :xsi_type => 'CustomCriteriaSet',
+      :logical_operator => 'AND',
+      :children => [custom_criteria[1], custom_criteria[2]]
+  }
+  top_custom_criteria_set = {
+      :xsi_type => 'CustomCriteriaSet',
+      :logical_operator => 'OR',
+      :children => [custom_criteria[0], sub_custom_criteria_set]
+  }
+
+  # Get the line item.
+  line_item = line_item_service.get_line_item(line_item_id)
+
+  # Set the custom criteria targeting on the line item.
+  line_item[:targeting] = {:custom_targeting => top_custom_criteria_set}
+
+  # Update the line items on the server.
+  return_line_item = line_item_service.update_line_item(line_item)
+
+  # Display the updated line item.
+  if return_line_item
+    puts "Line item ID: %d was updated with custom criteria targeting:" %
+        return_line_item[:id]
+    pp return_line_item[:targeting]
+  else
+    puts 'Line item update failed.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    target_custom_criteria()
+
+  # 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