push()

push() メソッドは、Adobe Client Data Layer (ACDL)に項目を追加します。 これは、ライブラリが読み込まれる前に呼び出すことができる唯一の方法なので、サイトコードがデータレイヤーと対話する主な方法です。

adobeDataLayer.push(...items: (object | Function)[]): number | undefined

ACDLが読み込まれる前は、push()が標準のArray.prototype.push() メソッドであり、ライブラリが読み込まれるまで項目は配列で待機します。 ACDLが読み込まれると、そのバージョンのpush()が各項目を直ちに処理します。 ​ キューと履歴を参照してください。

プッシュする前に必ず配列を作成します。

window.adobeDataLayer = window.adobeDataLayer || [];
window.adobeDataLayer.push({ page: { title: "Home" } });

項目タイプ item-types

3種類のアイテムをプッシュできます。

項目
ACDLの機能
​ データオブジェクト ​
オブジェクトを計算状態とトリガー adobeDataLayer:changeに結合します。
​ イベントオブジェクト ​
名前付きイベントとadobeDataLayer:eventをトリガーします。 オブジェクト内のデータを計算状態にマージします。
関数
関数を呼び出し、データレイヤーを渡します。

データオブジェクト data

event キーのないプレーンオブジェクト。 ACDLは、それを計算状態にマージします。

window.adobeDataLayer.push({
  page: { title: "Products", language: "en" },
  user: { loggedIn: true }
});

キーを削除するには、nullを値としてプッシュします。 ​ データの削除を参照してください。

イベントオブジェクト event

空でない文字列を含むevent キーを持つプレーンオブジェクト。 オブジェクトには、計算状態にマージするeventInfo キーとデータを含めることもできます。

window.adobeDataLayer.push({
  event: "cart add",
  eventInfo: { sku: "a-100" },
  cart: { itemCount: 3 }
});

ACDLは、この例のcartというデータを計算状態にマージし、イベントのリスナーを呼び出します。 ​ イベント ​を参照してください。

関数 function

ライブラリの準備が整ったときにACDLが呼び出す関数。 ライブラリがまだ読み込まれていない場合でも、他のACDL メソッドを安全に呼び出すために使用します。

window.adobeDataLayer.push(function(dl) {
  dl.addEventListener("cart add", function(event) {
    console.log("Added to cart:", event.eventInfo.sku);
  });
});

ACDLは、データ レイヤーを引数とし、thisとして関数を呼び出します。 関数を配列に保持しません。 関数がエラーをスローすると、エラーはpush()を呼び出したコードに反映されます。 ライブラリが読み込まれる前に、ACDLが残りのキューを処理するのもエラーにより停止します。 ACDLの準備ができたら​ コードを実行するを参照してください。

戻り値 return

ACDLが読み込まれた後、push()は、アイテムを履歴に追加するときに、配列の新しい長さを返します。 関数のみをプッシュしたり、無効な項目をプッシュしたりするなど、項目を追加しない場合は、undefinedを返します。

呼び出しごとに1つの項目をプッシュ one-item

1つのpush()呼び出しに複数の項目を渡すことができ、ACDLはそれらを順番に処理します。 ただし、1つの呼び出しが異なる種類の項目を組み合わせると、履歴に一貫性がなくなることがあります。 例えば、最初の項目が関数の場合、ACDLはその後に続くデータオブジェクトを処理しますが、履歴には追加しません。 各項目を個別の呼び出しにプッシュします。

無効な項目 invalid

ACDLでは、プレーンオブジェクトと関数のみを使用できます。 文字列、数値、ブール値、配列など、他の値をプッシュすると、ACDLはその値を処理せず、次のエラーをブラウザーコンソールに記録します。

The following item cannot be handled by the data layer because it does not have a valid format: "example"

nullまたはundefinedをプッシュすると、TypeErrorがスローされます。

NOTE
onとhandler キー、またはoff キーを持つオブジェクトはデータではありません。 ACDLはそれらを無視し、履歴に追加しません。 リスナーを追加または削除するには、addEventListener()とremoveEventListener()を使用します。
recommendation-more-help
experience-platform-help-collection