Adobe Client Data Layerの概要
Adobe Client Data Layer (ACDL)は、小さなオープンソースのJavaScript ライブラリで、web サイトでデータとイベントをページ上の任意のスクリプトに公開するための標準的な方法を提供します。 サイトコードは、データとイベントをadobeDataLayerという名前のJavaScript配列にプッシュします。 タグルール、Web SDK、およびその他のスクリプトは、ACDL スクリプトの読み込み時間に関係なく、そのデータを読み取り、それらのイベントをリッスンします。
このガイドでは、ACDL ライブラリについて説明します。 データ収集UIでACDLを使用するには、Adobe Client Data Layer タグ拡張機能を参照してください。
データレイヤーを使用する理由 why
データレイヤーがない場合、タグは多くの場合、DOM内のテキストやURL内のパラメーターなど、ページから値をスクレイピングします。 これらの実装は、ページデザインが変更されたときに破損し、ページに表示される内容のみを収集できます。 データレイヤーでは、次の2つの責任が分離されます。
- サイトコードは、ページ名、訪問者が閲覧した製品、送信されたフォームなど、ページ上で何が起こるかを表します。
- お客様のタグおよびその他のスクリプトは、Adobeに送信するデータや送信するタイミングなど、その情報の処理方法を決定します。
ACDLでは、このパターンに次の機能が追加されます。
- 非同期読み込み。 サイトコードは、ACDL スクリプトが読み込まれる前にデータをプッシュできます。 ACDLは、読み込み時にすべてを順番に処理するので、データを失うことなく
asyncまたはdeferで読み込むことができます。 - イベントとリスナー。 スクリプトは、リスナーが追加される前に発生したイベントを含む、名前付きイベントまたはデータの変更をリッスンできます。
- 状態を計算しました。 ACDLは、あらゆるデータ プッシュを、任意のスクリプトがいつでも読み取れる単一のオブジェクトにマージします。
- 履歴。 この配列には、プッシュされたデータとイベントの記録が保存され、実装のデバッグに役立ちます。
仕組み how-it-works
ACDLは、プレーンなJavaScript配列を中心に構築されています。
- このページは、まだ存在しない場合は
window.adobeDataLayer配列を作成します。 - サイトコードは、配列に
push()を含む項目を追加します。 項目には、データオブジェクト、イベントオブジェクト、または関数を使用できます。 ACDLが読み込まれる前に、これらの項目はキューのように配列で待機します。 - ACDL スクリプトが読み込まれると、
getState()やaddEventListener()などのメソッドが配列に追加され、push()が独自のバージョンに置き換えられます。 次に、キューに入れられたすべての項目をプッシュされた順序で処理します。 - その後、ACDLはプッシュされると、各新しい項目を処理します。 データを計算状態に結合し、 イベントリスナーと一致する呼び出しを行い、データとイベントオブジェクトを履歴として配列内に保持します。
// Site code: describe what happened on the page
window.adobeDataLayer = window.adobeDataLayer || [];
window.adobeDataLayer.push({
page: { title: "Home", language: "en" }
});
window.adobeDataLayer.push({ event: "page view" });
// Another script: react to what happened
window.adobeDataLayer.push(function(dl) {
dl.addEventListener("page view", function(event) {
console.log("Page title:", dl.getState("page.title"));
});
});
リスナーはデフォルトのall スコープ を使用するため、そのイベントが最初にプッシュされたにもかかわらず、page view イベントに対して実行されます。
ACDLは、ページ内のデータを保存および配布します。 データはどこにも送れません。 Adobeにデータを送信するには、タグまたはWeb SDKを使用してデータレイヤーから読み取ります。 Web SDK🔗を使用したAdobe Client Data Layer データの送信を参照してください。
ACDLと他のAdobe ツールの連携 adobe-tools
データ形式 data-format
ACDLには特定のデータ構造は必要ありません。 任意のプレーンオブジェクトをプッシュすると、ACDLによって計算状態にマージされます。 多くのスクリプトやチームは同じデータに依存するため、次の方法を検討してください。
- データ レイヤーに書き込む前に、構造に同意し、データをプッシュまたは読み取る全員に対して文書化します。
- 文字列、数値、ブール値、プレーンオブジェクト、配列など、JSONと互換性のある値を使用します。
Date個のオブジェクトや関数などの他の値は、結合に対して有効ではありません。 値の種類を参照してください。 - 宛先を検討してください。 Adobe Experience Platformにデータを送信する場合、マッピングしやすいようにXDM スキーマ に似るようにデータを構造化するか、独自の構造を保持して、データ収集用の データ準備を使用してデータストリームにマッピングできます。
ブラウザーの要件 browser-requirements
ACDL 3.xは、ブラウザーのstructuredClone()関数と最新のJavaScript構文を使用します。 次のいずれかのブラウザーまたはそれ以降が必要です。
- Chrome 98
- Edge 98
- Firefox 94
- Safari 15.4
ACDL 2.xのブラウザ要件は低くなります。 バージョン間の違いについては、2.xから3.xへのアップグレードを参照してください。
バージョンとソースコード source
ACDLは、Apache License 2.0の下でオープンソースです。
- Source コードと問題:
adobe/adobe-client-data-layer(GitHub上) - パッケージ:
@adobe/adobe-client-data-layer(npm) - リリースノート: GitHub リリース
どのバージョンがページで実行されているかを確認するには、ブラウザーのコンソールでversion プロパティを読みます。
adobeDataLayer.version