将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-Hans"/>
...
</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-Hans"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/sitecatalyst/util.js?lang=zh-Hans"></script>
<script type="text/javascript" src="/content/geometrixx-outdoors/_jcr_content/analytics.sitecatalyst.js?lang=zh-Hans"></script>
<script type="text/javascript" src="/etc/clientlibs/mac/mac-sc.js?lang=zh-Hans"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/sitecatalyst/plugins.js?lang=zh-Hans"></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的调用,以记录事件和数据。

示例:跟踪topnav单击

扩展foundation 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 Framework集成

配置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-Hans"%><%
%><%@ 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. 在“允许的组件”列表中,在“常规”部分选择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 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变量数据的组件。 例如,提交顺序组件(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>

限制跟踪调用的大小

通常,Web浏览器会限制GET请求的大小。 由于CQ产品和SKU值是存储库路径,因此包含多个值的产品阵列可能会超出请求大小限制。 因此,您的组件应限制每个CQ_Analytics.record functionproduct数组中的项数。 如果需要跟踪的项目数量超过限制,请创建多个函数。

例如,电子商务提交订单组件将调用中的product项目数限制为四。 当购物车包含四个以上的产品时,它会生成多个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