google-dfp-api 0.17.0 → 0.19.0

data/examples/v201508/forecast_service/get_availability_forecast_for_line_item.rb

@@ -1,84 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2015, 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 forecast for a prospective line item. To determine which
-# placements exist, run get_all_placements.rb.
-
-require 'dfp_api'
-
-API_VERSION = :v201508
-
-def get_availability_forecast_for_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 ForecastService.
-  forecast_service = dfp.service(:ForecastService, API_VERSION)
-
-  # Set the line item to get a forecast for.
-  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
-
-  # Set forecasting options.
-  forecast_options = {
-    :include_contending_line_items => True,
-    :include_targeting_criteria_breakdown => True,
-  }
-
-  # Get forecast for the line item.
-  forecast = forecast_service.get_availability_forecast_by_id(
-      line_item_id, forecast_options)
-
-  if forecast
-    # Display results.
-    matched = forecast[:matched_units]
-    available_percent = forecast[:available_units] * 100.0 / matched
-    unit_type = forecast[:unit_type].to_s.downcase
-    puts "%.2f %s matched." % [matched, unit_type]
-    puts "%.2f%% %s available." % [available_percent, unit_type]
-    puts "%d contending line items." % forecast[:contending_line_items].size
-    if forecast[:possible_units]
-      possible_percent = forecast[:possible_units] * 100.0 / matched
-      puts "%.2f%% %s possible." % [possible_percent, unit_type]
-    end
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_availability_forecast_for_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/v201508/forecast_service/get_delivery_forecast_for_line_items.rb

@@ -1,77 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2015, 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 delivery forecast for multiple line items. To determine
-# which placements exist, run get_all_placements.rb.
-
-require 'dfp_api'
-
-API_VERSION = :v201508
-
-def get_delivery_forecast_for_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 ForecastService.
-  forecast_service = dfp.service(:ForecastService, API_VERSION)
-
-  # Set the line items to get a forecast for.
-  line_item_id1 = 'INSERT_LINE_ITEM_ID_1_HERE'.to_i
-  line_item_id2 = 'INSERT_LINE_ITEM_ID_2_HERE'.to_i
-
-  # Get forecast for the line item.
-  forecast = forecast_service.get_delivery_forecast_by_ids(
-      [line_item_id1, line_item_id2], nil)
-
-  if forecast
-    forecast[:line_item_delivery_forecasts].each do |single_forecast|
-      # Display results.
-      unit_type = single_forecast[:unit_type]
-      puts ('Forecast for line item %d:\n\t%d %s matched\n\t%d %s ' +
-            'delivered\n\t%d %s predicted\n') % [
-                single_forecast[:line_item_id], single_forecast[:matched_units],
-                unit_type, single_forecast[:delivered_units], unit_type,
-                single_forecast[:predicted_delivery_units], unit_type]
-    end
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_delivery_forecast_for_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/v201508/inventory_service/create_ad_units.rb

@@ -1,97 +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 ad units under a the effective root ad unit. To
-# determine which ad units exist, run get_inventory_tree.rb or
-# get_all_ad_units.rb.
-
-require 'dfp_api'
-
-API_VERSION = :v201508
-# Number of ad units to create.
-ITEM_COUNT = 5
-
-def create_ad_units()
-  # 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 InventoryService.
-  inventory_service = dfp.service(:InventoryService, API_VERSION)
-
-  # Get the NetworkService.
-  network_service = dfp.service(:NetworkService, API_VERSION)
-
-  # Get the effective root ad unit ID of the network.
-  effective_root_ad_unit_id =
-      network_service.get_current_network[:effective_root_ad_unit_id]
-
-  puts "Using effective root ad unit: %d" % effective_root_ad_unit_id
-
-  # Create the creative placeholder.
-  creative_placeholder = {
-      :size => {:width => 300, :height => 250, :is_aspect_ratio => false},
-      :environment_type => 'BROWSER'
-  }
-
-  # Create an array to store local ad unit objects.
-  ad_units = (1..ITEM_COUNT).map do |index|
-    {:name => "Ad_Unit_%d" % index,
-     :parent_id => effective_root_ad_unit_id,
-     :description => 'Ad unit description.',
-     :target_window => 'BLANK',
-     # Set the size of possible creatives that can match this ad unit.
-     :ad_unit_sizes => [creative_placeholder]}
-  end
-
-  # Create the ad units on the server.
-  return_ad_units = inventory_service.create_ad_units(ad_units)
-
-  if return_ad_units
-    return_ad_units.each do |ad_unit|
-      puts "Ad unit with ID: %d, name: %s and status: %s was created." %
-          [ad_unit[:id], ad_unit[:name], ad_unit[:status]]
-    end
-  else
-    raise 'No ad units were created.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    create_ad_units()
-
-  # 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/v201508/inventory_service/create_mobile_ad_unit.rb

@@ -1,97 +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 a new mobile ad unit under the effective root ad unit.
-# To determine which ad units exist, run get_inventory_tree.rb or
-# get_all_ad_units.rb.
-#
-# Mobile features need to be enabled on your account to use mobile targeting.
-
-require 'dfp_api'
-
-API_VERSION = :v201508
-
-def create_mobile_ad_unit()
-  # 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 InventoryService.
-  inventory_service = dfp.service(:InventoryService, API_VERSION)
-
-  # Get the NetworkService.
-  network_service = dfp.service(:NetworkService, API_VERSION)
-
-  # Get the effective root ad unit ID of the network.
-  effective_root_ad_unit_id =
-      network_service.get_current_network[:effective_root_ad_unit_id]
-
-  puts "Using effective root ad unit: %s" % effective_root_ad_unit_id.to_s
-
-  # Create ad unit size.
-  ad_unit_size = {
-      :size => {:width => 400, :height => 300, :is_aspect_ratio => false},
-      :environment_type => 'BROWSER'
-  }
-
-  # Create local ad unit object.
-  ad_unit = {
-     :name => "Mobile_Ad_Unit_%d" % (Time.new.to_f * 1000).to_i,
-     :parent_id => effective_root_ad_unit_id,
-     :description => 'Mobile Ad unit description',
-     :target_window => 'BLANK',
-     :target_platform => 'MOBILE',
-     :mobile_platform => 'APPLICATION',
-     # Set the size of possible creatives that can match this ad unit.
-     :ad_unit_sizes => [ad_unit_size]
-  }
-
-  # Create the ad unit on the server.
-  return_ad_unit = inventory_service.create_ad_unit(ad_unit)
-
-  if return_ad_unit
-    puts "Ad unit with ID: %d, name: %s and status: %s was created." %
-        [return_ad_unit[:id], return_ad_unit[:name], return_ad_unit[:status]]
-  else
-    raise 'No ad units were created.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    create_mobile_ad_unit()
-
-  # 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/v201508/inventory_service/create_video_ad_unit.rb

@@ -1,104 +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 a new video ad unit under a the effective root ad unit.
-# To determine which ad units exist, run get_inventory_tree.rb or
-# get_all_ad_units.rb.
-#
-# This feature is only available to DFP premium solution networks.
-
-require 'dfp_api'
-
-API_VERSION = :v201508
-
-def create_video_ad_unit()
-  # 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 InventoryService.
-  inventory_service = dfp.service(:InventoryService, API_VERSION)
-
-  # Get the NetworkService.
-  network_service = dfp.service(:NetworkService, API_VERSION)
-
-  # Get the effective root ad unit ID of the network.
-  effective_root_ad_unit_id =
-      network_service.get_current_network[:effective_root_ad_unit_id]
-
-  puts "Using effective root ad unit: %s" % effective_root_ad_unit_id.to_s
-
-  # Create master ad unit size.
-  master_ad_unit_size = {
-      :size => {:width => 400, :height => 300, :is_aspect_ratio => false},
-      :environment_type => 'VIDEO_PLAYER',
-      # Add companions to master ad unit size.
-      :companions => [
-          {:size => {:width => 300, :height => 250, :is_aspect_ratio => false},
-           :environment_type => 'BROWSER'},
-          {:size => {:width => 728, :height => 90, :is_aspect_ratio => false},
-           :environment_type => 'BROWSER'}
-      ]
-  }
-
-  # Create local ad unit object.
-  ad_unit = {
-     :name => "Video_Ad_Unit_%d" % (Time.new.to_f * 1000).to_i,
-     :parent_id => effective_root_ad_unit_id,
-     :description => 'Video Ad unit description',
-     :target_window => 'BLANK',
-     :explicitly_targeted => true,
-     :target_platform => 'WEB',
-     # Set the size of possible creatives that can match this ad unit.
-     :ad_unit_sizes => [master_ad_unit_size]
-  }
-
-  # Create the ad unit on the server.
-  return_ad_unit = inventory_service.create_ad_unit(ad_unit)
-
-  if return_ad_unit
-    puts "Ad unit with ID: %d, name: %s and status: %s was created." %
-        [return_ad_unit[:id], return_ad_unit[:name], return_ad_unit[:status]]
-  else
-    raise 'No ad units were created.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    create_video_ad_unit()
-
-  # 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/v201508/inventory_service/deactivate_ad_units.rb

@@ -1,110 +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 deactivates all active ad units. To determine which ad units
-# exist, run get_all_ad_units.rb or get_inventory_tree.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-
-def deactivate_ad_units()
-  # 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 InventoryService.
-  inventory_service = dfp.service(:InventoryService, API_VERSION)
-
-  # Create statement text to select active ad units.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE status = :status',
-      [
-          {:key => 'status',
-           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
-      ]
-  )
-
-  ad_unit_ids = []
-
-  begin
-    # Get ad units by statement.
-    page = inventory_service.get_ad_units_by_statement(statement.toStatement())
-
-    if page[:results]
-      page[:results].each_with_index do |ad_unit, index|
-        puts ("%d) Ad unit with ID: %d, status: %s and name: %s will be " +
-              "deactivated.") % [index + statement.offset, ad_unit[:id],
-              ad_unit[:status], ad_unit[:name]]
-        ad_unit_ids << ad_unit[:id]
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.offset < page[:total_result_set_size]
-
-  puts "Number of ad units to be deactivated: %d" % ad_unit_ids.size
-
-  if !ad_unit_ids.empty?
-    # Modify statement for action. Note, the values are still present.
-    statement = DfpApi::FilterStatement.new(
-        "WHERE status = :status AND id in (%s)" % ad_unit_ids.join(', '),
-        [
-            {:key => 'status',
-             :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
-        ]
-    )
-
-    # Perform action.
-    result = inventory_service.perform_ad_unit_action(
-        {:xsi_type => 'DeactivateAdUnits'}, statement.toStatement())
-
-    # Display results.
-    if result and result[:num_changes] > 0
-      puts "Number of ad units deactivated: %d" % result[:num_changes]
-    else
-      puts 'No ad units were deactivated.'
-    end
-  else
-    puts 'No ad units found to deactivate.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    deactivate_ad_units()
-
-  # 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/v201508/inventory_service/get_ad_unit_sizes.rb

@@ -1,74 +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 code example gets all ad unit sizes.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-
-def get_all_ad_unit_sizes()
-  # 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 InventoryService.
-  inventory_service = dfp.service(:InventoryService, API_VERSION)
-
-  # Create statement select all ad unit sizes.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  # Get ad unit sizes by statement.
-  ad_unit_sizes = inventory_service.get_ad_unit_sizes_by_statement(
-      statement.toStatement())
-
-  if ad_unit_sizes
-    # Print details about each ad unit in results.
-    ad_unit_sizes.each_with_index do |ad_unit_size, index|
-      puts "%d) Web ad unit size of dimensions %s was found." %
-          [index, ad_unit_size[:full_display_string]]
-    end
-  else
-    puts 'No ad unit sizes found.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_ad_unit_sizes()
-
-  # 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