Install

This guide shows how to add Tealium to your Roku app to track user activity. Before you begin, here’s a video introduction to the platform:

Requirements

Before proceeding, ensure you have satisfied the following requirements:

• Tealium Universal Data Hub account
• Roku SDK 7.2 or higher
• Active Roku Developer Account
• Roku Device

We recommend developing in Eclipse with the Roku plugin.

Install

The code for the Tealium Roku library is stored on Github. You must download and install the library.

• Download: Tealium for Roku

We recommend cloning the library (instead of downloading) to make it easier to update to future releases.

The code is organized as a sample app. The Tealium code files are located in sample_app/source/tealium. The following files must be imported into your project’s source folder:

• tealium.brs
• tealiumCollect.brs
• tealiumLog.brs

If you are using Eclipse, refresh your project to access the Tealium components.

The code for a sample app is available in the sample_app/source/application/main.brs file. Here you will see examples of adding button tracking and defining a callback function.

Watch this video for an overview of the installation and setup of the code:

Initialize

Once the Tealium components are added to your project you are ready to start coding. The Tealium instance must be invoked with the following parameters before you can begin tracking:

• account - the name of your account
• profile - the name of your profile
• log level - a number 0-3 where:
  • 0 = None
  • 1 = Errors
  • 2 = Warnings
  • 3 = Verbose
• environment - (optional) one of “qa” or “prod”
• datasource - (optional) the data source key rom UDH

Tealium objects are constructed using a builder pattern.

builder = TealiumBuilder("ACCOUNT", "PROFILE", 1)
builder.SetEnvironment("prod")
builder.SetDatasource("DATASOURCE")
teal = builder.Build()

Be sure to set an appropriate log level when your app is released to production.

Track

Once the Tealium instance has been defined you can begin tracking events with the method TrackEvent(), which takes the following parameters:

• Event Name (required) - a name to identify the event
• Event Data (optional) - Object with event data as key/value pairs
• Callback Function (optional) - Object with a function assigned to the “callback” key

data = CreateObject("roAssociativeArray")
data.someKey = "someValue"

cb = CreateObject("roAssociativeArray")
cb.callBack = Function (event)
    responseHeaders = event.GetResponseHeaders()
    responseKeys = responseHeaders.Keys()
    responseCode = event.GetResponseCode()

    for each key in responseKeys
        value = responseHeaders[key]
        print key + " : " + value
    End for
End Function

teal.TrackEvent("someEvent", data, cb)

The callback function can be used for a number of purposes, such as:

• building a retry or fallback system for failed calls
• building a queueing or throttling system
• customizing the Logger
• chaining application logic 

Change Log

1.1.0

• Update trackEvent takes an additional String type arg with one of the following values:
  • activity
  • conversion
  • derived
  • interaction
  • view
• Additional Tealium variable:
  • tealium_event_type

Python 1.0.0