Personalização da estrutura do Adobe Analytics customizing-the-adobe-analytics-framework
A estrutura do Adobe Analytics determina as informações que são rastreadas com o Adobe Analytics. Para personalizar a estrutura padrão, use o JavaScript para adicionar rastreamento personalizado, integrar plug-ins do Adobe Analytics e alterar configurações gerais na estrutura usada para rastreamento.
Sobre a JavaScript gerada para Frameworks about-the-generated-javascript-for-frameworks
Quando uma página é associada a uma estrutura Adobe Analytics e inclui referências ao módulo do Analytics, um arquivo analytics.sitecatalyst.js é gerado automaticamente para a página.
O JavaScript na página cria um objeto s_gi
(que a biblioteca Adobe Analytics s_code.js define) e atribui valores às suas propriedades. O nome da instância do objeto é s
. Os exemplos de código apresentados nesta seção fazem várias referências a esta variável s
.
O código de exemplo a seguir é semelhante ao código em um arquivo analytics.sitecatalyst.js:
var s_account = "my_sitecatalyst_account";
var s = s_gi(s_account);
s.fpCookieDomainPeriods = "3";
s.currencyCode= 'USD';
s.trackInlineStats= true;
s.linkTrackVars= 'None';
s.charSet= 'UTF-8';
s.linkLeaveQueryString= false;
s.linkExternalFilters= '';
s.linkTrackEvents= 'None';
s.trackExternalLinks= true;
s.linkDownloadFileTypes= 'exe,zip,wav,mp3,mov,mpg,avi,wmv,doc,pdf,xls';
s.linkInternalFilters= 'javascript:,'+window.location.hostname;
s.trackDownloadLinks= true;
s.visitorNamespace = "mynamespace";
s.trackingServer = "xxxxxxx.net";
s.trackingServerSecure = "xxxxxxx.net";
/* Plugin Config */
/*
s.usePlugins=false;
function s_doPlugins(s) {
//add your custom plugin code here
}
s.doPlugins=s_doPlugins;
*/
Ao usar o código JavaScript personalizado para personalizar a estrutura, você altera o conteúdo desse arquivo.
Configuração das propriedades do Adobe Analytics configuring-adobe-analytics-properties
Há várias variáveis predefinidas no Adobe Analytics que podem ser configuradas em uma estrutura. As variáveis charset, cookieLifetime, currencyCode e trackInlineStats estão incluídas na lista Configurações Gerais do Analytics por padrão.
É possível adicionar nomes e valores de variáveis à lista. Essas variáveis predefinidas e quaisquer variáveis adicionadas são usadas para configurar as propriedades do objeto s
no arquivo analytics.sitecatalyst.js. O exemplo a seguir mostra como a propriedade prop10
adicionada de valor CONSTANT
é representada no código JavaScript:
var s_account = "my_sitecatalyst_account";
var s = s_gi(s_account);
s.fpCookieDomainPeriods = "3";
s.currencyCode= 'USD';
s.trackInlineStats= true;
s.linkTrackVars= 'None';
s.charSet= 'UTF-8';
s.linkLeaveQueryString= false;
s.linkExternalFilters= '';
s.linkTrackEvents= 'None';
s.trackExternalLinks= true;
s.linkDownloadFileTypes= 'exe,zip,wav,mp3,mov,mpg,avi,wmv,doc,pdf,xls';
s.prop10= 'CONSTANT';
s.linkInternalFilters= 'javascript:,'+window.location.hostname;
s.trackDownloadLinks= true;
s.visitorNamespace = "mynamespace";
s.trackingServer = "xxxxxxx.net";
s.trackingServerSecure = "xxxxxxx.net";
Use o procedimento a seguir para adicionar variáveis à lista:
-
Na página da estrutura do Adobe Analytics, expanda a área Configurações gerais do Analytics.
-
Abaixo da lista de variáveis, clique em Adicionar item para adicionar uma nova variável à lista.
-
Na célula à esquerda, digite um nome para a variável, por exemplo,
prop10
. -
Na coluna à direita, insira um valor para a variável, por exemplo,
CONSTANT
. -
Para remover uma variável, clique no botão (-) ao lado dela.
Adicionar um JavaScript personalizado a uma estrutura do Adobe Analytics adding-custom-javascript-to-an-adobe-analytics-framework
A caixa free-from JavaScript na área Configurações gerais do Analytics permite adicionar código personalizado a uma estrutura Adobe Analytics.
O código adicionado é anexado ao arquivo analytics.sitecatalyst.js. Portanto, você pode acessar a variável s
, que é uma instância do objeto JavaScript s_gi
definido em s_code.js
. Por exemplo, adicionar o código a seguir é equivalente a adicionar uma variável nomeada prop10
do valor CONSTANT
, que é o exemplo na seção anterior:
s.prop10= 'CONSTANT';
O código no arquivo analytics.sitecatalyst.js (que inclui o conteúdo do arquivo s-code.js
do Adobe Analytics) contém o seguinte código:
if (s.usePlugins) s.doPlugins(s)
O procedimento a seguir demonstra como usar a caixa JavaScript para personalizar o rastreamento do Adobe Analytics. Se o JavaScript precisar usar plug-ins do Adobe Analytics, integre-os no AEM.
-
Adicione o seguinte código JavaScript à caixa para que
s.doPlugins
seja executado:code language-none s.usePlugins=true; function s_doPlugins(s) { //add your custom code here } s.doPlugins=s_doPlugins;
note caution CAUTION Esse código é necessário se você quiser enviar variáveis em uma chamada do Adobe Analytics que foi personalizada de alguma forma que não pode ser feita por meio da interface básica de arrastar e soltar OU por meio do JavaScript em linha no Adobe Analytics View. Se as variáveis personalizadas estiverem fora da função s_doPlugins, elas serão enviadas como *indefinido *na chamada de Adobe Analytics -
Adicione seu código JavaScript na função s_doPlugins.
O exemplo a seguir concatena os dados capturados em uma página em ordem hierárquica, usando um separador comum de "|".
Uma estrutura Adobe Analytics tem as seguintes configurações:
-
A variável do Adobe Analytics
prop2
está mapeada para a propriedade do sitepagedata.sitesection
. -
A variável do Adobe Analytics
prop3
está mapeada para a propriedade do sitepagedata.subsection
. -
O código a seguir é adicionado à caixa free-from JavaScript:
code language-none s.usePlugins=true; function s_doPlugins(s) { s.prop1 = s.prop2+'|'+s.prop3; } s.doPlugins=s_doPlugins;
-
Quando a página da Web que usa a estrutura é visitada (ou, no modo de edição, a página é recarregada ou visualizada), as chamadas para o Adobe Analytics são executadas.
Por exemplo, os seguintes valores são gerados no Adobe Analytics:
Adição de código personalizado global para todas as estruturas do Adobe Analytics adding-global-custom-code-for-all-adobe-analytics-frameworks
Forneça o código JavaScript personalizado integrado a todas as estruturas do Adobe Analytics. Quando a estrutura Adobe Analytics de uma página não contém um JavaScript de forma livre personalizado, o JavaScript gerado pelo script /libs/cq/analytics/components/sitecatalyst/config.js.jsp é anexado ao arquivo analytics.sitecatalyst.js. Por padrão, o script não tem efeito porque está comentado. O código também define s.usePlugins
como false
:
/* Plugin Config */
/*
s.usePlugins=false;
function s_doPlugins(s) {
//add your custom plugin code here
}
s.doPlugins=s_doPlugins;
*/
O código no arquivo analytics.sitecatalyst.js (que inclui o conteúdo do arquivo s_code.js do Adobe Analytics) contém o seguinte código:
if (s.usePlugins) s.doPlugins(s)
Portanto, seu JavaScript deve definir s.usePlugins
como true
para que qualquer código na função s_doPlugins
seja executado. Para personalizar o código, sobreponha o arquivo config.js.jsp por um que use seu próprio JavaScript. Se o JavaScript precisar usar plug-ins do Adobe Analytics, integre-os no AEM.
-
No CRXDE Lite, crie a estrutura de pastas /apps/cq/analytics/components:
- Clique com o botão direito do mouse na pasta /apps e clique em Create > Create Folder.
- Especifique
cq
como o nome da pasta e clique em OK. - Da mesma forma, crie as pastas
analytics
ecomponents
.
-
Clique com o botão direito do mouse na pasta
components
que você criou e clique em Criar > Criar Componente. Especifique os seguintes valores de propriedade:- Rótulo:
sitecatalyst
- Título:
sitecatalyst
- Supertipo:
/libs/cq/analytics/components/sitecatalyst
- Grupo:
hidden
- Rótulo:
-
Clique em Avançar repetidamente até que o botão OK esteja ativado e, em seguida, clique em OK.
O componente sitecatalyst contém o arquivo sitecatalyst.jsp criado automaticamente.
-
Clique com o botão direito do mouse no arquivo sitecatalyst.jsp e clique em Excluir.
-
Clique com o botão direito do mouse no componente SiteCatalyst e clique em Criar > Criar arquivo. Especifique o nome
config.js.jsp
e clique em OK.O arquivo config.js.jsp é aberto automaticamente para edição.
-
Adicione o seguinte texto ao arquivo e clique em Salvar tudo:
code language-java <%@page session="true"%> /* Plugin Config */ s.usePlugins=true; function s_doPlugins(s) { //add your custom plugin code here } s.doPlugins=s_doPlugins;
O código JavaScript gerado pelo script /apps/cq/analytics/components/sitecatalyst/config.js.jsp agora é inserido no arquivo analytics.sitecatalyst.js para todas as páginas que usam uma estrutura Adobe Analytics.
-
Adicione o código JavaScript que deseja executar na função
s_doPlugins
e clique em Salvar tudo.
Utilização de plug-ins do Adobe Analytics no AEM using-adobe-analytics-plugins-in-aem
Obtenha o código JavaScript para plug-ins do Adobe Analytics e integre-os à sua estrutura do Adobe Analytics no AEM. Adicione o código a uma pasta da biblioteca do cliente da categoria sitecatalyst.plugins
para que ela fique disponível para o seu código JavaScript personalizado.
Por exemplo, se você integrar o plug-in getQueryParams
, poderá chamá-lo da função s_doPlugins
do seu JavaScript personalizado. O código de exemplo a seguir envia a sequência de consulta em "pid" da URL do referenciador como eVar 1, quando uma chamada de Adobe Analytics é acionada.
s.usePlugins=true;
function s_doPlugins(s) {
// take the query string from the referrer
s.eVar1=s.getQueryParam('pid','',document.referrer);
}
s.doPlugins=s_doPlugins;
O AEM instala os seguintes plug-ins do Adobe Analytics, para que estejam disponíveis por padrão:
- getQueryParam()
- getPreviousValue()
- split()
A pasta da biblioteca do cliente /libs/cq/analytics/clientlibs/sitecatalyst/plugins inclui esses plug-ins na categoria sitecatalyst.plugins.
/libs/cq/analytics/clientlibs/sitecatalyst/plugins
. Essa prática garante que sua contribuição para a categoria sitecatalyst.plugins
não seja substituída durante as reinstalações do AEM ou tarefas de atualização.Use o procedimento a seguir para criar a pasta da biblioteca do cliente para seus plug-ins. Você só precisa executar esse procedimento uma vez. Para adicionar um plug-in à pasta da biblioteca do cliente, use o procedimento subsequente.
-
Em um navegador da Web, abra o CRXDE Lite. (http://localhost:4502/crx/de)
-
Clique com o botão direito do mouse na pasta /apps/my-app/clientlibs e clique em Criar > Criar nó. Insira os seguintes valores de propriedade e clique em OK:
-
Nome: um nome para a pasta da biblioteca do cliente, como my-plugins
-
Tipo: cq:ClientLibraryFolder
-
-
Selecione a pasta da biblioteca do cliente que você criou e use a barra de propriedades inferior direita para adicionar a seguinte propriedade:
- Nome: categorias
- Tipo: String
- Valor: sitecatalyst.plugins
- Múltiplo: selecionado
Clique em OK na janela Editar para confirmar o valor da propriedade.
-
Clique com o botão direito do mouse na pasta da biblioteca do cliente que você criou e clique em Criar > Criar arquivo. No nome do arquivo, digite js.txt e clique em OK.
-
Clique em Salvar tudo.
Use o procedimento a seguir para obter o código do plug-in, armazená-lo no repositório AEM e adicioná-lo à pasta da biblioteca do cliente.
-
Faça logon em sc.omniture.com usando sua conta da Adobe Analytics.
-
Na página de aterrissagem, acesse Ajuda > Página inicial da ajuda.
-
No índice à esquerda, clique em Plug-ins de implementação.
-
Clique no link para o plug-in que deseja adicionar e, quando a página for aberta, localize o código-fonte do JavaScript para o plug-in e, em seguida, selecione o código e copie-o.
-
Clique com o botão direito do mouse na pasta da biblioteca do cliente e clique em Criar > Criar arquivo. Para o nome do arquivo, digite o nome do plug-in que você está integrando, seguido por .js, e clique em OK. Por exemplo, se você estiver integrando o plug-in getQueryParam, nomeie o arquivo como getQueryParam.js.
Ao criar o arquivo, ele é aberto para edição.
-
Cole o código JavaScript do plug-in no arquivo, clique em Salvar tudo e feche o arquivo.
-
Abra o arquivo js.txt da pasta da biblioteca do cliente.
-
Em uma nova linha, adicione o nome do arquivo que contém o plugin, por exemplo, getQueryParam.js. Em seguida, clique em Salvar tudo e feche o arquivo.