Tealium

これはFlutter用Tealiumの以前のバージョン（2.x）です。最新バージョンについては、Flutter用Tealiumをご覧ください。

クラス: `Tealium`

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

メソッド	説明
`addCustomRemoteCommand()`	リモートコマンドマネージャーにリモートコマンドのコールバックを追加します。
`addRemoteCommand()`	リモートコマンドマネージャーにリモートコマンドを追加します
`addToDataLayer()`	永続的なデータレイヤーにデータを追加します
`clearStoredVisitorIds()`	訪問IDの保存されたキャッシュを削除し、`resetVisitorId`を呼び出します。
`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.addCustomRemoteCommand('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`	`Map<String, Object>`	文字列のキーと文字列または文字列の配列の値を持つJSONオブジェクト	`{'persistent_key' : 'persistent_val'}`
`expiry`	`Expiry`	データを永続させる期間	`Expiry.forever`

`clearStoredVisitorIds()`

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

Tealium.clearStoredVisitorIds();

`getFromDataLayer()`

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

Tealium.getFromDataLayer(key);

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

例:

Tealium.getFromDataLayer('key')
    .then((value) => print('Value From data layer: $value'));

`getConsentCategories()`

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

Tealium.getConsentCategories();

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

例:

Tealium.getConsentCategories()
  .then((categories) =>
      print('Consent Categories: ' + categories.join(",")));

`getConsentStatus()`

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

Tealium.getConsentStatus();

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

例:

Tealium.getConsentStatus()
  .then((status) => print('Consent Status: $status'));

`getVisitorId()`

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

Tealium.getVisitorId();

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

`initialize()`

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

Tealium.initialize(config);

パラメータ	タイプ	説明
`config`	`TealiumConfig`	構成
`N/A`	`Future<bool>`	Tealiumの初期化が成功した後にFutureが完了します

例:

final config = TealiumConfig(
    'ACCOUNT',
    'PROFILE',
    TealiumEnvironment.dev,
    [
        Collectors.AppData,
        Collectors.DeviceData,
        Collectors.Lifecycle,
        Collectors.Connectivity,
    ],
    [
        Dispatchers.Collect,
        Dispatchers.TagManagement,
        Dispatchers.RemoteCommands,
    ],
    loglevel: LogLevel.DEV,
    consentLoggingEnabled: true,
    consentPolicy: ConsentPolicy.GDPR,
    visitorServiceEnabled: true);

Tealium.initialize(config).then((_) {
    print('Tealium Initialized');
    Tealium.setConsentStatus(ConsentStatus.consented);
    Tealium.setConsentExpiryListener(() => print('Consent Expired'));
});

`joinTrace()`

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

Tealium.joinTrace(id);

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

`leaveTrace()`

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

Tealium.leaveTrace();

`removeFromDataLayer()`

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

Tealium.removeFromDataLayer(keys);

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

`removeRemoteCommand()`

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

Tealium.removeRemoteCommand(id);

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

例:

Tealium.removeRemoteCommand('test_command');

`resetVisitorId()`

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

Tealium.resetVisitorId();

`setConsentCategories()`

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

Tealium.setConsentCategories(categories);

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

例:

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

同意カテゴリ

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

値	説明
`analytics`	アナリティクス
`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()`

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

Tealium.setConsentStatus(status);

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

例:

Tealium.setConsentStatus(ConsentStatus.consented);

同意ステータス

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

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

`setVisitorIdListener()`

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

Tealium.setVisitorIdListener(callback);

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

例:

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

`setVisitorServiceListener()`

訪問プロファイルが更新されたときに実行するコールバックを構成します。更新されたVisitorProfileはコールバックのレスポンスで提供されます。

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

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

Tealium.setVisitorServiceListener(callback);

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

例:

Tealium.setVisitorServiceListener((profile) {
    print(JsonEncoder().convert(profile));
});

`terminateInstance()`

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

Tealium.terminateInstance();

`track()`

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

Tealium.track(tealEvent);

パラメータ	型	説明
`tealEvent`	`TealiumDispatch`	イベント名とイベントデータを持つTealiumディスパッチ。

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

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

`gatherTrackData()`

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

例:

Tealium.gatherTrackData()
  .then((data) => print('Gather track data: $data'));

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

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

クラス: `TealiumEvent`

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

final tealEvent = TealiumEvent(eventName, dataLayer);
Tealium.track(tealEvent);

パラメータ	型	説明
`eventName`	`String`	`tealium_event`属性として渡されるイベント名。
`dataLayer`	`Map<String, Object>`	(オプション) イベントに送信されるキーと値の形式のデータ。

例:

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

クラス: `TealiumView`

画面表示を追跡するには、TealiumView(viewName, dataLayer)のインスタンスをtrack()メソッドに渡します。TealiumViewは、追跡コールにtealium_eventとして表示されるビュー名と、オプションのデータオブジェクトを含みます。

final screenView = TealiumView(viewName, dataLayer);
Tealium.track(screenView);

パラメータ	型	説明
`viewName`	`String`	`tealium_event`属性として渡されるビュー名。
`dataLayer`	`Map<String, Object>`	(オプション) イベントに送信されるキーと値の形式のデータ。

例:

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

クラス: Tealium

addCustomRemoteCommand()

addRemoteCommand()

addToDataLayer()

clearStoredVisitorIds()

getFromDataLayer()

getConsentCategories()

getConsentStatus()

getVisitorId()

initialize()

joinTrace()

leaveTrace()

removeFromDataLayer()

removeRemoteCommand()

resetVisitorId()

setConsentCategories()