TealiumConfig
クラス:TealiumConfig
以下は、一般的に使用されるiOS(Swift)TealiumConfig
クラスのメソッドとプロパティをまとめたものです。
メソッド/Property | 説明 |
---|---|
addRemoteCommand() |
後で実行するためのリモートコマンドを追加します |
adobeVisitorAuthState |
訪問者に関する現在の認証状況を設定します。 |
adobeVisitorCustomVisitorId |
訪問者 ID が初期化時に既知である場合は、既知の訪問者 ID を Adobe ECID に設定します。ECID が将来変更になった場合は、 linkECIDToKnownIdentifier を呼び出して、訪問者 ID を更新します。 |
adobeVisitorDataProviderId |
ECID を既知の ID とリンクさせるときに必要となる、Adobe が提供するデータ プロバイダー ID を設定します。 |
adobeVisitorExistingEcid |
新規の ECID をリクエストせず、以前のインストールからの既存の ECID (Adobe SDK など) を設定して用います。 |
adobeVisitorOrgId |
@ 部分を含めて、Adobe 組織 IDを含むストリング。 |
adobeVisitorRetries |
ECID を用いずにトラッキング コールが送信されることになる、リスクエストの失敗までに認められる無効な訪問者 ID の再試行の回数。 |
appDelegateProxyEnabled |
Tealium AppDelegate プロキシを有効 (デフォルト) または無効にします |
autoTrackingBlocklistFilename |
ローカル ブロック リスト ファイルの名前を設定します。 |
autoTrackingBlocklistURL |
リモート ブロック リスト ファイルの URL を設定します。 |
autoTrackingCollectorDelegate |
自動トラッキングされるビューのために実行されるグローバル デリゲートを設定します。 |
batchingBypassKeys |
バッチ処理がバイパスされる(個々のイベントとして送信される)イベント名のリストを設定します |
batchingEnabled |
イベントバッチ処理を有効または無効(デフォルト)にします |
batchSize |
単一のバッチリクエストにまとめるイベントの数を設定します(最大:10) |
connectivityRefreshEnabled |
有効な場合(デフォルト)、Connectivityモジュールは指定された間隔で接続を確認します |
connectivityRefreshInterval |
デフォルトの接続更新間隔を秒単位で設定します |
consentExpiry |
ユーザーの同意選択の有効期限を設定します |
consentLoggingEnabled |
同意の記録機能を有効または無効にします |
consentPolicy |
同意ポリシーを設定します (デフォルト: GDPR)、たとえばCCPA |
deepLinkTrackingEnabled |
ディープ リンクの自動トラッキングを有効化または無効化します |
desiredAccuracy |
アプリが受け取る位置データの精度 |
diskStorageDirectory |
ディスク ストレージ用に使用するディレクトリを設定します。デフォルトは .caches になっています。 |
dispatchAfter |
イベント数が何個になったらキーをフラッシュするかを設定します |
dispatchExpiration |
バッチの有効期限を日数で設定します。デバイスが長期間オフラインになると、この値よりも古いイベントは削除されます |
dispatchQueueLimit |
キューに追加されるイベントの最大数を設定します。この値に達したときに、キューがまだフラッシュされていない場合は、最も古いイベントが削除されます。 |
dispatchListeners |
ディスパッチの直前にトラッキン グコールを監視するためのカスタム DispatchListener を追加するオプションを提供します |
dispatchValidators |
イベントについて、ディスパッチ、キューの登録またはドロップを行うかどうかを制御するためのカスタム DispatchValidator を追加するオプションを提供します |
existingVisitorId |
アプリ拡張機能でファーストパーティIDとして使用される既存の訪問者IDを設定します |
geofenceFileName |
ローカルジオフェンスJSONファイルアセットの名前を設定します。ファイル拡張子は含めないでください。 |
geofenceTrackingEnabled |
ジオフェンス トラッキングを有効化または無効化します |
geofenceUrl |
ホスト型JSONファイルのURLを設定します |
hostedDataLayerExpiry |
ホスト型データレイヤーデータの有効期限を設定します |
hostedDataLayerKeys |
ホスト型データレイヤーモジュールがデータレイヤー ID を参照するときに使用するイベント マッピングを設定します |
isCollectEnabled |
Collect ディスパッチャーを無効化するオプションを提供します |
lifecycleAutoTrackingEnabled |
ライフサイクル自動トラッキングを有効化または無効化します。デフォルトは true です。false に設定したうえで、ライフサイクル起動/スリープ/スリープ解除イベントを希望する場合は、 LifecycleModule の公開メソッドを用いて手動で呼び出す必要があります |
logger |
カスタム ロガーを TealiumLoggerProtocol (現在の TealiumLogger から置き換えられるもの) に準拠するように設定します |
logLevel |
ログ (記録) されている情報の量を制御するログ レベル プロパティを設定します |
logType |
新しいログ タイプを設定します |
memoryReportingEnabled |
DeviceDataモジュールでメモリレポートを有効化または無効化します |
minimumFreeDiskSpace |
Disk Storage (ディスク ストレージ) を有効化するために最小フリー ディスク スペース (メガバイト単位) を設定します |
minutesBetweenRefresh |
CDN から公開設定を取得する頻度を決定します |
onConsentExpiration |
同意選択の有効期限が切れたときに実行するコールバック |
overrideCollectProfile |
データを別のTealiumプロファイルに送信するようにTealium Collectのプロファイルをオーバーライドします |
overrideCollectURL |
データを別のエンドポイントに送信するようにTealium CollectのURLをオーバーライドします |
overrideCollectBatchURL |
データを別のエンドポイントに送信するように Tealium Collect のバッチ URL をオーバーライドします |
overrideCollectDomain |
データを別のエンドポイントに送信するように Tealium Collect のドメイン名をオーバーライドします |
publishSettingsProfile |
公開設定のプロファイルをオーバーライドします |
publishSettingsURL |
公開設定の URL をオーバーライドします |
remoteAPIEnabled |
remote_api イベントを有効化または無効化します。DispatchQueueモジュールが使用されている場合にRemoteCommandsモジュールに必要です。 |
remoteCommands |
現在登録されているすべてのリモートコマンドの配列を返します |
remoteHTTPCommandDisabled |
true の場合、組み込みのリモートHTTPコマンドを無効にします |
rootView |
WKWebView がアタッチされる現在のUIView を設定します |
searchAdsEnabled |
属性モジュールでApple Search Ads APIを有効または無効にします |
sessionCountingEnabled |
Tealium iQ アカウント用のセッション カウントを無効化します。Tealium JavaScript ファイルをセルフホストしている場合にこれを用います |
shouldAddCookieObserver |
WKWebView Cookie オブザーバーを追加するかどうかを決定します |
shouldUseRemotePublishSettings |
モバイル公開設定を設定します(デフォルト:有効) |
skAdAttributionEnabled |
SKAdNetwork を使用するフレームワークを有効化します |
skAdConversionKeys |
SKAdNetwork.updateConversionValue() メソッドを呼び出す対象のイベントと値を定義します |
tagManagementOverrideURL |
Tag Managementモジュールで使用されるデフォルトのURLをオーバーライドします |
TealiumConfig() |
TealiumConfig オブジェクトのコンストラクタ |
timedEventTriggers |
自動トラッキング時間付きイベント用の TimedEventTrigger オブジェクトのリスト |
updateDistance |
位置情報の更新を受信する距離間隔(メートル)を設定します |
useHighAccuracy |
位置情報の精度を低精度(デフォルト)または高精度に設定します |
webviewProcessPool |
アプリに Tealium タグ管理ウェブビュー以外の他のウェブビューが含まれる場合における Cookie の同期問題を防止します |
webviewConfig |
カスタム WKWebviewConfiguration オブジェクトが渡されるように許可して、これが Tealium タグ管理ウェブビューによって使用されるようにします |
addRemoteCommand()
後で実行するためのリモートコマンドを追加します。
addRemoteCommand(command)
パラメータ | 型 | 説明 |
---|---|---|
command |
RemoteCommand |
追加する TealiumRemoteCommand のインスタンス |
次の例は、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 が初期化時に既知である場合は、既知の訪問者 ID を Adobe ECID に設定します。ECID が将来変更になった場合は、 linkECIDToKnownIdentifier
を呼び出して、訪問者 ID を更新します。
config.adobeVisitorCustomVisitorId = "20381482060927465156359999806251989655"
adobeVisitorDataProviderId
ECID を既知の ID とリンクさせるときに必要となる、Adobe が提供するデータ プロバイダー ID を設定します。
config.adobeVisitorDataProviderId = "01"
adobeVisitorExistingEcid
新規の ECID をリクエストせず、以前のインストールからの既存の ECID (Adobe SDK など) を設定して用います。
例:
config.adobeVisitorExistingEcid = "20381482060927465156359999806251989655"
adobeVisitorOrgId
@
部分を含めて、Adobe 組織 IDを含むストリング。組織 ID が提供されない場合は、モジュールは初期化されず、訪問者 ID が取得されません。トラッキング コールは、Adobe ECID がなくとも通常とおり継続します。
config.adobeVisitorOrgId = STRING_VALUE
例:
config.adobeVisitorOrgId = "1A2A111A111150AA0A110A12@AdobeOrg"
adobeVisitorRetries
ECID を用いずにトラッキング コールが送信されることになる、リスクエストの失敗までに認められる無効な訪問者 ID の再試行の回数。
例:
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 モジュールeとともに用いるため。
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 にそれを転送するモジュールです。コレクターの中にはコア ライブラリに含まれるものもあれば、オプションで、別個のモジュールとしてインストールされるものもあります。
以下の表では、利用可能なコレクターを列挙しています。デフォルト コレクターは、コレクター名に「*」印を付して注記しています。
Collector Name | TealiumConfig のリファレンス |
---|---|
AdobeVisitor |
Collectors.AdobeVisitor |
AppData * |
Collectors.AppData |
Connectivity * |
Collectors.Connectivity |
Device |
Collectors.Device |
Lifecycle |
Collectors.Lifecycle |
このモジュールは、 TealiumConfig
collectors
プロパティを用いて有効化または無効化されます。
お使いのコレクターの既存リストに以下の例を追加します。
config.collectors = [Collectors.AdobeVisitor]
connectivityRefreshEnabled
有効な場合(デフォルト)、Connectivityモジュールは、(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
同意ポリシーを設定します (デフォルト: GDPR)、たとえばCCPA。Consent Manager は、このプロパティが設定されている場合のみ有効です。
config.consentPolicy = .ccpa
deepLinkTrackingEnabled
標準ディープ リンク (Facebook などのソースからアプリへのリンクや、QR トレースなど) の自動トラッキングを有効化または無効化します。デフォルトでは有効になっています。
config.deepLinkTrackingEnabled = true
desiredAccuracy
アプリが受け取る位置データの精度。
config.desiredAccuracy = .best
利用可能な desiredAccuracy
オプションは、次のとおりです:
desiredAccuracy option |
説明 |
---|---|
.bestForNavigation |
正確なポジション情報が常に必要なナビゲーション アプリでの使用が意図される精度のレベル |
.best |
非常に高い精度 (ただし、ナビゲーションアプリに必要なものと同じレベルの精度は不要) |
.nearestTenMeters |
10 メートル単位での精度 |
.nearestHundredMeters |
100 メートル単位での精度 |
.reduced |
1 ~ 20 キロメートル単位の精度 |
.withinOneKilometer |
1 キロメートル単位の精度 |
.withinThreeKilometers |
3 キロメートル単位での精度 |
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
existingVisitorId
アプリ拡張機能でファーストパーティIDとして使用される既存の訪問者IDを設定します|
config.existingVisitorId = id
geofenceFileName
ローカルジオフェンスファイルアセットの名前を設定します。ファイル拡張子は含めないでください。
config.geofenceFileName = <String>
Type | 説明 | 例 |
---|---|---|
String |
JSONファイル名 | geofences.jsom |
geofenceTrackingEnabled
ジオフェンス トラッキングを有効化または無効化します。
config.geofenceTrackingEnabled = false
Type | 説明 | 例 |
---|---|---|
String |
JSONファイル名 | geofences.json |
geofenceUrl
ホスト型ジオフェンスファイルのURLを設定します。
config.geofenceUrl = <String (url)>
Type | 説明 | 例 |
---|---|---|
String |
ジオフェンスファイルのURL | https://example.com/.../geofences.json |
hostedDataLayerExpiry
ホスト型データレイヤーデータの有効期限を設定します。このプロパティが設定されていない場合は、ホストされているデータレイヤーアイテムの有効期限はデフォルトで 7 日間になっており、この期限が満了次第、CDN から再ダウンロードされます。
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
カスタム ロガーを TealiumLoggerProtocol
(現在の TealiumLogger
から置き換えられるもの) に準拠するように設定します。
次の例は、構成オブジェクトにカスタム ロガーを設定する方法を示しています。
class CustomLogger: TealiumLoggerProtocol {
// ... conforming to the TealiumLoggerProtocol
// plus your own custom methods
}
class TealiumHelper {
let config = TealiumConfig(...)
var tealium: Tealium?
let customLogger = CustomLogger()
// ...
private init() {
config.logger = customLogger
// ...
tealium = Tealium(config: config)
}
}
logLevel
ログ (記録) されている情報の量を制御するログ レベル プロパティを、以下の値のいずれかに設定します。
ログレベル | ログ アクティビティの説明 |
---|---|
.debug |
アプリケーションをデバッグするために用いられるデバッグ レベルのイベント (開発環境用で推奨) |
.info |
アプリケーションの進捗を表示する情報イベント |
.error |
重要なエラーと失敗などのエラー イベント |
.fault |
障害または重大イベント (システムレベル エラーや複数プロセス エラーなど) |
.silent |
ログがありません |
config.logLevel = .debug
Xcode コンソールまたは Mac Console アプリで開発ログを表示します。お使いの iOS デバイスに接続して、Console アプリを用いて本番ログを表示します。
logType
新しいロガー タイプを設定します。デフォルトは、 .os
または OSLog
になっています
次の例は、ログ レベルを print
に設定する方法を示しています。
config.logType = .print
memoryReportingEnabled
DeviceDataモジュールでメモリレポートを有効または無効にします(デフォルトでは無効)。
config.memoryReportingEnabled = true
minimumFreeDiskSpace
Disk Storage (ディスク ストレージ) を有効化するために最小フリー ディスク スペース (メガバイト単位) を設定します
config.minimumFreeDiskSpace = 25
minutesBetweenRefresh
CDN から公開設定を取得する頻度を決定します
config.minutesBetweenRefresh = 15
onConsentExpiration
同意選択の有効期限が切れたときに実行するコールバック。
config.onConsentExpiration = {
// display consent modal
}
overrideCollectProfile
データを別のTealiumプロファイルに送信するようにTealium Collectのプロファイルをオーバーライドします。
config.overrideCollectProfile = "main"
overrideCollectURL
データを別のエンドポイントに送信するようにTealium CollectのURLをオーバーライドします。イベント バッチング機能を用いる場合は、 overrideCollectBatchURL プロパティのオーバーライドもします。
config.overrideCollectURL = url
Property value | 型 | 説明 |
---|---|---|
url |
String |
オーバーライドするURL |
デフォルトのURLは次のとおりです。
https://collect.tealiumiq.com/event/
このプロパティは、カスタム ホスト名を設定するため、または特定の地域のホスト名を設定するために使用されます。次の例では、Tealium CollectのベースURLが中央ヨーロッパ地域内に留まるように設定されます。
let url = "https://collect-eu-central-1.tealiumiq.com/event/"
config.overrideCollectURL = url
overrideCollectBatchURL
データを別のエンドポイントに送信するように Tealium Collect のバッチ URL をオーバーライドします。
config.overrideCollectBatchURL = url
Property value | 型 | 説明 |
---|---|---|
url |
String |
オーバーライドするURL |
イベントバッチ処理を使用するデフォルトのURLは次のとおりです。
https://collect.tealiumiq.com/bulk-event/
このメソッドは通常、カスタムホスト名を設定するため、または特定の地域のホスト名を設定するために使用されます。次の例では、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"
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のRemoteCommandsモジュールに関するページを参照)。
config.remoteHTTPCommandDisabled = true
rootView
WKWebView
がアタッチされる現在のUIView
を設定します。自動検出が失敗する可能性がある、プッシュ通知などの複雑なビュー階層がある場合にのみ必要です。
let view = self.view
config.rootView = view
searchAdsEnabled
属性モジュールで Apple Search Ads API を有効または無効にします (デフォルト: 無効)。
config.searchAdsEnabled = true
sessionCountingEnabled
Tealium iQ アカウント用のセッション カウントを無効化します。Tealium JavaScript ファイルをセルフ ホストしている場合にこれを用います (デフォルト: true)。
config.sessionCountingEnabled = false
shouldAddCookieObserver
true
(デフォルト) に設定されている場合、このメソッドはすべての Cookie を正常に移行するために WKWebView
Cookie オブザーバーを追加するかどうかを決定します。false
に設定すると、複数のCookieオブザーバーが存在する場合に、そのうちの1つのみが呼び出されるため、一部のCookieが移行されない可能性があります。
config.shouldAddCookieObserver = false
shouldAddCookieObserver
プロパティを使用すると、Cookie の同期中に独自の Cookie オブザーバーを使用でき、Cookie オブザーバーは、設定後にメイン スレッドで Cookie を取得する必要があります。この問題はWKWebView
のバグを原因としたもので、独自のオブザーバーを呼び出すことができません。
shouldUseRemotePublishSettings
モバイル公開設定(バージョン1.9.0以降)を有効(デフォルト)または無効に設定します。
config.shouldUseRemotePublishSettings = false
モバイル公開設定はデフォルトで有効になっており、使用しない場合は無効にする必要があります。モバイル公開設定を iQ タグ管理で設定するか、Swift インストールで config.shouldUseRemotePublishSettings = false
を使用して機能を無効化します。これを行わないと、初期化が失敗し、トラッキングできなくなります。
skAdAttributionEnabled
属性モジュールで 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, optionalData:Dictionary, dataSource:String)
パラメータ | 型 | 説明 | 例 |
---|---|---|---|
account |
String |
Tealiumアカウントの名前 | companyXYZ |
profile |
String |
Tealiumプロファイルの名前 | main |
environment |
String |
Tealium環境の名前 | [dev , qa , prod ] |
datasource |
String |
(オプション)CDHのTealiumデータソースキー | abc123 |
timedEventTriggers
自動トラッキング時間付きイベント用の TimedEventTrigger
オブジェクトのリスト。
config.timedEventTriggers = [TimedEventTrigger(start: "START_EVENT",
stop: "STOP_EVENT",
name: "TIMED_EVENT_NAME")]
TimedEventTrigger
のパラメータは、以下のとおりです。
パラメータ | 型 | 説明 |
---|---|---|
start |
String |
時間付きイベントを開始するための TealiumEvent の名前 |
stop |
String |
時間付きイベントを停止するための TealiumEvent の名前 |
name |
String? |
(オプション) 時間付きイベントの名前 (デフォルト: "START_EVENT::STOP_EVENT" ) |
updateDistance
位置情報の更新を受信する距離間隔(メートル)を設定します。
このメソッドは、useHighAccuracy
がtrue
に設定されている場合にのみ使用してください。
config.updateDistance = <Double>
Type | 説明 | 例 |
---|---|---|
Double |
位置情報の更新を受信する距離間隔(メートル) | 150.0 |
使用方法の例:
func start() {
let config = TealiumConfig(account: "ACCOUNT",
profile: "NAME",
environment: "ENVIRONMENT",
datasource: "DATASOURCE",
optionalData: nil)
// Tealium Location module config methods
config.useHighAccuracy = true
config.updateDistance = 150.0
}
useHighAccuracy
位置情報の精度を低精度(デフォルト)または高精度に設定します。
このプロパティはデフォルトで無効になっており、位置の精度を低精度に設定します。位置情報対応デバイスが500メートル以上移動した場合は、位置の大幅な変更と見なされ、位置情報が更新されます。通常、この設定では、位置情報の更新に5分以上かかります。
Appleの大幅変更位置情報サービスの詳細については、こちらを参照してください。
有効になっている場合、このプロパティはデータの位置精度を可能な限り高精度に設定します。最初のイベントは可能な限り早急に配信され、位置の特定を継続し、そのデータが利用可能になったときに追加のイベントが必要に応じて配信されます。
Appleの位置データの精度の詳細については、こちらを参照してください。
高精度を使用すると、位置情報の更新が頻繁に行われるため、低精度を使用する場合よりもデバイスのバッテリー消費量が多くなります。
config.useHighAccuracy = <Bool>
Type | 説明 | 例 |
---|---|---|
Boolean |
位置データの精度を設定します | true |
使用方法の例:
func start() {
let config = TealiumConfig(account: "ACCOUNT",
profile: "NAME",
environment: "ENVIRONMENT",
datasource: "DATASOURCE",
optionalData: nil)
// Tealium Location module config methods
config.useHighAccuracy = true
config.updateDistance = 150.0
}
webviewProcessPool
アプリに Tealium タグ管理ウェブビュー以外の他のウェブビューが含まれる場合における Cookie の同期問題を防止します。アプリでウェブビューを使用する場合は、シングルトン WKProcessPool
を作成し保持し、Tealium をインタンス化する前に設定します。
例:
let processPool = MyApp.wkProcessPool
config.webviewProcessPool = processPool
webviewConfig
カスタム WKWebviewConfiguration
オブジェクトが渡されるように許可して、これが Tealium タグ管理ウェブビューによって使用されるようにしますwebviewProcessPool
オプションの代わりにこのオプションを使用する場合は、シングルトン WKProcessPool
を、カスタマイズ可能な WKWebviewConfiguration
processPool
プロパティを通じて設定します。
このオプションを使用することを推奨します。この理由は、将来の API の変更が WKWebView
になされた場合に必要になることがあるからです。
例:
let processPool = MyApp.wkProcessPool
let configuration = WKWebViewConfiguration()
configuration.processPool = processPool
config.webviewConfig = configuration
このページはお役にたちましたでしょうか?
最終更新日 :: 2022年August月29日