資料層

資料層是 Google 代碼管理工具和 gtag.js 用來將資訊傳遞至代碼的物件。事件或變數可透過資料層傳遞,且觸發條件可根據變數值設定。

舉例來說,如果您在 purchase_total 的值大於 $100 時,或根據特定事件 (例如點選按鈕時) 觸發再行銷代碼,則可設定資料層,讓代碼能夠使用該資料。資料層物件的結構為 JSON。例如:

{
  event: "checkout_button",
  gtm: {
    uniqueEventId: 2,
    start: 1639524976560,
    scrollThreshold: 90,
    scrollUnits: "percent",
    scrollDirection: "vertical",
    triggers: "1_27"
  },
  value: "120"
}

Google 代碼可輕鬆參考以有條理且可預測的方式加入資料層的資訊,而不需剖析變數、交易資訊、網頁類別,以及散落在網頁中的其他信號。導入的資料層中如含有變數和相關值,那麼當代碼需要這些資料時,就能馬上取得必要資訊。

安裝

如果是透過代碼管理工具安裝,則必須建立資料層。以下醒目顯示的程式碼,說明資料層的建立位置 (代碼管理工具載入前)。

<script>
window.dataLayer = window.dataLayer || [];
</script>
<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-XXXXXX');</script>
<!-- End Google Tag Manager -->

在標準 gtag.js 導入作業中,如果代碼是從產品內複製並加入網頁,系統會提供建立資料層的程式碼。在 Google 代碼的自訂實作中,請在指令碼開頭加入資料層程式碼,如下方醒目顯示的範例所示:

<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=TAG_ID"></script>
<script>
  window.dataLayer = window.dataLayer || [];
  function gtag(){dataLayer.push(arguments)};
  gtag('js', new Date());

  gtag('config', 'TAG_ID');
</script>

資料層資訊的處理方式

載入容器後,代碼管理工具就會開始處理所有已加入佇列的資料層推送訊息。代碼管理工具會依據先進先出的規則處理訊息:一次處理一則訊息,且處理順序與接收順序相同。如果訊息是事件,代碼管理工具會先觸發所有符合觸發條件的代碼,再接著處理下一則訊息。

如果網頁、自訂範本或自訂 HTML 代碼中的程式碼發出 gtag()dataLayer.push() 呼叫,相關訊息就會排入佇列,待系統評估完所有其他待處理訊息後加以處理。這表示對下一個事件來說,不保證會有最新的資料層值可用。如要化解這類情況,可以在系統將事件推送至資料層時在訊息中加入事件名稱,再使用自訂事件觸發條件監聽該事件名稱。

使用含有事件處理常式的資料層

dataLayer 物件會使用 event 指令啟動事件傳送作業。

Google 代碼和代碼管理工具會使用名為 event 的特殊資料層變數,JavaScript 事件監聽器會在使用者與網站元素互動時,使用這個變數觸發代碼。舉例來說,您可能想在使用者點選購買確認按鈕時,觸發轉換追蹤代碼。每當使用者與網站元素互動時 (例如連結、按鈕、捲動等),系統可能會呼叫事件。

只要在事件發生時呼叫 dataLayer.push(),就能實現這項功能。使用 dataLayer.push() 傳送事件的語法如下:

dataLayer.push({'event': 'event_name'});

其中 event_name 是描述事件的字串,例如 'login'purchasesearch

當您想評估的動作發生時,請使用 dataLayer.push() 傳送事件資料。舉例來說,如要在使用者點選按鈕時傳送事件,請修改按鈕的 onclick 處理常式,呼叫 dataLayer.push()

<button onclick="dataLayer.push({'event': 'login'});">Button 1</button>

您可以將資料層變數動態推送至資料層,擷取資訊,例如在表單中輸入或選取的值、與訪客播放影片相關聯的中繼資料、訪客自訂的產品顏色 (例如汽車)、點選連結的到達網頁網址等。

與事件相同,這項功能是透過呼叫 push() API,在資料層中新增或取代資料層變數來完成。設定動態資料層變數的基本語法如下:

dataLayer.push({'variable_name': 'variable_value'});

其中 'variable_name' 是字串,表示要設定的資料層變數名稱,'variable_value' 也是字串,表示要設定或取代的資料層變數值。

舉例來說,如要在訪客使用產品自訂工具時,設定含有偏好顏色的資料層變數,您可以推送下列動態資料層變數:

dataLayer.push({'color': 'red'});

一次推送多個變數

您可以一次推送多個變數和事件:

dataLayer.push({
  'color': 'red',
  'conversionValue': 50,
  'event': 'customize'
});

保留資料層變數

如要在網頁之間保留資料層變數,請在每次載入網頁時,於資料層例項化後呼叫 dataLayer.push(),並將變數推送至資料層。如要讓代碼管理工具在載入容器時使用這些資料層變數,請在代碼管理工具容器程式碼上方新增 dataLayer.push() 呼叫,如下所示。

<script>
window.dataLayer = window.dataLayer || [];

dataLayer.push({
 'event': 'Pageview',
 'pagePath': 'https://www.googleanalytics.dev/pancakes',
 'pageTitle': 'Pancake Event Signup',
 'visitorType': 'customer'
});
</script>
<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-XXXXXX');</script>
<!-- End Google Tag Manager -->

在資料層物件中宣告的每個變數,只會在訪客停留在目前網頁時持續存在。與網頁相關的資料層變數 (例如 visitorType) 必須在網站的每個網頁中宣告。雖然您不必在每個網頁的資料層中放入同一組變數,但應使用一致的命名慣例。換句話說,如果您在註冊頁面上使用名為 pageCategory 的變數設定頁面類別,產品和購買頁面也應使用 pageCategory 變數。

疑難排解

以下提供一些資料層疑難排解訣竅:

請勿覆寫 window.dataLayer 變數:直接使用資料層 (例如 dataLayer = [{'item': 'value'}])) 時,系統會覆寫 dataLayer 中的所有現有值。代碼管理工具安裝作業應盡可能在來源程式碼中較高的位置 (容器程式碼片段上方),使用 window.dataLayer = window.dataLayer || []; 例項化資料層。宣告 dataLayer 後,請使用 dataLayer.push({'item': 'value'}) 將其他值加入其中。如果這些值需要在網頁載入時提供給代碼管理工具,則 dataLayer.push() 呼叫也必須位於代碼管理工具容器程式碼上方。

dataLayer 物件名稱會區分大小寫:如果您嘗試推送變數或事件,但大小寫不正確,推送作業將無法運作。

datalayer.push({'pageTitle': 'Home'});    // Bad (datalayer in lowercase)
dataLayer.push({'pageTitle': 'Home'});    // Good (dataLayer in camel case)

呼叫 dataLayer.push 時必須使用有效的 JavaScript 物件。所有資料層變數名稱都應加上引號。

dataLayer.push({new-variable: 'value'});      // Bad - no quote marks
dataLayer.push({'new-variable': 'value'});    // Good - proper quote marks

確保各網頁的變數名稱一致:如果您在不同網頁上為相同概念使用不同的變數名稱,代碼就無法在所有所需位置穩定觸發。

不佳的做法:

// Homepage:
dataLayer.push({'visitorType': 'low-value'});

// Checkout Page:
dataLayer.push({'visitor_type': 'high-value'});

較佳做法:

// Homepage:
dataLayer.push({'visitorType': 'low-value'});

// Checkout Page:
dataLayer.push({'visitorType': 'high-value'});

重新命名資料層

Google 代碼或代碼管理工具啟動的資料層物件預設名稱為 dataLayer。如要為資料層使用其他名稱,請在 Google 代碼或代碼管理工具容器程式碼片段中,編輯資料層參數值,並使用您選擇的名稱。

gtag.js

在網址中加入名為「l」的查詢參數,即可設定新的資料層名稱,例如 l=myNewName。將 Google 代碼程式碼片段中的所有「dataLayer」例項更新為新名稱。

<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=TAG_ID&l=myNewName"></script>
<script>
  window.myNewName = window.myNewName || [];
  function gtag(){myNewName.push(arguments);}
  gtag('js', new Date());

  gtag('config', 'TAG_ID');
</script>

代碼管理工具

在容器程式碼片段中,將資料層參數值 (如下方醒目顯示) 替換為您選擇的名稱。

<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','myNewName','GTM-XXXXXX');</script>
<!-- End Google Tag Manager -->

重新命名後,所有對資料層的參照 (例如在程式碼片段上方宣告資料層,或使用 .push() 指令將事件或動態資料層變數推送至資料層時) 都必須調整,以反映自訂資料層名稱:

<script>
  myNewName = window.dataLayer || [];
  myNewName.push({'variable_name': 'variable_value'});
</script>

自訂資料層方法

如果您將函式推送至資料層,系統會以抽象資料模型呼叫函式。這個抽象資料模型可以取得及設定鍵/值存放區的值,也能重設資料層。

set

抽象資料模型上的 set 函式可讓您設定要透過 get 擷取的值。

window.dataLayer.push(function() {
  this.set('time', new Date());
});

get

抽象資料模型上的 get 函式可讓您擷取已設定的值。

window.dataLayer.push(function() {
  const existingTime = this.get('time');
  if (existingTime !== null) {
    // Change behavior based on whether or not this value exists...
  } else {
    // ...
  }
})

重設

抽象資料模型上的 reset 函式可讓您重設資料層中的資料。如果網頁會保持開啟,且資料層大小會隨時間持續增加,這個做法就非常實用。如要重設資料層,請使用下列程式碼:

window.dataLayer.push(function() {
  this.reset();
})