Advertiser Tracking Guide PT/Standard Implementation
From Wiki
[-] Guia de tracking de anunciantes
[-] Integração Padrão
[-] Journey Tag / MasterTag
A Journey Tag, ou MasterTag como chamamos na Awin, é uma biblioteca JavaScript que contém todas as funções necessárias para a nossa solução de tracking e deve ser incondicionalmente integrada em todas as páginas do site, incluindo a página de confirmação, e excluindo as páginas que exibam ou processem as informações de pagamento. Deve ser feito o mais tarde possível, por exemplo, colocando o elemento script HTML logo acima do fechamento da tag body declarando a mesma como defer="defer"
.
Uma das funcionalidades é de criar um first party tracking cookie no domínio do anunciante e este identificador será concatenado na URL de destino utilizando um parâmetro denominado awc
, por exemplo awc=1001_1403695822_a430d81e22c9e8687f423efcf024fbaa
. Portanto, é essencial que você encaminhe esse parâmetro e os valores contidos no redirecionamento ou qualquer outra alteração da a URL.
Modelo
https://www.dwin1.com/{{advertiserId}}.js
-
{{advertiserId}}
deve ser substituído pelo ID do programa. Consulte o gerente da sua conta ou o responsável designado em caso de dúvida.
Exemplo #1 - HTML script element
<script defer="defer" src="https://www.dwin1.com/1001.js" type="text/javascript"></script>
Exemplo #2 - JavaScript append
var awMastertag = document.createElement("script"); awMastertag.setAttribute("defer", "defer"); awMastertag.src = "https://www.dwin1.com/1001.js"; awMastertag.type = "text/javascript"; document.getElementsByTagName("body")[0].appendChild(awMastertag);
[-] Tag de conversão
A Tag de Conversão, ou Código de Tracking como também é conhecido, é a declaração do AWIN.Tracking.Sale
JavaScript object, que é integrado na página de confirmação para chamar a MasterTag que foi gerada uma conversão. A MasterTag posteriormente analisará as informações preenchidas no AWIN.Tracking.Sale object, gerará um conjunto de tracking request, que serão enviadas ao sistema da AWIN.
A declaração deve ser feita antes do carregamento da MasterTag. Num escenario aonde AJAX (ou similar) seja utilizado para o carregamento da confirmação do pedido, referir-se ao exemplo #2 como uma re-declaração do objeto |
Modelo
/*** Do not change ***/ var AWIN = AWIN || {}; AWIN.Tracking = AWIN.Tracking || {}; AWIN.Tracking.Sale = {}; /*** Set your transaction parameters ***/ AWIN.Tracking.Sale.amount = "{{totalAmount}}"; AWIN.Tracking.Sale.channel = "{{channel}}"; AWIN.Tracking.Sale.orderRef = "{{orderReference}}"; AWIN.Tracking.Sale.parts = "{{commissionGroupCode}}:{{totalAmount}}"; AWIN.Tracking.Sale.currency = "{{currencyCode}}"; AWIN.Tracking.Sale.voucher = "{{voucherCode}}"; AWIN.Tracking.Sale.test = "{{isTest}}";
-
{{totalAmount}}
deve ser substituído pelo valor total da transação - sem considerar o valor do frete, mas considerar descontos. O valor deve ser um númeral, sem separador de milhar e por padrão a casa decimal deve ser separada usando ponto, por exemplo: "1083.29
"
Se o tipo de transação for um lead, declare o número de leads, por exemplo: "1
" -
{{commissionGroupCode}}
deve ser substituido pelo Código do Grupo de Comissão ao que deve ser atribuida a transação. Caso não existan Grupos de Comissão deve colocar "Default". Os caracteres aceitos para o código commissionGroup são alfanuméricos (letra maiúscula), sublinhado '_', ponto '.' e menos '-' -
{{channel}}
deve ser substituído pelo nome do canal que foi considerado como último clique."aw
"deve ser sempre utilizado para Awin. Por favor, consulte a informação separada sobre o Channel Parameter para mais informações. -
{{orderReference}}
deve ser substituido pelo ID único de pedido / reserva -
{{currencyCode}}
se o site tiver múltiplas moedas, esse parâmetro deve ser preenchido com o código da moeda da transação específica, caso os clientes puderem fazer transações apenas em BRL, encaminhar BRL. -
{{voucherCode}}
se um cupom de desconto for utilizado em uma transação, o código dele deve ser preenchido dentro deste parâmetro; se não teve uso de cupom, deixar vazio. -
{{isTest}}
deve ser preenchido com "0
" quando o tracking estiver LIVE, ou com "1
" caso esteja em modo de teste. Quando definido para o último, os pedidos de teste recebidos não serão processados.
Exemplo #1 - Declaração da conversão prévia a chamada da MasterTag
<script type="text/javascript"> /*** Do not change ***/ var AWIN = AWIN || {}; AWIN.Tracking = AWIN.Tracking || {}; AWIN.Tracking.Sale = {}; /*** Set your transaction parameters ***/ AWIN.Tracking.Sale.amount = "8.33"; AWIN.Tracking.Sale.channel = "aw"; AWIN.Tracking.Sale.orderRef = "AA000001"; AWIN.Tracking.Sale.parts = "DEFAULT:8.33"; AWIN.Tracking.Sale.currency = "GBP"; AWIN.Tracking.Sale.voucher = "10OFF"; AWIN.Tracking.Sale.test = "0"; </script>
Exemplo #2 - Acionar conversão apos chamada da MasterTag
if (typeof AWIN != "undefined" && typeof AWIN.Tracking != "undefined") { AWIN.Tracking.Sale = {}; AWIN.Tracking.Sale.amount = parseFloat(fTotalAmount).toFixed(2); AWIN.Tracking.Sale.channel = sChannel; AWIN.Tracking.Sale.orderRef = sOrderReference; AWIN.Tracking.Sale.parts = "DEFAULT:" + parseFloat(fTotalAmount).toFixed(2); AWIN.Tracking.Sale.currency = sCurrency; AWIN.Tracking.Sale.voucher = sVoucherCode; AWIN.Tracking.Sale.test = "0"; AWIN.Tracking.run(); }
Exemplos de chamada
Se a Tag de conversão é a MasterTag foram integrados corretamente, o tracking request será similar ao seguinte:
https://www.awin1.com/sread.php?a=1001&b=8.33&cr=GBP&c=AA000001&d=DEFAULT:8.33&vc=&t=0&ch=aw&cks=1001_1403695822_a430d81e22c9e8687f423efcf024fbaa&l=https%3A//advertiser-domain.com/confirmation.php&tv=2&tt=ia https://www.awin1.com/sread.js?a=1001&b=8.33&cr=GBP&c=AA000001&d=DEFAULT:8.33&vc=&t=0&ch=aw&cks=1001_1403695822_a430d81e22c9e8687f423efcf024fbaa&l=https%3A//advertiser-domain.com/confirmation.php&tv=2&tt=js https://www.awin1.com/sread.php?a=1001&b=8.33&cr=GBP&c=AA000001&d=DEFAULT%3A8.33&vc=&t=0&cks=1001_1403695822_a430d81e22c9e8687f423efcf024fbaa&atp=&tv=2&tt=et&l=https%3A%2F%2Fwww.advertiser-domain.com%2Fconfirmation.php&ch=aw https://www.awin1.com/alt.php?mid=1001&gv=1&a=1001&b=8.33&cr=EUR&c=AA000001&d=DEFAULT:8.33&vc=&t=0&ch=aw&l=https%3A//www.advertiser-domain.com%2Fconfirmation.php https://www.awin1.com/m/1001.gif
Dependendo das configurações do seu programa, pode ver chamadas de tracking sendo encaminhadas ao nosso dominio alternativo de tracking |
[-] Fall-back Conversion Pixel
É Altamente Recomendado também chamar ao Fall-back Conversion Pixel na conversão. Pode ser feito via imagem HTML anexando um objeto imagem ao DOM.
Template
https://www.awin1.com/sread.img?tt=ns&tv=2&merchant={{advertiserId}}&amount={{totalAmount}}&ch={{channel}}&parts={{commissionGroupCode}}:{{totalAmount}}&ref={{orderReference}}&cr={{currencyCode}}&vc={{voucherCode}}&testmode={{isTest}}
-
{{advertiserId}}
deve ser substituído pelo ID do programa. Consulte o gerente da sua conta ou o responsável designado em caso de dúvida. -
{{totalAmount}}
deve ser substituído pelo valor total da transação - sem considerar o valor do frete, descontos, ou em determinados casos impostos. O valor deve ser um númeral, sem separador de milhar e por padrão a casa decimal deve ser separada usando ponto, por exemplo: "1083.29
"
Se o tipo de transação for um lead, declare o número de leads, por exemplo: "1
" -
{{commissionGroupCode}}
deve ser substituido pelo Código do Grupo de Comissão ao que deve ser atribuida a transação. Caso não existan Grupos de Comissão deve colocar Default. Os caracteres aceitos para o código commissionGroup são alfanuméricos (letra maiúscula), sublinhado '_', ponto '.' e menos '-' -
{{channel}}
deve ser substituído pelo nome do canal que foi considerado como último clique."aw
"deve ser sempre utilizado para Awin. Por favor, consulte a informação separada sobre o Channel Parameter para mais informações. -
{{orderReference}}
deve ser substituido pelo ID único de pedido / reserva -
{{currencyCode}}
se o site tiver múltiplas moedas, esse parâmetro deve ser preenchido com o código da moeda da transação específica, caso os clientes puderem fazer transações apenas em BRL, encaminhar BRL. -
{{voucherCode}}
se um cupom de desconto for utilizado em uma transação, o código dele deve ser preenchido dentro deste parâmetro; se não teve uso de cupom, deixar vazio. -
{{isTest}}
deve ser preenchido com "0
" quando o tracking estiver LIVE, ou com "1
" caso esteja em modo de teste. Quando definido para o último, os pedidos de teste recebidos não serão processados.
Exemplo #1 - HTML image element
<img border="0" height="0" src="https://www.awin1.com/sread.img?tt=ns&tv=2&merchant=1001&amount=8.33&ch=aw&parts=DEFAULT:8.33&ref=AA000001&cr=GBP&vc=10OFF&testmode=0" style="display: none;" width="0">
Exemplo #2 - JavaScript image object
var awPixel = new Image(0, 0) awPixel.src = "https://www.awin1.com/sread.img?tt=ns&tv=2&merchant=1001&amount=" + parseFloat(fTotalAmount).toFixed(2) + "&ch=" + sChannel + "&parts=DEFAULT:" + parseFloat(fTotalAmount).toFixed(2) + "&ref=" + sOrderReference + "&vc=" + sVoucherCode + "&cr=" + sCurrencyCode + "&testmode=0";