Plug-in da Adobe: addProductEvar

O plug-in addProductEvar permite adicionar facilmente uma eVar de merchandising do Adobe Analytics que usa a sintaxe do produto na variável products sem se preocupar se o conteúdo já existente da variável products será alterado/movido/excluído. A Adobe recomenda usar esse plug-in se você quiser adicionar com facilidade eVars de merchandising com sintaxe de produto à variável products. Você não precisa usar o plug-in addProductEvar se não usar eVars de merchandising com sintaxe de produto.

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 addProductEvar
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: addProductEvar v1.0 */
s.addProductEvar=function(en,ev,ap){if("string"===typeof en&&"string"===typeof ev&&""!==ev)if(ap=ap||!1,this.products){var e=this.products.split(","),f=e.length;ap=ap?0:f-1;for(var a;ap<f;ap++)a=e[ap].split(";"),a[5]&&-1<a[5].toLowerCase().indexOf("evar")?a[5]=a[5]+"|"+en+"="+ev:a[5]?a[5]=en+"="+ev:a[5]||(a[4]||(a[4]=""),a[3]||(a[3]=""),a[2]||(a[2]=""),a[1]||(a[1]=""),a[5]=en+"="+ev),e[ap]=a.join(";");this.products=e.join(",")}else this.products=";;;;;"+en+"="+ev};
/******************************************** END CODE TO DEPLOY ********************************************/

Usar o plug-in

O plug-in addProductEvar aceita os seguintes argumentos:

• en (obrigatório, string): eVar usada para adicionar à última entrada atualmente contida na variável products. Se a variável products estiver em branco, o plug-in criará uma entrada de produto "em branco" com o valor da eVar anexado ao final da entrada.
• ev (obrigatório, string): o valor atribuído à eVar.
• ap (opcional, booleano): se a variável products contiver mais de uma entrada de produto no momento, um valor true (ou 1) fará a eVar ser adicionada a todas as entradas de produto. O padrão é false (ou 0), o que faz a eVar ser adicionada somente à última entrada contida na variável products.

O plug-in addProductEvar não retorna nada. Em vez disso, ele adiciona a eVar (e o valor da eVar) especificada nos argumentos en e ev à variável products.

Exemplos

// Set a merchandising eVar to blue on the last product. The output for the products variable is ";product1;3;300,;product2;2;122,;product3;1;25;;eVar1=blue"
s.products=";product1;3;300,;product2;2;122,;product3;1;25";
s.addProductEvar("eVar1", "blue");

// Set a merchandising eVar to blue on all products. The output for the products variable is ";product1;3;300;;eVar1=blue,;product2;2;122;;eVar1=blue,;product3;1;25;;eVar1=blue"
s.products=";product1;3;300,;product2;2;122,;product3;1;25";
s.addProductEvar("eVar1", "blue", true);

// Set multiple merchandising eVars to the last product in the string. The output for the products variable is ";product1;3;300;event2=10;eVar23=large|eVar24=men|eVar1=blue,;product2;2;122,;product3;1;25;;eVar23=medium|eVar24=women|eVar1=red"
s.products=";product1;3;300;event2=10;eVar23=large|eVar24=men|eVar1=blue,;product2;2;122,;product3;1;25";
s.addProductEvar("eVar23", "medium");
s.addProductEvar("eVar24", "women");
s.addProductEvar("eVar1", "red");

// Set multiple merchandising eVars to all products in the string. The output for the products variable is ";product1;3;300;event2=10;eVar23=large|eVar24=men|eVar1=blue|eVar23=medium|eVar24=women|eVar1=red,;product2;2;122;;eVar23=medium|eVar24=women|eVar1=red,;product3;1;25;;eVar23=medium|eVar24=women|eVar1=red"
s.products=";product1;3;300;event2=10;eVar23=large|eVar24=men|eVar1=blue,;product2;2;122,;product3;1;25";
s.addProductEvar("eVar23", "medium", true);
s.addProductEvar("eVar24", "women", true);
s.addProductEvar("eVar1", "red", true);

// If the products variable is not set, the plug-in creates an empty product string correctly delimited to the merchandising eVar. The output for the products variable is ";;;;;eVar1=blue"
s.addProductEvar("eVar1", "blue");

Histórico da versão

1.0 (7 de outubro, 2019)

• Versão inicial.