google-dfp-api 0.2.8 → 0.3.0

data/examples/v201107/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb

@@ -1,147 +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 gets all custom targeting keys and the values. To create custom
-# targeting keys and values, run create_custom_targeting_keys_and_values.rb.
-#
-# Tags: CustomTargetingService.getCustomTargetingKeysByStatement,
-#       CustomTargetingService.getCustomTargetingValuesByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201107
-PAGE_SIZE = 500
-
-def get_all_custom_targeting_keys_and_values()
-  # 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 CustomTargetingService.
-  custom_targeting_service = dfp.service(:CustomTargetingService, 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 custom targeting keys by statement.
-    page = custom_targeting_service.get_custom_targeting_keys_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 key in results.
-      page[:results].each_with_index do |custom_targeting_key, index|
-        puts ("%d) Custom targeting key ID: %d, name: %s,  displayName: %s, " +
-              "type: %s") % [index + start_index,
-                             custom_targeting_key[:id],
-                             custom_targeting_key[:name],
-                             custom_targeting_key[:display_name],
-                             custom_targeting_key[:type]]
-        print_all_values_for_key(custom_targeting_service, custom_targeting_key)
-      end
-    end
-  end while offset < page[:total_result_set_size]
-
-  # Print a footer.
-  if page.include?(:total_result_set_size)
-    puts "Total number of targeting keys: %d" %
-        page[:total_result_set_size]
-  end
-end
-
-def print_all_values_for_key(custom_targeting_service, custom_targeting_key)
-  # Define initial values.
-  offset = 0
-  page = {}
-
-  # Create a statement to get values for given key.
-  statement_text = "WHERE customTargetingKeyId = :key_id LIMIT %d" % PAGE_SIZE
-  statement = {
-      :values => [
-          {:key => 'key_id',
-           :value => {:value => custom_targeting_key[:id],
-                      :xsi_type => 'NumberValue'}}
-      ]
-  }
-
-  begin
-    # Modify statement to get the next page.
-    statement[:query] = statement_text + " OFFSET %d" % offset
-
-    # Get custom targeting values by statement.
-    page = custom_targeting_service.get_custom_targeting_values_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 value in results.
-      page[:results].each_with_index do |custom_targeting_value, index|
-        puts ("\t%d) Custom targeting value ID: %d, name: %s, displayName: %s") %
-            [index + start_index,
-             custom_targeting_value[:id],
-             custom_targeting_value[:name],
-             custom_targeting_value[:display_name]]
-      end
-    end
-  end while offset < page[:total_result_set_size]
-
-  # Print a footer.
-  if page.include?(:total_result_set_size)
-    puts "\tTotal number of targeting values: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_custom_targeting_keys_and_values()
-
-  # 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/v201107/custom_targeting_service/get_custom_targeting_keys_by_statement.rb

@@ -1,91 +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 gets all predefined custom targeting keys. The statement
-# retrieves up to the maximum page size limit of 500. To create custom
-# targeting keys, run create_custom_targeting_keys_and_values.rb.
-#
-# Tags: CustomTargetingService.getCustomTargetingKeysByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201107
-
-def get_custom_targeting_keys_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 CustomTargetingService.
-  custom_targeting_service = dfp.service(:CustomTargetingService, API_VERSION)
-
-  # Create a statement to only select predefined custom targeting keys.
-  statement = {
-      :query => 'WHERE type = :type LIMIT 500',
-      :values => [
-          {:key => 'type',
-           :value => {:value => 'PREDEFINED', :xsi_type => 'TextValue'}}
-      ]
-  }
-
-  # Get custom targeting keys by statement.
-  page = custom_targeting_service.get_custom_targeting_keys_by_statement(
-      statement)
-
-  if page[:results]
-    # Print details about each key in results.
-    page[:results].each_with_index do |custom_targeting_key, index|
-      puts ("%d) Custom targeting key with ID [%d], name: %s," +
-          " displayName: %s type: %s") % [index,
-                                          custom_targeting_key[:id],
-                                          custom_targeting_key[:name],
-                                          custom_targeting_key[:display_name],
-                                          custom_targeting_key[:type]]
-    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_custom_targeting_keys_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/v201107/custom_targeting_service/get_custom_targeting_values_by_statement.rb

@@ -1,97 +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 gets custom targeting values for the given predefined custom
-# targeting key. The statement retrieves up to the maximum page size limit of
-# 500. To create custom targeting values, run
-# create_custom_targeting_keys_and_values.rb. To determine which custom
-# targeting keys exist, run get_all_custom_targeting_keys_and_values.rb.
-#
-# Tags: CustomTargetingService.getCustomTargetingValuesByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201107
-
-def get_custom_targeting_values_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 CustomTargetingService.
-  custom_targeting_service = dfp.service(:CustomTargetingService, API_VERSION)
-
-  # Set the ID of the custom targeting key to get custom targeting values for.
-  custom_targeting_key_id = 'INSERT_CUSTOM_TARGETING_KEY_ID_HERE'.to_i
-
-  # Create a statement to only select custom targeting values for a given key.
-  statement = {
-      :query => 'WHERE customTargetingKeyId = :key_id LIMIT 500',
-      :values => [
-          {:key => 'key_id',
-           :value => {:value => custom_targeting_key_id,
-                      :xsi_type => 'NumberValue'}
-          }
-      ]
-  }
-
-  # Get custom targeting values by statement.
-  page = custom_targeting_service.get_custom_targeting_values_by_statement(
-      statement)
-
-  if page[:results]
-    # Print details about each value in results.
-    page[:results].each_with_index do |custom_targeting_value, index|
-      puts ("%d) Custom targeting value with ID [%d], name: %s," +
-          " displayName: %s") % [index,
-                                 custom_targeting_value[:id],
-                                 custom_targeting_value[:name],
-                                 custom_targeting_value[:display_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_custom_targeting_values_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/v201107/custom_targeting_service/update_custom_targeting_values.rb

@@ -1,105 +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 display name of each custom targeting value up to
-# the first 500. To determine which custom targeting keys exist, run
-# get_all_custom_targeting_keys_and_values.rb.
-#
-# Tags: CustomTargetingService.getCustomTargetingValuesByStatement,
-#       CustomTargetingService.updateCustomTargetingValues
-
-require 'dfp_api'
-
-API_VERSION = :v201107
-
-def update_custom_targeting_values()
-  # 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 CustomTargetingService.
-  custom_targeting_service = dfp.service(:CustomTargetingService, API_VERSION)
-
-  # Set the ID of the custom targeting key to get custom targeting values for.
-  custom_targeting_key_id = 'INSERT_CUSTOM_TARGETING_KEY_ID_HERE'.to_i
-
-  # Create a statement to get first 500 custom targeting keys.
-  statement = {
-      :query => 'WHERE customTargetingKeyId = :key_id LIMIT 500',
-      :values => [
-          {:key => 'key_id',
-           :value => {:value => custom_targeting_key_id,
-                      :xsi_type => 'NumberValue'}
-          }
-      ]
-  }
-
-  # Get custom targeting keys by statement.
-  page = custom_targeting_service.get_custom_targeting_values_by_statement(
-      statement)
-  values = page[:results]
-
-  raise 'No targeting values found to update' if !values || values.empty?
-
-  # Update each local custom targeting values object by changing its display
-  # name.
-  values.each do |value|
-    display_name = (value[:display_name].nil?) ?
-        value[:name] : value[:display_name]
-    value[:display_name] = display_name + ' (Deprecated)'
-  end
-
-  # Update the custom targeting keys on the server.
-  result_values = custom_targeting_service.update_custom_targeting_values(values)
-
-  if result_values
-    # Print details about each value in results.
-    result_values.each_with_index do |custom_targeting_value, index|
-      puts ("%d) Custom targeting key with ID [%d], name: %s," +
-          " displayName: %s was updated") % [index, custom_targeting_value[:id],
-          custom_targeting_value[:name], custom_targeting_value[:display_name]]
-    end
-  else
-    puts 'No targeting keys values updated'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_custom_targeting_values()
-
-  # 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/v201107/forecast_service/get_forecast.rb

@@ -1,102 +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 gets a forecast for a prospective line item. To determine which
-# placements exist, run get_all_placements.rb.
-#
-# Tags: ForecastService.getForecast
-
-require 'dfp_api'
-
-API_VERSION = :v201107
-
-def get_forecast()
-  # 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 CreativeService.
-  forecast_service = dfp.service(:ForecastService, API_VERSION)
-
-  # Set the placement that the prospective line item will target.
-  targeted_placement_ids = ["INSERT_PLACEMENT_ID_HERE".to_i]
-
-  # Create targeting.
-  targeting = {
-      :inventory_targeting =>
-          {:targeted_placement_ids => targeted_placement_ids}
-  }
-
-  # Create prospective line item.
-  line_item = {
-    :line_item_type => 'SPONSORSHIP',
-    :targeting => targeting,
-    # Set the size of creatives that can be associated with this line item.
-    :creative_sizes =>
-        {:width => 300, :height => 250, :is_aspect_ratio => false},
-    # Set the line item's time to be now until the projected end date time.
-    :start_date_time_type => 'IMMEDIATELY',
-    :end_date_time => Time.utc(2012, 01, 01),
-    # Set the line item to use 50% of the impressions.
-    :unit_type => 'IMPRESSIONS',
-    :units_bought => 50,
-    # Set the cost type to match the unit type.
-    :cost_type => 'CPM'
-  }
-
-  # Get forecast for the line item.
-  forecast = forecast_service.get_forecast(line_item)
-
-  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]
-    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_forecast()
-
-  # 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