ユーティリティ関数 | APIリファレンス

以下の utag.ut 関数が利用可能です：

関数	説明
`decode()`	エンコードされたURIコンポーネントまたは `String` のデコード値を返します
`encode()`	デコードされたURIコンポーネントまたは `String` のエンコード値を返します
`flatten()`	オブジェクト引数のフラット化された値を返します
`hasOwn()`	オブジェクトが指定されたプロパティを自身のプロパティとして持っているかどうかを示すブール値を返します
`isEmpty()`	引数が空であることを示すブール値 `true` を返すか、空でない場合はブール値 `false` を返します
`isEmptyObject()`	オブジェクト引数が空であることを示すブール値 `true` を返すか、空でない場合はブール値 `false` を返します
`loader()`	タグテンプレートはこの関数を使用して、タグをiframe、画像、またはスクリプトとしてロードし、タグがロードされたときにコールバックをトリガーします。
`merge()`	一つのオブジェクトから別のオブジェクトへプロパティをマージします
`typeOf()`	変数の型を文字列として返します

`utag.ut.decode()`

エンコードされたURIコンポーネントまたは String のデコード値を返します。この関数は標準的なJavaScript関数 decodeURIComponent() と unescape() をラップしています。

utag.ut.decode(encodedStr)

パラメータ	タイプ	説明
`encodedStr`	`String`	デコードするためのエンコードされた文字列

例：

utag.ut.decode("Tealium%20Developer%20Docs!");     // "Tealium Developer Docs!"
utag.ut.decode("https%3A%2F%2Fdocs.tealium.com");  // "https://docs.tealium.com"

`utag.ut.encode()`

デコードされたURIコンポーネントまたは文字列のエンコード値を返します。この関数は標準的なJavaScript関数 encodeURIComponent() と escape() をラップしています。

utag.ut.encode(decodedStr)

パラメータ	タイプ	説明
`decodedStr`	`String`	エンコードするためのデコードされた文字列

例：

utag.ut.encode("Tealium Developer Docs!");   // "Tealium%20Developer%20Docs!"
utag.ut.encode("https://docs.tealium.com");  // "https%3A%2F%2Fdocs.tealium.com"

`utag.ut.flatten()`

オブジェクト引数のフラット化された値を返します。この関数は、渡されるオブジェクトが1レベル深さであることを前提としています。文字列、配列、ブール値、または数値（浮動小数点数または整数）に到達すると、関数は停止します。多階層のオブジェクトやオブジェクトの配列に対してこの関数を使用しないでください。

utag.ut.flatten(obj)

パラメータ	タイプ	説明
`obj`	`Object`	フラット化するオブジェクト

例：

utag.ut.flatten({"order_id": "0123567", "cart": {"total_items": 3, "total_amount": 123.45},"order_tax": 9.97});
// {order_id: "0123567", cart.total_items: 3, cart.total_amount: 123.45, order_tax: 9.97}

`utag.ut.hasOwn()`

オブジェクトが指定されたプロパティを自身のプロパティとして持っているかどうかを示すブール値を返します（継承するのではなく）。この関数は null チェックを行い、JavaScript関数 hasOwnProperty() をラップします。

utag.ut.hasOwn(obj, key)

パラメータ	タイプ	説明
`obj`	`Object`	テストするオブジェクト
`key`	`String`	テストするプロパティ

例：

var obj = new Object();     // オブジェクトを作成
obj.x = 3.14;               // 非継承のローカルプロパティを定義

utag.ut.hasOwn(obj, 'x');          // true - xはobjのローカルプロパティ
utag.ut.hasOwn(obj, 'y');          // false - objはプロパティyを持っていない

`utag.ut.isEmpty()`

引数が空であることを示すブール値 true を返すか、空でない場合はブール値 false を返します。まず、utag.ut.typeOf() 関数を使用してデータタイプを決定し、そのタイプに基づいて以下の値を返します：

タイプ	返り値の説明
`number`	JavaScript関数 `isNaN()` の値を返します
`boolean`	`false` を返します
`String`	文字列オブジェクトの `.length` フィールドが0の場合、`true` を返します
`Object`	`utag.ut.isEmptyObject()` 関数の値を返します

utag.ut.isEmpty(arg)

パラメータ	タイプ	説明
`arg`	[`number`, `boolean`, `String`, `Object`]	空かどうかをテストする引数

例：

utag.ut.isEmpty(5);         // false
utag.ut.isEmpty(NaN);       // true
utag.ut.isEmpty(undefined); // true
utag.ut.isEmpty(true);      // false
utag.ut.isEmpty(false);     // false
utag.ut.isEmpty("Tealium"); // false
utag.ut.isEmpty("");        // true

`utag.ut.isEmptyObject()`

オブジェクト引数が空であることを示すブール値 true を返すか、空でない場合はブール値 false を返します。

utag.ut.isEmptyObject(obj)

パラメータ	タイプ	説明
`obj`	`Object`	空かどうかをテストするオブジェクト

例：

utag.ut.isEmptyObject({});              // true
utag.ut.isEmptyObject({ foo: "bar" });  // false

`utag.ut.loader()`

Tealiumのタグテンプレートはこの関数を使用してタグをロードします。iframe、画像、スクリプトをロードし、スクリプトがロードされたときにコールバックを許可します。この関数は1つのオブジェクト引数のみを受け入れます。

同じIDのiframeとしてファイルがロードされると、関数は既存の要素を削除してから追加します。これはブラウザの履歴に影響を与えず、よりクリーンなDOMを維持するためです。

utag.ut.loader(object)

object には以下のパラメータがあります：

パラメータ	説明
`src`	ロードするファイルのURL
`type`	ロードするタグのタイプ：“iframe”, “img”, “script”（デフォルト）
`id`	（オプション）要素のID
`cb`	（オプション）コールバック関数
`attrs`	（オプション）追加のHTML要素属性のオブジェクト

例：

utag.ut.loader({
  type: "iframe",
  src: "https://example.com/path/file.js",
  id: "teal-tag1",
  cb: function() {},
  attrs: {"async":"true"}})
// 以下のHTML要素を結果とします：
// <iframe id="teal-tag1"  async="true" height="1" width="1" style="display:none"
//   src="https://example.com/path/file.js"> </iframe>

`utag.ut.merge()`

一つのオブジェクトから別のオブジェクトへプロパティをマージします。この関数は多階層のオブジェクトを扱いません。マージを試みる前にオブジェクトをフラット化してください。この関数は配列に対して使用すると参照を作成します。

utag.ut.merge(obj1, obj2, flag)

パラメータ	タイプ	説明
`obj1`	Object	マージする最初のキー-値ペアオブジェクト
`obj2`	Object	マージする2つ目のキー-値ペアオブジェクト
`overwrite`	number	`obj1` のプロパティ値を `obj2` のプロパティ値で上書きするかどうかを示すフラグ、`0`（いいえ）または `1`（はい）

例：

foo = { "key1":"value1", "key2":"value2" }
bar = { "key1":"value4", "key3":"value3" }
utag.ut.merge(foo, bar, 0)
// foo: {key1: "value1", key2: "value2", key3: "value3"}
// bar: {key1: "value4", key3: "value3"}

foo = { "key1":"value1", "key2":"value2" }
bar = { "key1":"value4", "key3":"value3" }
utag.ut.merge(foo, bar, 1)
// foo: {key1: "value4", key2: "value2", key3: "value3"}
// bar: {key1: "value4", key3: "value3"}

`utag.ut.typeOf()`

引数の変数タイプを String として返します。

utag.ut.typeOf(arg)

パラメータ	タイプ	説明
`arg`	Any type	タイプを決定する引数

例：

utag.ut.typeOf(5);         // "number"
utag.ut.typeOf("Tealium"); // "string"
utag.ut.typeOf(imgObj);    // "htmlimagelement"
utag.ut.typeOf(obj);       // "object"
utag.ut.typeOf(null);      // "null"
utag.ut.typeOf(undefined); // "undefined"
utag.ut.typeOf(obj.cb);    // "function"