將Adobe Analytics跟蹤添加到元件

在頁面元件中包括Adobe Analytics模組

頁面範本元件(例如head.jsp, body.jsp)需要JSP包含,以載入ContextHub和Adobe Analytics整合(此整合為Cloud Services的一部分)。 全部都包含載入JavaScript檔案。

ContextHub項目應緊接在<head>標籤下方,而Cloud Services項目應包含在<head></body>區段之前;例如:

<head>
   <sling:include path="contexthub" resourceType="granite/contexthub/components/contexthub" />
...
   <cq:include script="/libs/cq/cloudserviceconfigs/components/servicelibs/servicelibs.jsp?lang=zh-Hant"/>
...
</head>
<body>
...
    <cq:include path="cloudservices" resourceType="cq/cloudserviceconfigs/components/servicecomponents"/>
</body>

您在<head>元素後插入的contexthub指令碼會將ContextHub功能新增至頁面。

您在<head><body>區段中新增的cloudservices指令碼會套用至新增至頁面的雲端服務組態。 (如果頁面使用多個Cloud Services配置,則只需要包含一次ContextHub jsp和Cloud Servicesjsp。)

將Adobe Analytics框架添加到頁面時,cloudservices指令碼將生成與Adobe Analytics相關的javascript和對客戶端庫的引用,類似以下示例:

<div class="sitecatalyst cloudservice">
<script type="text/javascript" src="/etc/clientlibs/foundation/sitecatalyst/sitecatalyst.js?lang=zh-Hant"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/sitecatalyst/util.js?lang=zh-Hant"></script>
<script type="text/javascript" src="/content/geometrixx-outdoors/_jcr_content/analytics.sitecatalyst.js?lang=zh-Hant"></script>
<script type="text/javascript" src="/etc/clientlibs/mac/mac-sc.js?lang=zh-Hant"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/sitecatalyst/plugins.js?lang=zh-Hant"></script>
<script type="text/javascript">
<!--
CQ_Analytics.Sitecatalyst.frameworkComponents = ['foundation/components/page'];
/**
 * Sets Adobe Analytics variables accordingly to mapped components. If <code>options</code> 
 * object is provided only variables matching the options.componentPath are set.
 *
 * @param {Object} options Parameter object from CQ_Analytics.record() call. Optional.
 */
CQ_Analytics.Sitecatalyst.updateEvars = function(options) {
    this.frameworkMappings = [];
 this.frameworkMappings.push({scVar:"pageName",cqVar:"pagedata.title",resourceType:"foundation/components/page"});
    for (var i=0; i<this.frameworkMappings.length; i++){
  var m = this.frameworkMappings[i];
  if (!options || options.compatibility || (options.componentPath == m.resourceType)) {
   CQ_Analytics.Sitecatalyst.setEvar(m);
  }
    }
}

CQ_Analytics.CCM.addListener("storesinitialize", function(e) {
 var collect = true;
    var lte = s.linkTrackEvents;
    s.pageName="content:geometrixx-outdoors:en";
    CQ_Analytics.Sitecatalyst.collect(collect);
    if (collect) {
  CQ_Analytics.Sitecatalyst.updateEvars();
     /************* DO NOT ALTER ANYTHING BELOW THIS LINE ! **************/
     var s_code=s.t();if(s_code)document.write(s_code);
     s.linkTrackEvents = lte;
     if(s.linkTrackVars.indexOf('events')==-1){delete s.events};
     $CQ(document).trigger("sitecatalystAfterCollect");
    }
});
//-->
</script>
<script type="text/javascript">
<!--
if(navigator.appVersion.indexOf('MSIE')>=0)document.write(unescape('%3C')+'\!-'+'-')
//-->
</script>
<noscript><img src="https://daydocumentation.112.2o7.net/b/ss/daydocumentation/1/H.25--NS/1380120772954?cdp=3&gn=content%3Ageometrixx-outdoors%3Aen" height="1" width="1" border="0" alt=""/></noscript>
<span data-tracking="{event:'pageView', values:{}, componentPath:'foundation/components/page'}"></span>
<div id="cq-analytics-texthint" style="background:white; padding:0 10px; display:none;">
 <h3 class="cq-texthint-placeholder">Component clientcontext is missing or misplaced.</h3>
</div>
<script type="text/javascript">
$CQ(function(){
 if( CQ_Analytics &&
  CQ_Analytics.ClientContextMgr &&
  !CQ_Analytics.ClientContextMgr.isConfigLoaded ) 
  {
   $CQ("#cq-analytics-texthint").show();
  }
});
</script>
</div>

所有AEM範例網站(例如Geometrixx Outdoors)都包含此程式碼。

sitecatalystAfterCollect事件

cloudservices指令碼會觸發sitecatalystAfterCollect事件:

$CQ(document).trigger("sitecatalystAfterCollect");

此事件會觸發以指出頁面追蹤已完成。 如果您要在此頁面執行其他追蹤作業,則應監聽此事件,而非檔案載入或檔案就緒事件。 使用sitecatalystAfterCollect事件可避免衝突或其他無法預測的行為。

注意

/libs/cq/analytics/clientlibs/sitecatalyst/sitecatalyst.js程式庫包含來自Adobe Analyticss_code.js檔案的程式碼。

實作自訂元件的Adobe Analytics追蹤

讓您的AEM元件與Adobe Analytics架構互動。 然後,設定您的架構,讓Adobe Analytics追蹤元件資料。

當您編輯框架時,與Adobe Analytics框架互動的元件會出現在SideKick中。 將元件拖動到框架後,將顯示元件屬性,然後可以用Adobe Analytics屬性映射它們。 (請參閱設定基本追蹤的架構)。

當元件具有名為analytics的子節點時,元件可與Adobe Analytics框架交互。 analytics節點具有以下屬性:

  • cq:trackevents:識別元件公開的CQ事件。(請參閱自訂事件。)
  • cq:trackvars:命名與Adobe Analytics屬性映射的CQ變數。
  • cq:componentName:出現在Sidekick中的元件名稱。
  • cq:componentGroup:Sidekick中包含元件的群組。

元件JSP中的代碼將javascript添加到觸發跟蹤的頁面,並定義所跟蹤的資料。 javascript中使用的事件名稱和資料名稱必須符合analytics節點屬性的對應值。

當您使用這些資料追蹤方法時,Adobe Analytics整合模組會自動執行對Adobe Analytics的呼叫,以記錄事件和資料。

範例:追蹤Topnav點按次數

擴充基礎topnav元件,讓Adobe Analytics追蹤頁面頂端導覽連結的點按次數。 點按導覽連結時,Adobe Analytics會記錄點按的連結及其點按的頁面。

以下過程要求您已執行下列任務:

  • 已建立CQ應用程式。
  • 建立了Adobe Analytics配置和Adobe Analytics框架。

複製topnav元件

將topnav元件複製至您的CQ應用程式。 此過程要求在CRXDE Lite中設定應用程式。

  1. 按一下右鍵/libs/foundation/components/topnav節點,然後按一下「複製」。
  2. 按一下右鍵應用程式資料夾下的「元件」資料夾,然後按一下「貼上」。
  3. 按一下「全部儲存」。

將Topnav與Adobe Analytics框架整合

設定topnav元件並編輯JSP檔案以定義追蹤事件和資料。

  1. 按一下右鍵topnav節點,然後按一下「建立」>「建立節點」。 指定下列屬性值,然後按一下「確定」:

    • 名稱: analytics
    • 類型: nt:unstructured
  2. 新增下列屬性至分析節點,以命名追蹤事件:

    • 名稱:cq:trackevents
    • 類型:字串
    • 值:topnavClick
  3. 將下列屬性新增至分析節點,以命名資料變數:

    • 名稱:cq:trackvars
    • 類型:字串
    • 值:topnavTarget,topnavLocation
  4. 將下列屬性新增至分析節點,以命名Sidekick的元件:

    • 名稱:cq:componentName
    • 類型:字串
    • 值:topnav(追蹤)
  5. 將下列屬性新增至分析節點,以命名Sidekick的元件群組:

    • 名稱:cq:componentGroup
    • 類型:字串
    • 值:一般
  6. 按一下「全部儲存」。

  7. 開啟topnav.jsp檔案。

  8. 在元素中,新增下列屬性:

    onclick = "tracknav('<%= child.getPath() %>.html')" 
    
  9. 在頁面底部新增下列javascript程式碼:

    <script type="text/javascript">
        function tracknav(target) {
                if (CQ_Analytics.Sitecatalyst) {
                    CQ_Analytics.record({
                        event: 'topnavClick',
                        values: {
                            topnavTarget: target,
                            topnavLocation:'<%=currentPage.getPath() %>.html'
                        },
                        componentPath: '<%=resource.getResourceType()%>'
                    });
                }
        }
    </script> 
    
  10. 按一下「全部儲存」。

topnav.jsp檔案的內容應如下所示:

<%@page session="false"%><%--
  Copyright 1997-2008 Day Management AG
  Barfuesserplatz 6, 4001 Basel, Switzerland
  All Rights Reserved.

  This software is the confidential and proprietary information of
  Day Management AG, ("Confidential Information"). You shall not
  disclose such Confidential Information and shall use it only in
  accordance with the terms of the license agreement you entered into
  with Day.

  ==============================================================================

  Top Navigation component

  Draws the top navigation

--%><%@include file="/libs/foundation/global.jsp?lang=zh-Hant"%><%
%><%@ page import="java.util.Iterator,
        com.day.text.Text,
        com.day.cq.wcm.api.PageFilter,
        com.day.cq.wcm.api.Page,
        com.day.cq.commons.Doctype,
        org.apache.commons.lang3.StringEscapeUtils" %><%

    // get starting point of navigation
    long absParent = currentStyle.get("absParent", 2L);
    String navstart = Text.getAbsoluteParent(currentPage.getPath(), (int) absParent);

    //if not deep enough take current node
    if (navstart.equals("")) navstart=currentPage.getPath();

    Resource rootRes = slingRequest.getResourceResolver().getResource(navstart);
    Page rootPage = rootRes == null ? null : rootRes.adaptTo(Page.class);
    String xs = Doctype.isXHTML(request) ? "/" : "";
    if (rootPage != null) {
        Iterator<Page> children = rootPage.listChildren(new PageFilter(request));
        while (children.hasNext()) {
            Page child = children.next();
            %><a onclick = "tracknav('<%= child.getPath() %>.html')"  href="<%= child.getPath() %>.html"><%
            %><img alt="<%= StringEscapeUtils.escapeXml(child.getTitle()) %>" src="<%= child.getPath() %>.navimage.png"<%= xs %>></a><%
        }
    }
%><script type="text/javascript">
    function tracknav(target) {
            if (CQ_Analytics.Sitecatalyst) {
                CQ_Analytics.record({
                    event: 'topnavClick',
                    values: {
                        topnavTarget:target,
                        topnavLocation:'<%=currentPage.getPath() %>.html'
                    },
                    componentPath: '<%=resource.getResourceType()%>'
                });
            }
    }
</script>  
注意

您通常希望從ContextHub追蹤資料。 如需使用javascript取得此資訊的詳細資訊,請參閱ContextHub](/docs/experience-manager-64/sites-developing/extending-analytics.html?lang=zh-Hant#accessing-values-in-the-contexthub)中的「存取值」。[

將追蹤元件新增至Sidekick

將可使用Adobe Analytics追蹤的元件新增至Sidekick,以便將它們新增至架構。

  1. 從您的Adobe Analytics配置開啟您的Adobe Analytics框架。 (http://localhost:4502/etc/cloudservices/sitecatalyst.html)

  2. 在Sidekick上,按一下「設計」按鈕。

  3. 在「連結追蹤設定」區域中,按一下「設定繼承」。

    chlimage_1

  4. 在「允許的元件」清單中,選取「一般」區段中的topnav(追蹤),然後按一下「確定」。

  5. 展開Sidekick以進入編輯模式。 現在,「常規」組中提供該元件。

將topnav元件添加到Framework

將topnav元件拖曳至您的Adobe Analytics架構,並將元件變數和事件對應至Adobe Analytics變數和事件。 (請參閱設定基本追蹤的架構)。

chlimage_1-1

Topnav元件現在與Adobe Analytics框架相整合。 將元件新增至頁面時,按一下頂端導覽列中的項目會將追蹤資料傳送至Adobe Analytics。

傳送s.products資料至Adobe Analytics

元件可產生傳送至Adobe Analytics的s.products變數資料。 設計您的元件,以提供s.products變數:

  • 記錄名為product的特定結構值。
  • 公開product值的資料成員,以便與Adobe Analytics框架中的Adobe Analytics變數映射。

Adobe Analyticss.products變數使用下列語法:

s.products="category;product;quantity;price;eventY={value}|eventZ={value};evarA={value}|evarB={value}"

Adobe Analytics整合模組使用元件生成的product值構建s.productsAEM變數。 元件生成的javascript中的productAEM值是具有以下結構的值陣列:

"product": [{
    "category": "",
    "sku"     : "path to product node",
    "quantity": quantity,
    "price"   : price,
    "events   : {
      "eventName1": "eventValue1",
      "eventName_n": "eventValue_n"
    }
    "evars"   : {
      "eVarName1": "eVarValue1",
      "eVarName_n": "eVarValue_n"
    }
}]

當資料項目從product值中省略時,會以空字串的形式在s.products中傳送。

注意

當沒有事件與產品值關聯時,Adobe Analytics預設會使用prodView事件。

元件的analytics節點必須使用cq:trackvars屬性公開變數名:

  • product.category
  • product.sku
  • product.quantity
  • product.price
  • product.events.eventName1
  • product.events.eventName_n
  • product.evars.eVarName1
  • product.evars.eVarName_n

eCommerce模組提供數個產生s.products變數資料的元件。 例如,提交順序元件(http://localhost:4502/crx/de/index.jsp#/libs/commerce/components/submitorder/submitorder.jsp)生成與以下示例類似的javascript:

<script type="text/javascript">
    function trackCartPurchase() {
        if (CQ_Analytics.Sitecatalyst) {
            CQ_Analytics.record({
                "event": ["productsCartPurchase"],
                "values": {
                    "product": [
                        {
                            "category": "",
                            "sku"     : "/path/to/prod/1",
                            "quantity": 3,
                            "price"   : 179.7,
                            "evars"   : {
                                "childSku": "/path/to/prod/1/green/xs",
                                "size"    : "XS"
                            }
                        },
                        {
                            "category": "",
                            "sku"     : "/path/to/prod/2",
                            "quantity": 10,
                            "price"   : 150,
                            "evars"   : {
                                "childSku": "/path/to/prod/2",
                                "size"    : ""
                            }
                        },
                        {
                            "category": "",
                            "sku"     : "/path/to/prod/3",
                            "quantity": 2,
                            "price"   : 102,
                            "evars"   : {
                                "childSku": "/path/to/prod/3/m",
                                "size"    : "M"
                            }
                        }
                    ]
                },
                "componentPath": "commerce/components/submitorder"
            });
            CQ_Analytics.record({
                "event": ["discountRedemption"],
                "values": {
                    "discount": "/path/to/discount/1 - /path/to/discount/2",
                    "product" : [{
                        "category": "",
                        "sku"     : "Promotional Discount",
                        "events"  : {"discountRedemption": 20.00}
                    }]
                },
                "componentPath": "commerce/components/submitorder"
            });
            CQ_Analytics.record({
                "event": ["cartPurchase"],
                "values": {
                    "orderId"       : "00e40e2d-13a2-4a00-a8ee-01a9ebb0bf68",
                    "shippingMethod": "overnight",
                    "paymentMethod" : "Amex",
                    "billingState"  : "NY",
                    "billingZip"    : "10458",
                    "product"       : [{"category": "", "sku": "", "quantity": "", "price": ""}]
                },
                "componentPath": "commerce/components/submitorder"
            });
        }
        return true;
    }
</script>

限制追蹤呼叫的大小

一般而言,網頁瀏覽器會限制GET要求的大小。 由於CQ產品和SKU值是儲存庫路徑,因此包含多個值的產品陣列可能會超過請求大小限制。 因此,您的元件應限制每個CQ_Analytics.record functionproduct陣列中的項目數。 如果您需要追蹤的項目數量超過限制,請建立多個函式。

例如,電子商務提交訂單元件將呼叫中product項的數量限制為4。 當購物車包含4種以上的產品時,會產生多個CQ_Analytics.record功能。

本頁內容

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now