google-dfp-api 0.6.2 → 0.6.3

data/examples/v201306/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 = :v201306
+
+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[: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/v201306/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 = :v201306
+
+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[: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/v201306/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 = :v201306
+
+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

data/examples/v201306/creative_set_service/associate_creative_set_to_line_item.rb

@@ -0,0 +1,77 @@
+#!/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 code example creates a line item creative association for a creative
+# set. To create creative sets, run create_creative_set.rb. To create creatives,
+# run create_creatives.rb. To determine which LICAs exist, run get_all_licas.rb.
+#
+# Tags: LineItemCreativeAssociationService.createLineItemCreativeAssociations
+
+require 'dfp_api'
+
+API_VERSION = :v201306
+
+def associate_creative_set_to_line_item()
+  # 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')
+
+  # Set the line item ID and creative set ID to associate.
+  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
+  creative_set_id = 'INSERT_CREATIVE_SET_ID_HERE'.to_i
+
+  # Get the LineItemCreativeAssociationService.
+  lica_service = dfp.service(:LineItemCreativeAssociationService, API_VERSION)
+
+  lica = {
+    :creative_set_id => creative_set_id,
+    :line_item_id => line_item_id
+  }
+
+  # Create the LICAs on the server.
+  return_lica = lica_service.create_line_item_creative_associations([lica])
+
+  puts 'A LICA with line item ID %d and creative set ID %d was created.' %
+      [return_lica[:line_item_id], return_lica[:creative_set_id]]
+end
+
+if __FILE__ == $0
+  begin
+    associate_creative_set_to_line_item()
+
+  # 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/v201306/creative_set_service/create_creative_set.rb

@@ -0,0 +1,83 @@
+#!/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 code example creates a new creative set.
+#
+# Tags: CreativeSetService.createCreativeSet
+
+require 'dfp_api'
+
+API_VERSION = :v201306
+
+def create_creative_set()
+  # 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')
+
+  master_creative_id = 'INSERT_MASTER_CREATIVE_ID_HERE'.to_i
+  companion_creative_id = 'INSERT_COMPANION_CREATIVE_ID_HERE'.to_i
+
+  # Get the CreativeSetService.
+  creative_set_service = dfp.service(:CreativeSetService, API_VERSION)
+
+  # Create an array to store local creative set object.
+  creative_set = {
+      :name => 'Creative set #%d' % (Time.new.to_f * 1000),
+      :master_creative_id => master_creative_id,
+      :companion_creative_ids => [companion_creative_id]
+  }
+
+  # Create the creative set on the server.
+  return_set = creative_set_service.create_creative_set(creative_set)
+
+  if return_set
+    puts ('Creative set with ID: %d, master creative ID: %d and companion ' +
+        'creative IDs: [%s] was created') %
+        [return_set[:id], return_set[:master_creative_id],
+         return_set[:companion_creative_ids].join(', ')]
+  else
+    raise 'No creative set was created.'
+  end
+
+end
+
+if __FILE__ == $0
+  begin
+    create_creative_set()
+
+  # 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/v201306/creative_set_service/get_all_creative_sets.rb

@@ -0,0 +1,94 @@
+#!/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 code example gets all creative sets. To create creative sets run
+# create_creative_set.rb.
+#
+# Tags: CreativeSetService.getCreativeSetsByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201306
+PAGE_SIZE = 500
+
+def get_all_creative_sets()
+  # 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 CreativeSetService.
+  creative_set_service = dfp.service(:CreativeSetService, API_VERSION)
+
+  # Define initial values.
+  offset = 0
+  page = {}
+
+  begin
+    # Create statement for one page with current offset.
+    statement = {:query => 'LIMIT %d OFFSET %d' % [PAGE_SIZE, offset]}
+
+    # Get creative sets by statement.
+    page = creative_set_service.get_creative_sets_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 set in results page.
+      page[:results].each_with_index do |set, index|
+        puts ('%d) Creative set ID: %d, master creative ID: %d and companion ' +
+            'creative IDs: [%s]') % [index + start_index, set[:id],
+            set[:master_creative_id], set[:companion_creative_ids].join(', ')]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Print a footer
+  if page.include?(:total_result_set_size)
+    puts "Total number of creative sets: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_creative_sets()
+
+  # 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