DataLayer | APIリファレンス | Tealium開発者ドキュメントプレビュー

クラス: `DataLayer`

このクラスは、トラッキングされるすべてのイベントに含まれるキーと値のデータを永続的に保存するためのものです。

DataLayerクラスで利用可能なメソッドは以下の通りです。

メソッド	説明
`all()`	データレイヤーに現在格納されているすべてのキーと値のペアを取得します
`clear()`	データレイヤーからすべてのデータを削除します
`contains()`	指定したキーがデータレイヤーに存在する場合は`true`を返します
`count()`	データレイヤーに現在格納されている値の数を返します
`get()`	指定したキーの値を取得します
`getBoolean()`	指定したキーの`Boolean`値を取得します
`getBooleanArray()`	指定したキーの`Array<Boolean>`値を取得します
`getDouble()`	指定したキーの`Double`値を取得します
`getDoubleArray()`	指定したキーの`Array<Double>`値を取得します
`getInt()`	指定したキーの`Int`値を取得します
`getIntArray()`	指定したキーの`Array<Int>`値を取得します
`getJsonArray()`	指定したキーの`org.json.JSONArray`値を取得します
`getJsonObject()`	指定したキーの`org.json.JSONObject`値を取得します
`getLong()`	指定したキーの`Long`値を取得します
`getLongArray()`	指定したキーの`Array<Long>`値を取得します
`getString()`	指定したキーの`String`値を取得します
`getStringArray()`	指定したキーの`Array<String>`値を取得します
`keys()`	データレイヤーに現在格納されているすべてのキーの`List<String>`を返します
`putBoolean()`	指定したキーに`Boolean`値を格納します
`putBooleanArray()`	指定したキーに`Array<Boolean>`値を格納します
`putDouble()`	指定したキーに`Double`値を格納します
`putDoubleArray()`	指定したキーに`Array<Double>`値を格納します
`putInt()`	指定したキーに`Int`値を格納します
`putIntArray()`	指定したキーに`Array<Int>`値を格納します
`putJsonArray()`	指定したキーに`org.json.JSONArray`値を格納します
`putJsonObject()`	指定したキーに`org.json.JSONObject`値を格納します
`putLong()`	指定したキーに`Long`値を格納します
`putLongArray()`	指定したキーに`Array<Long>`値を格納します
`putString()`	指定したキーに`String`値を格納します
`putStringArray()`	指定したキーに`Array<String>`値を格納します
`remove()`	指定したキーの値を削除します

`all`

データレイヤーに現在格納されているすべてのキーと値のマップを返します。

val dataLayer = tealium.dataLayer.all()

`clear`

データレイヤーに現在格納されているすべてのアイテムを削除します。

tealium.dataLayer.clear()

`contains`

指定したキーがデータレイヤーに存在する場合はtrueを返し、存在しない場合はfalseを返します。

パラメーター	型	説明
`key`	`String`	削除する変数の名前

tealium.dataLayer.contains("KEY")

`count`

データレイヤーに現在格納されているアイテムの数を返します。

tealium.dataLayer.count()

`get`

指定したキーの値を取得します。返される型は許可されている型のいずれかに一致し、それ以外の場合はnullが返されます。

このメソッドはAny型の変数（JavaのObjectに相当）を取得します。データ型を適切に使用するために、型キャストやinstanceofを使用して型を調べる必要があります。

パラメーター	型	説明
`key`	`String`	取得する変数の名前

val any = tealium.dataLayer.get("KEY")

`getBoolean`

指定したキーのBoolean値を取得します。指定したキーの値がBooleanでない場合はnullが返されます。

パラメーター	型	説明
`key`	`String`	取得する変数の名前

val bool = tealium.dataLayer.getBoolean("KEY")

`getBooleanArray`

指定したキーのArray<Boolean>値を取得します。指定したキーの値がArray<Boolean>でない場合はnullが返されます。

パラメーター	型	説明
`key`	`String`	取得する変数の名前

val booleanArray = tealium.dataLayer.getBooleanArray("KEY")

`getDouble`

指定したキーのDouble値を取得します。指定したキーの値がDoubleでない場合はnullが返されます。

パラメーター	型	説明
`key`	`String`	取得する変数の名前

val double = tealium.dataLayer.getDouble("KEY")

`getDoubleArray`

指定したキーのArray<Double>値を取得します。指定したキーの値がArray<Double>でない場合はnullが返されます。

パラメーター	型	説明
`key`	`String`	取得する変数の名前

val doubleArray = tealium.dataLayer.getDoubleArray("KEY")

`getInt`

指定したキーのInt値を取得します。指定したキーの値がIntでない場合はnullが返されます。

パラメーター	`型`	説明
`key`	`String`	取得する変数の名前

val int = tealium.dataLayer.getInt("KEY")

`getIntArray`

指定したキーのArray<Int>値を取得します。指定したキーの値がArray<Int>でない場合はnullが返されます。

パラメーター	型	説明
`key`	`String`	取得する変数の名前

val intArray = tealium.dataLayer.getIntArray("KEY")

`getJsonArray`

指定したキーのorg.json.JSONArray値を取得します。指定したキーの値がJSONArrayでない場合はnullが返されます。

パラメーター	型	説明
`key`	`String`	取得する変数の名前

val jsonArray = tealium.dataLayer.getJsonArray("KEY")

`getJsonObject`

指定したキーのorg.json.JSONObject値を取得します。指定したキーの値がJSONObjectでない場合はnullが返されます。

パラメーター	型	説明
`key`	`String`	取得する変数の名前

val jsonObject = tealium.dataLayer.getJsonObject("KEY")

`getLong`

指定したキーのLong値を取得します。指定したキーの値がLongでない場合はnullが返されます。

パラメーター	型	説明
`key`	`String`	取得する変数の名前

val long = tealium.dataLayer.getLong("KEY")

`getLongArray`

指定したキーのArray<Long>値を取得します。指定したキーの値がArray<Long>でない場合はnullが返されます。

パラメーター	型	説明
`key`	`String`	取得する変数の名前

val longArray = tealium.dataLayer.getLongArray("KEY")

`getString`

指定したキーのString値を取得します。指定したキーの値がStringでない場合はnullが返されます。

パラメーター	型	説明
`key`	`String`	取得する変数の名前

val string = tealium.dataLayer.getString("KEY")

`getStringArray`

指定したキーのArray<String>値を取得します。指定したキーの値がArray<String>でない場合はnullが返されます。

パラメーター	型	説明
`key`	`String`	取得する変数の名前

val stringArray = tealium.dataLayer.getStringArray("KEY")

`keys`

データレイヤーに現在格納されているすべてのキーのList<String>を返します。

tealium.dataLayer.keys()

`putBoolean`

指定したキーにBoolean値を格納します。

パラメーター	型	説明
`key`	`String`	格納する変数の名前
`value`	`Boolean`	格納する`Boolean`値
`expiry`	`Expiry`	(オプション) この変数の有効期限

tealium.dataLayer.putBoolean("KEY", true, Expiry.FOREVER)

`putBooleanArray`

指定したキーにArray<Boolean>値を格納します。

パラメーター	型	説明
`key`	`String`	格納する変数の名前
`value`	`Array<Boolean>`	格納する`Array<Boolean>`値
`expiry`	`Expiry`	(オプション) この変数の有効期限

tealium.dataLayer.putBooleanArray("KEY", arrayOf(true, false, true), Expiry.FOREVER)

`putDouble`

指定したキーにDouble値を格納します。

パラメーター	型	説明
`key`	`String`	格納する変数の名前
`value`	`Double`	格納する`Double`値
`expiry`	`Expiry`	(オプション) この変数の有効期限

tealium.dataLayer.putDouble("KEY", 10.5, Expiry.FOREVER)

`putDoubleArray`

指定したキーにArray<Double>値を格納します。

パラメーター	型	説明
`key`	`String`	格納する変数の名前
`value`	`Array<Double>`	格納する`Array<Double>`値
`expiry`	`Expiry`	(オプション) この変数の有効期限

tealium.dataLayer.putDoubleArray("KEY", arrayOf(0.1, 10.5), Expiry.FOREVER)

`putInt`

指定したキーにInt値を格納します。

パラメーター	型	説明
`key`	`String`	格納する変数の名前
`value`	`Int`	格納する`Int`値
`expiry`	`Expiry`	(オプション) この変数の有効期限

tealium.dataLayer.putInt("KEY", 10, Expiry.FOREVER)

`putIntArray`

指定したキーにArray<Int>値を格納します。

パラメーター	型	説明
`key`	`String`	格納する変数の名前
`value`	`Array<Int>`	格納する`Array<Int>`値
`expiry`	`Expiry`	(オプション) この変数の有効期限

tealium.dataLayer.putIntArray("KEY", arrayOf(100, Int.MAX_VALUE), Expiry.FOREVER)

`putJsonArray`

指定したキーにorg.json.JSONArray値を格納します。

パラメーター	型	説明
`key`	`String`	格納する変数の名前
`value`	`JSONArray`	格納する`org.json.JSONArray`値
`expiry`	`Expiry`	(オプション) この変数の有効期限

val my_list = new JSONArray();
my_list.put("value_1");
my_list.put("value_2");
tealium.dataLayer.putJsonArray("KEY", my_list, Expiry.FOREVER);

`putJsonObject`

指定したキーにorg.json.JSONObject値を格納します。

パラメーター	型	説明
`key`	`String`	格納する変数の名前
`value`	`JSONObject`	格納する`org.json.JSONObject`値
`expiry`	`Expiry`	(オプション) この変数の有効期限

val my_obj = new JSONObject();
my_obj.put("key", "value");
tealium.dataLayer.putJsonObject("KEY", my_obj, Expiry.FOREVER);

`putLong`

指定したキーにLong値を格納します。

パラメーター	型	説明
`key`	`String`	格納する変数の名前
`value`	`Long`	格納する`Long`値
`expiry`	`Expiry`	(オプション) この変数の有効期限

tealium.dataLayer.putLong("KEY", Long.MAX_VALUE, Expiry.FOREVER)

`putLongArray`

指定したキーにArray<Long>値を格納します。

パラメーター	型	説明
`key`	`String`	格納する変数の名前
`value`	`Array<Long>`	格納する`Array<Long>`値
`expiry`	`Expiry`	(オプション) この変数の有効期限

tealium.dataLayer.putLongArray("KEY", arrayOf(1000L, Long.MAX_VALUE), Expiry.FOREVER)

`putString`

指定したキーにString値を格納します。

パラメーター	型	説明
`key`	`String`	格納する変数の名前
`value`	`String`	格納する`String`値
`expiry`	`Expiry`	(オプション) この変数の有効期限

tealium.dataLayer.putString("KEY", "String Value", Expiry.FOREVER)

`putStringArray`

指定したキーにArray<String>値を格納します。

パラメーター	型	説明
`key`	`String`	格納する変数の名前
`value`	`Array<String>`	格納する`Array<String>`値
`expiry`	`Expiry`	(オプション) この変数の有効期限

tealium.dataLayer.putStringArray("KEY",
    arrayOf("String 1", "String 2"), Expiry.FOREVER)

`remove`

指定したキーの値を削除します。

パラメーター	型	説明
`key`	`String`	削除する変数の名前

tealium.dataLayer.remove("KEY")

クラス: DataLayer

all

clear

contains

count

get

getBoolean

getBooleanArray

getDouble

getDoubleArray

getInt

getIntArray

getJsonArray

getJsonObject

getLong

getLongArray

getString

getStringArray

keys

putBoolean

putBooleanArray

putDouble

putDoubleArray

putInt

putIntArray

putJsonArray

putJsonObject

putLong

putLongArray

putString

putStringArray

remove