TealiumConfig

クラス: TealiumConfig

以下は、iOS（Swift）のTealiumConfigクラスの一般的に使用されるメソッドとプロパティをまとめたものです。

addRemoteCommand()

後で実行するためのリモートコマンドを追加します。

addRemoteCommand(command)

以下の例は、Tealiumの初期化の前にリモートコマンドを追加する方法を示しています。

#if os(iOS)
let remoteCommand = RemoteCommand(commandId: "test",
        description: "test") { response in
			print("Remote Command 'test' executed")
}
config.addRemoteCommand(remoteCommand)
#endif

adobeVisitorAuthState

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

例:

config.adobeVisitorAuthState = .authenticated
config.adobeVisitorAuthState = .loggedOut
config.adobeVisitorAuthState = .unknown

adobeVisitorCustomVisitorId

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

config.adobeVisitorCustomVisitorId = "20381482060927465156359999806251989655"

adobeVisitorDataProviderId

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

config.adobeVisitorDataProviderId = "01"

adobeVisitorExistingEcid

以前のインストールからの既存のECIDを構成します。Adobe SDKなどの代わりに使用されます。

例:

config.adobeVisitorExistingEcid = "20381482060927465156359999806251989655"

adobeVisitorOrgId

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

config.adobeVisitorOrgId = STRING_VALUE

例:

config.adobeVisitorOrgId = "1A2A111A111150AA0A110A12@AdobeOrg"

adobeVisitorRetries

リクエストが失敗した場合に、トラッキングコールがECIDなしで送信される前に許可される無効な訪問IDのリトライ回数です。

例:

config.adobeVisitorRetries = 5

appDelegateProxyEnabled

Tealium AppDelegateプロキシを有効にして、自動的にディープリンクのトラッキングを開始し、ディープリンクからTealiumトレースセッションを開始します。このプロパティはデフォルトで有効になっており、trueに構成されています。無効にするには、プロパティをfalseに構成します。

config.appDelegateProxyEnabled = false

autoTrackingBlocklistFilename

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

自動トラッキングから除外するビューのリストを含むブロックリストファイルの名前を構成します。ファイルは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

batchingBypassKeys

バッチ処理がバイパスされるイベント名のリストを構成します（個別のイベントとして送信されます）。

config.batchingBypassKeys = ["home_screen"]

batchingEnabled

イベントのバッチ処理を有効または無効にします。デフォルトは無効です。

config.batchingEnabled = true

batchSize

1つのバッチリクエストに結合するイベントの数を構成します。最大は10です。

config.batchSize = 8

Collectors

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

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

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

以下の例は、使用しているコレクタのリストに追加する方法を示しています。

config.collectors = [Collectors.AdobeVisitor]

connectivityRefreshEnabled

有効になっている場合（デフォルト）、接続モジュールは指定された間隔で接続をチェックします（setConnectivityRefreshIntervalで制御されます）。キューに入れられたディスパッチは、接続が再開されるとすぐに送信されます。

config.connectivityRefreshEnabled = true

connectivityRefreshInterval

デフォルトの接続更新間隔を秒単位で構成します。構成されていない場合、デフォルトは30秒です。

config.connectivityRefreshInterval = 30

consentExpiry

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

• CCPA：395日
• GDPR：365日

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

config.consentExpiry = (90, .days)

consentLoggingEnabled

同意ログ記録機能を有効にします。これにより、同意ステータスの変更が監査目的でTealium Customer Data Hubに送信されます。

config.consentLoggingEnabled = true

consentPolicy

同意ポリシーを構成します。このプロパティが構成されている場合にのみ、同意マネージャーが有効になります。

config.consentPolicy = .ccpa

deepLinkTrackingEnabled

ディープリンクの自動トラッキングを有効または無効にします。デフォルトは有効です。

config.deepLinkTrackingEnabled = true

desiredAccuracy

アプリが受け取りたい位置データの精度を構成します。

config.desiredAccuracy = .best

利用可能なdesiredAccuracyオプションは次のとおりです。

Appleのdesired accuracy constantsについて詳しく学びます。

diskStorageDirectory

ディスク保存に使用するディレクトリを構成します。デフォルトは.cachesです。

config.diskStorageDirectory = .documents

dispatchListeners

トラッキングコールの直前にカスタムのDispatchListenerを追加するオプションを提供します。

config.dispatchListeners = [self]

dispatchValidators

トラッキング、キュー、またはイベントのドロップを制御するためのカスタムのDispatchValidatorを追加するオプションを提供します。

config.dispatchValidators = [self]

dispatchAfter

イベント数が指定した数に達した後、キューを自動的にフラッシュします。

config.dispatchAfter = 20

dispatchExpiration

バッチの有効期限を日単位で構成します。デバイスがオフラインの場合、古いイベントは削除されます。

config.dispatchExpiration = 5

dispatchQueueLimit

キューに格納されるイベントの最大数を構成します。この数に達し、キューがフラッシュされていない場合、最も古いイベントが削除されます。

config.dispatchQueueLimit = 50

enableBackgroundLocation

アプリがバックグラウンドで実行されている間に位置情報の更新を有効にします。

config.enableBackgroundLocation = true

existingVisitorId

既存の訪問IDを構成します。アプリ拡張機能の第一のIDとして使用されます。

config.existingVisitorId = id

geofenceFileName

ローカルのジオフェンスJSONファイルアセットの名前を構成します。ファイル拡張子は含めないでください。

config.geofenceFileName = <String>

geofenceTrackingEnabled

ジオフェンスのトラッキングを無効または有効にします。

config.geofenceTrackingEnabled = false

geofenceUrl

ホストされているJSONファイルのURLを構成します。

config.geofenceUrl = <String (url)>

hostedDataLayerExpiry

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

config.hostedDataLayerExpiry = (1, unit: .minutes)

短い有効期間を構成すると、ネットワークリクエストが増えるため、モバイルデバイスのバッテリー寿命が短くなります。

hostedDataLayerKeys

ホストされているデータレイヤーモジュールがデータレイヤーIDを検索するときに使用するイベントマッピングを構成します。

config.hostedDataLayerKeys = ["product_view" : "product_id"]

isCollectEnabled

Collectディスパッチャーを無効にするオプションを提供します。

config.isCollectEnabled = false

lifecycleAutoTrackingEnabled

ライフサイクルの自動トラッキングを有効または無効にします。デフォルトはtrueです。falseに構成した場合、ライフサイクルの起動/スリープ/ウェイクイベントが必要な場合は、LifecycleModuleのパブリックメソッドを使用して手動で呼び出す必要があります。

config.lifecycleTrackingEnabled = false

logger

現在のTealiumLoggerを置き換えるTealiumLoggerProtocolに準拠するカスタムロガーを構成します。

以下の例は、configオブジェクトにカスタムロガーを構成する方法を示しています。

class CustomLogger: TealiumLoggerProtocol {
	// ... TealiumLoggerProtocolに準拠する
	// さらに独自のカスタムメソッドを追加します
}

class TealiumHelper {
	let config = TealiumConfig(...)
	var tealium: Tealium?
	let customLogger = CustomLogger()

	// ...

	private init() {
		config.logger = customLogger
		// ...
		tealium = Tealium(config: config)
	}
}

logLevel

ログレベルプロパティを構成します。これにより、ログに記録される情報の量が制御されます。

config.logLevel = .debug

開発環境では、XcodeコンソールまたはMacのConsoleアプリで開発ログを表示できます。iOSデバイスに接続している場合は、Consoleアプリで本番ログを表示できます。

logType

新しいログタイプを構成します。デフォルトは.osまたはOSLogです。

以下の例は、ログレベルをprintに構成する方法を示しています。

config.logType = .print

memoryReportingEnabled

デバイスデータモジュールでメモリレポートを有効または無効にします（デフォルトは無効）。

config.memoryReportingEnabled = true

minimumFreeDiskSpace

ディスク保存を有効にするための最小の空きディ