google-dfp-api 0.13.1 → 0.15.0

data/examples/v201605/creative_service/create_native_creative.rb

@@ -0,0 +1,189 @@
+#!/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 = :v201605
+
+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/{v201505 → v201605}/creative_service/get_all_creatives.rb

@@ -21,7 +21,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_all_creatives()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/creative_service/get_creatives_by_statement.rb

@@ -23,7 +23,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_creatives_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/creative_service/update_creatives.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def update_creatives()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/creative_set_service/associate_creative_set_to_line_item.rb

@@ -22,7 +22,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def associate_creative_set_to_line_item()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/creative_set_service/create_creative_set.rb

@@ -20,7 +20,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def create_creative_set()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/creative_set_service/get_all_creative_sets.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_all_creative_sets()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/creative_set_service/get_creative_sets_by_statement.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_creative_sets_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/creative_set_service/update_creative_sets.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def update_creative_sets()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/creative_template_service/get_all_creative_templates.rb

@@ -21,7 +21,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_all_creative_templates()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/creative_template_service/get_system_defined_creative_templates.rb

@@ -21,7 +21,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_creative_templates_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/creative_wrapper_service/create_creative_wrappers.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def create_creative_wrappers()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/creative_wrapper_service/deactivate_creative_wrapper.rb

@@ -21,7 +21,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def deactivate_creative_wrappers()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/creative_wrapper_service/get_all_creative_wrappers.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_all_creative_wrappers()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/creative_wrapper_service/get_creative_wrappers_by_statement.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_creative_wrappers_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/creative_wrapper_service/update_creative_wrappers.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def update_creative_wrappers()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/custom_field_service/create_custom_field_options.rb

@@ -23,7 +23,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def create_custom_field_options()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/custom_field_service/create_custom_fields.rb

@@ -21,7 +21,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def create_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/custom_field_service/deactivate_all_line_item_custom_fields.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def deactivate_all_line_item_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/custom_field_service/get_all_custom_fields.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_all_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/custom_field_service/get_all_line_item_custom_fields.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_all_line_item_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/custom_field_service/set_line_item_custom_field_value.rb

@@ -24,7 +24,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def set_line_item_custom_field_value()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/custom_field_service/update_custom_fields.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def update_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/custom_targeting_service/create_custom_targeting_keys_and_values.rb

@@ -23,7 +23,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def create_custom_targeting_keys_and_values()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/custom_targeting_service/delete_custom_targeting_keys.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def delete_custom_targeting_keys()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/custom_targeting_service/delete_custom_targeting_values.rb

@@ -23,7 +23,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def delete_custom_targeting_values()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_all_custom_targeting_keys_and_values()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201505 → v201605}/custom_targeting_service/get_custom_targeting_keys_by_statement.rb

@@ -23,7 +23,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201505
+API_VERSION = :v201605
 
 def get_custom_targeting_keys_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.