DataLayer
TealiumのAndroid(Kotlin)用DataLayerクラスとメソッドのリファレンスガイド。
クラス: 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")
最終更新日 :: 2025年July月30日