TealiumConfig

クラス: TealiumConfig

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

addDelegate()

TealiumDelegateプロトコルに準拠する新しいデリゲートを追加します。

addDelegate(delegate)

次の例は、現在のモジュールがTealiumDelegateプロトコルを実装していると仮定しています：

config.addDelegate(self)

addRemoteCommand()

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

addRemoteCommand(command)

Tealiumの初期化前に配置された次の例は、リモートコマンドを追加する方法を示しています：

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

batchingBypassKeys

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

config.batchingBypassKeys = ["home_screen"]

batchingEnabled

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

config.batchingEnabled = true

batchSize

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

config.batchSize = 8

collectOverrideProfile

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

config.collectOverrideProfile = "main"

collectOverrideURL

データを異なるエンドポイントに送信するためにTealium Collect URLを上書きします。

config.collectOverrideURL = url

デフォルトのURLは：

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

イベントバッチングを使用する場合のデフォルトのURLは：

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

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

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

connectivityRefreshEnabled

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

config.connectivityRefreshEnabled = true

connectivityRefreshInterval

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

config.connectivityRefreshInterval = 30

consentLoggingEnabled

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

config.consentLoggingEnabled = true

delegates

有効になっているデリゲートの配列を返します。

有効になっているデリゲートの配列を取得する方法を示す次の例：

let delegates = config.delegates

dispatchAfter

自動的にキューをフラッシュするイベントの数。

config.dispatchAfter = 20

dispatchExpiration

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

config.dispatchExpiration = 5

dispatchQueueLimit

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

config.dispatchQueueLimit = 50

enableRemoteHTTPCommand()

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

enableRemoteHTTPCommand()

existingVisitorId

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

config.existingVisitorId = id

geofenceFileName

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

config.geofenceFileName = <String>

geofenceUrl

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

config.geofenceUrl = <String (url)>

initialUserConsentCategories

ライブラリが初めて起動するときにユーザーの初期同意カテゴリを構成します。構成オブジェクトで渡された構成よりも保存された構成が優先されます。同意状態を .consented に構成します。

config.initialUserConsentCategories = [.cdp, .analytics]

initialUserConsentStatus

ライブラリが初めて起動するときにユーザーの初期同意状態を構成します。構成オブジェクトで渡された構成よりも保存された構成が優先されます。

同意状態が .consented の場合、利用可能なすべての同意カテゴリを含むカテゴリリストを構成します。カテゴリを選択的に構成することはできません。

このメソッドを使用して、同意が与えられる前に追跡されたすべてのイベントを無視し、同意が与えられる前にイベントをキューに入れるデフォルトの動作を上書きします。構成オブジェクトに次の行を追加します：

config.initialUserConsentStatus = .notConsented

以下は TealiumConsentStatus 列挙型からのTealium同意ステータスの異なるタイプを定義しています。

.unknown
unknown ステータスは、Consent Managerのデフォルト構成です。この状態では、Consent Managerはローカルにイベントをキューに入れ、肯定的な consented/notConsented ステータスが提供されるまで待ちます。

.consented
ユーザーが追跡に同意した場合に構成される consented ステータスです。この状態では、Consent Managerはすべての追跡コールが通常どおり続行されることを許可します。

.notConsented
ユーザーが追跡を拒否した場合に構成される notConsented ステータスです。この状態では、Consent Managerはすべての追跡コールをドロップし、SDKによるさらなる処理を停止します。

updateDistance

位置更新が受信される距離間隔（メートル）を構成します。

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

config.updateDistance = <Double>

使用例:

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

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

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

Appleの重要変更位置サービスについてもっと学ぶ。

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

Appleの位置データの精度についてもっと学ぶ。

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

config.useHighAccuracy = <Bool>

使用例:

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
  }