google-dfp-api 0.7.1 → 0.8.0

data/examples/v201208/line_item_creative_association_service/get_all_licas.rb

@@ -1,98 +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 item creative associations (LICA). To create LICAs,
-# run create_licas.rb or associate_creative_set_to_line_item.rb.
-#
-# Tags: LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201208
-PAGE_SIZE = 500
-
-def get_all_licas()
-  # 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 LineItemCreativeAssociationService.
-  lica_service = dfp.service(:LineItemCreativeAssociationService, API_VERSION)
-
-  # Define initial values.
-  offset = 0
-  page = {}
-
-  begin
-    # Create statement for one page with current offset.
-    statement = {:query => 'LIMIT %d OFFSET %d' % [PAGE_SIZE, offset]}
-
-    # Get LICAs by statement.
-    page =
-        lica_service.get_line_item_creative_associations_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 LICA in results page.
-      page[:results].each_with_index do |lica, index|
-        creative_text = (lica[:creative_set_id] != nil) ?
-            'creative set ID %d' % lica[:creative_set_id] :
-            'creative ID %d' % lica[:creative_id]
-        puts '%d) LICA with line item ID: %d, %s and status: %s' %
-            [index + start_index, lica[:line_item_id], creative_text,
-             lica[:status]]
-      end
-    end
-  end while offset < page[:total_result_set_size]
-
-  # Print a footer
-  if page.include?(:total_result_set_size)
-    puts 'Total number of LICAs: %d' % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_licas()
-
-  # 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/v201208/line_item_creative_association_service/get_lica.rb

@@ -1,77 +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 creative association (LICA) by the line item and
-# creative ID. To determine which line items exist, run get_all_line_items.rb.
-# To determine which creatives exit, run get_all_creatives.rb.
-#
-# Tags: LineItemCreativeAssociationService.getLineItemCreativeAssociation
-
-require 'dfp_api'
-
-API_VERSION = :v201208
-
-def get_lica()
-  # 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 LineItemCreativeAssociationService.
-  lica_service = dfp.service(:LineItemCreativeAssociationService, API_VERSION)
-
-  # Set the line item and creative IDs to use to retrieve the LICA.
-  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
-  creative_id = 'INSERT_CREATIVE_ID_HERE'.to_i
-
-  # Get the LICA.
-  lica =
-      lica_service.get_line_item_creative_association(line_item_id, creative_id)
-
-  if lica
-    puts ("LICA with line item ID: %d, creative ID: %d and status: %s was " +
-        "found.") % [lica[:line_item_id], lica[:creative_id], lica[:status]]
-  else
-    puts 'No lica found for this ID.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_lica()
-
-  # 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/v201208/line_item_creative_association_service/update_licas.rb

@@ -1,91 +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 destination URL of all LICAs up to the first 500. To
-# determine which LICAs exist, run get_all_licas.rb.
-#
-# Tags: LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatement
-# Tags: LineItemCreativeAssociationService.updateLineItemCreativeAssociations
-
-require 'dfp_api'
-
-API_VERSION = :v201208
-
-def update_licas()
-  # 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 LineItemCreativeAssociationService.
-  lica_service = dfp.service(:LineItemCreativeAssociationService, API_VERSION)
-
-  # Create a statement to get all LICAs.
-  statement = {:query => 'LIMIT 500'}
-
-  # Get LICAs by statement.
-  page =
-      lica_service.get_line_item_creative_associations_by_statement(statement)
-
-  if page[:results]
-    licas = page[:results]
-
-    # Update each local LICA object by changing its destination URL.
-    licas.each {|lica| lica[:destination_url] = 'http://news.google.com'}
-
-    # Update the LICAs on the server.
-    return_licas = lica_service.update_line_item_creative_associations(licas)
-
-    if return_licas
-      return_licas.each do |lica|
-        puts ("LICA with line item ID: %d and creative ID: %d was updated " +
-              "with destination url [%s]") %
-              [lica[:line_item_id], lica[:creative_id], lica[:destination_url]]
-      end
-    else
-      raise 'No LICAs were updated.'
-    end
-  else
-    puts 'No LICAs found to update.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_licas()
-
-  # 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/v201208/line_item_service/create_line_items.rb

@@ -1,177 +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 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 'dfp_api'
-
-API_VERSION = :v201208
-# 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] = 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/v201208/line_item_service/create_mobile_line_item.rb

@@ -1,135 +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 the mobile platform. 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 mobile ad unit, run
-# create_mobile_ad_unit.rb. To determine which placements exist, run
-# get_all_placements.rb.
-#
-# Mobile features needs to be enabled in your account to use mobile targeting.
-#
-# Tags: LineItemService.createLineItem
-
-require 'dfp_api'
-
-API_VERSION = :v201208
-
-def create_mobile_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 all created line items will belong to and the
-  # placement containing ad units with a mobile target platform.
-  order_id = 'INSERT_ORDER_ID_HERE'.to_i
-  targeted_placement_id = 'INSERT_MOBILE_PLACEMENT_ID_HERE'.to_i
-
-  # Create inventory targeting.
-  inventory_targeting = {:targeted_placement_ids => [targeted_placement_id]}
-
-  # Create technology targeting.
-  technology_targeting = {
-      :device_manufacturer_targeting => {
-          # Target the Google device manufacturer (40100).
-          :device_manufacturers => [{:id => 40100}],
-          :is_targeted => true
-      },
-      :mobile_device_targeting => {
-          # Exclude the Nexus One device (604046).
-          :excluded_mobile_devices => [{:id => 604046}]
-      },
-      :mobile_device_submodel_targeting => {
-          # Target the iPhone 4 device submodel (640003).
-          :targeted_mobile_device_submodels => [{:id => 640003}]
-      }
-  }
-
-  # Create targeting.
-  targeting = {
-      :inventory_targeting => inventory_targeting,
-      :technology_targeting => technology_targeting
-  }
-
-  # Create local line item object.
-  line_item = {
-      :name => 'Mobile line item',
-      :order_id => order_id,
-      :targeting => targeting,
-      :line_item_type => 'STANDARD',
-      :allow_overbook => true,
-      # Set the target platform to mobile.
-      :target_platform => 'MOBILE',
-      # Set the creative rotation type to even.
-      :creative_rotation_type => 'EVEN',
-      # Set the size of creatives that can be associated with this line item.
-      :creative_placeholders => [
-          {:size => {:width => 300, :height => 250, :is_aspect_ratio => false}}
-      ],
-      # 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 $2.
-      :cost_type => 'CPM',
-      :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.
-      :units_bought => 500000,
-      :unit_type => 'IMPRESSIONS'
-  }
-
-  # 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_mobile_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