Implementieren Server-seitiger Seitennamen für Analytics implementing-server-side-page-naming-for-analytics

CAUTION
AEM 6.4 hat das Ende der erweiterten Unterstützung erreicht und diese Dokumentation wird nicht mehr aktualisiert. Weitere Informationen finden Sie in unserer technische Unterstützung. Unterstützte Versionen suchen here.

Adobe Analytics verwendet die Eigenschaft s.pageName, um Seiten eindeutig zu identifizieren und die Daten, die für die Seiten erfasst werden, zu verknüpfen. Normalerweise führen Sie in AEM die folgenden Aufgaben aus, um dieser Eigenschaft, die AEM an Analytics übermittelt, einen Wert zuzuordnen:

Um Analytics-Berichtsdaten in der Sites-Konsole und in Inhaltserkenntnissen anzuzeigen, benötigt AEM den Wert der Eigenschaft s.pageName für jede Seite. Die Java-API für AEM Analytics definiert die Schnittstelle AnalyticsPageNameProvider, die Sie implementieren, um die Sites-Konsole und Inhaltserkenntnisse mit dem Wert der Eigenschaft s.pageName bereitzustellen. Ihr Dienst AnaltyicsPageNameProvider löst die Eigenschaft „pageName“ auf dem Server zu Berichtszwecken auf, da sie dynamisch mittels JavaScript auf dem Client aus Gründen der Nachverfolgung festgelegt werden kann.

Der standardmäßige Analytics Page Name Provider-Dienst the-default-analytics-page-name-provider-service

Der Service DefaultPageNameProvider ist der standardmäßige Dienst, der den Wert der Eigenschaft s.pageName bestimmt, die zum Abrufen der Analytics-Daten für eine Seite verwendet wird. Der Dienst arbeitet in Verbindung mit der AEM-Foundation-Seitenkomponente (/libs/foundation/components/page). Diese Seitenkomponente definiert die folgenden CQ-Variablen, die für die Zuordnung zur Eigenschaft s.pageName vorgesehen sind:

  • pagedata.path: Der Wert wird auf den Seitenpfad festgelegt.
  • pagedata.title: Der Wert wird auf den Seitentitel festgelegt.
  • pagedata.navTitle: Der Wert wird auf den Seitennavigationstitel festgelegt.

Der Service DefaultPageNameProvider bestimmt, welche dieser CQ-Variablen der Eigenschaft s.pageName im Framework des Analytics-Cloud-Service zugeordnet wird. Der Dienst bestimmt dann die entsprechende Seiteneigenschaft, die für das Abrufen von Analytics-Berichtsdaten verwendet werden soll:

  • pagedata.path: Der Dienst verwendet page.getPath()

  • pagedata.title: Der Dienst verwendet page.getTitle()

  • pagedata.navTitle: Der Dienst verwendet page.getNavigationTitle()

Das page-Objekt ist das Java-Objekt com.day.cq.wcm.api.Page für die Seite.

Wenn Sie der Eigenschaft s.pageName im Framework keine CQ-Variable zuordnen, wird aus dem Seitenpfad der Wert für s.pageName generiert. Beispielsweise verwendet die Seite mit dem Pfad /content/geometrixx/en den Wert content:geometrixx:en für s.pageName.

NOTE
Der Service DefaultPageNameProvider verwendet eine Service-Rangfolge von 100.

Wahren der Kontinuität beim Analytics-Reporting maintaining-continuity-in-analytics-reporting

Um einen vollständigen Verlauf der Analysedaten für eine Seite zu erhalten, muss sich der Wert der Eigenschaft s.pageName, die für eine Seite verwendet wird, nie ändern. Die Analytics-Eigenschaften, die die Foundation-Seitenkomponente definiert, können jedoch einfach geändert werden. Beispielsweise ändert das Verschieben einer Seite den Wert von pagedata.path. Damit ist die Kontinuität des Berichtsverlaufs nicht mehr gewahrt:

  • Daten, die für den vorherigen Pfad erfasst wurden, sind nicht mehr mit der Seite verknüpft.
  • Wenn eine andere Seite den Pfad verwendet, den eine andere Seite verwendet hat, übernimmt die andere Seite die Daten für diesen Pfad.

Um die Kontinuität des Reportings zu wahren, sollte der Wert von s.pageName die folgenden Merkmale aufweisen:

  • Eindeutig.
  • Stabil.
  • Menschen lesbar.

Beispielsweise kann eine benutzerdefinierte Seitenkomponente eine Seiteneigenschaft enthalten, mit der Autoren eine eindeutige ID für die Seite angeben, die als Wert für die Eigenschaft s.pageProperties verwendet wird:

  • Die Seite enthält eine Analytics-Variable, die auf den Wert der eindeutigen ID festgelegt ist, die in der Seiteneigenschaft gespeichert ist.
  • Die Analytics-Variable ist der Eigenschaft s.pageProperties im Analytics-Framework zugeordnet.
  • Ihre Implementierung der Schnittstelle „AnalyticsPageNameProvider“ ruft den Wert der Seiteneigenschaft ab, die zum Abfragen der Analytics-Daten der Seite verwendet wird.
NOTE
Wenden Sie sich an Ihren Analytics-Berater, um Unterstützung beim Entwickeln einer effektiven Strategie für Ihren Wert s.pageName zu erhalten.

Implementieren von Analytics Page Name Provider-Diensten implementing-an-analytics-page-name-provider-service

Implementieren Sie die Schnittstelle com.day.cq.analytics.sitecatalyst.AnalyticsPageNameProvider als OSGi-Dienst, um die Logik anzupassen, die den Wert der Eigenschaft „s.pageName“ abruft. Die Sites-Seitenanalyse und Inhaltserkenntnisse verwenden den Dienst zum Abrufen der Berichtsdaten von Analytics.

Die AnalyticsPageNameProvider-Schnittstelle definiert zwei Methoden, die Sie implementieren müssen:

  • getPageName: Gibt einen String-Wert zurück, der für den als Eigenschaft s.pageName zu verwendenden Wert steht.

  • getResource: Gibt ein org.apache.sling.api.resource.Resource-Objekt zurück, das für die mit der Eigenschaft s.pageName verbundenen Seite steht.

Bei beiden Methoden wird ein com.day.cq.analytics.sitecatalyst.AnalyticsPageNameContext-Objekt als Parameter verwendet. Die AnalyticsPageNameContext-Klasse stellt Informationen zum Kontext der Analytics-Aufrufe bereit:

  • Der Basispfad der Seitenressource.
  • Das Framework-Objekt für die Konfiguration des Analytics-Cloud-Service.
  • Das Resource-Objekt für die Seite.
  • Das ResourceResolver-Objekt für die Seite.

Die Klasse stellt auch einen Setter für den Seitennamen bereit.

Beispiel einer AnalyticsPageNameProvider-Implementierung example-analyticspagenameprovider-implementation

Die folgende AnalyticsPageNameProvider-Beispielimplementierung unterstützt eine Seitenkomponente:

  • Die Komponente erweitert die Foundation-Seitenkomponente.
  • Das Dialogfeld enthält ein Feld, mit dem die Autoren den Wert der Eigenschaft s.pageName angeben.
  • Der Wert der Eigenschaft wird in der Eigenschaft „pageName“ des Knotens jcr:content der Seiteninstanzen gespeichert.
  • Die Analytics-Eigenschaft, die die Eigenschaft s.pageName speichert, hat den Namen pagedata.pagename. Die Eigenschaft ist der Eigenschaft s.pageName im Analytics-Framework zugeordnet.

Die folgende Implementierung der Methode getPageName gibt den Wert der Knoteneigenschaft „pageName“ zurück, wenn die Framework-Zuordnung korrekt konfiguriert ist:

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

Die folgende Implementierung der getResource -Methode gibt das Resource -Objekt für die Seite zurück:

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

Der folgende Code stellt die gesamte Klasse dar, einschließlich SCR-Anmerkungen, die den Dienst konfigurieren. Beachten Sie, dass der Service-Rang 200 ist, wodurch der Standarddienst außer Kraft gesetzt wird.

/*************************************************************************
 *
 * 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 + "\"";
    }
}
recommendation-more-help
2315f3f5-cb4a-4530-9999-30c8319c520e