Serverpaginanamen voor analyse implementeren implementing-server-side-page-naming-for-analytics
Adobe Analytics gebruikt de eigenschap s.pageName
om pagina's op unieke wijze te identificeren en de gegevens die voor de pagina's worden verzameld, te koppelen. Typisch, voert u de volgende taken in AEM uit om een waarde aan dit bezit toe te wijzen dat AEM naar Analytics verzendt:
-
Gebruik het Cloud Service-framework Analytics om een CQ-variabele toe te wijzen aan de eigenschap Analytics
s.pageName
. (Zie Gegevens van de Component van de Toewijzing met de Eigenschappen van Adobe Analytics.) -
Ontwerp de paginacomponent zodanig dat deze de CQ-variabele bevat die u toewijst aan de eigenschap
s.pageName
. (Zie Uitvoerend Adobe Analytics die voor de Componenten van de Douane volgen.)
Om analysegegevens in de console van Plaatsen en in Inzicht van de Inhoud bloot te stellen, vereist AEM de waarde van het s.pageName
bezit voor elke pagina. De AEM Analytics Java API definieert de AnalyticsPageNameProvider
-interface die u implementeert om de Sites-console en Content Insights de waarde van de s.pageName
-eigenschap te geven. Uw AnaltyicsPageNameProvider
-service verhelpt de eigenschap pageName op de server voor rapportagedoeleinden, aangezien deze dynamisch kan worden ingesteld met JavaScript op de client voor traceringsdoeleinden.
De service Default Analytics Page Name Provider the-default-analytics-page-name-provider-service
De service DefaultPageNameProvider
is de standaardservice die de waarde bepaalt van de eigenschap s.pageName
die moet worden gebruikt voor het ophalen van analysegegevens voor een pagina. De service werkt samen met de component AEM basispagina ( /libs/foundation/components/page
). Deze paginacomponent definieert de volgende CQ-variabelen die aan de eigenschap s.pageName
moeten worden toegewezen:
pagedata.path
: de waarde wordt ingesteld op het paginapad.pagedata.title
: de waarde wordt ingesteld op de paginatitel.pagedata.navTitle
: de waarde wordt ingesteld op de titel van de paginanavigatie.
De service DefaultPageNameProvider
bepaalt welke van deze CQ-variabelen wordt toegewezen aan de eigenschap s.pageName
in het Cloud Service Framework Analytics. De dienst bepaalt dan het aangewezen paginabezit voor het terugwinnen van analyserapportgegevens te gebruiken:
-
pagedata.path
: de service gebruiktpage.getPath()
-
pagedata.title
: de service gebruiktpage.getTitle()
-
pagedata.navTitle
: de service gebruiktpage.getNavigationTitle()
Het page
-object is het Java-object com.day.cq.wcm.api.Page
voor de pagina.
Als u geen CQ-variabele toewijst aan de eigenschap s.pageName
in het framework, wordt de waarde voor s.pageName
gegenereerd vanuit het paginapad. De pagina met het pad /content/geometrixx/en
gebruikt bijvoorbeeld de waarde content:geometrixx:en
for s.pageName
.
Continuïteit behouden in analytische rapportage maintaining-continuity-in-analytics-reporting
Voor het bijhouden van een complete geschiedenis van analysegegevens voor een pagina moet de waarde van de eigenschap s.pageName die voor een pagina wordt gebruikt, nooit worden gewijzigd. Nochtans, kunnen de analtytische eigenschappen die de component van de stichtingspagina bepaalt gemakkelijk worden veranderd. Als u bijvoorbeeld een pagina verplaatst, verandert de waarde van pagedata.path
en wordt de continuïteit van de rapportgeschiedenis verbroken:
- Gegevens die voor het vorige pad zijn verzameld, zijn niet meer gekoppeld aan de pagina.
- Als een andere pagina het pad gebruikt dat een andere pagina ooit heeft gebruikt, neemt de andere pagina de gegevens voor dat pad over.
Om de rapportcontinuïteit te garanderen, moet de waarde van s.pageName
de volgende kenmerken hebben:
- Uniek.
- Stabiel.
- Voor de mens leesbaar.
Een aangepaste pagina-component kan bijvoorbeeld een pagina-eigenschap bevatten die auteurs gebruiken om een unieke id op te geven voor de pagina die als waarde voor de eigenschap s.pageProperties
wordt gebruikt:
- De pagina bevat een analytische variabele die is ingesteld op de waarde van de unieke id die is opgeslagen in de pagina-eigenschap.
- De variabele analytics wordt toegewezen aan de eigenschap
s.pageProperties
in het Analytics-framework. - Uw implementatie van de interface AnalycsPageNameProvider wint de waarde van het paginabezit aan gebruik voor het vragen van de gegevens van de pagina Analytics terug.
s.pageName
-waarde.De service voor het uitvoeren van een analyse van paginanummerservice implementing-an-analytics-page-name-provider-service
Implementeer de interface com.day.cq.analytics.sitecatalyst.AnalyticsPageNameProvider
als een OSGi-service om de logica aan te passen die de eigenschapswaarde s.pageName
ophaalt. De de paginaanalyses van Plaatsen en Inzicht van de Inhoud gebruiken de dienst om rapportgegevens van Analytics terug te winnen.
De interface AnalyticsPageNameProvider definieert twee methoden die u moet implementeren:
-
getPageName
: Geeft eenString
-waarde die de waarde vertegenwoordigt die als eigenschaps.pageName
moet worden gebruikt. -
getResource
: retourneert eenorg.apache.sling.api.resource.Resource
-object dat de pagina vertegenwoordigt die aan de eigenschaps.pageName
is gekoppeld.
Beide methoden nemen een com.day.cq.analytics.sitecatalyst.AnalyticsPageNameContext
-object als parameter. De klasse AnalyticsPageNameContext
biedt informatie over de context van de analytische aanroepen:
- Het basispad van de paginabron.
- Het
Framework
-object voor de cloudserviceconfiguratie Analytics. - Het
Resource
-object voor de pagina. - Het
ResourceResolver
-object voor de pagina.
De klasse biedt ook een setter voor de paginanaam.
Voorbeeld-analysePageNameProvider-implementatie example-analyticspagenameprovider-implementation
De volgende voorbeeldimplementatie AnalyticsPageNameProvider
ondersteunt een aangepaste pagina-component:
- De component breidt de component van de stichtingspagina uit.
- Het dialoogvenster bevat een veld waarmee auteurs de waarde van de eigenschap
s.pageName
kunnen opgeven. - De bezitswaarde wordt opgeslagen in het pageName bezit van de
jcr:content
knoop van de paginainstanties. - De eigenschap analytics die de eigenschap
s.pageName
opslaat, wordtpagedata.pagename
genoemd. Deze eigenschap wordt toegewezen aan de eigenschaps.pageName
in het Analytics-framework.
De volgende implementatie van de methode getPageName
retourneert de waarde van de eigenschap pageName node als de frameworktoewijzing correct is geconfigureerd:
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;
}
De volgende implementatie van de methode getResource keert het voorwerp van het Middel voor de pagina terug:
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 + "\"";
}
De volgende code vertegenwoordigt de volledige klasse, met inbegrip van SCR annotaties die de dienst vormen. De de dienstrangschikking is 200 die de standaarddienst met voeten treedt.
/*************************************************************************
*
* 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 + "\"";
}
}