google-dfp-api 0.6.3 → 0.7.0

data/examples/v201206/custom_targeting_service/create_custom_targeting_keys_and_values.rb

@@ -1,140 +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 custom targeting keys and values. To determine which
-# custom targeting keys and values exist, run
-# get_all_custom_targeting_keys_and_values.rb. To target these custom targeting
-# keys and values, run target_custom_criteria.rb.
-#
-# Tags: CustomTargetingService.createCustomTargetingKeys
-# Tags: CustomTargetingService.createCustomTargetingValues
-
-require 'dfp_api'
-
-API_VERSION = :v201206
-
-def create_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)
-
-  # Create predefined key.
-  gender_key = {:display_name => 'gender', :name => 'g', :type => 'PREDEFINED'}
-
-  # Create free-form key.
-  car_model_key = {:display_name => 'car model', :name => 'c',
-      :type => 'FREEFORM'}
-
-  # Create predefined key that may be used for content targeting.
-  genre_key = {:display_name => 'genre', :name => 'genre',
-      :type => 'PREDEFINED'}
-
-  # Create the custom targeting keys on the server.
-  return_keys = custom_targeting_service.create_custom_targeting_keys(
-      [gender_key, car_model_key, gender_key])
-
-  if return_keys
-    return_keys.each do |key|
-      puts ("Custom targeting key ID: %d, name: %s and display name: %s" +
-            " was created.") % [key[:id], key[:name], key[:display_name]]
-    end
-  else
-    raise 'No keys were created.'
-  end
-
-  # Create custom targeting value for the predefined gender key.
-  gender_male_value = {:custom_targeting_key_id => return_keys[0][:id],
-      :display_name => 'male', :match_type => 'EXACT'}
-  # Name is set to 1 so that the actual name can be hidden from website users.
-  gender_male_value[:name] = '1'
-
-  # Create another custom targeting value for the same key.
-  gender_female_value = {:custom_targeting_key_id => return_keys[0][:id],
-      :display_name => 'female', :name => '2', :match_type => 'EXACT'}
-
-  # Create custom targeting value for the free-form age key. These are values
-  # that would be suggested in the UI or can be used when targeting
-  # with a free-form custom criterion.
-  car_model_honda_civic_value = {
-      :custom_targeting_key_id => return_keys[1][:id],
-      :display_name => 'honda civic',
-      :name => 'honda civic',
-      # Setting match type to exact will match exactly "honda civic".
-      :match_type => 'EXACT'
-  }
-
-  # Create custom targeting values for the predefined genre key.
-  genre_comedy_value = {
-      :custom_targeting_key_id => return_keys[2][:id],
-      :display_name => 'comedy',
-      :name => 'comedy',
-      :match_type => 'EXACT'
-  }
-
-  genre_drama_value = {
-      :custom_targeting_key_id => return_keys[2][:id],
-      :display_name => 'drama',
-      :name => 'drama',
-      :match_type => 'EXACT'
-  }
-
-  # Create the custom targeting values on the server.
-  return_values = custom_targeting_service.create_custom_targeting_values(
-      [gender_male_value, gender_female_value, car_model_honda_civic_value,
-       genre_comedy_value, genre_drama_value])
-
-  if return_values
-    return_values.each do |value|
-      puts ("A custom targeting value ID: %d, name: %s and display name: %s" +
-          " was created for key ID: %d.") % [value[:id], value[:name],
-          value[:display_name], value[:custom_targeting_key_id]]
-    end
-  else
-    raise 'No values were created.'
-  end
-
-end
-
-if __FILE__ == $0
-  begin
-    create_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/v201206/custom_targeting_service/delete_custom_targeting_values.rb

@@ -1,125 +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 deletes custom targeting values for a given custom targeting key.
-# To determine which custom targeting keys and values exist, run
-# get_all_custom_targeting_keys_and_values.rb.
-#
-# Tags: CustomTargetingService.getCustomTargetingValuesByStatement
-# Tags: CustomTargetingService.performCustomTargetingValueAction
-
-require 'dfp_api'
-
-API_VERSION = :v201206
-PAGE_SIZE = 500
-
-def delete_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 ID of the custom targeting key to delete values from.
-  custom_targeting_key_id = 'INSERT_CUSTOM_TARGETING_KEY_ID_HERE'.to_i
-
-  # Create statement to only select custom values by the given custom targeting
-  # key ID.
-  statement_text = 'WHERE customTargetingKeyId = :key_id'
-
-  # Define initial values.
-  offset = 0
-  page = {}
-  custom_target_value_ids = []
-  statement = {
-      :values => [
-          {:key => 'key_id',
-           :value => {:value => custom_targeting_key_id,
-                      :xsi_type => 'NumberValue'}
-          }
-      ]
-  }
-
-  begin
-    # Create a statement to page through custom targeting values.
-    statement[:query] = statement_text + " LIMIT %d OFFSET %d" %
-        [PAGE_SIZE, 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
-      page[:results].each do |value|
-        # Add value ID to the list for deletion.
-        custom_target_value_ids << value[:id]
-      end
-    end
-  end while offset < page[:total_result_set_size]
-
-  # Print a footer.
-  puts "Number of custom targeting value to be deleted: %d" %
-      custom_target_value_ids.size
-
-  if !(custom_target_value_ids.empty?)
-    # Modify statement for action, note, values are still present.
-    statement[:query] = statement_text + " AND id IN (%s)" %
-        [custom_target_value_ids.join(', ')]
-
-    # Perform action.
-    result = custom_targeting_service.perform_custom_targeting_value_action(
-        {:xsi_type => 'DeleteCustomTargetingValues'}, statement)
-
-    # Display results.
-    if result and result[:num_changes] > 0
-      puts "Number of custom targeting values deleted: %d" %
-          result[:num_changes]
-    else
-      puts 'No custom targeting values were deleted.'
-    end
-  end
-end
-
-if __FILE__ == $0
-  begin
-    delete_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/v201206/inventory_service/create_ad_units.rb

@@ -1,101 +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 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.
-#
-# Tags: InventoryService.createAdUnits, NetworkService.getCurrentNetwork
-
-require 'dfp_api'
-
-API_VERSION = :v201206
-# 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/v201206/inventory_service/create_mobile_ad_unit.rb

@@ -1,100 +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 a new mobile 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.
-#
-# Mobile features need to be enabled on your account to use mobile targeting.
-#
-# Tags: InventoryService.createAdUnits, NetworkService.getCurrentNetwork
-
-require 'dfp_api'
-
-API_VERSION = :v201206
-
-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',
-     # 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