APIリファレンス

以下では、Tealium for Rokuライブラリで提供されている関数を示します。Roku用アプリは、強力なスクリプト言語であるBrightScriptで作成されています。BrightScriptの詳細については、こちらを参照してください。

クラス：`TealiumBuilder`

以下は、Rokuライブラリで一般的に使用されるTealiumBuilderクラスのメソッドをまとめたものです。

メソッド	説明
`SetDatasource()`	`Tealium`オブジェクトのデータソースキーを構成します
`SetEnvironment()`	`Tealium`オブジェクトの環境を構成します
`SetLogLevel()`	`Tealium`オブジェクトのログレベルを構成します
`TealiumBuilder()`	`Tealium`オブジェクトの初期化に役立つビルダーコンストラクタ関数

Tealiumオブジェクトのデータソースキーを構成します。

SetDatasource(datasource)

パラメータ	型	説明	例
`datasource`	`String`	データソースキー	“def456”

Tealiumオブジェクトの環境を構成します。

SetEnvironment(environment)

パラメータ	型	説明	例
`environment`	`String`	Tealium環境の名前	[`"dev"`, `"qa"`, `"prod"`]

Tealiumオブジェクトのログレベルを構成します。

SetLogLevel(logLevel)

パラメータ	型	説明	例
`logLevel`	整数	Tealiumログレベル	`1`

Tealiumオブジェクトの初期化に役立つビルダー関数。ユーティリティ関数を使って任意のパラメータを構成します。Build()を呼び出してTealiumオブジェクトを作成します。

TealiumBuilder(account, profile, logLevel)

パラメータ	型	説明	例
`account`	`String`	Tealiumアカウントの名前	`"account123"`
`profile`	`String`	Tealiumプロファイルの名前（デフォルト：`"main"`）	`"main"`
`logLevel`	`String`	ログレベル	`1`

以下は、Rokuライブラリで一般的に使用されるTealiumCoreクラスのメソッドをまとめたものです。

メソッド	説明
`ToStr()`	現在のTealiumインスタンスの構成の詳細を含む判読可能な文字列を返します
`TrackEvent()`	関連付けられたデータを含むイベントをトラッキングし、任意でコールバック関数をトリガーします
`ResetSessionId()`	リセットして新しいセッションIDを返します

現在のTealiumインスタンスの構成の詳細を含む判読可能な文字列を返します。

ToStr()

戻り値	戻り値の型	例
Readable String containing the configuration details of the current Tealium instance	`String`	`"Tealium instance for account: ACCOUNT profile: PROFILE environment: ENV"`

関連付けられたデータを含むイベントをトラッキングし、任意でコールバック関数をトリガーします。

trackEvent(eventType, eventName, data, callback)

パラメータ	型	説明
`eventType`	`String`	Tealiumのイベントの種類（アクティビティ、コンバージョン、インタラクション、ビュー）
`eventName`	`String`	イベントの名前（Tealium Customer Data Hubの`event_name`属性になります）
`data`	`Object`	コンテクスチュアルイベントデータである、キーと値のペアを含む`roAssociativeArray`オブジェクト
`callback`	`Object`	`roEvent`引数を受け取る"callback"という名前の関数プロパティを持つオブジェクト。このコールバック関数は、TrackEventコールの完了時にトリガーされます。

コールバック関数は、以下を含む複数の目的で使用されます。

リセットして新しいセッションIDを返します。このセッションIDは、ウェブサイトセッションと同様に、現在のユーザーセッションを識別しますが、有効期限がありません。createTealium()が呼び出されるたびに、新しいセッションIDが作成されます。

resetSessionId() as Integer

戻り値	戻り値の型
A new session ID	`Integer`