構成
utag.js
の動作を調整する利用可能な構成について学びます。
仕組み
utag.js
の多くの動作は、utag.cfg
オブジェクト内の構成で制御されます。これらの構成によって制御されるデフォルトの動作は、utag_cfg_ovrd
という新しいオブジェクトを使用してオーバーライドされます。このオブジェクトを使用するには、utag.js
をロードする前にページコード内で構成するか、以下のようにPre Loaderにスコープを持つJavaScript Code Extension内で構成します。
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 クッキーを無効化します。 |
nonblocking_tags |
すべてのタグを非ブロッキングにしてパフォーマンスを向上させ、極端なケースでのInteraction to Next Paint(INP)スコアを改善します。デフォルト:false 。 |
path |
パブリッシングパスを指定します。 |
readywait |
DOM-readyブラウザイベントまで操作を停止します。 |
secure_cookie |
Persist Data Values extensionとutag.loader.SC メソッドによって構成されるすべてのutag_main クッキーに対して、属性文字列をsecure に構成します。 |
session_timeout |
セッションの有効期限(ミリ秒単位)を構成します。 |
split_cookie |
utag_main クッキーを独立したクッキーに分割します。デフォルト:true |
split_cookie_allowlist |
許可されたutag_main サブクッキーまたは独立したクッキーの配列。 |
suppress_before_load_rules_with_uids |
UIDでロードされたタグに対してBefore Load Rulesにスコープを持つ拡張機能の実行を防ぎます。デフォルト:false 。 |
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 Readyではなく、document load eventでタグをロードします。これにより、DOM Readyにスコープを持つ任意の拡張機能も保留されます。(デフォルト: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
が呼び出されるたびに、ロードルールが再処理されるかどうかを制御します。新たにトリガーされたロードルールが新しいタグをページにロードする可能性があります。この構成は、utag.js
のバージョン4.2xより古いバージョンの動作を再現するために使用します。(デフォルト:true
)
window.utag_cfg_ovrd.load_rules_ajax = false;
load_rules_at_wait
拡張機能の後にロードルールを実行(レガシー)
拡張機能の後にロードルールを評価します。utag.js
をロードした後にデータレイヤーオブジェクトが満たされるインストールに使用されます。utag.js
の新しいバージョンでは、この構成の代わりに拡張機能の実行順序を使用します。(デフォルト:false
)
window.utag_cfg_ovrd.load_rules_at_wait = true;
lowermeta
メタタグデータを小文字にする(レガシー)
すべてのメタデータ変数名と値を小文字にします。utag.js
のバージョン4.2xより前のバージョンの動作を再現します。(デフォルト:false
)
メタタグの例:
<meta content="iQ Tag Management" property="Article:Section">
結果の値:
utag.data['meta.article:section']="iq tag management"
window.utag_cfg_ovrd.lowermeta = true;
lowerqp
クエリストリングパラメータ名と値を小文字にする(レガシー)
すべてのクエリストリング変数名と値を小文字にします。utag.js
のバージョン4.2xより前のバージョンの動作を再現します。(デフォルト:false
)
クエリストリングパラメータの例:&RefId=Abc123
結果の値:utag.data['qp.refid']="abc123"
window.utag_cfg_ovrd.lowerqp = true;
noload
すべての操作を停止する
Pre Loaderにスコープを持つ拡張機能の後で、すべてのコードの実行が停止します。DOM Readyにスコープを持つ拡張機能は引き続き実行されます。これは通常、タグのロードを防ぐの公開構成を使用して調整されます。(デフォルト:0
)
window.utag_cfg_ovrd.noload = true;
noview
初期ページロード時の自動トラッキングコールを無効化する
初期ページの読み込み時に自動的に発生するトラッキング呼び出しを抑制します。この構成は、シングルページアプリケーションサイトでよく使用されます。(デフォルト: false
)
window.utag_cfg_ovrd.noview = true;
nocookie
Cookieのオプトアウト
このオプションは、訪問がすべてのクッキーを明示的にオプトアウトした場合にのみ構成します。(デフォルト: false
)
このオプションを使用すると、訪問数とセッション数が増加し、すべての訪問が"シングルページセッション"のように見えます。
このオプションは、utag.js
によって保存されるすべてのクッキー、Persist Data Value extensionで構成されたクッキー、セッションクッキーを無効にします。また、クッキーが利用できない場合には、変数ut.visitor_id
、tealium_visitor_id
、cp.utag_main_v_id
のタイムスタンプを新しく構成します。
window.utag_cfg_ovrd.nocookie = true
nonblocking_tags
タグの非同期読み込み
(utag.js
4.52で新規追加)
すべてのタグに非ブロッキングの挙動を有効にし、INPスコアと全体的なページパフォーマンスを改善します。ユーザーのインタラクションを遅くするリソース集約型のタグがあるページや、INPスコアを低下させるページでこの構成を使用しますが、出口リンクのトラッキングは十分にテストしてください。(デフォルト: false
)
window.utag_cfg_ovrd.nonblocking_tags = true;
path
公開URLパス
タグテンプレートの公開URLパスを構成し、Publish Configuration dialogのPublish URLsフィールドを上書きします(指定されている場合)。公開URLパスの構成は、自己ホスティングやFirst Party Domainsの顧客にとって有用です。
window.utag_cfg_ovrd.path = '//tags.example.com/main/prod';
readywait
DOM-readyまでの操作を遅延
ブラウザからDOM-readyの信号を受け取るまで、すべての操作を停止します。Pre Loaderにスコープされた拡張機能は、utag.js
が読み込まれたときに実行されます。(デフォルト: 0
)
window.utag_cfg_ovrd.readywait = true;
secure_cookie
セキュアクッキー
(utag.js
4.48で新規追加)
Persist Data Values extensionとSC()
関数によって構成されるすべてのutag_main
クッキーの属性文字列をsecure
に構成します。セキュアクッキーはHTTPSページでのみ構成およびアクセスが可能です。(デフォルト: false
)
window.utag_cfg_ovrd.secure_cookie = true;
session_timeout
セッションタイムアウト
現在のセッションが期限切れになるまでの待ち時間をミリ秒単位で構成します。通常、この構成は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"];
suppress_before_load_rules_with_uids
UID呼び出しに対してBefore Load Rules拡張機能の実行を防止
(utag.js
4.52で新規追加)
デフォルトでは、Before Load Rulesにスコープされたすべての拡張機能は、ページの読み込みごとに一度実行されます。これは、UIDによって呼び出されたタグに対しても同様です。このオプションをtrue
に構成すると、UIDによって呼び出されたタグに対してBefore Load Rules拡張機能の実行を防止します。(デフォルト: false
)
window.utag_cfg_ovrd.suppress_before_load_rules_with_uids = true;
waittimer
タイマーでタグの遅延 DOM Readyイベント後にタグの読み込みを待つ時間(ミリ秒単位)を構成します。(デフォルト: 構成なし)
window.utag_cfg_ovrd.waittimer = 1000;
最終更新日 :: 2024年December月18日