APIリファレンス | Cordova用Tealium |Tealiumドキュメント

クラス: `Tealium`

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

メソッド	説明
`addRemoteCommand()`	リモートコマンドをリモートコマンドマネージャに追加します。
`addData()`	永続データレイヤーにデータを追加します。
`gatherTrackData()`	コレクタとデータレイヤーからすべてのトラックデータを収集します。
`getData()`	データレイヤーから指定された値を取得します。
`getConsentCategories()`	ユーザーの同意済みカテゴリを取得します。
`getConsentStatus()`	ユーザーの同意ステータスを取得します。
`getVisitorId()`	現在のビジターIDを取得します。
`initialize()`	構成パラメータでTealiumを初期化します。
`joinTrace()`	指定されたIDでトレースに参加します。
`leaveTrace()`	アクティブなトレースセッションを終了します。
`removeData()`	`addData()`を使用して以前に構成された永続データを削除します。
`removeRemoteCommand()`	リモートコマンドマネージャからリモートコマンドを削除します。
`setConsentCategories()`	ユーザーの同意カテゴリを構成します。
`setConsentExpiryListener()`	同意の有効期限が切れたときに実行するコールバックを定義します。
`setConsentStatus()`	ユーザーの同意ステータスを構成します。
`setVisitorServiceListener()`	ビジターサービスリスナーまたはコールバックを定義します。
`terminateInstance()`	Tealiumインスタンスを無効にし、破棄します。
`track()`	イベントまたは画面ビューをトラックします。

`addRemoteCommand()`

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

tealium.addRemoteCommand(id, callback);

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

例:

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

パラメータ	タイプ	説明	例
`data`	`Object`	キーが文字列で値が文字列または文字列の配列であるキーと値のペアのJSONオブジェクト	`{"persistent_key2" : "persistent_val2"}`
`expiry`	`Expiry`	データを永続化する期間の長さ	`Expiry.forever`

コレクタ

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

以下の表は、利用可能なコレクタの一覧です。デフォルトのコレクタは、コレクタ名の横に * が付いています。

コレクタ名	TealiumConfig リファレンス
`AppData`*	`Collectors.AppData`
`Connectivity`*	`Collectors.Connectivity`
`Device`	`Collectors.Device`
`Lifecycle`	`Collectors.Lifecycle`

これらのモジュールは、構成オブジェクトの collectors プロパティを使用して有効または無効にすることができます。定数の値は window.tealium.utils.Collectors から利用できます。

同意の有効期限

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

パラメータ	タイプ	説明	例
`time`	`Number`	有効期限までの時間の量	`90`
`unit`	`TimeUnit`	有効期限までの時間の単位	`TimeUnit.days`

例:

var ConsentExpiry = tealium.utils.ConsentExpiry
var TimeUnit = tealium.utils.TimeUnit
ConsentExpiry.create(90, TimeUnit.days)

TimeUnit

値	説明
.minutes	分
.hours	時間
.months	月
.days	日

同意ポリシー

遵守する同意ポリシーを定義します。configオブジェクトに同意ポリシーが定義されていない場合、同意マネージャは無効になります。定数は window.tealium.utils.ConsentPolicy から利用できます。

例:

var ConsentPolicy = tealium.utils.ConsentPolicy
var gdpr = ConsentPolicy.gdpr

値	説明
.gdpr	GDPR
.ccpa	CCPA

ディスパッチャ

ディスパッチャは、データレイヤーからデータを送信し、Tealiumエンドポイントに送信するモジュールです。以下のディスパッチャが現在利用可能です - 定数は window.tealium.utils.Dispatchers から利用できます。

ディスパッチャ名	TealiumConfig リファレンス
`Collect`	`Dispatchers.Collect`
`RemoteCommands`	`Dispatchers.RemoteCommands`
`TagManagement`	`Dispatchers.TagManagement`

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

有効期限

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

例:

Expiry.session

値	説明
`session`	現在のアクティブなセッションの寿命
`untilRestart`	アプリが再起動するまで
`forever`	アプリの寿命の間、削除されるまで

例:

var Expiry = tealium.utils.Expiry
var session = Expiry.session

`gatherTrackData()`

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

tealium.gatherTrackData(callback)

パラメータ	タイプ	説明
`callback`	`Function`	トラックデータオブジェクトを使用するコールバック関数

例:

  tealium.gatherTrackData(function(data) {
    console.log(data)
  });

`getData()`

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

tealium.getData(key, callback);

パラメータ	タイプ	説明
`key`	`String`	データレイヤーから取得するキー
`callback`	`Function`	取得した値をキーに使用するコールバック関数

例:

tealium.getData(key, function(data) {
  console.log(data)
});

`getConsentCategories()`

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

tealium.getConsentCategories(callback);

パラメータ	タイプ	説明
`callback`	`Function`	同意カテゴリを使用するコールバック関数

例:

tealium.getConsentCategories(categories => {
    console.log("同意カテゴリ: " + categories)
});

`getConsentStatus()`

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

tealium.getConsentStatus(callback);

パラメータ	タイプ	説明
`callback`	`Function`	同意ステータスを使用するコールバック関数

例:

tealium.getConsentStatus(function(categories) {
  console.log("同意ステータス: " + status)
})

`getVisitorId()`

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

tealium.getVisitorId(callback);

パラメータ	タイプ	説明	例
`callback`	`Function`	ビジターIDを使用するコールバック関数	(例を参照)

例:

tealium.getVisitorId(function(visitorId) {
  console.log("ビジターID: " + visitorId)
})

`initialize()`

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

tealium.initialize(config);

パラメータ	タイプ	説明	例
`config`	`TealiumConfig`	Tealiumの構成パラメータ	(例を参照)
`callback`	`Function`	(オプション) Tealiumインスタンスが準備できた後に実行するコールバック関数	(例を参照)

例:

let Environment = tealium.utils.Environment;
let Collectors = tealium.utils.Collectors;
let Dispatchers = tealium.utils.Dispatchers;
let ConsentPolicy = tealium.utils.ConsentPolicy;
let Expiry = tealium.utils.Expiry;

let config = {
    account: 'tealiummobile',
    profile: 'demo',
    environment: Environment.dev,
    dispatchers: [
        Dispatchers.Collect,
        Dispatchers.TagManagement,
        Dispatchers.RemoteCommands
    ],
    collectors: [
        Collectors.AppData,
        Collectors.DeviceData,
        Collectors.Lifecycle,
        Collectors.Connectivity
    ],
    consentLoggingEnabled: true,
    // consentExpiry: {
    //     'time': 10,
    //     'unit': 'days'
    // },
    // consentPolicy: ConsentPolicy.gdpr,
    lifecycleAutotrackingEnabled: true,
    batchingEnabled: false,
    visitorServiceEnabled: true,
    useRemoteLibrarySettings: false
};

window.tealium.initialize(config, function(success) {
    console.log("初期化結果: " + success)
    if(success) {
        tealium.setVisitorServiceListener(logVisitorUpdated)
        tealium.setConsentExpiryListener(logConsentExpired)
        tealium.addRemoteCommand("hello-world", logRemoteCommand)
    }
})

`joinTrace()`

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

tealium.joinTrace(id);

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

`leaveTrace()`

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

tealium.leaveTrace();

LogLevel

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

値	説明
`LogLevel.dev`	アプリケーションの進行状況を示す情報イベント
`LogLevel.qa`	デバッグレベルのイベントで、アプリケーションのデバッグに使用されます
`LogLevel.prod`	クリティカルなエラーや障害などのエラーイベント
`LogLevel.silent`	ログなし（デフォルト）

例:

LogLevel.dev

`setConsentCategories()`

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

tealium.setConsentCategories(categories);

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

例:

var ConsentCategories = tealium.utils.ConsentCategories;

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

ConsentCategories

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

`setConsentExpiryListener()`

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

tealium.setConsentExpiryListener(callback);

パラメータ	タイプ	説明
`callback`	`Function`	同意が期限切れになった後に実行するコード

例:

tealium.setConsentExpiryListener(() => {
    print("同意が期限切れになりました");
});

`setConsentStatus()`

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

tealium.setConsentStatus(status);

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

例:

var ConsentStatus = window.tealium.utils.ConsentStatus

tealium.setConsentStatus(ConsentStatus.consented);

ConsentStatus

値	説明
`.consented`	ユーザーが同意済みです。
`.notConsented`	ユーザーが同意していません。
`.unknown`	ユーザーの同意ステータスが不明です。

`setVisitorServiceListener()`

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

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

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

tealium.setVisitorServiceListener(callback);

パラメータ	タイプ	説明
`callback`	`Function`	更新されたビジタープロファイルが返された後に実行するコード

例:

tealium.setVisitorServiceListener((profile) => {
    console.log(JSON.stringify(profile));
});

`removeData()`

tealium.addData()で以前に構成された永続データを削除します。

tealium.removeData(keys);

パラメータ	タイプ	説明	例
`keys`	`Array (Strings)`	キーの配列	`["foo", "bar"]`

`removeRemoteCommand()`

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

tealium.removeRemoteCommand(id);

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

例:

tealium.removeRemoteCommand("firebase");

TealiumEnvironment

環境は、3つのデフォルト環境（Dev、QA、Prod）またはTealiumが公開する任意のカスタム環境のいずれかを選択します。これらの環境のいずれかを選択します。定数は window.tealium.utils.Environment から利用できます。

例:

Environment.dev

値	説明
`.dev`	開発
`.qa`	QA/UAT
`.prod`	本番

Config

以下は、configオプションとそのキーのプロパティの概要です。

パラメータ	タイプ	説明	例
`account`	`String`	(必須) Tealiumアカウント名	`"companyXYZ"`
`profile`	`String`	(必須) Tealiumプロファイル名	`"main"`
`environment`	`TealiumEnvironment`	(必須) Tealium環境名	`"Environment.dev"`
`dataSource`	`String`	CDHデータソースキー	`"abc123"`
`collectors`	`Collectors[]`	(必須) 初期化するための`Collectors`のリストを構成します	`[Collectors.AppData]`
`dispatchers`	`Dispatchers[]`	(必須) 初期化するための`Dispatchers`のリストを構成します	`[Dispatchers.Collect]`
`customVisitorId`	`String`	カスタムビジターIDを構成します	`ALK2398LSDKJ3289SLKJ3298SLKJ3`
`memoryReportingEnabled`	`Boolean`	デバイスデータモジュールでメモリレポートを有効または無効にします（デフォルト: 無効）。	`true`
`overrideCollectURL`	`String`	Tealium Collect URLを別のエンドポイントに送信するためにオーバーライドします。イベントバッチング機能を使用している場合は、`overrideCollectBatchURL`プロパティもオーバーライドしてください。	`https://custom-domain.com/event`
`overrideCollectBatchURL`	`String`	Tealium CollectバッチURLを別のエンドポイントに送信するためにオーバーライドします。	`https://custom-domain.com/batch-event`
`overrideCollectProfile`	`String`	Tealium Collectプロファイルを別のTealiumプロファイルに送信するためにオーバーライドします。	`custom-profile`
`overrideCollectDomain`	`String`	Tealium Collect URLのドメイン名を別のエンドポイントに送信するためにオーバーライドします。	`custom-domain`
`overrideLibrarySettingsURL`	`String`	パブリッシュ構成URLをオーバーライドします。	`https://custom-domain.com/mobile.html`
`overrideTagManagementURL`	`String`	タグ管理モジュールで使用するデフォルトのURLをオーバーライドします。これは、Tealium iQタグ管理でJavaScriptファイルを自己ホストしている場合に必要です。	`https://custom-domain.com/path/env/utag.js`
`deepLinkTrackingEnabled`	`Boolean`	Facebookやその他のソースからアプリへのリンクなど、標準のディープリンクの自動トラッキングを有効または無効にします（デフォルト: 有効）	`false`
`qrTraceEnabled`	`Boolean`	QRトレースを有効または無効にします（デフォルト: 有効）	`false`
`loglevel`	`LogLevel`	ログレベルプロパティを構成し、ログに記録される情報の量を制御します（デフォルト: silent）	`LogLevel.dev`
`consentExpiry`	`ConsentExpiry`	ユーザーの同意構成の有効期限を構成します（デフォルトはポリシーに依存します）	`ConsentExpiry(90, TimeUnit.days)`
`consentLoggingEnabled`	`Boolean`	同意ステータスの変更を監査目的でTealium Customer Data Hubに送信する同意ログ機能を有効または無効にします（デフォルト: 有効）	true
`consentPolicy`	`ConsentPolicy`	CCPAまたはGDPRなどの同意ポリシーを構成します。このプロパティが構成されている場合にのみ同意マネージャが有効になります。	`ConsentPolicy.gdpr`
`lifecycleAutotrackingEnabled`	`Boolean`	ライフサイクルの自動トラッキングを有効または無効にします（デフォルト: 有効）	`false`
`useRemoteLibrarySettings`	`Boolean`	モバイルパブリッシュ構成を有効または無効にします（デフォルト: 有効）。Tealium iQタグ管理でモバイルパブリッシュ構成を構成するか、機能を無効にします。	`false`
`visitorServiceEnabled`	`Boolean`	データレイヤーエンリッチメントAPIを使用してビジタープロファイルを自動的に取得する機能を有効または無効にします（デフォルト: 無効）	`true`
`remoteCommands`	`RemoteCommand[]`	インスタンスが準備できた後に追加するRemoteCommandオブジェクトのリストを構成します	`[{ id: "hello-world", callback: (payload) => { console.log("hello-world: " + JSON.stringify(payload)); } }]`
`sessionCountingEnabled`	`Boolean`	Tealium iQアカウントのセッションカウントを有効または無効にします。Tealium JavaScriptファイルを自己ホストしている場合は、これを `false` に構成します（デフォルト: 有効）	`false`

Dispatch

イベントとビューを作成するためのユーティリティオブジェクト。

View

画面ビューをトラックするには、track()メソッドにビュー名とオプションのデータレイヤーを持つオブジェクトを渡します。これらは手動で提供するか、tealium.utils.Dispatch.view(viewName, dataLayer)のユーティリティメソッドを使用して提供できます。

例:

var Dispatch = tealium.utils.Dispatch
var tealView = Dispatch.view("VIEW_NAME", {"key": "value"})
tealium.track(tealView)

// 以下と同等です
tealium.track({
  type: "view",
  viewName: "VIEW_NAME",
  dataLayer: {"key": "value"}
})

Event

イベントをトラックするには、track()メソッドにイベント名とオプションのデータレイヤーを持つオブジェクトを渡します。これらは手動で提供するか、tealium.utils.Dispatch.event(eventName, dataLayer)のユーティリティメソッドを使用して提供できます。

例:

var Dispatch = tealium.utils.Dispatch
var tealEvent = Dispatch.event("EVENT_NAME", {"key": "value"})
tealium.track(tealEvent)

// 以下と同等です
tealium.track({
  type: "event",
  eventName: "EVENT_NAME",
  dataLayer: {"key": "value"}
})

`terminateIntance()`

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

tealium.terminateIntance();

`track()`

イベントまたはビューDispatchオブジェクトでイベントをトラックします。

tealium.track(dispatch);

パラメータ	タイプ	説明	例
`dispatch`	`Object`	イベント名とデータレイヤーを持つTealiumディスパッチ	`Dispatch.view("view name", {"key": "value"})`

VisitorProfile

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

属性タイプ

パラメータ	プロパティ	値
`arraysOfBooleans`	id: String, value: Boolean[]	`id: "5129", value: [true,false,true,true]`
`arraysOfNumbers`	id: String, value: Number[]	`id: "57", value: [4.82125, 16.8, 0.5714285714285714]`
`arraysOfStrings`	id: String, value: String[]	`id: "5213", value: ["green shirts", "green shirts", "blue shirts"]`
`audiences`	id: String, value: String	`id: "tealiummobile\_demo\_103", value: "iOS Users"`
`badges`	id: String, value: Boolean	`id: "2815", value: true`
`booleans`	id: String, value: Boolean	`id: "4868", value: true`
`currentVisit`	現在のビジットのビジタープロファイルのすべての属性。現在のビジットプロファイルには、AudiencesやBadgesは含まれません。	`TealiumCurrentVisitProfile(dates: ["5376": 1567536668080, "10": 1567536668000], booleans: ["4530": true], numbers: ["32": 3.8])`
`dates`	id: String, value: Number	`id: "22", value: 1567120112000`
`numbers`	id: String, value: Number	`id: "5728", value: 4.82125`
`setOfStrings`	id: String, value: Set(String)	`id: "5211", value: ["green shirts", "red shirts", "blue shirts"]`
`strings`	id: String, value: String	`id: "5380", value: "green shirts"`
`tallies`	id: String, value: Object	`"57": [["category 1": 2.0], "category 2": 1.0]]`
`tallyValue`	id: String, value: Number	`["category 1": 2.0]`

RemoteCommand

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

値	説明
`id`	リモートコマンドの一意の識別子名
`path`	(オプション) マッピングに使用するローカルファイル
`url`	(オプション) マッピングに使用するリモートファイル
`callback`	(オプション) リモートコマンドのコールバック関数

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

クラス: Tealium

addRemoteCommand()

addData()

コレクタ

同意の有効期限

TimeUnit

同意ポリシー

ディスパッチャ

有効期限

gatherTrackData()

getData()

getConsentCategories()

getConsentStatus()

getVisitorId()

initialize()

joinTrace()

leaveTrace()