使用外掛程式

外掛程式是強化 analytics.js 功能的指令碼,可協助評估使用者互動。外掛程式通常只適用於部分 Google Analytics (分析) 使用者可能不需要的功能 (例如ecommerce跨網域評估),因此預設不會納入 analytics.js。

本指南說明如何要求及使用 analytics.js 外掛程式。

需要外掛程式

require 指令會使用外掛程式的名稱,並註冊該外掛程式以與 ga() 指令佇列搭配使用。如果外掛程式接受設定選項,這些選項會將這些選項做為最終引數傳遞至 require 指令。

以下是完整的 require 指令簽章:

ga('[trackerName.]require', pluginName, [pluginOptions]);

以下舉例說明要搭配預設追蹤程式使用「加強型電子商務」外掛程式的情況:

ga('require', 'ec');

以下說明如何為名為「myTracker」的追蹤程式要求使用廣告功能外掛程式,並傳送覆寫預設 Cookie 名稱值的設定選項:

ga('myTracker.require', 'displayfeatures', {
  cookieName: 'display_features_cookie'
});

載入外掛程式程式碼

require 指令會初始化與 ga() 指令佇列搭配使用的外掛程式方法,但不會載入外掛程式指令碼本身。如果您使用第三方外掛程式,或是自行編寫外掛程式,就必須手動在網頁中加入外掛程式程式碼。

如要在網頁上新增外掛程式程式碼,建議您透過 <script> 標記並設定 async 屬性,確保該標記不會妨礙網站上的其他功能載入。

下列程式碼都需要並載入假設的連結追蹤外掛程式:

<script>
ga('create', 'UA-XXXXX-Y', 'auto');
ga('require', 'linkTracker');
ga('send', 'pageview');
</script>

<!--Note: plugin scripts must be included after the tracking snippet. -->
<script async src="/path/to/link-tracker-plugin.js"></script>

正在等待外掛程式載入

由於 analytics.js 程式庫和 analytics.js 外掛程式是以非同步方式載入,因此要確認外掛程式何時已完全載入且可供使用,可能並不容易。

為解決這個問題,analytics.js 程式庫在遇到尚未載入的外掛程式 require 指令時,會暫停執行指令佇列。外掛程式載入後,佇列執行作業會照常進行。

因此,請務必測試您使用的外掛程式,確保外掛程式能正常載入與執行。如果外掛程式無法載入或發生錯誤,就會阻止所有後續的 analytics.js 指令執行。

呼叫外掛程式方法

需要外掛程式後,即可將其方法與 ga() 指令佇列搭配使用。以下是呼叫外掛程式方法的指令簽章:

ga('[trackerName.][pluginName:]methodName', ...args);

舉例來說,您可以像這樣呼叫加強型電子商務外掛程式的 addProduct 方法:

ga('ec:addProduct', {
  'id': 'P12345',
  'quantity': 1
});

或者透過將追蹤器名稱新增至指令字串,在具名追蹤器上:

ga('myTracker.ec:addProduct', {
  'id': 'P12345',
  'quantity': 1
});

後續步驟

如果您已閱讀本節中的所有指南,應該可以熟悉 analytics.js 的大部分功能。下一份指南將說明如何對 analytics.js 導入項目進行偵錯,以便更輕鬆地偵測錯誤並查看程式碼的具體情況。