Tealium（ティリウム） | APIリファレンス | Tealium開発者ドキュメントプレビュー

クラス: `Tealium`

以下は、NativeScriptプラグインのTealiumクラスの一般的に使用されるメソッドとプロパティをまとめたものです。

メソッド/プロパティ	説明
`addRemoteCommand()`	リモートコマンドをリモートコマンドマネージャーに追加します
`addData()`	永続データストレージにデータを追加します
`consentCategories`	ユーザーの同意カテゴリーを取得または設定します
`consentStatus`	ユーザーの同意ステータスを取得または設定します
`getData()`	データレイヤーからデータを取得します
`gatherTrackData()`	すべてのコレクターとデータレイヤーからデータを収集します
`initialize()`	設定パラメーターでTealiumを初期化します
`joinTrace()`	指定したIDでトレースに参加します
`leaveTrace()`	アクティブなトレースセッションを終了します
`removeData()`	`addData()`を使用して以前に設定された永続データを削除します
`removeRemoteCommand()`	リモートコマンドマネージャーからリモートコマンドを削除します
`removeVisitorServiceListener()`	訪問者サービスリスナー/コールバックを削除します
`setVisitorServiceListener()`	訪問者サービスリスナー/コールバックを定義します
`terminateInstance()`	Tealiumライブラリを無効にし、すべてのモジュール参照を削除します
`track()`	イベントまたは画面ビューをトラックします
`visitorId`	現在の訪問者IDを取得します

`addRemoteCommand()`

リモートコマンドをリモートコマンドマネージャーに追加します。

Tealium.addRemoteCommand(id, callback);

パラメーター	タイプ	説明	例
`id`	`String`	タグの設定からのリモートコマンドIDの名前	`"test_command"`
`callback`	`Function`	リモートコマンドからのレスポンスを受け取った後に実行するコールバック関数。コールバックは、タグマッピングからのキーと値のペアのペイロードを返します。	(例を参照)

例:

Tealium.addRemoteCommand('mycommand', (result: any): void => {
	console.log(result["payload"]["command_id"]);            // "mycommand"をログに出力
	console.log(result["payload"]["my_remote_command_key"]); // "my_remote_command_key"のキーの値をログに出力
});

`addData()`

指定された有効期限の永続データストレージにデータを追加します。

Tealium.addData(data, expiry);

パラメーター	タイプ	説明	例
`data`	`Object`	キーと値のペアのマップ。キーは文字列で、値は文字列または文字列の配列です。	`{"persistent_key2" : "persistent_val2"}`
`expiry`	`Expiry`	データを永続化する期間	`Expiry.forever`

例:

let data: Map<string, any> = new Map([['test_session_data', 'test']]);
data.set('my_test_value', 1);
data['my_test_value'] = 1;
Tealium.addData(data, Expiry.session);

`Expiry`

プロパティの有効期限を設定するための有効期限を定義します。

次の有効期限オプションが利用可能です:

値	説明
`Expiry.session` (デフォルト)	現在のセッションの終了時に期限切れになります
`Expiry.forever`	アプリがインストールされている間は期限切れになりません
`Expiry.untilRestart`	デバイスが再起動されたときに期限切れになります

`consentCategories`

ユーザーの同意カテゴリーを取得または設定します。

ユーザーの同意カテゴリーを設定するには:

Tealium.consentCategories = categories

ユーザーの同意カテゴリーを取得するには:

let categories = Tealium.consentCategories

パラメーター	タイプ	説明	例
`categories`	`ConsentCategories[]`	ユーザーの同意カテゴリーの配列	`[ConsentCategories.email, ConsentCategories.personalization]`

例:

Tealium.consentCategories = [ConsentCategories.analytics, ConsentCategories.email];

次の同意カテゴリーが利用可能です:

値	説明
`analytics`	アナリティクス
`affiliates`	アフィリエイト
`displayAds`	広告表示
`email`	メール
`personalization`	パーソナライゼーション
`search`	検索
`social`	ソーシャル
`bigData`	ビッグデータ
`mobile`	モバイル
`engagement`	エンゲージメント
`monitoring`	モニタリング
`crm`	CRM
`cdp`	CDP
`cookieMatch`	Cookieマッチ
`misc`	その他

`consentStatus`

ユーザーの同意ステータスを取得または設定します。デフォルトは.unknownです。

ユーザーの同意ステータスを設定するには:

Tealium.consentStatus = status;

ユーザーの同意ステータスを取得するには:

let status = Tealium.consentStatus

パラメーター	タイプ	説明	例
`status`	`ConsentStatus`	ユーザーの同意ステータス	`ConsentStatus.consented`

例:

Tealium.consentStatus = ConsentStatus.consented;

次の同意ステータスが利用可能です:

値	説明
`.consented`	同意済み
`.notConsented`	同意されていない
`.unknown`	不明

`getData()`

データレイヤーからデータをanyタイプで取得します。

let data = Tealium.getData(key);

パラメーター	タイプ	説明	例
`key`	`String`	取得するデータのキー	`"KEY"`

let data: Tealium.getData("KEY")

`initialize()`

他のメソッドを呼び出す前にTealiumを初期化します。

Tealium.initialize(config);

パラメーター	タイプ	説明	例
`config`	`TealiumConfig`	Tealiumの設定パラメーター	(例を参照)

例:

let config: TealiumConfig =
{
	account: 'ACCOUNT',
	profile: 'PROFILE',
	environment: TealiumEnvironment.dev,
	dispatchers: [Dispatchers.Collect,
	 			  Dispatchers.TagManagement,
	  			Dispatchers.RemoteCommands],
	collectors: [Collectors.AppData,
				 Collectors.DeviceData,
				 Collectors.Lifecycle,
				 Collectors.Connectivity],
	consentLoggingEnabled: true,
	consentPolicy: ConsentPolicy.gdpr,
	visitorServiceEnabled: true
};

Tealium.initialize(config);

`joinTrace()`

指定したIDでトレースに参加します。Tealium Customer Data Hubのトレース機能について詳しくは、リンクを参照してください。

Tealium.joinTrace(id);

パラメーター	タイプ	説明	例
`id`	`String`	データソースキーから取得したトレースID	`abc123xy`

例:

Tealium.joinTrace("abc123xy");

`leaveTrace()`

トレースは、leaveTrace()メソッドが呼び出されるまでアプリのセッションの間アクティブなままであり、以前に参加したトレースを終了し、訪問者セッションを終了します。

Tealium.leaveTrace();

`removeData()`

Tealium.addData()を使用して以前に設定された永続データを削除します。

Tealium.removeData(keys);

パラメーター	タイプ	説明	例
`keys`	`String[]`	キー名の配列	`["foo", "bar"]`

例:

Tealium.removeData(["foo", "bar"]);

`gatherTrackData()`

すべてのコレクターとデータレイヤーからデータを収集します。

例:

Tealium.gatherTrackData((response: Map<string, any>): void => {				
	console.log(response);
});

`removeRemoteCommand()`

リモートコマンドマネージャーからリモートコマンドを削除します。

Tealium.removeRemoteCommand(id);

パラメーター	タイプ	説明	例
`id`	`String`	削除するコマンドIDの名前	`"test_command"`

例:

Tealium.removeRemoteCommand("test_command");

`setVisitorServiceListener()`

訪問者プロファイルが更新されたときに実行するコールバックを定義します。更新されたVisitorProfileは、コールバックのレスポンスで提供されます。

VisitorServiceモジュールは、Tealium Customer Data Hubのデータレイヤーエンリッチメント機能を実装しています。

このモジュールの使用は、Tealium AudienceStreamのライセンスを受けており、モバイルアプリケーションでユーザーエクスペリエンスを向上させるために訪問者プロファイルを使用したい場合に推奨されます。AudienceStreamのライセンスを受けていない場合、このモジュールの使用は推奨されません。

Tealium.setVisitorServiceListener(callback);

パラメーター	タイプ	説明	例
`callback`	`Function`	更新された訪問者プロファイルが返されたときに実行するコード	(例を参照)

次の例は、訪問者のオーディエンスとバッジをコンソールにログ出力します:

Tealium.setVisitorServiceListener(profile => {
    console.log(profile["audiences"]);
    console.log(profile["badges"]);
});

`terminateInstance()`

Tealiumライブラリを無効にし、すべてのモジュール参照を削除します。必要に応じて新しいTealiumインスタンスを作成して再度有効にします。

Tealium.terminateInstance();

`track()`

イベントまたは画面ビューをTealiumEventまたはTealiumViewディスパッチでトラックします。

Tealium.track(dispatch);

パラメーター	タイプ	説明	例
`dispatch`	`TealiumDispatch`	イベント/ビュー名とデータレイヤーを持つTealiumディスパッチ	`TealiumEvent("button_click", new Map([["button_name", "Submit"]]))`

`TealiumView`

画面ビューをトラックするには、TealiumView(viewName, data)のインスタンスをtrack()メソッドに渡します。TealiumViewは、トラッキングコールに表示されるビュー名（tealium_eventとして表示される）とオプションのデータディクショナリで構成されています。

let tealView = new TealiumView("VIEW_NAME", new Map([["key", "value"]]));
Tealium.track(tealView);

`TealiumEvent`

ビュー以外のイベントをトラックするには、TealiumEvent(eventName, data)のインスタンスをtrack()メソッドに渡します。TealiumEventは、トラッキングコールに表示されるイベント名（tealium_eventとして表示される）とオプションのデータディクショナリで構成されています。

以下は例です:

let tealEvent = new TealiumEvent("EVENT_NAME", new Map([["key", "value"]]));
Tealium.track(tealEvent);

`visitorId`

現在の訪問者IDを取得します。

let visitorId = Tealium.visitorId;

`TealiumDispatch`

トラックされるディスパッチのタイプ、イベントまたはタイトル、およびデータレイヤーを定義するインターフェースです。

クラス: Tealium

addRemoteCommand()

addData()

Expiry

consentCategories

consentStatus

getData()

initialize()

joinTrace()

leaveTrace()

removeData()

gatherTrackData()

removeRemoteCommand()

setVisitorServiceListener()

terminateInstance()

track()

TealiumView

TealiumEvent

visitorId

TealiumDispatch