API リファレンス

クラス: Tealium

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

addRemoteCommand()

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

Tealium.addRemoteCommand(id, callback);

例:

Tealium.addRemoteCommand("firebase", payload => {

  var eventName = payload["firebase_event_name"];
  var eventProperties = payload["firebase_event_properties"];

  analytics.logEvent(eventName, eventProperties);
});

addData()

指定された有効期限で永続データ保存にデータを追加します。

Tealium.addData(data, expiry);

コレクター

コレクターは、デバイスから補足情報を収集し、Tealium Customer Data Hubに送信される前にデータレイヤーに追加するモジュールです。いくつかのコレクターはコアライブラリに含まれており、他のコレクターは別のモジュールとしてインストールされています。

以下の表は、利用可能なコレクターをリストしています。デフォルトのコレクターはコレクター名の隣に*が付けられています。

これらのモジュールは、以下に説明されているTealiumConfigのcollectorsプロパティを使用して有効または無効にされます

ConsentExpiry

同意の構成の有効期限を定義します

例:

ConsentExpiry(90, TimeUnit.days)

TimeUnit

ConsentPolicy

遵守すべき同意ポリシーを定義します。TealiumConfigオブジェクトに同意ポリシーが定義されていない場合、同意マネージャーは無効になります。

例:

ConsentPolicy.gdpr

ディスパッチャー

ディスパッチャーは、データレイヤーからのデータを収集し、Tealiumのエンドポイントに送信するモジュールです。現在利用可能なディスパッチャーは以下の通りです:

少なくとも1つのディスパッチャーが必要です。ディスパッチャーが指定されていない場合、データはどこにも送信されません。

有効期限

カスタムデータの有効期限を定義します。

例：

Expiry.session

例：

ConsentExpiry(90, TimeUnit.days)

TimeUnit

gatherTrackData()

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

Tealium.gatherTrackData(callback);

例：

Tealium.gatherTrackData(value => {
   console.log("Track data: " + JSON.stringify(value))
});

getData()

永続データレイヤーで指定されたキーの値を取得し、コールバック関数の形で返します。

Tealium.getData(key, callback);

例：

Tealium.getData('test_session_key', value => {
   console.log("Value: " + value)
});

getConsentCategories()

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

Tealium.getConsentCategories(callback);

例：

Tealium.getConsentCategories(categories => {
    console.log("Consent Categories: " + categories)
});

getConsentStatus()

ユーザーの同意状態を取得し、コールバック関数の形で返します。

Tealium.getConsentStatus(callback);

例：

Tealium.getConsentStatus(status => {
    console.log("Consent Status: " + status)
});

getSessionId()

現在のセッションIDを取得し、コールバック関数の形で返します。

Tealium.getSessionId(callback);

例：

Tealium.getSessionId(value => {
    console.log("Sesssion ID: " + value)
});

getVisitorId()

ユーザーのビジターIDを取得し、コールバック関数の形で返します。

Tealium.getVisitorId(callback);

例：

Tealium.getVisitorId(value => {
    console.log("Visitor ID: " + value)
});

initialize()

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

Tealium.initialize(config);

例：

let config: TealiumConfig =
{
	account: 'tealiummobile',
	profile: 'demo',
	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, success => {
    if (!success) {
        // インスタンスの作成に失敗しました。
    }
    // 準備ができたら何かを行います
});

joinTrace()

指定されたIDでトレースに参加します。Tealium Customer Data HubのTrace機能についてもっと学びましょう。

Tealium.joinTrace(id);

leaveTrace()

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

Tealium.leaveTrace();

LogLevel

ログレベルプロパティを構成し、どれだけの情報がログに記録されるかを以下の値のいずれかで制御します：

例：

LogLevel.dev

setConsentCategories()

ユーザーの同意カテゴリを構成します。カテゴリの配列を渡して構成します。デフォルトは、ConsentStatusが.consentedに構成されるまで空の配列です。同意状態が.consentedでsetConsentCategories()メソッドでカテゴリが指定されていない場合、すべてのカテゴリが構成されます。

Tealium.setConsentCategories(categories);

例：

Tealium.setConsentCategories([ConsentCategories.analytics, ConsentCategories.email]);

同意カテゴリー

setConsentExpiryListener()

ユーザーの同意構成が期限切れになった後に実行するコールバックを定義します。ConsentExpiryに従います。

Tealium.setConsentExpiryListener(callback);

例:

Tealium.setConsentExpiryListener(() => {
    console.log("Consent Expired");
});

setConsentStatus()

ユーザーの同意状態を構成します。デフォルトは .unknown で、変更されるまでそのままです。

Tealium.setConsentStatus(status);

例:

Tealium.setConsentStatus(ConsentStatus.consented);

同意状態

setVisitorServiceListener()

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

VisitorServiceモジュールはTealium Customer Data HubのData Layer Enrichment機能を実装しています。

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

Tealium.setVisitorServiceListener(callback);

例:

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

removeData()

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

Tealium.removeData(keys);

removeRemoteCommand()

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

Tealium.removeRemoteCommand(id);

例:

Tealium.removeRemoteCommand("firebase");

TealiumEnvironment

環境はデフォルトの3つの環境（Dev, QA, Prod）またはTealiumが公開する任意のカスタム環境のいずれかです。これらの環境のいずれかを選択します。

例:

TealiumEnvironment.dev

TealiumConfig

以下は、TealiumConfig クラスのプロパティについての要約です。

terminateIntance()

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

Tealium.terminateIntance();

track()

TealiumEventまたはTealiumViewディスパッチでイベントを追跡します。

Tealium.track(dispatch);

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

訪問プロファイル

訪問プロファイルは、各属性に対して親しみやすい名前が含まれているオブジェクトです。currentVisitプロパティを使用して、訪問/訪問属性のタイプを区別できます。サブスクリプトを使用してIDで各属性値にアクセスします。属性が存在しない場合は、nullが返されます。以下のリストを参照してください。

属性タイプ

リモートコマンド

リモートコマンドを定義するインターフェース

パスとURLはオプションですが、どちらか一方のみを提供するか、Tealium iQタグ管理でタグによってマッピングが処理される場合は両方を省略します。

コマンドがReact Nativeアプリの範囲内で処理される場合は、コールバックを提供します。ハンドラが既にネイティブに登録されている場合は、コールバックを省略します。

以下は、Javascriptで処理されるコマンドのローカルマッピングファイルの例です：

let localCommand: RemoteCommand = {
    id: "hello-world",
    path: "hello-mappings.json",
    callback: (payload) => {
        //...
    }
}

以下は、ネイティブで処理されるコマンドのリモートマッピングファイルの例です：

let remoteNativeCommand: RemoteCommand = {
    id: "hello-world",
    url: "https://you.domain.com/hello-mappings.json"
}

インターフェース: TealiumDispatch

追跡するイベントのタイプを定義するインターフェース。以下のクラスがTealiumDispatchを実装しています：

クラス: TealiumEvent

ユーザーの画面とのやり取りを追跡するには、TealiumEvent(tealiumEvent, dataLayer)のインスタンスをtrack()メソッドに渡します。TealiumEventは、追跡コールにtealium_eventとして表示されるイベント名と、オプションのイベントデータオブジェクトで構成されます。

let tealEvent = TealiumEvent(tealiumEvent, {eventData})
tealium?.track(tealEvent)

例：

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

クラス: TealiumView

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

let screenView = TealiumView(tealiumEvent, {eventData})
tealium?.track(screenView)

例：

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