google-dfp-api 0.8.1 → 0.9.0

data/examples/v201211/content_service/get_content_by_category.rb

@@ -1,143 +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 active content categorized as "comedy" using the
-# network's content browse custom targeting key.
-#
-# This feature is only available to DFP video publishers.
-#
-# Tags: NetworkService.getCurrentNetwork
-# Tags: ContentService.getContentByStatementAndCustomTargetingValue
-# Tags: CustomTargetingService.getCustomTargetingValuesByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201211
-PAGE_SIZE = 500
-
-def get_content_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 NetworkService.
-  network_service = dfp.service(:NetworkService, API_VERSION)
-
-  # Get content browse custom targeting key ID.
-  current_network = network_service.get_current_network
-  content_browse_custom_targeting_key_id =
-      current_network[:content_browse_custom_targeting_key_id]
-
-  # Get the CustomTargetingService.
-  custom_targeting_service = dfp.service(:CustomTargetingService, API_VERSION)
-
-  # Create a statement to select the categories matching the name comedy.
-  statement = {
-      :query => 'WHERE customTargetingKeyId = :targeting_key_id' +
-          ' and name = :category LIMIT 1',
-      :values => [
-          {:key => 'targeting_key_id',
-           :value => {:value => content_browse_custom_targeting_key_id,
-                      :xsi_type => 'NumberValue'}},
-          {:key => 'category',
-           :value => {:value => 'comedy',
-                      :xsi_type => 'TextValue'}},
-      ]
-  }
-
-  # Get categories matching the filter statement.
-  page = custom_targeting_service.get_custom_targeting_values_by_statement(
-      statement)
-
-  # Get the custom targeting value ID for the comedy category.
-  if page[:results]
-    category_custom_targeting_value_id = page[:results].first()[:id]
-
-    # Get the ContentService.
-    content_service = dfp.service(:ContentService, API_VERSION)
-
-    # Define initial values.
-    offset = 0
-    page = {}
-
-    statement_text = 'WHERE status = :status'
-    statement = {
-        :query => statement_text,
-        :values => [
-            {:key => 'status',
-             :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
-        ]
-    }
-
-    begin
-      # Create a statement to get one page with current offset.
-      statement[:query] = statement_text +
-          " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
-
-      # Get content by statement.
-      page =
-          content_service.get_content_by_statement_and_custom_targeting_value(
-              statement, category_custom_targeting_value_id)
-
-      if page[:results]
-        # Increase query offset by page size.
-        offset += PAGE_SIZE
-
-        page[:results].each_with_index do |content, index|
-          puts "%d) Content ID: %d, name: %s, status: %s." %
-              [index + start_index, content[:id], content[:name],
-               content[:status]]
-        end
-      end
-    end while offset < page[:total_result_set_size]
-
-    # Print a footer.
-    if page.include?(:total_result_set_size)
-      puts "Number of results found: %d" % page[:total_result_set_size]
-    end
-  else
-    puts "Category was not found for targeting key ID %d." %
-        content_browse_custom_targeting_key_id
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_content_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/v201211/creative_service/copy_image_creatives.rb

@@ -1,115 +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 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 'dfp_api'
-
-require 'base64'
-
-API_VERSION = :v201211
-
-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, dfp.config))
-      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/v201211/creative_service/create_creative_from_template.rb

@@ -1,139 +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 creates a new template 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. To
-# determine which creative templates run get_all_creative_templates.rb.
-#
-# Tags: CreativeService.createCreative
-
-require 'base64'
-require 'dfp_api'
-
-API_VERSION = :v201211
-
-def create_creative_from_template()
-  # 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
-
-  # Use the image banner with optional third party tracking template.
-  creative_template_id = 10000680
-
-  # Create the local custom creative object.
-  creative = {
-      :xsi_type => 'TemplateCreative',
-      :name => 'Template creative',
-      :advertiser_id => advertiser_id,
-      :creative_template_id => creative_template_id,
-      :size => {:width => 300, :height => 250, :is_aspect_ratio => false}
-  }
-
-  # Prepare image data for asset value.
-  image_url =
-      'http://www.google.com/intl/en/adwords/select/images/samples/inline.jpg'
-  image_data = AdsCommon::Http.get(image_url, dfp.config)
-  image_data_base64 = Base64.encode64(image_data)
-
-  # Create the asset variable value.
-  asset_variable_value = {
-      :xsi_type => 'AssetCreativeTemplateVariableValue',
-      :unique_name => 'Imagefile',
-      :asset_byte_array => image_data_base64,
-      # Filenames must be unique.
-      :file_name => "image%d.jpg" % Time.new.to_i
-  }
-
-  # Create the image width variable value.
-  image_width_variable_value = {
-      :xsi_type => 'LongCreativeTemplateVariableValue',
-      :unique_name => 'Imagewidth',
-      :value => 300
-  }
-
-  # Create the image height variable value.
-  image_height_variable_value = {
-      :xsi_type => 'LongCreativeTemplateVariableValue',
-      :unique_name => 'Imageheight',
-      :value => 250
-  }
-
-  # Create the URL variable value.
-  url_variable_value = {
-      :xsi_type => 'UrlCreativeTemplateVariableValue',
-      :unique_name => 'ClickthroughURL',
-      :value => 'www.google.com'
-  }
-
-  # Create the target window variable value.
-  target_window_variable_value = {
-      :xsi_type => 'StringCreativeTemplateVariableValue',
-      :unique_name => 'Targetwindow',
-      :value => '__blank'
-  }
-
-  creative[:creative_template_variable_values] = [asset_variable_value,
-      image_width_variable_value, image_height_variable_value,
-      url_variable_value, target_window_variable_value]
-
-  # Create the creatives on the server.
-  return_creative = creative_service.create_creative(creative)
-
-  if return_creative
-    puts(("Template creative with ID: %d, name: %s and type '%s' was " +
-            "created and can be previewed at: '%s'") %
-            [return_creative[:id], return_creative[:name],
-             return_creative[:creative_type], return_creative[:preview_url]])
-  else
-    raise 'No creatives were created.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    create_creative_from_template()
-
-  # 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/v201211/creative_service/create_creatives.rb

@@ -1,106 +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 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 = :v201211
-# 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, dfp.config)
-  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