Plug-in da Adobe: getPageName

O plug-in getPageName cria uma versão formatada amigável e fácil de ler do URL atual. A Adobe recomenda usar esse plug-in se você quiser um valor de pageName fácil de definir e de entender nos relatórios. Esse plug-in será desnecessário se você já tiver uma estrutura de nomeação para a variável pageName, como por meio de uma camada de dados. Ele é melhor usado quando você não tem outra solução para definir a variável pageName.

Instale o plug-in usando a extensão Adobe Experience Platform Launch

A Adobe oferece uma extensão que permite usar os plug-ins usados com mais frequência.

1. Faça logon em launch.adobe.com usando as credenciais da Adobe ID.
2. Clique na propriedade desejada.
3. Vá para a guia Extensões e clique no botão Catálogo.
4. Instale e publique a extensão Plug-ins comuns do Analytics.
5. Caso ainda não o tenha feito, crie uma regra denominada "Inicializar plug-ins" com a seguinte configuração:
   • Condição: Nenhuma
   • Evento: principal – biblioteca carregada (início da página)
6. Adicione à regra acima uma ação com a seguinte configuração:
   • Extensão: Plug-ins comuns do Analytics
   • Tipo de ação: inicializar getPageName
7. Salve e publique as alterações na regra.

Instale o plug-in usando o editor de código personalizado do Launch

Se você não quiser usar a extensão do plug-in, poderá usar o editor de código personalizado.

1. Faça logon em launch.adobe.com usando as credenciais da Adobe ID.
2. Clique na propriedade desejada.
3. Vá até a guia Extensões e clique no botão Configurar na extensão do Adobe Analytics.
4. Expanda a opção Configurar rastreamento usando código personalizado, que revela o botão Abrir editor.
5. Abra o editor de código personalizado e cole na janela de edição o código do plug-in fornecido abaixo.
6. Salve e publique as alterações na extensão do Analytics.

Instalar o plug-in usando o AppMeasurement

Copie e cole o seguinte código em qualquer lugar no arquivo AppMeasurement depois que o objeto de rastreamento do Analytics for instanciado (usando s_gi). A preservação de comentários e números de versão do código na sua implementação ajuda a Adobe a solucionar possíveis problemas.

/******************************************* BEGIN CODE TO DEPLOY *******************************************/
/* Adobe Consulting Plugin: getPageName v4.2 */
var getPageName=function(si,qv,hv,de){var a=si,b=qv,f=hv,e=de;if("-v"===a)return{plugin:"getPageName",version:"4.2"};a:{if("undefined"!==typeof window.s_c_il){var d=0;for(var g;d<window.s_c_il.length;d++)if(g=window.s_c_il[d],g._c&&"s_c"===g._c){d=g;break a}}d=void 0}"undefined"!==typeof d&&(d.contextData.getPageName="4.2");var c=location.hostname,h=location.pathname.substring(1).split("/"),l=h.length,k=location.search.substring(1).split("&"),m=k.length;d=location.hash.substring(1).split("&");g=d.length;e=e?e:"|";a=a?a:c;b=b?b:"";f=f?f:"";if(1===l&&""===h[0])a=a+e+"home";else for(c=0;c<l;c++)a=a+e+decodeURIComponent(h[c]);if(b&&(1!==m||""!==k[0]))for(h=b.split(","),l=h.length,c=0;c<l;c++)for(b=0;b<m;b++)if(h[c]===k[b].split("=")[0]){a=a+e+decodeURIComponent(k[b]);break}if(f&&(1!==g||""!==d[0]))for(f=f.split(","),k=f.length,c=0;c<k;c++)for(b=0;b<g;b++)if(f[c]===d[b].split("=")[0]){a=a+e+decodeURIComponent(d[b]);break}return a.substring(a.length-e.length)===e?a.substring(0,a.length-e.length):a};
/******************************************** END CODE TO DEPLOY ********************************************/

Usar o plug-in

O método getPageName aceita os seguintes argumentos:

• si (opcional, string): uma ID inserida no início da string que representa a ID do site. Esse valor pode ser uma ID numérica ou um nome amigável. Quando não estiver definido, o padrão será o domínio atual.
• qv (opcional, string): uma lista, delimitada por vírgulas, de parâmetros da string de consulta que, se encontrados no URL, são adicionados à string
• hv (opcional, string): uma lista de parâmetros delimitada por vírgulas encontrada no hash do URL que, se encontrados no URL, são adicionados à string
• de (opcional, string): o delimitador usado para dividir partes individuais da string. O padrão é uma barra vertical (|).

O método retorna uma string que contém uma versão amigável do URL. Normalmente, essa string é atribuída à variável pageName, mas também pode ser usada em outras variáveis.

Exemplos de chamadas

Exemplo #1

Se o URL atual fosse…

https://mail.google.com/mail/u/0/#inbox

… e o código a seguir for executado…

s.pageName = getPageName()

… o valor final de s.pageName será:

s.pageName = "mail.google.com|mail|u|0";

Exemplo #2

Se o URL atual fosse…

https://mail.google.com/mail/u/0/#inbox

… e o código a seguir for executado…

s.pageName = getPageName("gmail")

… o valor final de s.pageName será:

s.pageName = "gmail|mail|u|0";

Exemplo #3

Se o URL atual fosse…

https://www.google.com/

… e o código a seguir for executado…

s.pageName = getPageName()

… o valor final de s.pageName será:

s.pageName = "www.google.com|home"

Observação: quando o código é executado em um URL que não contém um caminho, ele sempre adicionará o valor de "home" ao final do valor de retorno

Exemplo #4

Se o URL atual fosse…

https://www.google.com/

… e o código a seguir for executado…

s.pageName = getPageName("google","","","|")

… o valor final de s.pageName será:

s.pageName = "google|home"

Exemplo #5

Se o URL atual fosse…

https://www.hotelrooms.com/en/booking/room-booking.html?cid=1235#/step2&arrive=2018-05-26&depart=2018-05-27&numGuests=2

… e o código a seguir for executado…

s.pageName = getPageName()

… o valor final de s.pageName será:

s.pageName = "www.hotelrooms.com|en|booking|room-booking.html"

No entanto, se, em vez disso, o código a seguir for executado…

s.pageName = getPageName("hotelrooms","cid","arrive,numGuests",": ")

… o valor final de s.pageName será:

s.pageName = "hotelrooms: en: booking: room-booking.html: cid=1235: arrive=2018-05-26: numGuests=2"

Melhorias em relação às versões anteriores

A versão 4.0+ do plug-in getPageName não depende da existência do objeto AppMeasurement do Adobe Analytics (ou seja, do objeto "s") para ser executado. Se você optar por atualizar para esta versão, altere o código que chama o plug-in removendo qualquer instância do objeto "s" da chamada.
Por exemplo, altere isso:

s.pageName = s.getPageName();

…para isto:

s.pageName = getPageName();

Histórico da versão

4.2 (19 de março de 2021)

• Adição do número da versão como dados de contexto.

4.1 (17 de setembro de 2019)

• Delimitador padrão alterado para um caractere de barra vertical (era dois pontos + espaço).

4.0 (22 de maio de 2018)

• Reanálise/reescrita completa do plug-in