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

注意

AEM 6.4已结束扩展支持，本文档将不再更新。有关更多详细信息，请参阅技术支助期. 查找支持的版本此处.

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

使用Analytics云服务框架将CQ变量映射到Analytics s.pageName 属性。 (请参阅使用Adobe Analytics属性映射组件数据.)
设计页面组件，以便它包含您映射到的CQ变量 s.pageName 属性。 (请参阅为自定义组件实施Adobe Analytics跟踪.)

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

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

的 DefaultPageNameProvider 服务是确定 s.pageName 用于检索页面Analytics数据的属性。该服务可与AEM Foundation页面组件( /libs/foundation/components/page)。此页面组件定义了以下要映射到 s.pageName 属性：

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

的 DefaultPageNameProvider 服务确定这些CQ变量中的哪个变量被映射到 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.

注意

DefaultPageNameProvider服务使用100的服务排名。

在Analytics报表中维护连续性

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

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

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

唯一.
稳定。
人类可读。

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

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

注意

请咨询您的Analytics顾问，以获取有关为您的 s.pageName 值。

实施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 属性。
属性值存储在的pageName属性中 jcr:content页面实例的节点。
用于存储的分析属性 s.pageName 属性被调用 pagedata.pagename. 此属性已映射到 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

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

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

在Analytics报表中维护连续性

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

AnalyticsPageNameProvider实施示例

Business.Adobe.com 资源

在此页面上

查看下一个：

学习

文档

社区

技术支持

资源

Adobe 帐户

Adobe