Integração CPA

Documentação destinada à implementação das tags de tracking CPA.


Essa documentação é destinada para lojas que trabalharão com o modelo de comissionamento CPA.

Pré-requisitos
  • Definir um parâmetro na URL que identifica quando o usuário acessou a loja através da gente (Exemplo: utm_source=SocialSoul) e nos comunicar qual foi o parâmetro escolhido. Os parâmetros são necessários pois sempre que um afiliado escolher divulgar um link da campanha, ele vai gerar uma URL trackeada com os parâmetros informados.
  • Garantir/validar que seu sistema consegue identificar se a venda foi realizada através de uma divulgação nossa, respeitando o tempo de latência estabelecido em contrato. Lembrando que preferencialmente acessos orgânicos posteriores ao click também devem contabilizar como uma venda nossa.

Ao iniciar a implementação das TAG’s tenha em mãos o seu advertiserId (código de 4 digitos disponibilizado por nós), ele será necessário em cada etapa do processo.
Após a inserção das TAG’s o suporte técnico entrará em contato e iniciará o processo de homologação, serão necessários testes para validação da implementação e parâmetros. 
Caso as TAG’s, parâmetros e testes feitos estejam corretos, a loja será ativada. Caso contrário voltará para homologação com as considerações e possíveis correções. 

Se sua loja utiliza alguma das plataformas abaixo, clique no nome da plataforma para ver a documentação simplificada. Caso não tenha identificado a sua plataforma na listagem abaixo siga a documentação para implementação das TAG's.

 

TAG's

Basicamente você deverá inserir a TAG em todas as principais páginas de sua loja, independente da origem do tráfego, porém em cada página você deverá fornecer informações diferentes. Veja abaixo a estrutura básica que deverá ser inserida em sua loja:

<script type="text/javascript">
	var lomadee_datalayer = {dataLayer};
    
	var lomadeeTag = document.createElement('script');
	lomadeeTag.type = 'text/javascript';
	lomadeeTag.src = "//secure.lomadee.com/a/{advertiserId}.js";
	document.getElementsByTagName('body')[0].appendChild(lomadeeTag);
</script>
Nome Descrição
{dataLayer} Deverá ser preenchido de acordo com a página, conforme instruções a seguir, fora das chaves {}.
{advertiserId} Deverá ser substituido pelo ID da loja fornecido por nós, fora das chaves {}.

 

Página "Home": Ver exemplo

Na página inicial do seu e-commerce você deverá implementar o "lomadee_datalayer" de acordo com as instruções abaixo:

var lomadee_datalayer = {
	"page" : "home"
};

 

Página de "Produto": Ver exemplo

Nas páginas de produto da sua loja você deverá implementar o "lomadee_datalayer" de acordo com as instruções abaixo:

var lomadee_datalayer = {
	"page" : "product"
};

 

Página de "Categoria": Ver exemplo

Na página de categoria da sua loja você deverá implementar o "lomadee_datalayer" de acordo com as instruções abaixo:

var lomadee_datalayer = {
	"page" : "category"
};
 
Outras Páginas: Ver exemplo

Nas demais página de sua loja (exemplo, categoria ou páginas de campanhas especiais) você deverá implementar o "lomadee_datalayer" de acordo com as instruções abaixo:

var lomadee_datalayer = {
	"page" : "visit"
};

 

Página de "Conversão": Ver exemplo

Na página de conversão (venda realizada com sucesso) da sua loja você deverá implementar o "lomadee_datalayer" de acordo com as instruções abaixo:

var lomadee_datalayer = {
	"page" : "conversion",
	"conversion" : {
		"transactionId" : "",
		"amount" : 0.0,
		"discount" : 0.0,
		"currency" : "BRL",
		"paymentType" : "",
		"items" : [
			{
				"sku" : "",
				"name" : "",
				"category" : "",
				"price" : 0.0,
				"quantity" : 0
			}
		]
	}
};
Nome Descrição
conversion Objeto que contém os dados do pedido.
conversion.transactionId Objeto que contém os dados do pedido.
conversion.amount Preencha com o valor total do pedido.
conversion.discount (opcional) Preencha com o valor do desconto aplicado no pedido (exemplo: descontos aplicados a pagamento por boleto).
conversion.currency Preencha com o tipo da moeda (BRL para Real)
conversion.paymentType Preencha com a forma de pagamento utilizada:
  • cc (cartão de crédito)
  • cd (débito)
  • bl (boleto)
  • fp (outros)
.
conversion.items[] Preencha com a lista de items comprados pelo usuário.
conversion.items[].sku Preencha com o SKU do produto.
conversion.items[].name Preencha com o Nome do produto.
conversion.items[].category Preencha com a categoria do produto (De acordo com a listagem que deverá ser enviada para nós).
conversion.items[].price* Preencha com o preço unitário  pelo produto. (*IMPORTANTE: Preço final à ser pago pelo produto, já reduzidos os descontos)
conversion.items[].quantity Preencha com a quantidade do produto que foi comprada pelo usuário.