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`	クッキーマッチ
`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のTrace機能について詳しくはこちらをご覧ください。

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のData Layer Enrichment機能を実装しています。

このモジュールの使用は、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()`

オプショナルな関連データを持つ画面表示またはイベントを追跡します。

tealium?.track(tealEvent)

パラメータ	型	説明
`tealEvent`	string	TealiumDispatch で、イベント名を `tealium_event` 属性として渡し、オプショナルなイベントデータオブジェクトを含みます。

イベントを追跡するには、track() メソッドに TealiumEvent のインスタンスを渡します：

let tealEvent = new TealiumEvent(
	"cart_add", 
	new Map([
		[
			"customer_id": "abc123", 
			"product_id": ["PROD123", "PROD456"], 
			"product_price": [4.00, 6.00]
		]
	])
);
Tealium.track(tealEvent);

`visitorId`

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

let visitorId = Tealium.visitorId;

インターフェース: `TealiumDispatch`

追跡するディスパッチのタイプを定義するインターフェースです。次のクラスが TealiumDispatch を実装しています：

クラス: `TealiumEvent`

ユーザーの画面とのやり取りまたは画面表示を追跡するには、Track() メソッドに TealiumEvent(tealiumEvent, dataLayer) のインスタンスを渡します。TealiumEvent はイベント名を含み、追跡コールで tealium_event として表示され、オプショナルなデータ辞書が含まれます。

let tealEvent = new TealiumEvent(tealiumEvent, eventData);
Tealium.track(tealEvent);

パラメータ	型	説明
`tealiumEvent`	`string`	イベント名で、`tealium_event` 属性として渡されます。
`eventData`	`<string, object>`	オプショナル。イベントに送信されるキーと値の形式のデータ。

例:

let tealEvent = new TealiumEvent(
	"cart_add", 
	new Map([
		[
			"customer_id": "abc123", 
			"product_id": ["PROD123", "PROD456"], 
			"product_price": [4.00, 6.00]
		]
	])
);
Tealium.track(tealEvent);

クラス: `TealiumView`

画面表示を追跡するには、Track() メソッドに TealiumView(tealiumEvent, dataLayer) のインスタンスを渡します。TealiumView はビュー名を含み、追跡コールで tealium_event として表示され、オプショナルなデータ辞書が含まれます。

let screenView = new TealiumEvent(tealiumEvent, eventData);
Tealium.track(screenView);

パラメータ	型	説明
`tealiumEvent`	`string`	イベント名で、`tealium_event` 属性として渡されます。
`eventData`	`Dictionary<string, object>`	オプショナル。イベントに送信されるキーと値の形式のデータ。

例:

let screenView = new TealiumView(
	'purchase', 
	new Map([
		[
			'customer_id', 'abc123', 
			'order_total', 10.00, 
			'product_id', ["PROD123", "PROD456"], 
			'order_id': "0123456789"
		]
	])
);
Tealium.track(screenView);

クラス: Tealium

addRemoteCommand()

addData()

Expiry

consentCategories

consentStatus

getData()

initialize()

joinTrace()

leaveTrace()

removeData()

gatherTrackData()

removeRemoteCommand()

setVisitorServiceListener()

terminateInstance()

track()

visitorId

インターフェース: TealiumDispatch

クラス: TealiumEvent

クラス: TealiumView