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

Dispatchers

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

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

Expiry

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

例:

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)
});

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のトレース機能について詳しくは、リンクを参照してください。

Tealium.joinTrace(id);

leaveTrace()

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

Tealium.leaveTrace();

LogLevel

ログレベルプロパティを構成し、ログに記録される情報の量を制御します。

例:

LogLevel.dev

setConsentCategories()

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

Tealium.setConsentCategories(categories);

例:

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

ConsentCategories

setConsentExpiryListener()

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

Tealium.setConsentExpiryListener(callback);

例:

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

setConsentStatus()

ユーザーの同意ステータスを構成します。デフォルトは .unknown です。

Tealium.setConsentStatus(status);

例:

Tealium.setConsentStatus(ConsentStatus.consented);

ConsentStatus

setVisitorServiceListener()

ビジタープロファイルが更新された後に実行するコールバックを定義します。更新された VisitorProfile は、コールバックの応答として提供されます。

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

このモジュールの使用は、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クラスのプロパティをまとめたものです。

TealiumDispatch

トラッキングするディスパッチのタイプを定義するインターフェースです。

TealiumView

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

以下は例です:

let tealView = TealiumView("VIEW_NAME", {"key": "value"})
Tealium.track(tealView)

TealiumEvent

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

以下は例です:

let tealEvent = TealiumEvent("EVENT_NAME", {"key": "value"})
Tealium.track(tealEvent)

terminateIntance()

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

Tealium.terminateIntance();

track()

TealiumEventまたはTealiumViewディスパッチを使用してイベントをトラッキングします。

Tealium.track(dispatch);

VisitorProfile

ビジタープロファイルは、各属性のフレンドリーな名前を含むオブジェクトです。currentVisitプロパティがあり、ビジター/ビジット属性タイプを区別することができます。各属性の値は、サブスクリプトを使用してIDでアクセスします。属性が存在しない場合は、nullが返されます。以下は例です。

属性タイプ

RemoteCommand

構成されたリモートコマンドを定義するインターフェースです。

pathと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"
}