google-dfp-api 0.18.0 → 0.19.0

data/examples/v201608/creative_service/create_creatives.rb

@@ -1,108 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'base64'
-require 'dfp_api'
-
-API_VERSION = :v201608
-# 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)
-  size = {:width => 300, :height => 250}
-
-  # Create an array to store local creative objects.
-  creatives = (1..ITEM_COUNT).map do |index|
-    {
-        :xsi_type => 'ImageCreative',
-        :name => "Image creative #%d-%d" % [index, (Time.new.to_f * 1000).to_i],
-        :advertiser_id => advertiser_id,
-        :destination_url => 'http://www.google.com',
-        :size => size,
-        :primary_image_asset => {
-            :file_name => 'image.jpg',
-            :asset_byte_array => image_data_base64,
-            :size => size
-        }
-    }
-  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/v201608/creative_service/create_custom_creative.rb

@@ -1,103 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'base64'
-require 'dfp_api'
-
-API_VERSION = :v201608
-
-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, dfp.config)
-  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',
-           :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/v201608/creative_service/create_native_creative.rb

@@ -1,189 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2015, 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 native 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.
-#
-# The code in this example will use app data from the Google sample app
-# 'Pie Noon':
-#
-# https://play.google.com/store/apps/details?id=com.google.fpl.pie_noon&hl=en
-
-require 'base64'
-require 'dfp_api'
-
-API_VERSION = :v201608
-
-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
-
-  # Set the URLs of the application screenshot and the small application icon to
-  # use and convert them to byte array strings.
-  screenshot_url = 'https://lh4.ggpht.com/GIGNKdGHMEHFDw6TM2bgAUDKPQQRIReKZPq' +
-                   'EpMeEhZOPYnTdOQGaSpGSEZflIFs0iw=h300'
-  screenshot_data = AdsCommon::Http.get(screenshot_url, dfp.config)
-  screenshot_data_base64 = Base64.encode64(screenshot_data)
-
-  app_icon = 'https://lh6.ggpht.com/Jzvjne5CLs6fJ1MHF-XeuUfpABzl0YNMlp4' +
-             'RpHnvPRCIj4--eTDwtyouwUDzVVekXw=w300')
-  app_icon_data = AdsCommon::Http.get(app_icon, dfp.config)
-  app_icon_data_base64 = Base64.encode64(app_icon_data)
-
-  # Use the native creative template.
-  creative_template_id = 10004400
-
-  # Create the local custom creative object.
-  creative = {
-      :xsi_type => 'TemplateCreative',
-      :name => "Native creative %d" % Time.new.to_i,
-      :advertiser_id => advertiser_id,
-      :creative_template_id => creative_template_id,
-      :size => {:width => 1, :height => 1, :is_aspect_ratio => false},
-      :destination_url => 'https://play.google.com/store/apps/details?id=' +
-                          'com.google.fpl.pie_noon'
-  }
-
-  # Create the Image asset variable value.
-  image_variable_value = {
-      :xsi_type => 'AssetCreativeTemplateVariableValue',
-      :unique_name => 'Image',
-      :asset => {
-          :asset_byte_array => screenshot_data_base64,
-          # Filenames must be unique.
-          :file_name => "image%d.png" % Time.new.to_i
-      }
-  }
-
-  # Create the Appicon asset variable value.
-  appicon_variable_value = {
-      :xsi_type => 'AssetCreativeTemplateVariableValue',
-      :unique_name => 'Appicon',
-      :asset => {
-          :asset_byte_array => app_icon_data_base64,
-          # Filenames must be unique.
-          :file_name => "image%d.png" % Time.new.to_i
-      }
-  }
-
-  # Create the Price variable value.
-  price_variable_value = {
-      :xsi_type => 'StringCreativeTemplateVariableValue',
-      :unique_name => 'Price',
-      :value => 'Free'
-  }
-
-  # Create the Calltoaction variable value.
-  calltoaction_variable_value = {
-      :xsi_type => 'StringCreativeTemplateVariableValue',
-      :unique_name => 'Calltoaction',
-      :value => 'Install'
-  }
-
-  # Create the Starrating variable value.
-  starrating_variable_value = {
-      :xsi_type => 'StringCreativeTemplateVariableValue',
-      :unique_name => 'Starrating',
-      :value => '4'
-  }
-
-  # Create the Store variable value.
-  store_variable_value = {
-      :xsi_type => 'StringCreativeTemplateVariableValue',
-      :unique_name => 'Store',
-      :value => 'Google Play'
-  }
-
-  # Create the Headline variable value.
-  headline_variable_value = {
-      :xsi_type => 'StringCreativeTemplateVariableValue',
-      :unique_name => 'Headline',
-      :value => 'Pie Noon'
-  }
-
-  # Create the Body variable value.
-  body_variable_value = {
-      :xsi_type => 'StringCreativeTemplateVariableValue',
-      :unique_name => 'Body',
-      :value => 'Try multi-screen mode!'
-  }
-
-  # Create the DeeplinkclickactionURL variable value.
-  deeplinkurl_variable_value = {
-      :xsi_type => 'UrlCreativeTemplateVariableValue',
-      :unique_name => 'DeeplinkclickactionURL',
-      :value => 'market://details?id=com.google.fpl.pie_noon'
-  }
-
-  creative[:creative_template_variable_values] = [
-      deeplinkurl_variable_value,
-      body_variable_value,
-      headline_variable_value,
-      store_variable_value,
-      starrating_variable_value,
-      calltoaction_variable_value,
-      price_variable_value,
-      appicon_variable_value,
-      image_variable_value
-  ]
-
-  # Create the creatives on the server.
-  return_creative = creative_service.create_creatives([creative])[0]
-
-  if return_creative
-    puts(("Native creative with ID: %d and name: %s was " +
-            "created and can be previewed at: '%s'") %
-            [return_creative[:id], return_creative[:name],
-             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/v201608/creative_service/get_all_creatives.rb

@@ -1,80 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201608
-
-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)
-
-  # Create a statement to get one page with current offset.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  begin
-    # Get creatives by statement.
-    page = creative_service.get_creatives_by_statement(statement.toStatement())
-
-    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 + statement.offset, creative[:id],
-             creative[:name], creative[:creative_type]]
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.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