APIリファレンス | Cordova用Tealiumバージョン1.x

クラス: `Tealium`

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

メソッド	説明
`addPersistent()`	Tealium永続データストアにデータを追加します。
`addVolatile()`	Tealiumボラティルデータストアにデータを追加します。
`init()`	Tealium Cordovaプラグインを初期化します。
`getPersistent()`	Tealium永続データから値を返します。
`getVisitorID()`	現在のユーザーのTealiumビジターIDを返します。
`getVolatile()`	Tealiumボラティルデータストアから値を返します。
`removePersistent()`	Tealium永続データストアからデータを削除します。
`removeVolatile()`	Tealiumボラティルデータストアからボラティルデータを削除します。
`track()`	最初の引数のタイプとして`"view"`を渡すことでビューをトラックし、最初の引数のタイプとして`"link"`を渡すことでイベントをトラックします。
`trackEvent()`	すべての非閲覧者クティビティをトラックします。
`trackView()`	ユーザーがアプリ内で画面を開いたり変更したりするたびにトラックします。

`addPersistent()`

Tealium永続データストアに永続データを追加します。

tealium.addPersistent(key, data, instance);

パラメーター	タイプ	説明	例
`key`	`String`	永続化する値のキー名	`"user_hashed_email"`
`data`	`String` or `[String]`	このキーのために永続化する値	`["testpersist", "testpersist2"]`
`instance`	`String`	特定のトラッキングインスタンスを参照するための任意のインスタンス名定数	`"tealium_main"`

`addVolatile()`

Tealiumボラティルデータストアにデータを追加します。

tealium.addVolatile(key, data, instance);

パラメーター	タイプ	説明	例
`key`	`String`	ボラティルメモリに保存する値のキー名	`"user_hashed_email"`
`data`	`String` or `[String]`	このキーのためにボラティルメモリに保存する値	`["testvolatile1", "testvolatile2"]`
`instance`	`String`	特定のトラッキングインスタンスを参照するための任意のインスタンス名定数	`"tealium_main"`

`init()`

Tealium Cordovaプラグインを初期化します。

tealium.init(config, successCallBack, errorCallback);

パラメーター	タイプ	説明
`config`	JavaScript/JSONオブジェクト	構成オブジェクト（以下のテーブルを参照）
`successCallback`	関数	デフォルトの成功コールバックをオーバーライドしてカスタムの成功処理を行います。
`errorCallback`	関数	デフォルトの成功コールバックをオーバーライドしてカスタムの成功処理を行います。

configオブジェクトは最初の引数として渡され、以下のデータを含みます。

tealium.init({account, profile, environment, instance,
                isLifecycleEnabled,
                collectDispatchURL,
                collectDispatchProfile,
                isCrashReporterEnabled,
                logLevel,
                dataSourceId});

パラメーター	タイプ	説明	例
`account`	`String`	Tealiumアカウント名	`"companyXYZ"`
`profile`	`String`	Tealiumプロファイル名	`"main"`
`environment`	`String`	Tealium環境名	[`"dev"`, `"qa"`, `"prod"`]
`instance`	`String`	Tealiumインスタンス名（複数のインスタンスがサポートされています）	`"tealium_main`
`isLifecycleEnabled`	`String`	（オプション）ライフサイクルトラッキングを有効にするための文字列値 “true"または “false”（デフォルト：`"true"`）	[`"true"`, `"false"`]
`collectDispatchURL`	`String`	Tealium CollectエンドポイントURLを上書きします。	`"https: //collect. tealiumiq.com/ vdata/i.gif ?tealium_account =companyXYZ &tealium_profile =main"`
`collectDispatchProfile`	`String`	Tealium Collectエンドポイントで使用するプロファイルを構成します。	`"cordova-demo"`
`isCrashReporterEnabled`	`String`	（オプションでAndroidのみ）クラッシュレポートを有効にします（未キャッチの例外ハンドラ）	[`"true"`, `"false"`]
`logLevel`	`String`	（オプション）ログレベルを構成します（環境にデフォルトが構成されます）	`tealium.logLevels.DEV`（情報、警告、エラー）、`tealium.logLevels.QA`（警告、エラー）、`tealium.logLevels.PROD`（エラーのみ）、`tealium.logLevels.SILENT`（ログなし）
`dataSourceId`	`String`	（オプション）データソースキー	“abc123”

`getPersistent()`

Tealium永続データから値を返します。要求されたデータが見つからない場合、JavaScript側ではnullを返します。

tealium.getPersistent(key, instance, callback);

パラメーター	タイプ	説明	例
`key`	`String`	永続保存から取得する値のキー名	`"user_hashed_email"`
`instance`	`String`	特定のトラッキングインスタンスを参照するための任意のインスタンス名定数	`"tealium_main"`
`callback`	`Function`	永続保存から要求された値を返すためのコールバックオブジェクト	`null`

`getVisitorID()`

現在のユーザーのTealiumビジターIDを返します。

返り値	返り値のタイプ
現在のビジターID	`String`

`getVolatile()`

Tealiumボラティルデータストアから値を返します。要求されたデータが見つからない場合、JavaScript側ではnullを返します。

tealium.getVolatile(key, instance, callback);

パラメーター	タイプ	説明	例
`key`	`String`	ボラティル保存から取得する値のキー名	`"user_hashed_email"`
`instance`	`String`	特定のトラッキングインスタンスを参照するための任意のインスタンス名定数	`"tealium_main"`
`callback`	`Function`	ボラティル保存から要求された値を返すためのコールバックオブジェクト	`null`

`removePersistent()`

Tealium永続データストアから永続データを削除します。

tealium.removePersistent(key, instance);

パラメーター	タイプ	説明	例
`key`	`String`	永続保存から削除する値のキー名	`"user_hashed_email"`
`instance`	`String`	特定のトラッキングインスタンスを参照するための任意のインスタンス名定数	`"tealium_main"`

`removeVolatile()`

Tealiumボラティルデータストアからボラティルデータを削除します。

tealium.removeVolatile(key, instance);

パラメーター	タイプ	説明	例
`key`	`String`	ボラティルメモリから削除する値のキー名	`"user_hashed_email"`
`instance`	`String`	特定のトラッキングインスタンスを参照するための任意のインスタンス名定数	`"tealium_main"`

`track()`

最初の引数のタイプとして"view"を渡すことでビューをトラックし、最初の引数のタイプとして"link"を渡すことでイベントをトラックします。

tealium.track(type, data, instance);

パラメーター	タイプ	説明	例
`type`	`String`	Tealiumイベントタイプ名 - `"link"`（イベント）または`"view"`（画面ビュー）	[`"link"`, `"view"`]
`data`	JavaScript/JSONオブジェクト	このトラッキングコールのデータレイヤーを指定されたキーと値のペアで埋めます。	`{"tealium_event" : "page_view"}`
`instance`	`String`	Tealiumインスタンス名 - 特定のトラッキングインスタンスを参照します。	`"tealium_main"`

`trackEvent()`

すべての非閲覧者クティビティをトラックします。

tealium.trackEvent(data, instance);

パラメーター	タイプ	説明	例
`data`	JavaScript/JSONオブジェクト	イベントデータをキーと値のペアで指定します。	`{"tealium_event": "cart_add"}`
`instance`	`String`	Tealiumインスタンス名 - 特定のトラッキングインスタンスを参照します。	`"tealium_main"`

`trackView()`

ユーザーがアプリ内で画面を開いたり変更したりするたびにトラックします。

tealium.trackView(data, instance);

パラメーター	タイプ	説明	例
`data`	JavaScript/JSONオブジェクト	ビューデータをキーと値のペアで指定します。	`{tealium_event:"screen_view", "screen_name":"Homescreen"}`
`instance`	`String`	Tealiumインスタンス名	`"tealium_main"`

クラス: Tealium

addPersistent()

addVolatile()

init()

getPersistent()

getVisitorID()

getVolatile()

removePersistent()

removeVolatile()

track()

trackEvent()

trackView()