google-dfp-api 0.17.0 → 0.19.0

data/examples/v201605/line_item_service/create_line_items.rb

@@ -1,182 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-API_VERSION = :v201605
-# 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 targets.
-      :targeted_locations => [
-          {:id => 2840},    # USA.
-          {:id => 20123},   # Quebec, Canada.
-          {:id => 9000093}  # Postal code B3P (Canada).
-      ],
-      # Exclude targets.
-      :excluded_locations => [
-          {:id => 1016367}, # Chicago.
-          {:id => 200501}   # New York.
-      ]
-  }
-
-  # 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-%d" % [Time.new.to_f * 1000, 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'
-
-    # Create the creative placeholder.
-    creative_placeholder = {
-        :size => {:width => 300, :height => 250, :is_aspect_ratio => false}
-    }
-
-    # Set the size of creatives that can be associated with this line item.
-    line_item[:creative_placeholders] = [creative_placeholder]
-
-    # Set the length of the line item to run.
-    line_item[:start_date_time_type] = 'IMMEDIATELY'
-    line_item[:end_date_time] = {:date => {:year => Time.now.year + 1,
-                                           :month => 9,
-                                           :day => 30},
-                                 :hour => 0,
-                                 :minute => 0,
-                                 :second => 0,
-                                 :time_zone_id => 'America/Los_Angeles'}
-
-    # 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[:primary_goal] = {
-        :units => '500000',
-        :unit_type => 'IMPRESSIONS',
-        :goal_type => 'LIFETIME'
-    }
-
-    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/v201605/line_item_service/create_video_line_item.rb

@@ -1,164 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-API_VERSION = :v201605
-
-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 = {:position_type => 'PREROLL'}
-  video_position_target = {:video_position => video_position}
-  video_position_targeting = {:targeted_positions => [video_position_target]}
-
-  # 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',
-      line_item[:end_date_time] = {:date => {:year => Time.now.year + 1,
-                                       :month => 9,
-                                       :day => 30},
-                             :hour => 0,
-                             :minute => 0,
-                             :second => 0,
-                             :time_zone_id => 'America/Los_Angeles'}
-      # 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%.
-      :primary_goal => {
-          :units => '100',
-          :unit_type => 'IMPRESSIONS',
-          :goal_type => 'DAILY'
-      }
-  }
-
-  # 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/v201605/line_item_service/get_all_line_items.rb

@@ -1,82 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-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)
-
-  # Create a statement to get one page with current offset.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  begin
-    # Get line items by statement.
-    page = line_item_service.get_line_items_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      # 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 + statement.offset, line_item[:id],
-             line_item[:order_id], line_item[:name]]
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.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/v201605/line_item_service/get_line_items_by_statement.rb

@@ -1,91 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2014, 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 a given order. To create line
-# items, run create_line_items.rb. To determine which orders exist, run
-# get_all_orders.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-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 = DfpApi::FilterStatement.new(
-      'WHERE orderId = :order_id ORDER BY id ASC',
-      [
-          {: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.toStatement())
-
-  while page and page[:results] do
-    page[:results].each_with_index do |line_item, index|
-      puts "%d) [%d] belongs to order ID %d, name: %s." % [
-          index + statement.offset,
-          line_item[:id], line_item[:order_id], line_item[:name]]
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-    page = line_item_service.get_line_items_by_statement(
-        statement.toStatement())
-  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/v201605/line_item_service/get_recently_updated_line_items.rb

@@ -1,100 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'date'
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-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 = DfpApi::FilterStatement.new(
-    'WHERE lastModifiedDateTime >= :date_time_string AND ' +
-    'orderId = :order_id ORDER BY id ASC',
-    [
-      {: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'
-      }},
-    ]
-  )
-
-  begin
-    # Get line items by statement.
-    page = line_item_service.get_line_items_by_statement(
-        statement.toStatement())
-
-    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 + statement.offset, line_item[:id],
-            line_item[:order_id], line_item[:name]]
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.offset < page[:total_result_set_size]
-
-  # 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