google-dfp-api 0.4.0 → 0.5.0

data/examples/v201201/label_service/create_labels.rb

@@ -1,82 +0,0 @@
-#!/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 labels. To determine which labels exist, run
-# get_all_labels.rb.
-#
-# This feature is only available to DFP premium solution networks.
-#
-# Tags: LabelService.createLabels
-
-require 'dfp_api'
-
-API_VERSION = :v201201
-# Number of labels to create.
-ITEM_COUNT = 5
-
-def create_labels()
-  # 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 LabelService.
-  label_service = dfp.service(:LabelService, API_VERSION)
-
-  # Create an array to store local label objects.
-  labels = (1..ITEM_COUNT).map do |index|
-    {:name => "Label #%d" % index, :type => 'COMPETITIVE_EXCLUSION'}
-  end
-
-  # Create the labels on the server.
-  return_labels = label_service.create_labels(labels)
-
-  if return_labels
-    return_labels.each do |label|
-      puts "Label with ID: %d, name: %s and type: %s was created." %
-          [label[:id], label[:name], label[:type]]
-    end
-  else
-    raise 'No labels were created.'
-  end
-
-end
-
-if __FILE__ == $0
-  begin
-    create_labels()
-
-  # 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/v201201/label_service/update_labels.rb

@@ -1,103 +0,0 @@
-#!/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 descriptions of all labels that are competitive
-# exclusion by updating its description up to the first 500. To determine which
-# labels exist, run get_all_labels.rb.
-#
-# This feature is only available to DFP premium solution networks.
-#
-# Tags: LabelService.getLabelsByStatement, LabelService.updateLabels
-
-require 'dfp_api'
-
-API_VERSION = :v201201
-
-def update_labels()
-  # 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 LabelService.
-  label_service = dfp.service(:LabelService, API_VERSION)
-
-  # Create a statement to only select labels that are competitive exclusion and
-  # active.
-  statement = {
-      :query => 'WHERE type = :type and isActive = true LIMIT 500',
-      :values => [
-          {:key => 'type',
-           :value => {
-               :value => 'COMPETITIVE_EXCLUSION',
-               :xsi_type => 'TextValue'}
-          }
-      ]
-  }
-
-  # Get labels by statement.
-  page = label_service.get_labels_by_statement(statement)
-
-  if page[:results]
-    labels = page[:results]
-
-    # Update each local label object by changing its description.
-    labels.each do |label|
-      label[:description] =
-          'These labels are still competiting with each other'
-    end
-
-    # Update the labels on the server.
-    return_labels = label_service.update_labels(labels)
-
-    if return_labels
-      return_labels.each do |label|
-        puts ("Label ID: %d, name: %s was updated with description: %s.") %
-            [label[:id], label[:name], label[:description]]
-      end
-    else
-      raise 'No labels were updated.'
-    end
-  else
-    puts 'No labels found to update.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_labels()
-
-  # 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/v201201/line_item_creative_association_service/deactivate_licas.rb

@@ -1,126 +0,0 @@
-#!/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 LICAs for the line item. To determine which LICAs
-# exist, run get_all_licas.rb. To determine which line items exist, run
-# get_all_line_items.rb.
-#
-# Tags: InventoryService.getLineItemsByStatement,
-#       InventoryService.performAdUnitAction
-
-require 'dfp_api'
-
-API_VERSION = :v201201
-PAGE_SIZE = 500
-
-def deactivate_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)
-
-  # Set the line item to get LICAs by.
-  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
-
-  # Create statement text to select active LICAs for a given line item.
-  statement_text = 'WHERE lineItemId = :line_item_id AND status = :status'
-
-  statement = {
-      :values => [
-          {:key => 'line_item_id',
-           :value => {:value => line_item_id, :xsi_type => 'NumberValue'}},
-          {:key => 'status',
-           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
-      ]
-  }
-
-  # Define initial values.
-  offset = 0
-  page = {}
-  creative_ids = []
-
-  begin
-    # Create a statement to get one page with current offset.
-    statement[:query] = statement_text +
-        " 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
-
-      page[:results].each do |lica|
-        puts ("%d) LICA with line item ID: %d, creative ID: %d and status: %s" +
-            " will be deactivated.") % [creative_ids.size, lica[:line_item_id],
-            lica[:creative_id], lica[:status]]
-        creative_ids << lica[:creative_id]
-      end
-    end
-  end while offset < page[:total_result_set_size]
-
-  puts "Number of LICAs to be deactivated: %d" % creative_ids.size
-
-  if !creative_ids.empty?
-    # Modify statement for action. Note, the values are still present.
-    statement[:query] = statement_text + " AND creativeId IN (%s)" %
-        creative_ids.join(', ')
-
-    # Perform action.
-    result = lica_service.perform_line_item_creative_association_action(
-        {:xsi_type => 'DeactivateLineItemCreativeAssociations'}, statement)
-
-    # Display results.
-    if result and result[:num_changes] > 0
-      puts "Number of LICAs deactivated: %d" % result[:num_changes]
-    else
-      puts 'No LICAs were deactivated.'
-    end
-  else
-    puts 'No LICAs found to deactivate.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    deactivate_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/v201201/line_item_service/activate_line_items.rb

@@ -1,130 +0,0 @@
-#!/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 activates all line items for the given order. To be activated,
-# line items need to be in the approved (needs creatives) state and have at
-# least one creative associated with them. To approve line items, approve the
-# order to which they belong by running approve_orders.rb. To create LICAs, run
-# create_licas.rb. To determine which line items exist, run
-# get_all_line_items.rb. To determine which orders exist, run get_all_orders.rb.
-#
-# Tags: LineItemService.getLineItemsByStatement,
-#       LineItemService.performLineItemAction
-
-require 'dfp_api'
-
-API_VERSION = :v201201
-PAGE_SIZE = 500
-
-def activate_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 only select line items from the specified order that
-  # are in the approved (needs creatives) state.
-  statement_text = 'WHERE orderID = :order_id AND status = :status'
-  statement = {
-      :values => [
-          {:key => 'order_id',
-           :value => {:value => order_id, :xsi_type => 'NumberValue'}},
-          {:key => 'status',
-           :value => {:value => 'NEEDS_CREATIVES', :xsi_type => 'TextValue'}}
-      ]
-  }
-
-  # Define initial values.
-  offset = 0
-  page = {}
-  line_item_ids = []
-
-  begin
-    # Create a statement to get one page with current offset.
-    statement[:query] = statement_text +
-        " 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
-
-      page[:results].each do |line_item|
-        if !line_item[:is_archived]
-          puts ("%d) Line item with ID: %d, order ID: %d and name: %s will " +
-              "be activated.") % [line_item_ids.size, line_item[:id],
-              line_item[:order_id], line_item[:name]]
-          line_item_ids << line_item[:id]
-        end
-      end
-    end
-  end while offset < page[:total_result_set_size]
-
-  puts "Number of line items to be activated: %d" % line_item_ids.size
-
-  if !line_item_ids.empty?
-    # Modify statement for action. Note, the values are still present.
-    statement[:query] = statement_text + " AND id IN (%s)" %
-        line_item_ids.join(', ')
-
-    # Perform action.
-    result = line_item_service.perform_line_item_action(
-        {:xsi_type => 'ActivateLineItems'}, statement)
-
-    # Display results.
-    if result and result[:num_changes] > 0
-      puts "Number of line items activated: %d" % result[:num_changes]
-    else
-      puts 'No line items were activated.'
-    end
-  else
-    puts 'No line items found to activate.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    activate_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/v201201/line_item_service/create_video_line_item.rb

@@ -1,155 +0,0 @@
-#!/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 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 = :v201201
-
-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