google-dfp-api 0.6.3 → 0.7.0

data/examples/v201204/line_item_service/create_video_line_item.rb

@@ -1,156 +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 create a new line item to serve to video content. To determine
-# which line items exist, run get_all_line_items.rb. To determine which orders
-# exist, run get_all_orders.rb. To create a video ad unit, run
-# create_video_ad_unit.rb. To create criteria for categories, run
-# create_custom_targeting_keys_and_values.rb.
-#
-# This feature is only available to DFP premium solution networks.
-#
-# Tags: LineItemService.createLineItem
-
-require 'dfp_api'
-
-API_VERSION = :v201204
-
-def create_video_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 order that the created line item will belong to and the video ad
-  # unit ID to target.
-  order_id = 'INSERT_ORDER_ID_HERE'.to_i
-  targeted_video_ad_unit_id = 'INSERT_VIDEO_AD_UNIT_ID_HERE'.to_s
-
-  # Set the custom targeting key ID and value ID representing the metadata on
-  # the content to target. This would typically be a key representing a "genre"
-  # and a value representing something like "comedy".
-  content_custom_targeting_key_id =
-      'INSERT_CONTENT_CUSTOM_TARGETING_KEY_ID_HERE'.to_i
-  content_custom_targeting_value_id =
-      'INSERT_CONTENT_CUSTOM_TARGETING_VALUE_ID_HERE'.to_i
-
-  # Create custom criteria for the content metadata targeting.
-  content_custom_criteria = {
-      :xsi_type => 'CustomCriteria',
-      :key_id => content_custom_targeting_key_id,
-      :value_ids => [content_custom_targeting_value_id],
-      :operator => 'IS'
-  }
-
-  # Create custom criteria set.
-  custom_criteria_set = {
-      :children => [content_custom_criteria]
-  }
-
-  # Create inventory targeting.
-  inventory_targeting = {
-      :targeted_ad_units => [
-          {:ad_unit_id => targeted_video_ad_unit_id}
-      ]
-  }
-
-  # Create video position targeting.
-  video_position_targeting = {:targeted_video_positions => ['PREROLL']}
-
-  # Create targeting.
-  targeting = {
-      :custom_targeting => custom_criteria_set,
-      :inventory_targeting => inventory_targeting,
-      :video_position_targeting => video_position_targeting
-  }
-
-  # Create local line item object.
-  line_item = {
-      :name => 'Video line item',
-      :order_id => order_id,
-      :targeting => targeting,
-      :line_item_type => 'SPONSORSHIP',
-      :allow_overbook => true,
-      # Set the environment type to video.
-      :environment_type => 'VIDEO_PLAYER',
-      # Set the creative rotation type to optimized.
-      :creative_rotation_type => 'OPTIMIZED',
-      # Set delivery of video companions to optional.
-      :companion_delivery_option => 'OPTIONAL',
-      # Set the length of the line item to run.
-      :start_date_time_type => 'IMMEDIATELY',
-      :end_date_time => Time.new + 60 * 60 * 24 * 7,
-      # Set the cost per day to $1.
-      :cost_type => 'CPD',
-      :cost_per_unit => {:currency_code => 'USD', :micro_amount => 1000000},
-      # Set the percentage to be 100%.
-      :units_bought => 100
-  }
-
-  # Create the master creative placeholder and companion creative placeholders.
-  creative_master_placeholder = {
-      :size => {:width => 400, :height => 300, :is_aspect_ratio => false},
-      :companions => [
-          {:size => {:width => 300, :height => 250, :is_aspect_ratio => false}},
-          {:size => {:width => 728, :height => 90, :is_aspect_ratio => false}}
-      ]
-  }
-
-  # Set the size of creatives that can be associated with this line item.
-  line_item[:creative_placeholders] = [creative_master_placeholder]
-
-  # Create the line item on the server.
-  return_line_item = line_item_service.create_line_item(line_item)
-
-  if return_line_item
-    puts(("Line item with ID: %d, belonging to order ID: %d, " +
-        "and named: %s was created.") %
-        [return_line_item[:id], return_line_item[:order_id],
-         return_line_item[:name]])
-  else
-    raise 'No line items were created.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    create_video_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/v201204/line_item_service/get_all_line_items.rb

@@ -1,94 +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 line items. To create line items, run
-# create_line_items.rb.
-#
-# Tags: LineItemService.getLineItemsByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201204
-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/v201204/line_item_service/get_line_item.rb

@@ -1,74 +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 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 = :v201204
-
-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/v201204/line_item_service/get_recently_updated_line_items.rb

@@ -1,98 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2012, 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 code example shows how to get recently updated line items. To create line
-# items, run create_line_items.rb. To determine which orders exist, run
-# get_all_orders.rb.
-#
-# Tags: LineItemService.getLineItemsByStatement
-
-require 'date'
-
-require 'dfp_api'
-
-API_VERSION = :v201204
-
-def get_recently_updated_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 statement object to only select line items belonging to the order and
-  # have been modified in the last 3 days.
-  statement = {
-    :query => 'WHERE lastModifiedDateTime >= :date_time_string AND ' +
-        'orderId = :order_id LIMIT 500',
-    :values => [
-      {:key => 'order_id',
-       :value => {:value => order_id, :xsi_type => 'NumberValue'}},
-      {:key => 'date_time_string',
-       :value => {
-           :value => (DateTime.now - 3).strftime('%Y-%m-%dT%H:%M:%S'),
-           :xsi_type => 'TextValue'
-      }},
-    ]
-  }
-
-  # 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_recently_updated_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/v201204/line_item_service/update_line_items.rb

@@ -1,109 +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 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 = :v201204
-
-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(new_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