google-dfp-api 0.3.2 → 0.3.3

data/examples/v201206/creative_service/create_custom_creative.rb

@@ -0,0 +1,104 @@
+#!/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 custom creative 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.
+#
+# This feature is only available to DFP premium solution networks.
+#
+# Tags: CreativeService.createCreative
+
+require 'base64'
+require 'dfp_api'
+
+API_VERSION = :v201206
+
+def create_custom_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 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.
+  custom_creative = {
+      :xsi_type => 'CustomCreative',
+      :name => 'Custom creative',
+      :advertiser_id => advertiser_id,
+      :destination_url => 'http://www.google.com',
+      :custom_creative_assets => [
+          {:macro_name => 'IMAGE_ASSET',
+           :file_name => "image%d.jpg" % Time.new.to_i,
+           :asset_byte_array => image_data_base64}
+      ],
+      # Set the HTML snippet using the custom creative asset macro.
+      :html_snippet => "<a href='%%CLICK_URL_UNESC%%%%DEST_URL%%'>" +
+        "<img src='%%FILE:IMAGE_ASSET%%'/></a><br>Click above for great deals!",
+      # Set the creative size.
+      :size => {:width => 300, :height => 250, :is_aspect_ratio => false}
+  }
+
+  # Create the creatives on the server.
+  return_creative = creative_service.create_creative(custom_creative)
+
+  if return_creative
+    puts "Custom creative with ID: %d, name: '%s' and type: '%s' was created." %
+        [return_creative[:id], return_creative[:name],
+         return_creative[:creative_type]]
+  else
+    raise 'No creatives were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_custom_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/v201206/creative_service/get_all_creatives.rb

@@ -0,0 +1,93 @@
+#!/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 creatives. To create creatives, run create_creatives.rb.
+#
+# Tags: CreativeService.getCreativesByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201206
+PAGE_SIZE = 500
+
+def get_all_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)
+
+  # 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 creatives by statement.
+    page = creative_service.get_creatives_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 creative in results.
+      page[:results].each_with_index do |creative, index|
+        puts "%d) Creative ID: %d, name: %s, type: %s" %
+            [index + start_index, creative[:id],
+             creative[:name], creative[:type]]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # 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_all_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/v201206/creative_service/get_creative.rb

@@ -0,0 +1,72 @@
+#!/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 a creative by its ID. To determine which creatives exist,
+# run get_all_creatives.rb.
+#
+# Tags: CreativeService.getCreative
+
+require 'dfp_api'
+
+API_VERSION = :v201206
+
+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/v201206/creative_service/get_creatives_by_statement.rb

@@ -0,0 +1,87 @@
+#!/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 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 = :v201206
+
+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/v201206/creative_service/update_creatives.rb

@@ -0,0 +1,96 @@
+#!/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 updates the destination URL of all image creatives up to the
+# first 500. To determine which image creatives exist, run get_all_creatives.rb.
+#
+# Tags: CreativeService.getCreativesByStatement, CreativeService.updateCreatives
+
+require 'dfp_api'
+
+API_VERSION = :v201206
+
+def update_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)
+
+  # Create a statement to get first 500 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]
+    creatives = page[:results]
+
+    # Update each local creative object by changing its destination URL.
+    creatives.each do |creative|
+      creative[:destination_url] = 'http://news.google.com'
+    end
+
+    # Update the creatives on the server.
+    return_creatives = creative_service.update_creatives(creatives)
+
+    if return_creatives
+      return_creatives.each do |creative|
+        puts "Creative with ID: %d, name: %s and url: [%s] was updated." %
+            [creative[:id], creative[:name], creative[:destination_url]]
+      end
+    else
+      raise 'No creatives were updated.'
+    end
+  else
+    puts 'No creatives found to update.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    update_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