Icareus Pixel

Icareus Pixel

Introduction

Icareus Suite provides a Javascript based HbbTV Advertising Library that can be included in any standard HbbTV Application. The JS is available from the Icareus Suite Cloud and the latest URL can be queried from Icareus.

Stable Release: 2.8


PRODUCTION URL (CDN MAPPED)

https://icareus-cache.secure2.footprint.net/hbbtv/libs/adverts/SuiteAdsLib2.8.min.js

USING THE JS

Suite audience measurement and Addressable TV Library inclusion

SuiteAdsLib.init( organizationId, applicationId, deviceId, channelName, serverType, streamEventTrigger, broadcastObjectId, customId, debug, applicationTypeId, parentEventId, sendExternalReports, campaignAPIVersion, interactionKey, keyReserveCallback, suiteChannelId, audienceEnabled, channelStartReportCallback, addressableEnabled, adFormDeviceTracker, channelCookieName, gaEnabled, analyticsServerPrefix);
 
Other functions (if needed)
SuiteAdsLib.disable(); //No reaction to stream events after this is called
SuiteAdsLib.enable(); //Normal function after this is called

Explanation Of Parameters

Parameter
 Info
 Type
 Values/Format
organizationId
 Can be queried from Icareus or can also be seen in the admin UI under Channels > Select a Channel > Value of organization ID
 Number
  
applicationId
 It is the ID of the HbbTV Broadband Launcher type application instance that is relevant to a particular campaign.
 Number
  
deviceId
 Some device ID for the HbbTV Device
 String/Text
  
channelName
 Precise name of the channel as is visible on the TV
 String/Text
  
serverType
 Type of the Icareus Suite server used
 Number
 0 = Beta, 1 = Production
broadcastObjectId
 ID attribute of the video/broadcast type HTML object (if exists)
 String/Text
  
customId
 Any external or custom ID to reference third party elements. e.g. ID of various regions
 String/Text
 "001", "012" etc. supported for now
debug
 If want to enable or disable debug logs
 Boolean
  
applicationTypeId
 Application typeId from suite
 Boolean
  
parentEventId
 If of parent event if any
 Boolean
  
sendExternalReports
 Whether to send reports to external sources (implemented per customer/requirement)
 Boolean
  
interactionKey
 Which color key to use for interacting with the ad(s)
 String
 BLUE,YELLOW
keyReserveCallback
 A callback function to call when/if a key is reserved by the Ads Library
 Function
  
suiteChannelId
 A valid linear channel ID from Icareus Suite Account
 Number
  
audienceEnabled
 Whether to report audience data or not
 Boolean
  
channelStartReportCallback
 Function to call when channel_start is reported
 Function. For use with Icareus Suite launcher only
  
addressableEnabled
 Whether to report addressabletv (advertising) data or not
 Boolean
  
adFormDeviceTracker
 Whether to use device tracking from Adform
 Boolean. Set to false if unsure
  
channelCookieName
 Name of channel tracking cookie
 String. Digita Only
  
gaEnabled
 Enable Google Analytics
 Boolean. For use with Icareus Suite launcher only
  
channelCookieName
 Name of channel tracking cookie
 String. For use with Icareus Suite launcher only
  

KEY RESERVE CALLBACK

The keyReserveCallback will be called as keyReserveCallback(true/false, key_code_of_key), and example can be seen below:

// In the host (code that includes the Ads JS)
var keyReserveCallback = function(reserved, keyCode) {
     if (reserved) {
         // The key with code keyCode is now reserved by adlibrary, manage local flags etc. as necessary
     }
};
SuiteAdsLib.init(.........., keyReserveCallback);

BETA: 2.10

TEST URL

https://suitecache.icareus.com/hbbtv/libs/test/SuiteAdsLib2.10.js

USING THE JS

SuiteAdsLib.init(organizationId, applicationId, deviceId, channelName, serverType, streamEventTrigger, broadcastObjectId, customId, debug, applicationTypeId, parentEventId, sendExternalReports, campaignAPIVersion, interactionKey, keyReserveCallback, suiteChannelId, audienceEnabled, channelStartReportCallback, addressableEnabled, adFormDeviceTracker, channelCookieName, gaEnabled, analyticsServerPrefix, destroyBroadcastObject);

Additional parameter
Parameter
Info
Type
Values/Format
destroyBroadcastObject
Whether or not to destroy/re-create the broadcastObject before adding the streamEventListener to it. Defaults to false if omitted.
Boolean


NEW FEATURES:

SUPPORT FOR HANDLING HTML5 BROADBAND PLAYERS FOR SHOWING ADS. THE BROADCASTOBJECTID CAN TAKE THE ID ATTRIBUTE OF AN HTML5 PLAYER.
SUPPORT FOR MULTIPLE SWITCH IN CAMPAIGNS AT THE SAME TIME ON THE SAME CHANNEL. NOTHING SPECIAL NEEDS TO BE CONFIGURED ON JS AS LONG AS VALID CAMPAIGNS ARE CONFIGURED ON SUITE.


    • Related Articles

    • Icareus Playout Products and Modules

      Foreword  Icareus Playout is a head-end platform targeted at broadcasters and operators to enhance their DVB networks to provide a better TV experience to their viewers. Icareus products included on the same product portfolio are: Icareus Playout EP ...

    • Introduction to Icareus Studio

      Icareus Studio is an easy-to use browser based video editor tool for all the marketing, communication, training and video content people that want to produce branded video content fast in Icareus Suite video cloud environment easily and fast without ...

    • Music Library

      Introduction to Music Library The user can add music to their video from the free music library. The library contains free music from various genres to use eg. as background music. Adding music to the timeline A music file from the library can be ...

    • Updating Icareus Playout

      Updating Icareus Playout 6 Introduction When updating Icareus Playout 6 to a newer version, for example from version 6.0.2.6 to 6.1.0.0, it's not necessary to install a new Operating System (OS). A successful update process involves copying new ...

    • Brand Media

      Introduction to Brand Media The concept of brand media is that all users can insert brand media files to their videos so that they follow the brand guidelines of your organization. This can include, for example, graphics following the visual ...