將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"/>
...
</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"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/sitecatalyst/util.js"></script>
<script type="text/javascript" src="/content/geometrixx-outdoors/_jcr_content/analytics.sitecatalyst.js"></script>
<script type="text/javascript" src="/etc/clientlibs/mac/mac-sc.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/sitecatalyst/plugins.js"></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 Analytics s_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的呼叫,以記錄事件和資料。

範例:追蹤頂端導覽點按次數

擴充foundation topnav元件,讓Adobe Analytics可追蹤頁面頂端導覽連結上的點按次數。 按一下導覽連結時,Adobe Analytics會記錄已點按的連結及其點按的頁面。

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

  • 建立CQ應用程式。
  • 建立Adobe Analytics設定和Adobe Analytics架構。

複製頂層導航元件

將topnav元件複製到CQ應用程式。 該過程要求以CRXDE Lite設定應用程式。

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

將Topnav與Adobe Analytics架構整合

配置topnav元件並編輯JSP檔案以定義跟蹤事件和資料。

  1. 以滑鼠右鍵按一下頂端導覽節點,然後按一下「建立>建立節點」。 指定下列屬性值,然後按一下「確定」:

    • 名稱: 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"%><%
%><%@ 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中的值。

將追蹤元件新增至Sidekick

新增已啟用以透過Adobe Analytics追蹤的元件至Sidekick,以便您將其新增至架構。

  1. 從Adobe Analytics設定開啟Adobe Analytics架構。 (http://localhost:4502/etc/cloudservices/sitecatalyst.html)

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

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

    chlimage_1

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

  5. 展開Sidekick以進入編輯模式。 元件現在可在「一般資訊」組中使用。

將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 Analytics s.products變數使用下列語法:

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

Adobe Analytics整合模組會使用AEM元件產生的product值來建構s.products變數。 AEM元件產生的javascript中的product值是具有下列結構的值陣列:

"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

電子商務模組提供數個元件,可產生s.products變數資料。 例如,submitorder元件(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個。 當購物車包含超過四種產品時,會產生多個CQ_Analytics.record函式。

本頁內容