Tealium（ティーリウム） | APIリファレンス | Tealium開発者ドキュメントプレビュー

クラス: `Tealium（ティーリウム）`

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

メソッド	説明
`addRemoteCommand()`	リモートコマンドをリモートコマンドマネージャーに追加します
`addToDataLayer()`	永続データレイヤーにデータを追加します
`deleteFromDataLayer()`	`addToDataLayer()`を使用して以前に構成されたデータレイヤーから単一のキーと値のペアを削除します
`gatherTrackData()`	すべてのコレクターとデータレイヤーからデータを収集します
`getFromDataLayer()`	永続データレイヤー内の指定されたキーの値を取得します
`getConsentCategories()`	ユーザーの同意済みカテゴリを取得します
`getConsentStatus()`	ユーザーの同意ステータスを取得します
`getVisitorId()`	ユーザーのビジターIDを取得します
`initialize()`	構成パラメータでTealiumを初期化します
`joinTrace()`	指定されたIDでトレースに参加します
`leaveTrace()`	以前に参加したトレースを終了し、ビジターセッションを終了します
`removeFromDataLayer()`	`addToDataLayer()`を使用して以前に構成された永続データのキーと値のペアを削除します
`removeRemoteCommand()`	リモートコマンドをリモートコマンドマネージャーから削除します
`setConsentCategories()`	ユーザーの同意カテゴリを構成します
`setConsentExpiryListener()`	同意の有効期限が切れたときに実行するコールバックを構成します
`setConsentStatus()`	ユーザーの同意ステータスを構成します
`setVisitorServiceListener()`	ビジターサービスのリスナー/コールバックを構成します
`terminateInstance()`	Tealiumインスタンスを終了し、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);
});

`addToDataLayer()`

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

Tealium.addToDataLayer(data, expiry);

パラメータ	型	説明	例
`data`	`Object`	キーと値のペアのJSONオブジェクト。キーは文字列で、値は文字列または文字列の配列です。	`{'persistent_key' : 'persistent_val'}`
`expiry`	`Expiry`	データを永続化する期間	`Expiry.forever`

`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 From data layer: $value')));

`getConsentCategories()`

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

Tealium.getConsentCategories();

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

例:

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

`getConsentStatus()`

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

Tealium.getConsentStatus(callback);

パラメータ	型	説明
`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`	`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 Initialized'),
              Tealium.setConsentStatus(ConsentStatus.consented),
              Tealium.setConsentExpiryListener(
                  () => print('Consent Expired'));
            }
          else
            {
            	print('Tealium Initialization Error')
            }
        });

`joinTrace()`

指定されたIDでトレースに参加します。[トレースについて詳しく見る]（/platforms/getting-started-mobile/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');

`setConsentCategories()`

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

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`	Cookieマッチ
`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`	不明

`setVisitorServiceListener()`

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

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

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

Tealium.setVisitorServiceListener(callback);

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

例:

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

`terminateInstance()`

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

Tealium.terminateIntance();

`track()`

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

Tealium.track(dispatch);

パラメータ	型	説明	例
`dispatch`	`TealiumDispatch`	イベント名とデータレイヤーを持つTealiumディスパッチ	`TealiumEvent('button_click', { 'button_name': 'Submit' })`

`gatherTrackData()`

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

例:

Tealium.gatherTrackData()
  .then((data) => developer.log('Gather track Data: $data'))

クラス: Tealium（ティーリウム）

addRemoteCommand()

addToDataLayer()

deleteFromDataLayer()

getFromDataLayer()

getConsentCategories()

getConsentStatus()

getVisitorId()

initialize()

joinTrace()

leaveTrace()

removeFromDataLayer()

removeRemoteCommand()

setConsentCategories()