为Analytics实施服务器端页面命名

Adobe Analytics使用s.pageName属性来唯一标识页面并关联为页面收集的数据。 通常，您会在AEM中执行以下任务，以便为AEM发送到Analytics的此属性分配一个值：

• 使用Analytics云服务框架将CQ变量映射到Analytics s.pageName属性。 (请参阅将组件数据映射到Adobe Analytics属性。)

• 设计页面组件，以使其包含映射到s.pageName属性的CQ变量。 (请参阅为自定义组件实施Adobe Analytics跟踪。)

要在站点控制台和内容分析中显示Analytics报表数据， AEM要求每个页面的s.pageName属性值。 AEM Analytics Java API定义了您实施的AnalyticsPageNameProvider界面，以向站点控制台和内容分析提供s.pageName属性的值。 您的AnaltyicsPageNameProvider服务解析服务器上的pageName属性以用于报告目的，因为该属性可以使用客户端上的Javascript动态设置以用于跟踪目的。

默认的Analytics页面名称提供程序服务

DefaultPageNameProvider服务是默认服务，它确定用于检索页面Analytics数据的s.pageName属性值。 该服务可与AEM基础页面组件(/libs/foundation/components/page)配合使用。 此页面组件定义了以下要映射到s.pageName属性的CQ变量：

• pagedata.path:值设置为页面路径。
• pagedata.title:值将设置为页面标题。
• pagedata.navTitle:值将设置为页面导航标题。

DefaultPageNameProvider服务可确定其中哪些CQ变量映射到Analytics云服务框架中的s.pageName属性。 然后，该服务会确定用于检索分析报表数据的相应页面属性：

• pagedata.path:服务使用 page.getPath()

• pagedata.title:服务使用 page.getTitle()

• pagedata.navTitle:服务使用 page.getNavigationTitle()

page对象是页面的 com.day.cq.wcm.api.Page Java对象。

如果未将CQ变量映射到框架中的s.pageName属性，则s.pageName的值将从页面路径生成。 例如，路径为/content/geometrixx/en的页面使用content:geometrixx:en的值s.pageName。

在Analytics报表中维护连续性

要维护页面分析数据的完整历史记录，需要用于页面的s.pageName属性的值永远不变。 但是，基础页面组件定义的分析属性可以轻松更改。 例如，移动页面会更改pagedata.path的值，并中断报表历史记录的连续性：

• 为上一路径收集的数据不再与页面关联。
• 如果其他页面使用其他页面以前使用的路径，则不同页面会继承该路径的数据。

为确保报告的连续性，s.pageName的值应具有以下特征：

• 唯一.
• 稳定。
• 人类可读。

例如，自定义页面组件可以包含作者用于为页面指定唯一ID的页面属性，该ID用作s.pageProperties属性的值：

• 该页面包含一个Analytics变量，该变量设置为存储在页面属性中的唯一ID的值。
• 分析变量会映射到Analytics框架中的s.pageProperties属性。
• 您对AnalyticsPageNameProvider界面的实施会检索用于查询页面分析数据的页面属性值。

实施Analytics页面名称提供程序服务

将com.day.cq.analytics.sitecatalyst.AnalyticsPageNameProvider接口作为OSGi服务实施，以自定义检索s.pageName属性值的逻辑。 站点页面分析和内容分析使用服务从Analytics中检索报表数据。

AnalyticsPageNameProvider界面定义了必须实施的两种方法：

• getPageName:返回 String 表示要用作属性的值的 s.pageName 值。

• getResource:返回一 org.apache.sling.api.resource.Resource 个对象，该对象表示与属性关联的 s.pageName 页面。

这两种方法都采用com.day.cq.analytics.sitecatalyst.AnalyticsPageNameContext对象作为参数。 AnalyticsPageNameContext类提供有关分析调用上下文的信息：

• 页面资源的基本路径。
• Analytics云服务配置的Framework对象。
• 页面的Resource对象。
• 页面的ResourceResolver对象。

类还为页面名称提供setter。

AnalyticsPageNameProvider实施示例

以下示例AnalyticsPageNameProvider实施支持自定义页面组件：

• 该组件扩展了基础页面组件。
• 该对话框包括作者用于指定s.pageName属性值的字段。
• 属性值存储在页面实例jcr:content节点的pageName属性中。
• 存储s.pageName属性的分析属性称为pagedata.pagename。 此属性已映射到Analytics框架中的s.pageName属性。

如果框架映射配置正确，则getPageName方法的以下实现会返回pageName节点属性的值：

public String getPageName(AnalyticsPageNameContext context) {
        String pageName = null;

        Framework framework = context.getFramework();
        Resource resource = context.getResource();

        if (resource != null && framework != null && framework.mapsSCVariable(S_PAGE_NAME)) {
            String cqVar = framework.getMapping(S_PAGE_NAME);
            Page page = resource.adaptTo(Page.class);
            if (cqVar.equals("pagedata.pagename")) {
                pageName = page.getProperties().get("pageName",null);
            }
        }
        return pageName;
    }

getResource方法的以下实现返回页面的Resource对象：

     public Resource getResource(AnalyticsPageNameContext context) {
        Resource res = null;

        Framework framework = context.getFramework();
        ResourceResolver resolver = context.getResourceResolver();
        String pageName = context.getPageName();
        String basePath = context.getBasePath();

        if (pageName != null && basePath != null && resolver != null
                && framework != null && framework.mapsSCVariable(S_PAGE_NAME)) {
            String cqVar = framework.getMapping(S_PAGE_NAME);
            if (cqVar.equals("pagedata.pagename")) {
             Iterator<Resource>
             hits = resolver.findResources(createQuery(pageName, basePath, "pagename"), Query.JCR_SQL2);
             if (hits.hasNext()) {
              res = hits.next();
              res = res.getParent();
             }
            }
        }
        return res;
    }

    private String createQuery(String pageName, String basePath, String propName) {
        return "SELECT * FROM [cq:PageContent] WHERE ISDESCENDANTNODE(["
                + basePath + "]) and [" + propName + "] = \"" + pageName + "\"";
    }

以下代码表示整个类，包括用于配置服务的SCR注释。 请注意，服务排名为200，它覆盖默认服务。

/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 * Copyright 2019 Adobe Systems Incorporated
 * All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and may be covered by U.S. and Foreign Patents,
 * patents in process, and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 **************************************************************************/
package com.day.cq.analytics.sitecatalyst;

import java.util.Iterator;

import javax.jcr.query.Query;

import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;
import org.osgi.framework.Constants;
import org.osgi.service.component.annotations.Component;

import com.day.cq.analytics.sitecatalyst.AnalyticsPageNameContext;
import com.day.cq.analytics.sitecatalyst.AnalyticsPageNameProvider;
import com.day.cq.analytics.sitecatalyst.Framework;
import com.day.cq.wcm.api.Page;

import static com.day.cq.analytics.sitecatalyst.AnalyticsPageNameContext.S_PAGE_NAME;

/**
 * Default implementation of {@link AnalyticsPageNameProvider} that resolves
 * page title, path or navTitle if mapped in {@link Framework}.
 */
@Component(
    service = { AnalyticsPageNameProvider.class },
    property = {
        Constants.SERVICE_DESCRIPTION + "=Example Page Name Resolver implementation",
        Constants.SERVICE_RANKING + ":Integer=200"
    }
)
public class ExamplePageNameProvider implements AnalyticsPageNameProvider {
    public String getPageName(AnalyticsPageNameContext context) {
        String pageName = null;

        Framework framework = context.getFramework();
        Resource resource = context.getResource();

        if (resource != null && framework != null && framework.mapsSCVariable(S_PAGE_NAME)) {
            String cqVar = framework.getMapping(S_PAGE_NAME);
            Page page = resource.adaptTo(Page.class);
            if (cqVar.equals("pagedata.path")) {
                pageName = page.getProperties().get("pageName",null);
            }
        }
        return pageName;
    }

    public Resource getResource(AnalyticsPageNameContext context) {
        Resource res = null;

        Framework framework = context.getFramework();
        ResourceResolver resolver = context.getResourceResolver();
        String pageName = context.getPageName();
        String basePath = context.getBasePath();

        if (pageName != null && basePath != null && resolver != null
                && framework != null && framework.mapsSCVariable(S_PAGE_NAME)) {
            String cqVar = framework.getMapping(S_PAGE_NAME);
            if (cqVar.equals("pagedata.pagename")) {
                Iterator<Resource>
                hits = resolver.findResources(createQuery(pageName, basePath, "pagename"), Query.JCR_SQL2);
                if (hits.hasNext()) {
                    res = hits.next();
                    res = res.getParent();
                }
            }
        }
        return res;
    }

    private String createQuery(String pageName, String basePath, String propName) {
        return "SELECT * FROM [cq:PageContent] WHERE ISDESCENDANTNODE(["
                + basePath + "]) and [" + propName + "] = \"" + pageName + "\"";
    }
}

Business.Adobe.com资源

Ecommerce Integrations Content Insights Automated Onboarding Style System Customer Communications Dynamic Media