google-dfp-api 0.7.0 → 0.7.1

data/examples/v201311/custom_field_service/get_all_line_item_custom_fields.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2012, 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 fields that apply to line items. To create custom
+# fields, run create_custom_fields.rb.
+#
+# Tags: CustomFieldService.getCustomFieldsByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+
+def get_all_line_item_custom_fields()
+  # 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 CustomFieldService.
+  custom_field_service = dfp.service(:CustomFieldService, API_VERSION)
+
+  # Create statement to select only custom fields that apply to line items.
+  statement = {
+     :query => 'WHERE entityType = :entity_type',
+     :values => [
+         {:key => 'entity_type',
+          :value => {:value => 'LINE_ITEM', :xsi_type => 'TextValue'}}
+     ]
+  }
+
+  # Get custom fields by statement.
+  page = custom_field_service.get_custom_fields_by_statement(statement)
+
+  if page[:results]
+    # Print details about each custom field in results.
+    page[:results].each_with_index do |custom_field, index|
+      puts "%d) Custom field with ID %d and name: '%s' was found." %
+          [index, custom_field[:id], custom_field[:name]]
+    end
+  end
+
+  # Print a footer.
+  if page.include?(:total_result_set_size)
+    puts "Total number of custom fields: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_line_item_custom_fields()
+
+  # 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/v201311/custom_field_service/set_line_item_custom_field_value.rb

@@ -0,0 +1,135 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2012, 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 sets custom field values on a line item. To determine which
+# custom fields exist, run get_all_custom_fields.rb. To determine which line
+# items exist, run get_all_line_items.rb. To create custom field options, run
+# create_custom_field_options.rb.
+#
+# Tags: CustomFieldService.getCustomField, LineItemService.getLineItem
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+
+def set_line_item_custom_field_value()
+  # 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 CustomFieldService.
+  custom_field_service = dfp.service(:CustomFieldService, API_VERSION)
+
+  # Get the LineItemService.
+  line_item_service = dfp.service(:LineItemService, API_VERSION)
+
+  # Set the ID of the custom fields, custom field option, and line item.
+  custom_field_id = 'INSERT_CUSTOM_FIELD_ID_HERE'.to_i
+  drop_down_custom_field_id = 'INSERT_DROP_DOWN_CUSTOM_FIELD_ID_HERE'.to_i
+  custom_field_option_id = 'INSERT_CUSTOM_FIELD_OPTION_ID_HERE'.to_i
+  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
+
+  # Get custom field.
+  custom_field = custom_field_service.get_custom_field(custom_field_id)
+
+  # Get drop-down custom field.
+  drop_down_custom_field = custom_field_service.get_custom_field(
+      drop_down_custom_field_id)
+
+  # Get line item.
+  line_item = line_item_service.get_line_item(line_item_id)
+
+  if custom_field and drop_down_custom_field and line_item
+    # Create custom field values.
+    custom_field_value = {
+      :custom_field_id => custom_field[:id],
+      :type => 'CustomFieldValue',
+      :value => {:type => 'TextValue', :value => 'Custom field value'}
+    }
+
+    drop_down_custom_field_value = {
+      :custom_field_id => drop_down_custom_field[:id],
+      :type => 'DropDownCustomFieldValue',
+      :custom_field_option_id => custom_field_option_id
+    }
+
+    custom_field_values = [custom_field_value, drop_down_custom_field_value]
+    old_custom_field_values = line_item.include?(:custom_field_values) ?
+      line_item[:custom_field_values] : []
+
+    # Only add existing custom field values for different custom fields than the
+    # ones you are setting.
+    old_custom_field_values.each do |old_custom_field_value|
+      unless custom_field_values.map {|value| value[:id]}.include?(
+          old_custom_field_value[:custom_field_id])
+        custom_field_values << old_custom_field_value
+      end
+    end
+
+    line_item[:custom_field_values] = custom_field_values
+
+    # Update the line item on the server.
+    return_line_items = line_item_service.update_line_items([line_item])
+
+    return_line_items.each do |return_line_item|
+      custom_field_value_strings = []
+      if return_line_item.include?(:custom_field_values)
+        return_line_item[:custom_field_values].each do |value|
+          if value[:base_custom_field_value_type].eql?('CustomFieldValue')
+            custom_field_value_strings << "{ID: %d, value: '%s'}" %
+                [value[:custom_field_id], value[:value][:value]]
+          end
+          if value[:base_custom_field_value_type].eql?(
+              'DropDownCustomFieldValue')
+            custom_field_value_strings <<
+                "{ID: %d, custom field option ID: %d}" %
+                [value[:custom_field_id], value[:custom_field_option_id]]
+          end
+        end
+      end
+      puts "Line item ID %d set with custom field values: [%s]" %
+          [return_line_item[:id], custom_field_value_strings.join(', ')]
+    end
+  end
+end
+
+if __FILE__ == $0
+  begin
+    set_line_item_custom_field_value()
+
+  # 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/v201311/custom_field_service/update_custom_fields.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2012, 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 custom field descriptions. To determine which custom
+# fields exist, run get_all_custom_fields.rb.
+#
+# Tags: CustomFieldService.updateCustomFields
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+
+def update_custom_fields()
+  # 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 CustomFieldService.
+  custom_field_service = dfp.service(:CustomFieldService, API_VERSION)
+
+  # Set the ID of the custom field to update.
+  custom_field_id = 'INSERT_CUSTOM_FIELD_ID_HERE'.to_i
+
+  # Get custom field.
+  custom_field = custom_field_service.get_custom_field(custom_field_id)
+
+  if custom_field
+    # Update local custom field object.
+    custom_field[:description] = '' if custom_field[:description].nil?
+    custom_field[:description] +=' Updated.'
+
+    # Update the custom field on the server.
+    return_custom_fields =
+        custom_field_service.update_custom_fields([custom_field])
+
+    return_custom_fields.each do |custom_field|
+      puts "Custom field ID: %d, name: '%s' and description '%s' was updated." %
+          [custom_field[:id], custom_field[:name], custom_field[:description]]
+    end
+  else
+    puts 'No custom fields were found to update.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    update_custom_fields()
+
+  # 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/v201311/custom_targeting_service/create_custom_targeting_keys_and_values.rb

@@ -0,0 +1,140 @@
+#!/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 = :v201311
+
+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, genre_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/v201311/custom_targeting_service/delete_custom_targeting_keys.rb

@@ -0,0 +1,121 @@
+#!/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 key by its name. To determine which
+# custom targeting keys exist, run get_all_custom_targeting_keys_and_values.rb.
+#
+# Tags: CustomTargetingService.getCustomTargetingKeysByStatement
+# Tags: CustomTargetingService.performCustomTargetingKeyAction
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+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 = {}
+  custom_target_key_ids = []
+  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