Tealium

クラス: Tealium

以下は、FlutterのTealiumクラスでよく使用されるメソッドをまとめたものです。

メソッド	説明
addCustomRemoteCommand()	リモートコマンドマネージャーにリモートコマンドのコールバックを追加します。
addRemoteCommand()	リモートコマンドマネージャーにリモートコマンドを追加します
addToDataLayer()	永続的なデータレイヤーにデータを追加します
clearStoredVisitorIds()	訪問IDの保存されたキャッシュを削除し、resetVisitorIdを呼び出します。
deleteFromDataLayer()	addToDataLayer()を使用して以前に構成されたデータレイヤーから単一のキー値ペアを削除します
gatherTrackData()	すべてのコレクターとデータレイヤーからデータを収集します
getFromDataLayer()	永続的なデータレイヤーで指定されたキーの値を取得します
getConsentCategories()	ユーザーの同意したカテゴリを取得します
getConsentStatus()	ユーザーの同意状態を取得します
getVisitorId()	ユーザーの訪問IDを取得します
initialize()	構成パラメーターでTealiumを初期化します
joinTrace()	指定されたIDでトレースに参加します
leaveTrace()	以前に参加したトレースを離れ、訪問セッションを終了します
removeFromDataLayer()	addToDataLayer()を使用して以前に構成された永続的なデータキー値ペアのリストを削除します
removeRemoteCommand()	リモートコマンドマネージャーからリモートコマンドを削除します
resetVisitorId()	ユーザーの新しい訪問IDを生成します。
setConsentCategories()	ユーザーの同意カテゴリを構成します
setConsentExpiryListener()	同意期限切れリスナー/コールバックを構成します
setConsentStatus()	ユーザーの同意状態を構成します
setVisitorIdListener()	visitorIdの変更に関するリスナーを追加します。
setVisitorServiceListener()	訪問サービスリスナー/コールバックを構成します
terminateInstance()	Tealiumライブラリを無効にし、すべてのモジュール参照を削除することでTealiumインスタンスを終了します
track()	イベントまたは画面表示を追跡します

addCustomRemoteCommand()

Tealium iQタグ管理のタグに基づいてリモートコマンドマネージャーにカスタムリモートコマンドを追加します。

Tealium.addCustomRemoteCommand(id, callback);

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

例:

Tealium.addRemoteCommand('CUSTOM_COMMAND_ID', (payload) => {
  print(JsonEncoder().convert(payload));
});

addRemoteCommand()

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

Tealium.addRemoteCommand(remoteCommand);

パラメータ	タイプ	説明	例
remoteCommand	RemoteCommand	パス、URL、またはウェブビュー構成を持つ事前に構築されたリモートコマンド。	下記の例を参照。

例:

Tealium.addRemoteCommand(RemoteCommand(TealiumFirebase.commandName, path: "firebase.json")); // local
Tealium.addRemoteCommand(RemoteCommand(TealiumFirebase.commandName, url: "www.tealium.com/path_to_remote_command/firebase.json")); // remote
Tealium.addRemoteCommand(RemoteCommand(TealiumFirebase.commandName)); // webview

addToDataLayer()

指定された有効期限のために永続的なデータレイヤーにデータを追加します。

Tealium.addToDataLayer(data, expiry);

パラメータ	タイプ	説明	例
data	Object	文字列のキーと、値が文字列または文字列の配列であるキー値ペアのJSONオブジェクト	{'persistent_key' : 'persistent_val'}
expiry	Expiry	データを永続させる時間の長さ	Expiry.forever

clearStoredVisitorIds()

以前に保存された訪問IDとハッシュ化された顧客識別子をすべてクリアします。

Tealium.clearStoredVisitorIds()

deleteFromDataLayer()

addToDataLayer()を使用して以前に構成されたデータレイヤーから単一のキー値ペアを削除します。

Tealium.deleteFromDataLayer(key);

パラメータ	タイプ	説明	例
key	String	データレイヤーから取得するキー	"key_to_delete"

getFromDataLayer()

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

Tealium.getFromDataLayer(key);

パラメータ	タイプ	説明
key	String	データレイヤーから取得するキー
N/A	Future<dynamic>	Tealium.dataLayerから値が正常に取得された後にFutureが成功します

例:

Tealium.getFromDataLayer('key')
    .then((value) => print('データレイヤーからの値: $value')));

getConsentCategories()

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

Tealium.getConsentCategories();

パラメータ	タイプ	説明
N/A	Future<List<ConsentCategories>>	Tealium.ConsentManagerから同意カテゴリが正常に取得された後にFutureが完了します

例:

Tealium.getConsentCategories()
  .then((categories) =>
      print('同意カテゴリ: ' + categories.join(","))));

getConsentStatus()

ユーザーの同意状態をコールバック関数として取得します。

Tealium.getConsentStatus(callback);

パラメータ	タイプ	説明
N/A	Future<String>	Tealium.ConsentManagerから同意状態が正常に取得された後にFutureが完了します

例:

Tealium.getConsentStatus()
  .then((status) => print('同意状態: $status')));

getVisitorId()

ユーザーの訪問IDをコールバック関数として取得します。

Tealium.getVisitorId();

パラメータ	タイプ	説明
N/A	Future<String>	Tealium.visitorIdが正常に取得された後にFutureが返されます

initialize()

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

Tealium.initialize(config);

パラメータ	タイプ	説明
config	config	構成
N/A	Future<String>	Tealiumの初期化が成功した場合はtrueを返し、エラーがある場合はfalseを返します

例:

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],
    loglevel: LogLevel.DEV,
	consentLoggingEnabled: true,
	consentPolicy: ConsentPolicy.GDPR,
	visitorServiceEnabled: true
};

    Tealium.initialize(config)
      .then((value) => {
          if (value)
            {
              print('Tealiumが初期化されました'),
              Tealium.setConsentStatus(ConsentStatus.consented),
              Tealium.setConsentExpiryListener(
                  () => print('同意期限切れ'));
            }
          else
            {
            	print('Tealiumの初期化エラー')
            }
        });

joinTrace()

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

Tealium.joinTrace(id);

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

leaveTrace()

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

Tealium.leaveTrace();

removeFromDataLayer()

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

Tealium.removeFromDataLayer(keys);

パラメータ	型	説明	例
keys	List<String>	キー名の配列	["key1", "key2"]

removeRemoteCommand()

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

Tealium.removeRemoteCommand(id);

パラメータ	型	説明	例
keys	String	削除するコマンドIDの名前	"test_command"

例:

Tealium.removeRemoteCommand('test_command');

resetVisitorId()

ユーザーの新しい訪問IDを生成します。

Tealium.resetVisitorId()

setConsentCategories()

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

Tealium.setConsentCategories(categories);

パラメータ	型	説明	例
categories	List<ConsentCategories>	ユーザーの同意カテゴリの配列	[ConsentCategories.email, ConsentCategories.personalization]

例:

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

同意カテゴリ

以下の同意カテゴリが利用可能です：

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

setConsentExpiryListener()

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

Tealium.setConsentExpiryListener(callback);

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

Tealium.setConsentExpiryListener(() => {
    print('Consent Expired');
});

setConsentStatus()

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

Tealium.setConsentStatus(status);

パラメータ	型	説明
status	status	同意ステータス

例:

Tealium.setConsentStatus(ConsentStatus.consented);

同意ステータス

以下の同意ステータスが利用可能です：

値	説明
.consented	同意済み
.notConsented	同意していない
.unknown	不明

setVisitorIdListener()

訪問IDが変更されたときに実行するコールバックを構成します。

Tealium.setVisitorIdListener(callback);

パラメータ	型	説明
callback	Function	更新された visitorId で実行するコード

例:

Tealium.setVisitorIdListener((newVisitorId) => {
    print(newVisitorId);
});