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が変更された場合は、訪問IDを更新するためにlinkECIDToKnownIdentifierを呼び出します。

config.adobeVisitorCustomVisitorId = "20381482060927465156359999806251989655"

adobeVisitorDataProviderId

Adobeから提供されるデータプロバイダIDを構成します。これは、ECIDを既知の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

appDelegateProxyEnabled

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

config.appDelegateProxyEnabled = false

autoTrackingBlocklistFilename

AutoTracking Moduleと共に使用します。

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

config.autoTrackingBlocklistFilename = "autotracking-blocklist.json"

autoTrackingBlocklistURL

AutoTracking Moduleと共に使用します。

自動トラッキングから省略するビューのリストを含むJSON形式のブロックリストファイルへのURLを構成します。

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

autoTrackingCollectorDelegate

AutoTracking Moduleと共に使用します。

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

config.autoTrackingCollectorDelegate = myCollectorDelegate

batchingBypassKeys

バッチングをバイパスする（個々のイベントとして送信する）イベント名のリストを構成します。

config.batchingBypassKeys = ["home_screen"]

batchingEnabled

イベントバッチングを有効または無効にします。デフォルトでは無効になっています。

config.batchingEnabled = true

batchSize

単一のバッチリクエストに組み合わせるイベントの量を構成します。最大は10です。

config.batchSize = 8

Collectors

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

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

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

以下の例は、使用しているコレクターのリストに追加します：

config.collectors = [Collectors.AdobeVisitor]

connectivityRefreshEnabled

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

config.connectivityRefreshEnabled = true

connectivityRefreshInterval

デフォルトの接続性リフレッシュ間隔を秒単位で構成します。TealiumConfigインスタンスに構成されていない場合のデフォルトは30秒です。

config.connectivityRefreshInterval = 30

consentExpiry

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

• CCPA：395日
• GDPR：365日

以下は、同意の有効期限を90日に構成します。

config.consentExpiry = (90, .days)

consentLoggingEnabled

Consent Logging機能を有効にし、すべての同意ステータスの変更を監査目的でTealium Customer Data Hubに送信します。

config.consentLoggingEnabled = true

consentPolicy

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

config.consentPolicy = .ccpa

deepLinkTrackingEnabled

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

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

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

config.geofenceFileName = <String>

geofenceTrackingEnabled

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

config.geofenceTrackingEnabled = false

geofenceUrl

ホストされたジオフェンスファイルのURLを構成します。

config.geofenceUrl = <String (url)>

hostedDataLayerExpiry

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

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

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

hostedDataLayerKeys

ホストされたデータレイヤーモジュールがデータレイヤーIDを取得する際に使用するホストされたデータレイヤーキー（ルックアップ変数）を構成します。

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

isCollectEnabled

collect dispatcherを無効にするオプションを提供します。主にリモートパブリッシュ構成で使用されます。

config.isCollectEnabled = false

lifecycleAutoTrackingEnabled

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

config.lifecycleTrackingEnabled = false

logger

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

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

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

DeviceDataモジュールでのメモリレポートを有効または無効にします（デフォルト：無効）。

config.memoryReportingEnabled = true

minimumFreeDiskSpace

ディスク保存が有効になるための最小限の空きディスクスペースをメガバイトで構成します。

config.minimumFreeDiskSpace = 25

minutesBetweenRefresh

パブリッシュ構成をどのくらいの頻度で取得するかを決定します。

config.minutesBetweenRefresh = 15

onConsentExpiration

同意選択が期限切れになったときに実行するコールバック。

config.onConsentExpiration = {
	// display consent modal
}

overrideCollectProfile

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

config.overrideCollectProfile = "main"

overrideCollectURL

Tealium Collect URLを上書きして、データを別のエンドポイントに送信します。イベントバッチング機能を使用している場合は、overrideCollectBatchURLプロパティも上書きします。

config.overrideCollectURL = url

デフォルトのURLは次のとおりです：

https://collect.tealiumiq.com/event/

このプロパティは、カスタムホスト名を構成するため、または特定の地域のホスト名を構成するために使用されます。次の例では、Tealium CollectのベースURLをEU Central地域内に保持するように構成しています：

let url = "https://collect-eu-central-1.tealiumiq.com/event/"
config.overrideCollectURL = url

overrideCollectBatchURL

Tealium CollectバッチURLを上書きして、データを別のエンドポイントに送信します。

config.overrideCollectBatchURL = url

イベントバッチングを使用した場合のデフォルトのURLは次のとおりです：

https://collect.tealiumiq.com/bulk-event/

このメソッドは、カスタムホスト名を構成するため、または特定の地域のホスト名を構成するために通常使用されます。次の例では、Tealium CollectのベースURLをEU Central地域内に保持するように構成しています：

let url = "https://collect-eu-central-1.tealiumiq.com/bulk-event/"
config.overrideCollectBatchURL = url

overrideCollectDomain

デフォルトのCollectドメインを上書きします。値をプロトコルを除いたホスト名（例：my-company.com）に構成します。このプロパティはバッチと単一イベントの両方のディスパッチに使用します。overrideCollectURLまたはoverrideCollectBatchURLが入力されている場合、このプロパティが優先されます。

config.overrideCollectDomain = "my-company.com"

overrideConsentCategoriesKey

同意イベントで送信される同意カテゴリ属性の名前を上書きします。これを使用して、サーバーサイドの同意のカスタム強制をサポートします。デフォルト値は consent_categories です。

config.overrideConsentCategoriesKey = "consent_categories_granted"

デフォルトの同意イベント：

{
    "tealium_event"      : "grant_partial_consent",
    "policy"             : "gdpr",
    "consent_categories" : ["Affiliates", "Social"]
}

上書きを含む同意イベント：

{
    "tealium_event"              : "grant_partial_consent",
    "policy"                     : "gdpr",
    "consent_categories_granted" : ["Affiliates", "Social"]
}

サーバーサイドの同意管理の自動強制を無効にするについて詳しく学びましょう。

publishSettingsProfile

パブリッシュ構成プロファイルを上書きします。

config.publishSettingsProfile = "main"

publishSettingsURL

パブリッシュ構成URLを上書きします。

config.publishSettingsURL = "https://www.example.com/custom/publish/settings.html"

remoteAPIEnabled

remote_api イベントを有効または無効にします。DispatchQueueモジュールが使用中の場合、RemoteCommandsモジュールが必要です。デフォルトは false です。

config.remoteAPIEnabled = true

remoteCommands

登録されているすべてのリモートコマンドの配列を返します。

次の例は、登録されているすべてのリモートコマンドの配列を取得する方法を示しています：

let remoteCommands = config.remoteCommands

remoteHTTPCommandDisabled

組み込みのリモートHTTPコマンドを無効にします（Swift Module: RemoteCommandsを参照）。

config.remoteHTTPCommandDisabled = true

rootView

WKWebView が接続される現在の UIView を構成します。プッシュ通知などの複雑なビュー階層がある場合、自動検出が失敗する可能性があるため、この構成が必要です。

let view = self.view
config.rootView = view

searchAdsEnabled

AttributionモジュールのApple Search Ads APIを有効または無効にします（デフォルト：無効）。

config.searchAdsEnabled = true

sendCrashDataOnCrashDetected

クラッシュが検出されたときにクラッシュイベントを送信し、そのイベントにのみクラッシュデータを追加します（デフォルト：false）。

config.sendCrashDataOnCrashDetected = true

sessionCountingEnabled

Tealium iQアカウントのセッションカウントを無効にします。Tealium JavaScriptファイルを自己ホスティングしている場合にこれを使用します（デフォルト：true）。

config.sessionCountingEnabled = false

shouldAddCookieObserver

true（デフォルト）に構成されている場合、このメソッドはすべてのクッキーを正常に移行するために WKWebView クッキーオブザーバーを追加するかどうかを決定します。false に構成されている場合、複数のクッキーオブザーバーが存在すると、そのうちの1つだけが呼び出され、一部のクッキーが移行しない可能性があります。

config.shouldAddCookieObserver = false

shouldAddCookieObserverプロパティは、クッキー同期中に自分のクッキーオブザーバーを使用することを許可します。これは、クッキーの構成後にメインスレッドでクッキーを取得するためにクッキーオブザーバーが必要で、WKWebViewのバグにより、自分のオブザーバーが呼び出されない問題が発生します。

shouldUseRemotePublishSettings

Mobile Publish Settings（バージョン1.9.0+）を有効（デフォルト）または無効に構成します。

config.shouldUseRemotePublishSettings = false

Mobile Publish Settingsはデフォルトで有効になっており、使用しない場合は無効にする必要があります。iQ Tag ManagementでMobile Publish Settingsを構成するか、Swiftインストールでconfig.shouldUseRemotePublishSettings = falseを使用して機能を無効にします。これを行わないと、初期化に失敗し、トラッキングが防止されます。

skAdAttributionEnabled

AttributionモジュールのApple SKAdNetwork APIを有効または無効にします（デフォルト：無効）。

config.skAdAttributionEnabled = true

skAdConversionKeys

SKAdNetwork.updateConversionValue()メソッドを呼び出すイベントと、変換値として使用するキーを定義する辞書。

config.skAdConversionKeys = ["purchase": "number_of_coins"]

この場合、以下のイベントは SKAdNetwork.updateConversionValue(40) に等しくなります。

tealium?.track("purchase", dataLayer: ["number_of_coins": 40])

tagManagementOverrideURL

Tag Managementモジュールで使用されるデフォルトのURLを上書きします。これは、Tealium JavaScriptファイルを自己ホスティングしている場合に必要です。

次の例は、Tag Managementモジュールで使用されるデフォルトのURLを上書きする方法を示しています。

let url = "https://tags.mycdn.com/utag/myaccount/myprofile/myenv/mobile.html"
config.tagManagementOverrideURL =  url

TealiumConfig()

TealiumConfigオブジェクトのコンストラクタ。このオブジェクトは、ライブラリを特定のアカウントに対して初期化するために必要です。

TealiumConfig(account:String, profile:String, environment:String, dataSource:String)

timedEventTriggers

タイムドイベントを自動的にトラッキングするためのTimedEventTriggerオブジェクトのリスト。

config.timedEventTriggers = [TimedEventTrigger(start: "START_EVENT",
                                               stop: "STOP_EVENT",
                                               name: "TIMED_EVENT_NAME")]

以下はTimedEventTriggerパラメータです:

updateDistance

位置情報の更新を受け取る距離間隔（メートル）を構成します。

このメソッドは、useHighAccuracyがtrueに構成されている場合にのみ使用してください。

config.updateDistance = <Double>

使用例:

func start() {
      let config = TealiumConfig(account: "ACCOUNT",
                                 profile: "NAME",
                                 environment: "ENVIRONMENT",
                                 datasource: "DATASOURCE")
      // Tealium Location module config methods
      config.useHighAccuracy = true
      config.updateDistance = 150.0
  }

useHighAccuracy

位置精度を低精度（デフォルト）または高精度に構成します。

このプロパティはデフォルトで無効になっており、位置精度を低精度に構成します。位置情報を有効にしたデバイスが500メートル以上移動すると、これは大きな位置変更とみなされ、位置情報の更新が行われます。この構成では、位置情報の更新には通常5分以上かかります。

Appleのsignificant-change location serviceについて詳しく学びましょう。

有効にすると、このプロパティはデータ精度の位置を可能な限り高い精度に構成します。初期イベントはできるだけ早く配信され、その後、位置を決定し、そのデータが利用可能になるときに必要に応じて追加のイベントを配信し続けます。

Appleの位置データの精度について詳しく学びましょう。

高精度を使用すると、位置情報の更新が頻繁に行われるため、デバイスのバッテリー消費が低精度よりも大きくなります。

config.useHighAccuracy = <Bool>

使用例:

func start() {
      let config = TealiumConfig(account: "ACCOUNT",
                                 profile: "NAME",
                                 environment: "ENVIRONMENT",
                                 datasource: "DATASOURCE")
      // Tealium Location module config methods
      config.useHighAccuracy = true
      config.updateDistance = 150.0
  }

visitorIdentityKey

データレイヤー内の指定されたvisitorIdentityKeyで訪問の切り替えを有効にします。

例:

  func start() {
      let customerIdentifierKey = "customer_id"
      let config = TealiumConfig(account: "ACCOUNT",
                                 profile: "NAME",
                                 environment: "ENVIRONMENT",
                                 datasource: "DATASOURCE")
      config.visitorIdentityKey = customerIdentifierKey
      // use the same customerIdentifierKey for storing a specific customer identifier in the data layer
  }

webviewProcessPool

アプリがTealium Tag Management webview以外の他のwebviewを含む場合、クッキーの同期問題を防ぎます。アプリでwebviewを使用する場合、シングルトンのWKProcessPoolインスタンスを作成し、Tealiumをインスタンス化する前に構成します。

例:

let processPool = MyApp.wkProcessPool
config.webviewProcessPool = processPool

webviewConfig

カスタムのWKWebviewConfigurationオブジェクトを渡すことを許可します。これはTealium Tag Management webviewに使用されます。webviewProcessPoolオプションの代わりにこのオプションを使用する場合、カスタマイズ可能なWKWebviewConfigurationのprocessPoolプロパティを介してシングルトンのWKProcessPoolを構成します。

WKWebViewに対して将来的にAPIの変更が行われる場合があるため、このオプションの使用が推奨されます。

例:

let processPool = MyApp.wkProcessPool
let configuration = WKWebViewConfiguration()
configuration.processPool = processPool
config.webviewConfig = configuration