Tealium（ティリウム） | APIリファレンス | Tealium開発者ドキュメントプレビュー

クラス: `Tealium`

以下は、iOS（Swift）のTealiumクラスの一般的に使用されるメソッドの概要です。

メソッド/プロパティ	説明
`cancelTimedEvent()`	タイマーをキャンセルします。
`clearStoredVisitorIds()`	visitorIdsのキャッシュを削除し、`resetVisitorId`を呼び出します。
`clearAllTimedEvents()`	以前に開始されたすべてのタイマーイベントをクリアします。
`decorateUrl()`	URLにAdobe ECIDパラメータを追加します。
`disable()`	Tealiumライブラリを無効にします。
`flushQueue()`	キューに入れられたディスパッチをすぐに送信します。
`gatherTrackData()`	カスタムデータレイヤーの値とコレクターモジュールのデータレイヤーの値をすべて返します。
`getTagManagementWebView()`	TagManagement WebViewを返します。
`joinTrace()`	指定したIDでトレースに参加します。
`leaveTrace()`	以前に参加したトレースを終了し、訪問者セッションを終了します。
`linkECIDToKnownIdentifier`	現在のECIDを既知のセカンダリID（電子メールアドレスなど）にリンクします。
`onVisitorId`	`visitorId`の変更を通知します。
`resetVisitor()`	次のトラッキングコールで新しいvisitor ECIDを取得してリセットします。
`resetVisitorId()`	ユーザーの新しいvisitor IDを生成します。
`startTimedEvent()`	指定した名前でタイマーイベントを開始します。
`stopTimedEvent()`	タイマーを停止し、`timed_event`トラッキングコールをトリガーします。
`Tealium()`	新しい`Tealium`オブジェクトのコンストラクターです。
`track()`	関連するデータを持つイベントをトラッキングし、必要に応じてコールバック関数をトリガーします。
`visitor`	完全な`AdobeVisitor`インスタンスを返します。
`visitorId`	ランダムに生成された一意の永続的なvisitor IDを返します。

`cancelTimedEvent()`

タイマーイベントのタイマーをキャンセルします。タイマーイベントはトラッキングされません。

tealium?.cancelTimedEvent(name: "TIMED_EVENT_NAME")

パラメーター	タイプ	説明
`name`	`String`	タイマーイベントの名前

`clearAllTimedEvents()`

以前に開始されたすべてのタイマーイベントをクリアします。タイマーイベントはトラッキングされません。

tealium?.clearAllTimedEvents()

`clearStoredVisitorIds()`

以前に保存されたすべてのvisitor IDとハッシュ化された顧客識別子をクリアします。

tealium?.clearStoredVisitorIds()

`decorateUrl()`

入力URLにAdobe ECIDクエリパラメータを追加します。

decorateUrl(_ url: URL, completion: ((URL) → Void)

パラメーター	タイプ	説明
`url`	`URL`	デコレートするURL
`completion`	`URL` -> Void	デコレートされたURLで呼び出されるブロック。

例:

var tealium: Tealium?
...
let url = URL(string: "https://www.tealium.com")!
tealium?.adobeVisitorApi?.decorateUrl(url) { newUrl in
    // 新しいURLを使用する
}

`disable()`

Tealiumライブラリを無効にし、すべてのモジュール参照を削除します。必要な場合は、新しいTealiumインスタンスを作成して再度有効にします。

tealium?.disable()

`flushQueue()`

キューに入れられたすべてのディスパッチをすぐに送信します。同意マネージャなどのDispatchValidatorによってリクエストがブロックされる場合があります。

tealium?.disable()

`gatherTrackData()`

現在のカスタムデータレイヤーの値とコレクターモジュールのデータレイヤーの値をすべて取得します。結果はキャッシュされ、非同期に返されます。最新の値を取得するには、retrieveCachedDataをfalseに設定します。返された値を処理するために、完了ハンドラを使用します。カスタムデータレイヤーの値は、カスタムキーを使用して直接参照し、コレクターモジュールの値はTealiumDataKey.を使用して参照します。

 tealium?.gatherTrackData(retreiveCachedData: false, completion: { allData in
    let lifecycleTotalWakeCount = allData[TealiumDataKey.totalWakeCount]
    let visitorId = allData[TealiumDataKey.visitorId]
    let userLanguage = allData["user_language"]
})

参照: Tealium.dataLayer.allも参照してください。

`getTagManagementWebView()`

（v2.10.0で新規追加）

TagManagement WebViewを返します。クライアントはisInspectableフラグを設定してXCode 14.3+でデバッグできます。

他のWebviewオブジェクトの使用（別のWebページの読み込みなど）は、予測不可能な動作を引き起こす可能性があるため、強く推奨されません。

 tealium?.getTagManagementWebView { webView in
    if #available(iOS 16.4, *) {
        webView.isInspectable = true // XCode 14.3+およびiOS 16.4+でTagManagement Webviewを検査するために使用します。
    }
  }

`joinTrace()`

指定したIDでトレースに参加します。leaveTrace()が呼び出されるまで、トレースはアプリのセッションの間有効です。Tealium Customer Data Hubのトレース機能について詳しくは、ドキュメントを参照してください。

joinTrace(traceId: String)

パラメーター	タイプ	説明	例
`traceId`	`String`	Traceツールから取得したトレースID	`"12345"`

`leaveTrace()`

以前に参加したトレースを終了し、訪問者セッションを終了します。トレース訪問者セッションを保持する場合は、オプションのパラメーターを指定します。

tealium?.leaveTrace(killVisitorSession: false)

パラメーター	タイプ	説明	例
`killVisitorSession`	`Bool`	（オプション）パラメーターが指定されていない場合は`true`に設定します。訪問者セッションを終了したくない場合は`false`に設定します。デフォルトは`true`です。	`false`

`linkECIDToKnownIdentifier()`

現在のECIDを既知のセカンダリID（電子メールアドレスなど）にリンクします。

linkECIDToKnownIdentifier(
  _ knownID: String,
  adobeDataProviderId: String,
  authState: AdobeVisitorAuthState?,
  completion: ((Result<AdobeVisitor, Error>) → Void)

パラメーター	タイプ	説明
`knownId`	`String`	既知の識別子。
`adobeDataProviderId`	`String`	Adobeデータプロバイダー識別子。
`authState`	`AdobeVisitorAuthState`	認証状態。
`completion`	`Result<AdobeVisitor, Error>`	Adobeのレスポンスリスナー。

例:

var tealium: Tealium?
...

tealium?.adobeVisitorApi?.linkECIDToKnownIdentifier(
  "myidentifier", adobeDataProviderId: "123456", .unknown
  )

`onVisitorId`

visitor IDの変更を通知します。

let subscription = tealium?.onVisitorId.subscribe { newVisitor in
    // visitorの変更を処理する
}

`resetVisitor()`

次のトラッキングコールで新しいvisitor ECIDを取得してリセットします。

resetVisitor()

例:

var tealium: Tealium?
//...
tealium?.adobeVisitorApi?.resetVisitor()

`resetVisitorId()`

ユーザーの新しいvisitor IDを生成します。

tealium?.resetVisitorId()

`startTimedEvent()`

指定した名前でタイマーイベントを開始します。同じイベント名でこのメソッドが再度呼び出された場合、イベントが終了またはキャンセルされていない場合は無視されます。イベントの開始時刻は永続化されません。

イベント名と一緒にオプションのデータが渡された場合、タイマーがstopTimedEvent()呼び出しで停止されると、トラックコールに追加されます。

tealium.startTimedEvent(name: "TIMED_EVENT_NAME", with: ["custom_key": "custom_value"])

パラメーター	タイプ	説明
`name`	`String`	タイマーイベントの名前
`["custom_key": "custom_value"]` (オプション)	`Map`	データレイヤーでトラッキングするキーと値のオブジェクト

`stopTimedEvent()`

タイマーイベントのタイマーを停止し、timed_eventトラッキングコールをトリガーします。

tealium?.stopTimedEvent(name: "TIMED_EVENT_NAME")

パラメーター	タイプ	説明
`name`	`String`	タイマーイベントの名前

`Tealium()`

新しいTealiumオブジェクトのコンストラクターです。

Tealium(config: TealiumConfig, completion: Closure)

パラメーター	タイプ	説明
`config`	`TealiumConfig`	アカウントの詳細を含む`TealiumConfig`オブジェクトでTealiumオブジェクトを初期化します。
`completion`	`Closure`	（オプション）初期化が完了したときに呼び出される完了クロージャー`()-> Void )?`

`track()`

TealiumViewまたはTealiumEventタイプを使用して、スクリーンビューまたはイベントをトラッキングします。

let tealView = TealiumView("VIEW_NAME", dataLayer: ["key": "value"])
tealium?.track(tealView)

パラメーター	タイプ	説明	例
`viewName`	`String`	トラッキングするスクリーンの名前	`viewName: "Buy Now"`
`dataLayer`	`Dictionary`	トラッキングするイベントに関連するデータのキーと値のオブジェクト	`data: data: ["product_id" : ["widget123"]]`

let tealEvent = TealiumEvent("EVENT_NAME", dataLayer: ["key": "value"])
tealium?.track(tealEvent)

viewNameに渡された値は、データレイヤーに変数tealium_eventとして表示されます。

パラメーター	タイプ	説明	例
`eventName`	`String`	トラッキングするイベントの名前	`eventName: "Buy Now"`
`dataLayer`	`Dictionary`	トラッキングするイベントに関連するデータのキーと値のオブジェクト	`data: data: ["product_id" : ["widget123"]]`

eventNameに渡された値は、データレイヤーに変数tealium_eventとして表示されます。

`visitor`

完全なAdobeVisitorインスタンスを返します。

var tealium: Tealium?
//...
let visitor = tealium?.adobeVisitorApi?.visitor
let id: String? = visitor?.experienceCloudId
let nextRefresh: Date? = visitor?.nextRefresh
let blob: String? = visitor?.blob
let region: String? = visitor?.dcsRegion
let ttl: String? = visitor?.idSyncTTL

`visitorId`

ランダムに生成された一意の永続的なvisitor IDを返します。

let visitorId: String? = tealium.visitorId

クラス: Tealium

cancelTimedEvent()

clearAllTimedEvents()

clearStoredVisitorIds()

decorateUrl()

disable()

flushQueue()

gatherTrackData()

getTagManagementWebView()

joinTrace()

leaveTrace()

linkECIDToKnownIdentifier()

onVisitorId

resetVisitor()

resetVisitorId()

startTimedEvent()

stopTimedEvent()

Tealium()

track()

visitor

visitorId