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

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

config.adobeVisitorCustomVisitorId = "20381482060927465156359999806251989655"

adobeVisitorDataProviderId

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

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

Collectors

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

次の表は、使用可能なコレクターの一覧です。デフォルトのコレクターは、コレクター名の横にある * で示されています。

これらのモジュールは、TealiumConfig の 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  // enable

consentManagerPolicy

アプリ内で準拠する ConsentPolicy を構成します。このポリシーは、関連する法的要件に従って、SDK 全体でディスパッチをキューに追加するか、破棄するかを制御します。

config.consentManagerPolicy = ConsentPolicy.GDPR

consentManagerLoggingEnabled

同意構成の変更を記録するために、リモートサーバーへ送信する必要があるかどうかを構成します。

config.consentManagerLoggingEnabled = true

consentManagerLoggingProfile

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

config.consentManagerLoggingProfile = "us-mobile"

consentManagerLoggingUrl

同意構成の変更を記録するときに使用する URL を構成します。

config.consentManagerLoggingUrl = url

deepLinkTrackingEnabled

Facebook やその他のソースからアプリへのリンクなど、標準的なディープリンクおよび QR Trace の自動トラッキングを有効または無効にします。デフォルトでは有効です。

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 モジュールを使用している場合、RemoteCommands モジュールに必要です。デフォルトは false です。

config.remoteAPIEnabled = true

sessionCountingEnabled

タグ管理アカウントのセッションカウントを無効にします。Tealium JavaScript ファイルをセルフホスティングしている場合に使用します。デフォルトは true です。

config.sessionCountingEnabled = false

TealiumConfig

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

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

TealiumConfig インスタンスは、次のパラメータを使用して構成されます。

次に例を示します。

// Assuming execution is within Application.onCreate()
val config = TealiumConfig(this, "ACCOUNT_NAME", "PROFILE_NAME", Environment.PROD)

// Add required Dispatchers
config.dispatchers.addAll(setOf(CollectDispatcher, TagManagementDispatcher))

// Add required Modules
config.modules.add(VisitorService)

// Automatic tracking mode
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 値です（デフォルト：無効）。タグ管理でモバイルパブリッシュ構成を構成するか、この機能を無効にします。

config.useRemoteLibrarySettings = true