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()`	次のトラッキングコールで新しいものを取得することにより、訪問のECIDをリセットします。
`resetVisitorId()`	ユーザーの新しい訪問IDを生成します。
`startTimedEvent()`	指定された名前でタイムドイベントを開始します。
`stopTimedEvent()`	タイムドイベントのタイマーを停止し、`timed_event`トラッキングコールをトリガーします。
`Tealium()`	新しい`Tealium`オブジェクトのコンストラクター。
`track()`	関連データを持つイベントをトラックし、オプションでコールバック関数をトリガーします。
`visitor`	完全な`AdobeVisitor`インスタンスを返します。
`visitorId`	ランダムに生成され、一意の永続的な訪問IDを返します。

`cancelTimedEvent()`

タイムドイベントのタイマーをキャンセルします。タイムドイベントは追跡されません。

tealium?.cancelTimedEvent(name: "TIMED_EVENT_NAME")

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

`clearAllTimedEvents()`

以前に開始されたすべてのタイムドイベントをクリアします。タイムドイベントは追跡されません。

tealium?.clearAllTimedEvents()

`clearStoredVisitorIds()`

以前に保存された訪問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（例：Consent Manager）によってブロックされる可能性があります。

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オブジェクトの他の使用、例えば別のウェブページのロードなどは、予測不可能な挙動を引き起こす可能性があり、強く非推奨です。

 tealium?.getTagManagementWebView { webView in
    if #available(iOS 16.4, *) {
        webView.isInspectable = true // XCode 14.3+およびiOS 16.4+でtagManagement webviewsを検査するため
    }
  }

`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`

訪問IDの変更を通知します。

let subscription = tealium?.onVisitorId.subscribe { newVisitor in
    // 訪問の変更をここで処理
}

`resetVisitor()`

次のトラッキングコールで新しいECIDを取得することにより、訪問のECIDをリセットします。

resetVisitor()

例:

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

`resetVisitorId()`

ユーザーの新しい訪問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"]]`

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

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

パラメーター	型	説明	例
`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`

ランダムに生成された一意の永続的な訪問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