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

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

config.adobeVisitorDataProviderId = "01"

adobeVisitorExistingEcid

新しいECIDを要求する代わりに、以前のインストールから使用する既存のECID（Adobe SDKなど）を構成します。

例:

config.adobeVisitorExistingEcid = "20381482060927465156359999806251989655"

adobeVisitorOrgId

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

config.adobeVisitorOrgId = STRING_VALUE

例:

config.adobeVisitorOrgId = "1A2A111A111150AA0A110A12@AdobeOrg"

adobeVisitorRetries

ECIDがない場合にリクエストが失敗する前に許可される無効な訪問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モジュールで使用するための構成です。

自動トラッキングモジュールによってトラッキングされるアクティビティのために実行されるグローバルデリゲートを構成します。特定のアクティビティに含まれるデータをカスタマイズするために、このデリゲートを編集します。

config.autoTrackingCollectorDelegate = myCollectorDelegate

autoTrackingMode

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

• FULL
@Autotracked(track=false)で注釈が付けられていないすべてのアクティビティをトラッキングします。
• ANNOTATED
@Autotrackedで注釈が付けられたアクティビティのみをトラッキングします。
• NONE
  すべての自動トラッキングを無効にします（デバッグまたは開発ビルドの場合に使用します）。

config.autoTrackingMode = AutoTrackingMode.FULL

Collectors

Collectorsは、デバイスから補足情報を収集し、Tealium Customer Data Hubに送信する前にデータレイヤーに追加するモジュールです。一部のCollectorsはコアライブラリに含まれており、他のものはオプションとして別のモジュールとしてインストールされます。

以下の表は、利用可能なCollectorsの一覧です。デフォルトのCollectorsは、コレクター名の横に*が付いています。

これらのモジュールは、TealiumConfigのcollectorsプロパティを使用して有効または無効にできます。

以下の例は、使用しているCollectorsのリストに追加する方法です:

val config = TealiumConfig(collectors = mutableSetOf(Collectors.AdobeVisitor))

consentExpiry

ユーザーの同意選択の有効期限を構成します。Tealiumの初期化前にこのプロパティを構成します。同意選択のデフォルトの有効期限は次のとおりです:

• CCPA: 395日
• GDPR: 365日

以下は、同意の有効期限を90日に構成する例です。

config.consentExpiry = ConsentExpiry(90, TimeUnit.DAYS)

consentManagerEnabled

ConsentManagerモジュールが有効かどうかを構成します。consentManagerPolicyを構成する必要もあります。

config.consentManagerEnabled = true  // 有効化

consentManagerPolicy

アプリ内で適用されるConsentPolicyを構成します。このポリシーは、関連する法的要件に従ってSDK内でDispatchesがキューに入れられ、破棄されるかどうかを制御します。

config.consentManagerPolicy = ConsentPolicy.GDPR

consentManagerLoggingEnabled

同意の変更をリモートサーバーに送信して記録するかどうかを構成します。

config.consentManagerLoggingEnabled = true

consentManagerLoggingProfile

データを送信するTealium Collectのプロファイルを上書きします。

config.consentManagerLoggingProfile = "us-mobile"

consentManagerLoggingUrl

同意のログ記録の更新先のURLを構成します。

config.consentManagerLoggingUrl = url

deepLinkTrackingEnabled

FacebookなどのソースからアプリへのリンクやQRトレースなどの標準的なディープリンクの自動トラッキングを有効化または無効化します。デフォルトで有効化されています。

config.deepLinkTrackingEnabled = true

existingVisitorId

tealium_visitor_idのデータレイヤー値を構成します。独自の一意の識別子を持っている場合に使用します。

config.existingVisitorId = "8243d23b56d5488571027547bc72d93"

hostedDataLayerMaxCacheTimeMinutes

ホストされたデータレイヤーデータの有効期限を構成します。このプロパティが構成されていない場合、ホストされたデータレイヤーアイテムはデフォルトで7日間保持され、この期間が経過するとTealiumから再ダウンロードされます。

hostedDataLayerMaxCacheTimeMinutes = 30

ホストされたデータレイヤーが頻繁に更新される場合、より低い値を構成するとネットワークリクエストが増えるため、バッテリー寿命に影響する可能性があります。

hostedDataLayerEventMappings

ホストされたデータレイヤーモジュールがデータレイヤーIDを検索する際に使用するイベントマッピングを構成します。キーはディスパッチのtealium_eventキーの値です。

hostedDataLayerEventMappings = mapOf("pdp" to "product_id")

logLevel

ログレベルプロパティを構成して、ログに記録される情報の量を制御します。このプロパティを構成すると、TealiumConfigのenvironmentプロパティからのデフォルト値が上書きされます。

ログレベルを次のいずれかの値に構成します:

config.logLevel = LogLevel.DEV

Android StudioのLogCatを使用して開発ログを表示します。Androidデバイスに接続してLogCatアプリで本番ログを表示します。

remoteAPIEnabled

remote_apiイベントを有効化または無効化します。DispatchQueueモジュールを使用している場合は必須です。デフォルトはfalseです。

config.remoteAPIEnabled = true

sessionCountingEnabled

Tealium iQアカウントのセッションカウントを無効化します。TealiumのJavaScriptファイルを自己ホストしている場合に使用します。デフォルトはtrueです。

config.sessionCountingEnabled = false

TealiumConfig

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

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

TealiumConfigインスタンスは、次のパラメータで構成されます:

以下は例です:

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

// 必要なDispatchersを追加
config.dispatchers.addAll(setOf(CollectDispatcher, TagManagementDispatcher))

// 必要なModulesを追加
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のパラメータです: