Analytics에 대한 서버측 페이지 이름 지정 구현

Adobe Analytics은 s.pageName 속성을 사용하여 페이지를 고유하게 식별하고 페이지에 대해 수집된 데이터를 연결합니다. 일반적으로 AEM에서 다음 작업을 수행하여 AEM이 Analytics에 전송하는 이 속성에 값을 할당합니다.

Sites 콘솔 및 Content Insight에서 Analytics 보고서 데이터를 노출하려면 AEM에 다음 값이 필요합니다. s.pageName 각 페이지의 속성입니다. AEM Analytics Java API는 AnalyticsPageNameProvider 를 사용하여 사이트 콘솔 및 콘텐츠 통찰력에 다음과 같은 가치를 제공하는 인터페이스 s.pageName 속성. 사용자 AnaltyicsPageNameProvider 이 서비스는 추적 목적으로 클라이언트에서 JavaScript를 사용하여 동적으로 설정할 수 있으므로, 보고 목적으로 서버의 pageName 속성을 확인합니다.

기본 Analytics 페이지 이름 공급자 서비스

다음 DefaultPageNameProvider 서비스는 의 값을 결정하는 기본 서비스입니다. s.pageName 페이지의 Analytics 데이터를 검색하는 데 사용할 속성입니다. 이 서비스는 AEM foundation 페이지 구성 요소( )와 함께 작동합니다 /libs/foundation/components/page). 이 페이지 구성 요소는 로 매핑될 다음 CQ 변수를 정의합니다. s.pageName 속성:

  • pagedata.path: 값이 페이지 경로로 설정됩니다.
  • pagedata.title: 값이 페이지 제목으로 설정됩니다.
  • pagedata.navTitle: 값이 페이지 탐색 제목으로 설정됩니다.

다음 DefaultPageNameProvider 서비스는 이러한 CQ 변수 중 어느 변수가 s.pageName analytics 클라우드 서비스 프레임워크의 속성. 그런 다음 서비스는 분석 보고서 데이터를 검색하는 데 사용할 적절한 페이지 속성을 결정합니다.

  • 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를 지정하는 데 사용하는 페이지 속성이 포함될 수 있습니다. s.pageProperties 속성:

  • 페이지에는 페이지 속성에 저장된 고유 ID의 값으로 설정된 analytics 변수가 포함되어 있습니다.
  • Analytics 변수가 s.pageProperties analytics 프레임워크의 속성.
  • AnalyticsPageNameProvider 인터페이스를 구현하면 페이지 Analytics 데이터를 쿼리하는 데 사용할 페이지 속성의 값을 검색합니다.
노트

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 analytics 클라우드 서비스 구성에 대한 개체입니다.
  • 다음 Resource 페이지에 대한 개체입니다.
  • 다음 ResourceResolver 페이지에 대한 개체입니다.

클래스는 페이지 이름에 대한 setter도 제공합니다.

예제 AnalyticsPageNameProvider 구현

다음 예 AnalyticsPageNameProvider 구현은 사용자 지정 페이지 구성 요소를 지원합니다.

  • 구성 요소가 기초 페이지 구성 요소를 확장합니다.
  • 대화 상자에는 작성자가 값 지정에 사용하는 필드가 포함되어 있습니다. s.pageName 속성.
  • 속성 값은 의 pageName 속성에 저장됩니다. jcr:content페이지 인스턴스의 노드
  • 를 저장하는 analytics 속성 s.pageName 속성이 호출됨 pagedata.pagename. 이 속성은 다음에 매핑됩니다. s.pageName analytics 프레임워크의 속성.

다음 구현 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 + "\"";
    }
}

이 페이지에서는