google-dfp-api 0.2.0 → 0.2.1

data/examples/v201104/custom_targeting_service/create_custom_targeting_keys_and_values.rb

@@ -0,0 +1,118 @@
+#!/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 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,
+#       CustomTargetingService.createCustomTargetingValues
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201104
+
+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 the custom targeting keys on the server.
+  return_keys = custom_targeting_service.create_custom_targeting_keys(
+      [gender_key, car_model_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".
+  car_model_honda_civic_value[: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])
+
+  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/v201104/custom_targeting_service/delete_custom_targeting_keys.rb

@@ -0,0 +1,121 @@
+#!/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 deletes custom targeting key by its name. To determine which
+# custom targeting keys exist, run get_all_custom_targeting_keys_and_values.rb.
+#
+# Tags: CustomTargetingService.getCustomTargetingKeysByStatement,
+#       CustomTargetingService.performCustomTargetingKeyAction
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201104
+PAGE_SIZE = 500
+
+def delete_custom_targeting_keys()
+  # 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 name of the custom targeting key to delete.
+  custom_targeting_key_name = 'INSERT_CUSTOM_TARGETING_KEY_NAME_HERE'
+
+  # Create statement to only select custom targeting key by the given name.
+  statement_text = 'WHERE name = :name'
+
+  # Define initial values.
+  offset = 0
+  page = Hash.new
+  custom_target_key_ids = Array.new
+  statement = {
+      :values => [
+          {:key => 'name',
+           :value => {:value => custom_targeting_key_name,
+                      :xsi_type => 'TextValue'}
+          }
+      ]
+  }
+
+  begin
+    # Create a statement to page through custom targeting keys.
+    statement[:query] = statement_text + " LIMIT %d OFFSET %d" %
+        [PAGE_SIZE, offset]
+
+    page = custom_targeting_service.get_custom_targeting_keys_by_statement(
+        statement)
+
+    if page[:results]
+      # Increase query offset by page size.
+      offset += PAGE_SIZE
+      page[:results].each do |key|
+        # Add key ID to the list for deletion.
+        custom_target_key_ids << key[:id]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Print a footer.
+  puts "Number of custom targeting keys to be deleted: %d" %
+      custom_target_key_ids.size
+
+  if !(custom_target_key_ids.empty?)
+    # Modify statement for action.
+    statement = {:query => "WHERE id IN (%s)" %
+        [custom_target_key_ids.join(', ')]}
+
+    # Perform action.
+    result = custom_targeting_service.perform_custom_targeting_key_action(
+        {:xsi_type => 'DeleteCustomTargetingKeys'}, statement)
+
+    # Display results.
+    if result and result[:num_changes] > 0
+      puts "Number of custom targeting keys deleted: %d" % result[:num_changes]
+    else
+      puts 'No custom targeting keys were deleted.'
+    end
+  end
+end
+
+if __FILE__ == $0
+  begin
+    delete_custom_targeting_keys()
+
+  # 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/v201104/custom_targeting_service/delete_custom_targeting_values.rb

@@ -0,0 +1,125 @@
+#!/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 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,
+#       CustomTargetingService.performCustomTargetingValueAction
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201104
+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 = Hash.new
+  custom_target_value_ids = Array.new
+  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/v201104/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb

@@ -0,0 +1,148 @@
+#!/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 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201104
+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 = Hash.new
+
+  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 = Hash.new
+
+  # 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