TealiumConfig

クラス: TealiumConfig

TealiumConfig クラスは、メインの Tealium クラスの構成オプションを構成するメソッドを提供します。以下のドキュメントは、Kotlin用の TealiumConfig クラスの一般的に使用されるメソッドとプロパティをまとめたものです。個々のモジュールが有効になっている場合、それらのモジュールは TealiumConfig クラスの独自の拡張を提供することもあります。これらは関連するモジュールのドキュメントで説明されています。

adobeVisitorAuthState

訪問の現在の認証状態を構成します。

例:

config.adobeVisitorAuthState = AdobeAuthState.AUTH_STATE_AUTHENTICATED
config.adobeVisitorAuthState = AdobeAuthState.AUTH_STATE_LOGGED_OUT
config.adobeVisitorAuthState = AdobeAuthState.AUTH_STATE_UNKNOWN

adobeVisitorCustomVisitorId

初期化時に既知のAdobe ECIDがある場合、その訪問IDを構成します。将来ECIDが変更された場合は、linkECIDToKnownIdentifierを呼び出して訪問IDを更新します。

config.adobeVisitorCustomVisitorId = "20381482060927465156359999806251989655"

adobeVisitorDataProviderId

Adobeから提供されるデータプロバイダーIDを構成します。これは、既知のIDにECIDをリンクする際に必要です。

config.adobeVisitorDataProviderId = "01"

adobeVisitorExistingEcid

以前のインストールからの既存のECIDを構成します。例えばAdobe SDKのように、新しいECIDを要求する代わりに使用します。

例：

config.adobeVisitorExistingEcid = "20381482060927465156359999806251989655"

adobeVisitorOrgId

Adobe Org IDを含む文字列で、@部分を含みます。Org IDが提供されていない場合、モジュールは初期化されず、訪問IDは取得されません。トラッキングコールはAdobe ECIDなしで通常通り続けられます。

config.adobeVisitorOrgId = STRING_VALUE

例：

config.adobeVisitorOrgId = "1A2A111A111150AA0A110A12@AdobeOrg"

adobeVisitorRetries

無効な訪問IDのリトライが許可される回数を構成します。リクエストが失敗すると、ECIDなしでトラッキングコールが送信されます。

例：

config.adobeVisitorRetries = 5

autoTrackingBlocklistFilename

AutoTrackingモジュールで使用します。

自動トラッキングから除外するアクティビティのリストを含むJSON形式のブロックリストファイルの名前を構成します。ファイルはAndroidのassetsディレクトリに存在する必要があります。

config.autoTrackingBlocklistFilename = "autotracking-blocklist.json"

autoTrackingBlocklistUrl

AutoTrackingモジュールで使用します。

自動トラッキングから除外するアクティビティのリストを含むJSON形式のブロックリストファイルのURLを構成します。

config.autoTrackingBlocklistUrl = "https://example.com/autotracking-blocklist.json"

autoTrackingCollectorDelegate

AutoTrackingモジュールで使用します。

AutoTrackingモジュールによって追跡されるアクティビティに含まれるデータをカスタマイズするために実行されるグローバルデリゲートを構成します。

config.autoTrackingCollectorDelegate = myCollectorDelegate

autoTrackingMode

AutoTrackingモジュールのトラッキングレベルを構成します。

• FULL
@Autotracked(track=false)で注釈されているものを除くすべてのアクティビティを追跡します。
• ANNOTATED
@Autotrackedで注釈されているアクティビティのみを追跡します。
• NONE
  すべての自動トラッキングを無効にします（アプリのデバッグまたは開発ビルド用）。

config.autoTrackingMode = AutoTrackingMode.FULL

TealiumConfig

TealiumConfig インスタンスを作成するコンストラクタメソッド。

val config = TealiumConfig(
      application,
      account,
      profile,
      environment);

以下のパラメータで構成された TealiumConfig インスタンス:

以下は例です:

// Application.onCreate() 内で実行されると仮定
val config = TealiumConfig(this, "ACCOUNT_NAME", "PROFILE_NAME", Environment.PROD)

// 必要なディスパッチャーを追加
config.dispatchers.addAll(setOf(CollectDispatcher, TagManagementDispatcher))

// 必要なモジュールを追加
config.modules.add(VisitorService)

// 自動追跡モード
config.autoTrackingMode = AutoTrackingMode.FULL // (FULL, ANNOTATED, NONE)

timedEventTriggers

タイムドイベントを自動的に追跡するための EventTrigger オブジェクトのリスト。

val config = TealiumConfig(…).apply {
  timedEventTriggers = mutableListOf(
     EventTrigger.forEventName(
       start_event,
       stop_event,
       timed_event_name)
  )  
}

以下は EventTrigger のパラメータです:

useRemoteLibrarySettings

モバイルパブリッシュ構成 を有効または無効にするためのオプションの Boolean (デフォルト: 無効)。iQタグ管理でモバイルパブリッシュ構成を構成するか、機能を無効にします。

config.useRemoteLibrarySettings = true