構成
utag.jsの動作を調整するための利用可能な構成について学びます。
動作原理
utag.jsの多くの動作は、utag.cfgオブジェクト内の構成によって制御されます。これらの構成によって制御されるデフォルトの動作は、utag_cfg_ovrdという新しいオブジェクトを使用してオーバーライドされます。このオブジェクトを使用するには、次のようにページコード内でutag.jsの読み込み前またはJavaScriptコード拡張内で構成します。
window.utag_cfg_ovrd = window.utag_cfg_ovrd || {};
次の表は、利用可能な構成をまとめたものです:
| 構成 | 説明 |
|---|---|
always_set_v_id |
utag_main_v_idクッキーまたはutag_mainのv_idコンポーネントを構成します。デフォルト:false |
cmcookiens |
同意管理クッキーの名前を構成します。 |
consentPeriod |
ユーザーの同意構成を保持する日数を構成します。 |
dom_complete |
DOMの完了(ロード)イベントまでタグの読み込みを遅延させます。 |
domain |
クッキーの構成に使用するドメインを上書きします。 |
gdprDLRef |
同意管理者が使用する言語構成を保存するデータレイヤー変数の名前を指定します。 |
ignoreLocalStorage |
データレイヤーにローカル保存変数を追加しません。 |
ignoreSessionStorage |
データレイヤーにセッション保存変数を追加しません。 |
load_rules_ajax |
ページの読み込み後にロードルールを無効にします(旧バージョン)。 |
load_rules_at_wait |
拡張機能の後にロードルールを実行します(旧バージョン)。 |
lowermeta |
メタタグの名前と値を小文字にします(旧バージョン)。 |
lowerqp |
クエリ文字列パラメータの名前と値を小文字にします(旧バージョン)。 |
noload |
すべての機能を無効にします。 |
noview |
初回のページ読み込み時に自動トラッキングコールを無効にします。 |
nocookie |
utag_mainクッキーを無効にします。 |
path |
公開パスを指定します。 |
readywait |
DOMの準備が完了するまで操作を待機します。 |
secure_cookie |
Persist Data Values拡張機能とutag.loader.SCメソッドによって構成されるすべてのutag_mainクッキーに対してsecure属性文字列を構成します。 |
session_timeout |
セッションの有効期限を構成します(ミリ秒単位)。 |
split_cookie |
utag_mainクッキーをスタンドアロンクッキーに分割します。デフォルト:true |
split_cookie_allowlist |
許可されるutag_mainサブクッキーまたはスタンドアロンクッキーの配列。 |
waittimer |
タグの読み込み前の待機時間を構成します(ミリ秒単位)。 |
always_set_v_id
utag.jsにutag_main_v_idクッキーまたはutag_mainのv_idコンポーネントを構成する
(utag.js 4.50で新規)
utag_mainのv_id変数は、Tealium Collectタグによって構成され、データプライバシーと同意目的に準拠するために使用されます。この構成をtrueにすると、utag.jsはこのクッキーをすべての訪問に対して構成します。 (デフォルト:false)
window.utag_cfg_ovrd.always_set_v_id = true;
cmcookiens
同意管理クッキーの名前
異なるプロファイルが同じドメイン名を共有している場合に便利な同意管理クッキーの名前をカスタマイズします。
window.utag_cfg_ovrd.cmcookiens = "CONSENTMGR_NL-CMB-CG1";
consentPeriod
同意構成の保持期間
GDPRとCCPAの同意ステータスを保持する日数を構成します。GDPRのデフォルトの有効期限は365日、CCPAのデフォルトの有効期限は395日です。
window.utag_cfg_ovrd.consentPeriod = 60;
dom_complete
DOMの完了(ロード)ブラウザイベントまでタグの読み込みを遅延させる
DOMの準備が完了するまでタグをドキュメントロードイベントで読み込みます。これにより、DOMの準備が完了するまでの間、DOMの準備にスコープが構成された拡張機能も遅延されます。 (デフォルト:false)
window.utag_cfg_ovrd.dom_complete = true;
domain
クッキードメインの上書き
utag_mainクッキーが構成されるドメインを構成します。クッキーを受け入れないルートドメイン上のサイトに便利です。 例:amazonaws.com。 (デフォルト:location.hostnameのトップレベルドメイン)
window.utag_cfg_ovrd.domain = "mysite.amazonaws.com";
gdprDLRef
同意管理者での言語構成の上書き
同意管理者で使用する言語を保存するデータレイヤー変数の名前を指定します。
たとえば、データレイヤーにsite_languageという変数が含まれている場合:
window.utag_cfg_ovrd = window.utag_cfg_ovrd || {}
window.utag_cfg_ovrd.gdprDLRef = "site_language";
言語コードを直接構成しないでください。このオーバーライド構成は、言語コードの値ではなく変数名を期待します。
ignoreLocalStorage
ローカル保存変数を無視する
ローカル保存変数を無視します。 (デフォルト:false)
window.utag_cfg_ovrd.ignoreLocalStorage = true;
ignoreSessionStorage
セッション保存変数を無視する
セッション保存変数を無視します。 (デフォルト:false)
window.utag_cfg_ovrd.ignoreSessionStorage = true;
load_rules_ajax
ページの読み込み後にロードルールを無効にする(旧バージョン)
同じページ読み込み内のutag.viewおよびutag.linkの各呼び出しでロードルールが再処理されるかどうかを制御します。新たにトリガーされたロードルールが新しいタグをページに読み込む可能性があります。バージョン4.2xより前のutag.jsの動作を再現するためにこの構成を使用します。 (デフォルト:true)
window.utag_cfg_ovrd.load_rules_ajax = false;
load_rules_at_wait
拡張機能の後にロードルールを実行する(旧バージョン)
拡張機能の後にロードルールを評価します。utag.jsの読み込み後にデータレイヤーオブジェクトが埋め込まれるインストールや、古いバージョンのutag.jsを使用している場合に使用します。新しいバージョンのutag.jsでは、この構成の代わりに拡張機能の実行順序を使用します。 (デフォルト:false)
window.utag_cfg_ovrd.load_rules_at_wait = true;
lowermeta
メタタグデータを小文字にする(旧バージョン)
すべてのメタデータ変数名と値を小文字にします。バージョン4.2xより前のutag.jsの動作を再現します。 (デフォルト:false)
メタタグの例:
<meta content="iQ Tag Management" property="Article:Section">
結果の値:
utag.data['meta.article:section']="iq tag management"
window.utag_cfg_ovrd.lowermeta = true;
lowerqp
クエリ文字列パラメータの名前と値を小文字にする(旧バージョン)
すべてのクエリ文字列変数名と値を小文字にします。バージョン4.2xより前のutag.jsの動作を再現します。 (デフォルト:false)
クエリ文字列パラメータの例:&RefId=Abc123
結果の値:utag.data['qp.refid']="abc123"
window.utag_cfg_ovrd.lowerqp = true;
noload
すべての操作を停止する
Pre Loaderにスコープが構成された拡張機能の後、すべてのコードの実行が停止します。DOM Readyにスコープが構成された拡張機能は引き続き実行されます。これは通常、Prevent Tag Loadの公開構成を使用して調整されます。 (デフォルト:0)
window.utag_cfg_ovrd.noload = true;
noview
初回のページ読み込み時の自動トラッキングコールを無効にする
初回のページ読み込み時に自動的に行われるトラッキングコールを抑制します。この構成は、シングルページアプリケーションサイトでよく使用されます。 (デフォルト:false)
window.utag_cfg_ovrd.noview = true;
nocookie
クッキーオプトアウト
訪問が明示的にすべてのクッキーをオプトアウトした場合にのみこのオプションを構成します。 (デフォルト:false)
このオプションを使用すると、Persist Data Values拡張機能で構成されたすべてのクッキーやセッションクッキーを含む、utag.jsによって保存されるすべてのクッキーが無効になります。また、クッキーが利用できない場合、変数ut.visitor_id、tealium_visitor_id、cp.utag_main_v_idの新しいタイムスタンプも構成されます。
window.utag_cfg_ovrd.nocookie = true
path
公開URLパス
タグテンプレートの公開URLパスを構成し、公開構成ダイアログの公開URLフィールドを上書きします。公開URLパスの構成は、セルフホスティングとFirst Party Domainsの顧客に便利です。
window.utag_cfg_ovrd.path = '//tags.example.com/main/prod';
readywait
DOMの準備が完了するまで操作を遅延する
utag.jsの読み込み時にPre Loaderにスコープが構成された拡張機能は引き続き実行されますが、すべての操作がDOMの準備が完了するまで待機します。 (デフォルト:0)
window.utag_cfg_ovrd.readywait = true;
secure_cookie
セキュアクッキー
(utag.js 4.48で新規)
Persist Data Values拡張機能とSC()関数によって構成されるすべてのutag_mainクッキーに対してsecure属性文字列を構成します。セキュアクッキーはHTTPSページでのみ構成およびアクセスできます。 (デフォルト:false)
window.utag_cfg_ovrd.secure_cookie = true;
session_timeout
セッションのタイムアウト
現在のセッションの有効期限が切れるまでの待機時間をミリ秒単位で構成します。通常は、セッションタイムアウトの公開構成を使用して調整されます。 (デフォルト:1800000(30分))
タイムアウトを900000ミリ秒(15分)に構成する例:
window.utag_cfg_ovrd.session_timeout = 900000;
split_cookie
スタンドアロンクッキー
(utag.js 4.50で新規) utag_名前空間のクッキー(組み込みのutag_mainクッキーなど)をutag.loader.SCによってマルチバリュークッキーとして書き込むか、スタンドアロンクッキーとして書き込むかを決定します。 (デフォルト:true)
window.utag_cfg_ovrd.split_cookie = false;
split_cookie_allowlist
utag_mainサブクッキー
(utag.js 4.50で新規) 許可されるutag_mainサブクッキーの配列を指定します。split_cookieがtrueに構成されている場合にのみ、許可リストが適用されます(バージョン4.50以降のデフォルト構成)。
split_cookie_allowlistが定義されて有効な場合、次のことが適用されます:
utag.loader.SCはutag_mainクッキーのみを構成します。- このリストに含まれるサブクッキーのみが
utag_main名前空間に構成されます。
split_cookie_allowlistが定義されていないか、split_cookieがtrueでない場合、すべてのutag_名前空間のクッキーが許可されます。
ses_id、_st、_ssを許可せずにこのオプションを使用すると、訪問数とセッション数が増え、すべての訪問が「単一ページセッション」のように見えるようになります。
window.utag_cfg_ovrd.split_cookie_allowlist = ["v_id", "_ss", "_st", "ses_id"];
waittimer
タイマーでタグの読み込みを遅延する DOMの準備完了イベントの後、タグを読み込む前に待機する時間をミリ秒単位で構成します。 (デフォルト:未構成)
window.utag_cfg_ovrd.waittimer = 1000;
最終更新日 :: 2024年March月29日