google-dfp-api 0.2.0 → 0.2.1

data/examples/v201103/company_service/get_company.rb

@@ -0,0 +1,72 @@
+#!/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 company by its ID. To determine which companies exist, run
+# get_all_companies.rb.
+#
+# Tags: CompanyService.getCompany
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201103
+
+def get_company()
+  # 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 CompanyService.
+  company_service = dfp.service(:CompanyService, API_VERSION)
+
+  # Set the ID of the company to get.
+  company_id = 'INSERT_COMPANY_ID_HERE'.to_i
+
+  # Get the company.
+  company = company_service.get_company(company_id)
+
+  if company
+    puts "Company with ID: %d, name: %s and type: %s was found." %
+        [company[:id], company[:name], company[:type]]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_company()
+
+  # 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/v201103/company_service/update_companies.rb

@@ -0,0 +1,95 @@
+#!/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 updates the names of all companies that are advertisers by
+# appending "LLC." up to the first 500. To determine which companies exist, run
+# get_all_companies.rb
+#
+# Tags: CompanyService.updateCompanies
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201103
+
+def update_companies()
+  # 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 CompanyService.
+  company_service = dfp.service(:CompanyService, API_VERSION)
+
+  # Create a statement to only select companies that are advertisers.
+  statement = {
+      :query => "WHERE type = :type LIMIT 500",
+      :values => [
+          {:key => 'type',
+           :value => {:value => 'ADVERTISER', :xsi_type => 'TextValue'}}
+      ]
+  }
+
+  # Get companies by statement.
+  page = company_service.get_companies_by_statement(statement)
+
+  if page[:results]
+    companies = page[:results]
+
+    # Update each local company object by appending ' LLC.' to its name.
+    companies.each {|company| company[:name] += ' LLC.'}
+
+    # Update the companies on the server.
+    return_companies = company_service.update_companies(companies)
+
+    if return_companies
+      return_companies.each do |company|
+        puts "A company with ID [%d], name: %s and type %s was updated." %
+            [company[:id], company[:name], company[:type]]
+      end
+    else
+      raise 'No companies were updated.'
+    end
+  else
+    puts 'No companies found to update.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    update_companies()
+
+  # 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/v201103/creative_service/copy_image_creatives.rb

@@ -0,0 +1,117 @@
+#!/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 copies a given set of image creatives. This would typically be
+# done to reuse creatives in a small business network. To determine which
+# creatives exist, run get_all_creatives.rb.
+#
+# Tags: CreativeService.getCreativesByStatement, CreativeService.createCreatives
+
+require 'rubygems'
+require 'dfp_api'
+
+require 'base64'
+
+API_VERSION = :v201103
+
+def copy_image_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 list of creative ids to copy.
+  image_creative_ids = [
+      'INSERT_IMAGE_CREATIVE_ID_HERE'.to_i,
+      'INSERT_IMAGE_CREATIVE_ID_HERE'.to_i,
+      'INSERT_IMAGE_CREATIVE_ID_HERE'.to_i,
+      'INSERT_IMAGE_CREATIVE_ID_HERE'.to_i
+  ]
+
+  # Create the statement to filter image creatives by ID.
+  statement = {
+      :query => "WHERE id IN (%s) AND creativeType = :creative_type" %
+          image_creative_ids.join(', '),
+      :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]
+
+    # Copy each local creative object and change its name.
+    new_creatives = creatives.map do |creative|
+      new_creative = creative.dup()
+      old_id = new_creative.delete(:id)
+      new_creative[:name] += " (Copy of %d)" % old_id
+      image_url = new_creative.delete(:image_url)
+      new_creative[:image_byte_array] =
+          Base64.encode64(AdsCommon::Http.get(image_url))
+      # Savon doesn't get us xsi_type back yet so we have to specify it.
+      new_creative[:xsi_type] = 'ImageCreative'
+      new_creative
+    end
+
+    # Create the creatives on the server.
+    return_creatives = creative_service.create_creatives(new_creatives)
+
+    # Display copied creatives.
+    if return_creatives
+      return_creatives.each_with_index do |creative, index|
+        puts "A creative with ID [%d] was copied to ID [%d], name: %s" %
+            [creatives[index][:id], creative[:id], creative[:name]]
+      end
+    else
+      raise 'No creatives were copied.'
+    end
+  else
+    puts 'No creatives found to copy.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    copy_image_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/v201103/creative_service/create_creatives.rb

@@ -0,0 +1,109 @@
+#!/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 'rubygems'
+require 'base64'
+require 'dfp_api'
+
+API_VERSION = :v201103
+# 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 = Array.new
+  ITEM_COUNT.times do |index|
+    creatives << {
+        :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/v201103/creative_service/get_all_creatives.rb

@@ -0,0 +1,93 @@
+#!/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 creatives. To create creatives, run create_creatives.rb.
+#
+# Tags: CreativeService.getCreativesByStatement
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201103
+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 = Hash.new
+
+  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