google-dfp-api 0.6.3 → 0.7.0

data/examples/v201204/creative_template_service/get_creative_templates_by_statement.rb

@@ -1,80 +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 gets up to 500 system defined creative templates.
-#
-# Tags: CreativeTemplateService.getCreativeTemplatesByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201204
-
-def get_creative_templates_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 CreativeTemplateService.
-  creative_template_service = dfp.service(:CreativeTemplateService, API_VERSION)
-
-  # Create a statement to only select image creative_templates.
-  statement = {:query => 'LIMIT 500'}
-
-  # Get creative templates by statement.
-  page =
-      creative_template_service.get_creative_templates_by_statement(statement)
-
-  if page[:results]
-    # Print details about each creative template in results.
-    page[:results].each_with_index do |template, index|
-      puts "%d) Creative template ID: %d, name: %s, type: %s" %
-          [index, template[:id], template[:name], template[:type]]
-    end
-  end
-
-  # Print a footer.
-  if page.include?(:total_result_set_size)
-    puts "Total number of creative templates: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_creative_templates_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/v201204/custom_field_service/set_line_item_custom_field_value.rb

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

@@ -1,121 +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 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 = :v201204
-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

data/examples/v201204/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb

@@ -1,148 +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 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
-# Tags: CustomTargetingService.getCustomTargetingValuesByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201204
-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