Actionpay

Confira abaixo as instruções para integrar seu PrestaShop com a rede de afiliados Actionpay através do Google Tag Manager.

Verificado os dados necessários para a configuração

Antes de começar a integração tenha certeza que você tem:

• PARTNER_ID e ID DA META – eles são obtidos com o gerente de contas do Actionpay;

• Link para sua campanha – ele é obtido com o gerente de contas do Actionpay;

• Marcas Analíticas UTM e Informações sobre as ações alvo – esses dados obtidos com o responsável pela conta por parte do anunciante (você) ou no apêndix do contrato;

• Janela de Comissão (Post-Click Period) – esses dados são obtidos com o responsável pela conta (contrato);

• Informações sobre como é realizada o rastreamento sobre a última fonte de tráfego pago (ultimo cookie vence).

Configurando a TAG da Actionpay

A configuração consiste em três partes e é aceitável para a maioria das campanhas. Contudo as campanhas podem ter peculiaridades individuais ou técnicas e específicas, que demandem customizações.

Caso não seja possível utilizar o procedimento padrão outras alternativas de integração são possíveis, entre em contato com a nossa equipe para verificar essas alternativas.

A integração padrão consiste em três etapas principais:

• Processar a transição entre a rede da Actionpay e sua loja virtual em PrestaShop (anunciante);

• Notificação da rede da Actionpay sobre a ação executada (pixel);

• Notificação da rede da Actionpay sobre a mudança do status da ação previamente executada (opcional) – Executada fora do GTM. Cada parte é descrita em detalhe daqui por diante.

Cada uma das etapas descritas acima serão detalhadas abaixo.

1. Processando a transição da rede Actionpay na loja virtual

Para identificar que a transação foi feita através da rede da Actionpay ao invés de uma outra fonte. Existem duas formas alternativas para identificação: a forma completa e a compacta. Fica a critério do anunciante decidir quais das duas formas utilizar, depois é necessário informar ao gerente de contas, ou gerente de integração, a decisão para que seja feita a configuração no sistema.

Links desse tipo serão utilizados para as suas campanhas por nossos afiliados:

https://www.dominio.com/click/53b29c288b30a8c0598b458b/81092/67345/

O usuário que seguir esse link, verá, por exemplo, na barra de endereço do browser o URL a seguir, no formato completo:

https://www.dominio.com/?actionpay=27606ca9-b7ee-c96f-ef18-01493ec212cf.67345&utm_source=actionpay

Essas variáveis são:

• utm_source: origem do tráfego;

• actionpay: identificador da fonte de origem da transação.

Os identificadores da fonte de origem da transação, que são indicados no exemplo como “0”, são representados por sequências alfanuméricas. A extensão máxima é de 50 caracteres.

É possível adicionar diversos parâmetros UTM para o seu monitoramento e rastreamento interno. Favor informar a equipe de integração quais parâmetros devem ser adicionados.

Por exemplo: utm_source=actionpay&utm_medium=cpa&utm_campaign=actionpay

1.1. Adicionar os parâmetros URL nos Cookies

É necessário armazenar os valores dos parâmetros GET nos cookies dos usuários para ser possível identificar o usuário quando retornar e também para o correto funcionamento do rastreamento.

O tempo de vida do acesso ao “cookie” deve corresponder ao período do “Post-Click” ou janela de comissão da campanha, valor especificado no anexo ao contrato (por exemplo, se a janela de comissão for igual a 30 dias, o cookie será ativo até o momento que é uma soma da data da transação somado de 30 dias).

A rede da Actionpay irá testar automaticamente o ajuste correto dos cookies (nome correto, significado e validade) periodicamente. Junto com o cookie, a loja virtual anunciante pode salvar os parâmetros recebidos durante a transição da rede da Actionpay com seus sistemas internos (base de dados, perfil do usuário e outros). Entretanto, o ajuste do cookie é fundamental.

Existem algumas formas de configurar um cookie no Google Tag Manager. O Exemplo abaixo é apenas uma sugestão. Neste exemplo estamos utilizando o link compacto, caso deseje utilizar o completo, não esqueça de informar a equipe da Actionpay responsável pela integração para alterar o link.

A próxima etapa é criar uma TAG HTML personalizada para criar o cookie actionpay, para identificarmos quando o tráfego vier dos afiliados da Actionpay. Acesse o Google Tag Manager:

1. Vá em TAG e selecione uma NOVA;

2. Dê um nome para a TAG, por exemplo: tag_actionpay;

3. Escolha o tipo de TAG: HTML personalizado;

4. No HTML, cole o seguinte código javascript:

<script language="JavaScript" type="text/javascript">
	var sourcevar = getQueryVariable("utm_source");
	var apclickvar = getQueryVariable("actionpay");
	var postclick = 30;         // alterar pelo número de dias de sua janela de comissão
	var domain = "dominio.com"; // alterar pelo seu domínio, sem o www.
	var partnerId = "12345";    // alterar pelo seu partnerId, obtido com seu gerente de contas da Actionpay

	function getQueryVariable(variable) {
		var query = window.location.search.substring(1);
		var vars = query.split("&");
		for (var i = 0; i < vars.length; i++) {
			var pair = vars[i].split("=");
			if (pair[0] == variable) {
				return pair[1];
			}
		}
	}

	function setCookie(cname, cvalue, exdays) {
		var d = new Date();
		d.setTime(d.getTime() + (exdays * 24 * 60 * 60 * 1000));
		var expires = "expires=" + d.toUTCString();
		document.cookie = cname + "=" + cvalue + "; path=/;" + expires + "; domain=" +domain;
		return cookieap;
	}

	if (sourcevar == "actionpay") {
		var cookieap = setCookie("Actionpay", apclickvar, postclick);
		var cookieap = setCookie("Origem", "actionpay", postclick);
	} else if (sourcevar != undefined) {
		var cookieap = setCookie("Origem", sourcevar, postclick);;
	}

	(function() {
		var s = document.createElement('script');
		s.type = 'text/javascript';
		s.async = s.defer = true;
		s.src = '//aprtn.com/code/' + partnerId + '/';
		var p = document.getElementsByTagName('body')[0] ||
		document.getElementsByTagName('head')[0];
		if (p) p.appendChild(s);
	})();
</script>

Você precisa obter o PARTER_ID com o seu gerente de contas e lembre-se de alterar o domínio "dominio.com.br" pelo seu domínio sem o www. Ou seja, se o seu site é “www.exemplo.com.br” o domínio será “exemplo.com.br”.

Você deve alterar o valor do POSTCLICK marcados de 30, para o número de dias da sua janela de comissão, (período de postclick), esse valor está definido no contrato com a Actionpay.

O código JavaScript acima irá criar esses dois cookies diferentes:

• Cookie Actionpay=0000-0000-0000-0000.0000000;

• Cookie Origem=actionpay.

Além de realizar uma verificação no tráfego evitando fraudes e otimizando as campanhas da Actionpay.

1. Marque Suporte para document.write;

2. Escolha o acionador para disparar essa tag.

A próxima etapa é definir uma regra de acionamento da TAG dentro da "tag_actionpay" recém-criada.

Selecione todas as páginas (All Pages), uma regra que já vem pré-configurada no TAG Manager.

1.2. Gerenciamento da última fonte paga

O segundo cookie criado (Origem) é quem permite rastrear a última fonte paga. Caso você utilize outro cookie para gerenciar isso é só alterar no código a palavra Origem para o nome do cookie utilizado, alterando também o valor “actionpay” pelo código que representa a nossa rede. Se já tem outra Tag para gerenciar o último clique, você pode ignorar essa etapa.

1.3. Testando os cookies criados

Com a TAG criada com suas respectivas regras e variáveis, publique o contêiner para realizar o teste. Utilizando o navegador Google Chrome, entre em Visualizar e selecione Visualizar e depurar como mostra na figura 4.

Esse comando irá simular a TAG dentro do seu site. Acesse o seu site, abaixo vai abrir o depurador do tagmanager. A TAG tag_actionpay deve ser disparada, em todas as páginas. Caso não tenha sido disparada verifique as regras de disparo da TAG.

Depois, na mesma janela criada pelo comando depurar, copie e cole o link gerado pelo seu gerente de contas. O link deve ser similar ao link abaixo, direcionado para o seu site. Verifique se a TAG foi disparada.

Exemplo: https://www.dominio.com/click/54501e6b8b30b837748b4567/00000/70505/subaccount (esse link exemplo não funciona!!)

Selecione o modo de desenvolvimento do Chrome (f12) no campo Application / Cookies / (seu site)

Vá em Application/(seu domínio) e verifique se o cookie Actionpay foi criado corretamente, copiando os dados do apclick e apsource para o cookie. Além disso verifique se o cookie Origem é igual a “Actionpay”. Ambos os cookies devem expirar conforme definido na Janela de Comissão da Campanha.

2. Notificação sobre a execução da ação (pixel)

O Tracking-pixel, ou pixel de rastreamento, (daqui por diante somente “pixel”) é usado para informar a rede da Actionpay sobre a ação executada no Site do anunciante. Em outras palavras, no momento em que a ação está sendo executada; um código que carrega uma imagem transparente no tamanho de 1x1 pixel do servidor do Actionpay será substituído no código mostrado ao usuário da página.

Esta imagem não é mostrada ao usuário mas serve como uma forma de solicitar que o servidor do Actionpay guarde os parâmetros da ação. Existem outras formas de integração que podem ser usadas caso a instalação do pixel não seja viável para saber mais favor entrar em contato com a nossa equipe de suporte. Veja nossos contatos no item 2 desse manual.

O código pixel com a transmissão dos parâmetros, é similar a:

<img src="https://apretailer.com.br/ok/0000.png?actionpay={{cookie_actionpay}}&apid={{ID_Transacao}}&price={{Valor_Transacao}}&width=1&height=1" width= "1" height= "1"/>

Onde:

• 0000 – É o identificador da ação na rede da Actionpay (Id da Meta);

• actionpay= 0000-0000-0000-0000.0000000 é o identificador da transição;

• apid=NNNN Se existir um identificador único atribuído a cada ação executada no lado do anunciante, este identificador deve ser transmitido ao pixel com a ajuda do parâmetro “apid”.

O identificador único pode ser, por exemplo:

• Número de ordem;

• Número de pedido;

• Identificador do usuário;

• Número do pagamento;

• Identificador da ação criada no sistema do anunciante;

• Etc.

Qualquer a sequência de símbolos alfanumérica com marcas de pontuação, mas sem espaços pode ser um identificador.

Um identificador é importante para que as ações sejam comparadas futuramente e nomedas como aprovadas ou canceladas.

price= 000.0000 - Se alguma quantia de dinheiro for atribuída a cada ação executada no lado do anunciante, esta quantia deve ser transmitida ao pixel com a ajuda do parâmetro “apprice”.

Esta quantidade pode ser, por exemplo:

• Uma quantia de ordem/compra;

• Uma quantia de pagamento;

• Uma quantia de reabastecimento (recarga);

• Etc.

Neste caso, a unidade da quantia trocada pode ser em qualquer moeda incluindo moeda virtual (por exemplo, paypal).

Em um número com parte fracionária, o símbolo decimal deve ser um ponto. (Modelo americano). A quantidade máxima de caracteres depois do ponto é 4.

Caso não exista um VALOR atribuído a ação, como no exemplo de um cadastro, esse parâmetro pode ser excluído do pixel.

É importante que o pixel só seja chamado quando a ação tiver origem da Actionpay por isso o controle do último clique é fundamental. Caso seja impossível o rastreamento do último clique é possível trabalhar sem, contudo, sua oferta vai ficar pior classificada perante os afiliados devido a taxa de rejeição das ações.