Implementação de nomenclatura de página do lado do servidor para o Analytics

A Adobe Analytics usa a variável s.pageName para identificar de forma exclusiva as páginas e associar os dados coletados para as páginas. Normalmente, você executa as seguintes tarefas no AEM para atribuir um valor a essa propriedade que AEM envia para o Analytics:

Para expor os dados de relatório do Analytics no console Sites e no Content Insight, AEM exige o valor da variável s.pageName para cada página. A API Java do AEM Analytics define a variável AnalyticsPageNameProvider interface que você implementa para fornecer o console Sites e os Content Insights com o valor da variável s.pageName propriedade. Seu AnaltyicsPageNameProvider resolve a propriedade pageName no servidor para fins de relatório, pois pode ser definida dinamicamente usando Javascript no cliente para fins de rastreamento.

O serviço padrão do provedor de nome de página do Analytics

O DefaultPageNameProvider serviço é o serviço padrão que determina o valor da variável s.pageName propriedade a ser usada para recuperar dados do Analytics para uma página. O serviço funciona em conjunto com o componente de página de base AEM ( /libs/foundation/components/page). Esse componente de página define as seguintes variáveis CQ que devem ser mapeadas para a variável s.pageName propriedade:

  • pagedata.path: O valor é definido como o caminho da página.
  • pagedata.title: O valor é definido como o título da página.
  • pagedata.navTitle: O valor é definido como o título de navegação da página.

O DefaultPageNameProvider determina qual dessas variáveis CQ é mapeada para a variável s.pageName na estrutura do serviço de nuvem do Analytics. O serviço determina a propriedade de página apropriada a ser usada para recuperar os dados do relatório de análise:

  • pagedata.path: O serviço usa page.getPath()

  • pagedata.title: O serviço usa page.getTitle()

  • pagedata.navTitle: O serviço usa page.getNavigationTitle()

O page o objeto é o com.day.cq.wcm.api.Page Objeto Java para a página.

Se você não mapear uma variável CQ para a variável s.pageName na estrutura, o valor de s.pageName é gerada a partir do caminho da página. Por exemplo, a página com o caminho /content/geometrixx/en usa o valor content:geometrixx:en para s.pageName.

OBSERVAÇÃO

O serviço DefaultPageNameProvider usa uma classificação de serviço de 100.

Manutenção da continuidade em relatórios do Analytics

Manter um histórico completo de dados de análise para uma página requer que o valor da propriedade s.pageName usada para uma página nunca mude. No entanto, as propriedades de análise que o componente da página de base define podem ser facilmente alteradas. Por exemplo, mover uma página altera o valor de pagedata.path e quebra a continuidade do histórico de relatórios:

  • Os dados coletados para o caminho anterior não são mais associados à página.
  • Se uma página diferente usar o caminho usado por outra página, a página diferente herdará os dados desse caminho.

Para garantir a continuidade do relatório, o valor de s.pageName devem ter as seguintes características:

  • Único.
  • Estável.
  • Leitura humana.

Por exemplo, um componente de página personalizada pode incluir uma propriedade de página que os autores usam para especificar uma ID exclusiva para a página que é usada como o valor da variável s.pageProperties propriedade:

  • A página inclui uma variável do Analytics definida com o valor da ID exclusiva armazenada na propriedade da página.
  • A variável do Analytics é mapeada para o s.pageProperties na estrutura do Analytics.
  • Sua implementação da interface AnalyticsPageNameProvider recupera o valor da propriedade da página a ser usada para consultar os dados do Analytics da página.
OBSERVAÇÃO

Peça ajuda ao consultor do Analytics para desenvolver uma estratégia eficaz para s.pageName valor.

Implementar um serviço de provedor de nome de página do Analytics

Implemente o com.day.cq.analytics.sitecatalyst.AnalyticsPageNameProvider interface como um serviço OSGi para personalizar a lógica que recupera a s.pageName valor da propriedade. A análise de página Sites e o Content Insight usam o serviço para recuperar dados de relatório do Analytics.

A interface AnalyticsPageNameProvider define dois métodos que você deve implementar:

  • getPageName: Retorna um String que representa o valor a ser usado como o s.pageName propriedade.

  • getResource: Retorna um org.apache.sling.api.resource.Resource objeto que representa a página associada ao s.pageName propriedade.

Ambos os métodos têm uma com.day.cq.analytics.sitecatalyst.AnalyticsPageNameContext como parâmetro. O AnalyticsPageNameContext A classe fornece informações sobre o contexto das chamadas do analytics:

  • O caminho base do recurso de página.
  • O Framework objeto para a configuração do serviço de nuvem do Analytics.
  • O Resource para a página.
  • O ResourceResolver para a página.

A classe também fornece um setter para o nome da página.

Exemplo de implementação do AnalyticsPageNameProvider

O exemplo a seguir AnalyticsPageNameProvider a implementação suporta um componente de página personalizada:

  • O componente estende o componente de página de base.
  • A caixa de diálogo inclui um campo usado pelos autores para especificar o valor da variável s.pageName propriedade.
  • O valor da propriedade é armazenado na propriedade pageName da variável jcr:contentnó das instâncias da página.
  • A propriedade do Analytics que armazena a variável s.pageName propriedade é chamada pagedata.pagename. Essa propriedade é mapeada para a variável s.pageName na estrutura do Analytics.

A aplicação do getPageName retornará o valor da propriedade do nó pageName se o mapeamento da estrutura estiver configurado corretamente:

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;
    }

A seguinte implementação do método getResource retorna o objeto Resource da página:

     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 + "\"";
    }

O código a seguir representa a classe inteira, incluindo anotações SCR que configuram o serviço. Observe que a classificação de serviço é 200, o que substitui o serviço padrão.

/*************************************************************************
 *
 * 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 + "\"";
    }
}

Nesta página