google-dfp-api 0.4.0 → 0.5.0

data/examples/v201108/creative_service/create_creatives.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 creates new image creatives for a given advertiser. To determine
-# which companies are advertisers, run get_companies_by_statement.rb. To
-# determine which creatives already exist, run get_all_creatives.rb.
-#
-# Tags: CreativeService.createCreatives
-
-require 'base64'
-require 'dfp_api'
-
-API_VERSION = :v201108
-# Number of creatives to create.
-ITEM_COUNT = 5
-
-def create_creatives()
-  # 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.
-  creative_service = dfp.service(:CreativeService, API_VERSION)
-
-  # Set the ID of the advertiser (company) that all creatives will be assigned
-  # to.
-  advertiser_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'.to_i
-
-  # Prepare image data for creative.
-  image_url =
-      'http://www.google.com/intl/en/adwords/select/images/samples/inline.jpg'
-  image_data = AdsCommon::Http.get(image_url)
-  image_data_base64 = Base64.encode64(image_data)
-
-  # Create an array to store local creative objects.
-  creatives = (1..ITEM_COUNT).map do |index|
-    {:xsi_type => 'ImageCreative',
-     :name => "Image creative #%d" % index,
-     :advertiser_id => advertiser_id,
-     :destination_url => 'http://www.google.com',
-     :image_name => 'image.jpg',
-     :size => {:width => 300, :height => 250, :is_aspect_ratio => false},
-     :image_byte_array => image_data_base64}
-  end
-
-  # Create the creatives on the server.
-  return_creatives = creative_service.create_creatives(creatives)
-
-  if return_creatives
-    return_creatives.each do |creative|
-      if creative[:creative_type] == 'ImageCreative'
-        puts ("Image creative with ID: %d, name: %s, size: %dx%d was " +
-            "created and can be previewed at: [%s]") %
-            [creative[:id], creative[:name],
-             creative[:size][:width], creative[:size][:height],
-             creative[:preview_url]]
-      else
-        puts "Creative with ID: %d, name: %s and type: %s was created." %
-            [creative[:id], creative[:name], creative[:creative_type]]
-      end
-    end
-  else
-    raise 'No creatives were created.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    create_creatives()
-
-  # 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/v201108/creative_service/get_creative.rb

@@ -1,71 +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 creative by its ID. To determine which creatives exist,
-# run get_all_creatives.rb.
-#
-# Tags: CreativeService.getCreative
-
-require 'dfp_api'
-
-API_VERSION = :v201108
-
-def get_creative()
-  # 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.
-  creative_service = dfp.service(:CreativeService, API_VERSION)
-
-  # Set the ID of the creative to get.
-  creative_id = 'INSERT_CREATIVE_ID_HERE'.to_i
-
-  # Get the creative.
-  creative = creative_service.get_creative(creative_id)
-
-  if creative
-    puts "Creative with ID: %d, name: %s and type: %s was found." %
-        [creative[:id], creative[:name], creative[:type]]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_creative()
-
-  # 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/v201108/creative_service/get_creatives_by_statement.rb

@@ -1,86 +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 image creatives. The statement retrieves up to the
-# maximum page size limit of 500. To create an image creative, run
-# create_creatives.rb.
-#
-# Tags: CreativeService.getCreativesByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201108
-
-def get_creatives_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 CreativeService.
-  creative_service = dfp.service(:CreativeService, API_VERSION)
-
-  # Create a statement to only select image creatives.
-  statement = {
-     :query => 'WHERE creativeType = :creative_type LIMIT 500',
-     :values => [
-         {:key => 'creative_type',
-          :value => {:value => 'ImageCreative', :xsi_type => 'TextValue'}}
-     ]
-  }
-
-  # Get creatives by statement.
-  page = creative_service.get_creatives_by_statement(statement)
-
-  if page[:results]
-    # Print details about each creative in results.
-    page[:results].each_with_index do |creative, index|
-      puts "%d) Creative ID: %d, name: %s, type: %s" %
-          [index, creative[:id], creative[:name], creative[:type]]
-    end
-  end
-
-  # Print a footer.
-  if page.include?(:total_result_set_size)
-    puts "Total number of creatives: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_creatives_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/v201108/custom_targeting_service/create_custom_targeting_keys_and_values.rb

@@ -1,117 +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 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 'dfp_api'
-
-API_VERSION = :v201108
-
-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/v201108/custom_targeting_service/delete_custom_targeting_values.rb

@@ -1,124 +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 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 'dfp_api'
-
-API_VERSION = :v201108
-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