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

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

config.adobeVisitorCustomVisitorId = "20381482060927465156359999806251989655"

adobeVisitorDataProviderId

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

config.adobeVisitorDataProviderId = "01"

adobeVisitorExistingEcid

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

例：

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モジュールで使用します。

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

config.autoTrackingBlocklistFilename = "autotracking-blocklist.json"

autoTrackingBlocklistURL

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

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

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

autoTrackingCollectorDelegate

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

AutoTrackingモジュールによって追跡されるビューに含まれるデータをカスタマイズするために編集される、TealiumConfigオブジェクトに構成されるグローバルデリゲートです。

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

同意ログ記録機能を有効にし、すべての同意状態の変更を監査目的でTealium Customer Data Hubに送信します。

config.consentLoggingEnabled = true

consentPolicy

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

config.consentPolicy = .ccpa

deepLinkTrackingEnabled

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

config.deepLinkTrackingEnabled = true

desiredAccuracy

アプリが受け取りたい位置情報の精度。

config.desiredAccuracy = .best

利用可能なdesiredAccuracyオプションは以下の通りです：

Appleの位置精度定数についてもっと学ぶ。

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

minimumFreeDiskSpace

ディスク保存を有効にするための最小限の空きディスク容量をメガバイト単位で構成します。

config.minimumFreeDiskSpace = 25

minutesBetweenRefresh

公開構成を取得する頻度を決定します。

config.minutesBetweenRefresh = 15

onConsentExpiration

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

config.onConsentExpiration = {
	// 同意モーダルを表示
}

overrideCollectProfile

データを異なるTealiumプロファイルに送信するためにTealium Collectプロファイルを上書きします。

config.overrideCollectProfile = "main"

overrideCollectURL

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

config.overrideCollectURL = url

デフォルトのURLは以下の通りです：

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

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

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/

この方法は通常、カスタムホスト名を構成するか、特定の地域のホスト名を構成するために使用されます。以下の例では、EU Central地域内に留まるようにTealium Collectの基本URLを構成しています：

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"]
}

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

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の重要な変更位置情報サービスについてもっと学ぶ。

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

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タグ管理ウェブビュー以外のウェブビューを含むアプリの場合、クッキーの同期問題を防ぐために、アプリで WKProcessPool のシングルトンインスタンスを作成して保持し、Tealiumをインスタンス化する前に構成します。

例：

let processPool = MyApp.wkProcessPool
config.webviewProcessPool = processPool

webviewConfig

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

このオプションを使用することをお勧めします。これは、WKWebView に対する将来のAPI変更が行われた場合に必要になる可能性があるためです。

例：

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