Tealium

これは旧バージョン（2.x）のTealium for Flutterです。最新バージョンについては、Tealium for Flutterを参照してください。

クラス：`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.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、またはWebView構成を使用する構築済みのリモートコマンド。	以下の例を参照してください。

例：

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のトレースに参加します。詳しくは、トレースを参照してください。

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`	Cookieマッチング
`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 はコールバックのレスポンスで提供されます。

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

Customer Data Platform（CDP）のライセンスを保有し、訪問プロファイルを使用してモバイルアプリケーションのユーザーエクスペリエンスを向上させる場合は、このモジュールの使用を推奨します。Customer Data Platform（CDP）のライセンスを保有していない場合、訪問プロファイルが返されないため、このモジュールの使用は推奨されません。

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