Advertiser Tracking Guide

From Wiki

Jump to: navigation, search

Deutsch . Español . Italiano . Nederlands . Polski . Português (Brasil) . Svenska .


Advertiser Tracking Guide

Introduction

Awin's tracking consists of five core elements, namely the Advertiser MasterTag, the Conversion Tag, the Server to Server (S2S) implementation, the Fall-back Conversion Pixel and finally Product Level Tracking which is optional:

Element Placement Description Dependency
Advertiser MasterTag also referred to as the Dwin1 Tag All pages* JavaScript library which contains all functions required for the tracking solution Mandatory
Conversion Tag also referred to as Tracking Code or Tracking Tag Confirmation page JavaScript declaration which instructs the Mastertag a conversion has taken place Mandatory
Server to Server (S2S) Server side Browser-independent tracking method Mandatory
Fall-back Conversion Pixel also referred to as Image Pixel Confirmation page Alternative tracking method Mandatory
Product Level Tracking Confirmation page Allows the advertiser to utilise reporting down to each individually purchased product Optional


"*" Please note that the MasterTag should be integrated on all pages except those which display or process payment information.

As tracking can be implemented very differently depending on the site and the campaign / programme type we have broken down the integration guide into individual parts, each with their own sub-page.

If you have any questions what so ever please get in touch with your account contact or assigned integrator.


[+] Standard Implementation

[+] Advertiser MasterTag

The MasterTag is a JavaScript library containing all functions required for our tracking solution and should be unconditionally appended to every page on the site, including the confirmation page, but excluding any page that displays or processes payment information. This should be done as late as possible, for example by placing the HTML script element just above the closing body tag and declaring it as defer="defer".


Template

https://www.dwin1.com/{{advertiserId}}.js


  • {{advertiserId}} must be replaced by the applicable Awin advertiser programme ID. Consult your account contact or assigned integrator if in any doubt


[+] Conversion Tag

The Conversion Tag, or Tracking Code as it also might be referred to, is the declaration of the AWIN.Tracking.Sale JavaScript object, which is done on the confirmation page to instruct the Mastertag that a conversion has taken place. It will then subsequently perform the necessary tracking requests.


Template

/*** Do not change ***/
var AWIN = {};
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 = "{{commissionGroup}}:{{totalAmount}}";
AWIN.Tracking.Sale.voucher = "{{voucher_code}}";
AWIN.Tracking.Sale.currency = "{{currency_code}}";
AWIN.Tracking.Sale.test = "{{isTest}}";


  • {{totalAmount}} must be replaced by the total transaction amount, in most cases excluding VAT (or other taxes), delivery and discounts. The value must be a float, no thousand separator is allowed and finally the decimal place has to be a standard dot character, for example: "1083.29"
    If the transaction type is a lead, then instead declare the number of leads, for example: "1"
  • {{channel}} should be replaced with the name of the channel that is deemed as last click referrer. "aw" should always be utilised for Awin. Please refer to separate information about the Channel Parameter for more guidance
  • {{orderReference}} must be replaced by the unique booking / order reference
  • {{parts}} should be populated with the commission group for the transaction followed by the sale amount. Example: NEW:20.00
  • {{commissionGroup}} should be populated with the commission group for the transaction. If no commission group is specified this dhould set to Default.
  • {{voucher_code}} should be populated with the voucher code used in the transaction. Example: 10%_OFF
  • {{currencyCode}} should be populated with the ISO currency code of the currency that was used in the transaction. Example: GBP
  • {{isTest}} should be populated with "0" when tracking is in live mode or alternatively "1" if in test mode. When set to the latter, the incoming tracking requests will not be processed


[+] Fall-back Conversion Pixel

It is mandatory to also display a Fall-back Conversion Pixel on conversion. This can be done via a HTML image element or by appending an image object to the DOM.


Template

https://www.awin1.com/sread.img?tt=ns&tv=2&merchant={{advertiserId}}&amount={{totalAmount}}&ch={{channel}}&parts={{commissionGroup}}:{{totalAmount}}&vc={{voucher_code}}&cr={{currencyCode}}&ref={{orderReference}}&testmode={{isTest}}


  • {{advertiserId}} must be replaced by the applicable Awin advertiser programme ID. Consult your account contact or assigned integrator if in any doubt
  • {{totalAmount}} must be replaced by the total transaction amount, in most cases excluding VAT (or other taxes), delivery and discounts. The value must be a float, no thousand separator is allowed and finally the decimal place has to be a standard dot character, for example: "1083.29"
    If the transaction type is a lead, then instead declare the number of leads, for example: "1"
  • {{channel}} should be replaced with the name of the channel that is deemed as last click referrer. "aw" should always be utilised for Awin. Please refer to separate information about the Channel Parameter for more guidance
  • {{parts}} should be populated with with the commission group for the transaction followed by the sale amount. Example: NEW:20.00
  • {{commissionGroup}} should be populated with the commission group for the transaction. If no commission group is specified this should set to Default.
  • {{voucher_code}} should be populated with the voucher code used in the transaction. Example: 10%_OFF
  • {{currencyCode}} should be populated with the ISO currency code of the currency that was used in the transaction. Example: GBP
  • {{orderReference}} must be replaced by the unique booking / order reference
  • {{isTest}} should be populated with "0" when tracking is in live mode or alternatively "1" if in test mode. When set to the latter, the incoming tracking requests will not be processed

[+] Cross Device Tracking

Awin's Cross Device Tracking solution allows advertisers to reward publishers for multi-device journey transactions. The ability to track cross-device will allow advertisers true understanding of how the performance channel drives customers, where previously anybody interacting with the channel across more than one device was instantly lost.

This solution now allows Awin to reward publishers for multi-device purchasing journeys, functionality that has been missing from the industry since users started to consume the internet on multiple devices.

For more informaiton on Cross Device Tracking and how this work, please view this page, here. With a standard implementation, you will be enabled for this functionality, if you'd like to opt-out of this feature, ensure you speak to your Awin technical contact.


[+] De-duplication

If you are working with multiple marketing channels and/or networks it is necessary to perform de-duplication so that commission is not paid out to several traffic sources for the same conversion.


[+] Channel Parameter

Awin strongly advise all clients to utilise the Channel Parameter to instruct our system how to process each conversion based on the source of the traffic.


[+] Example Implementations


[+] Commission Groups

Commission groups can be utilised to attribute the whole or parts of the transaction to a specific commission percentage or amount. The groups themselves are created and maintained within Commission Management in the Awin interface.


[+] New vs Existing

A very effective way of rewarding publishers for delivering new customers is to pay out a slightly higher commission for these transactions.


[+] Multiple Commission Groups

It is possible to split the transaction into parts which each gets assigned to a separate commission group. Do this by populating each part separated by a pipe ("|") character.


[+] Currency Conversion

If your site transacts in multiple currencies you can utilise Awin to perform the conversion from the foreign currency over to the base currency set for your advertiser programme [which are Pound Sterling (GBP) for United Kingdom, Euro (EUR) for Ireland, US Dollar (USD) for United States of America and finally Canadian Dollar (CAD) for Canadian programmes].


[+] Discount / Voucher Code Tracking

Awin's tracking supports reporting on whether or not a discount / voucher code was utilised by the customer during the check-out process.


[+] Custom Tracking Parameters

It is possible to declare other information and associate it with the transaction using custom tracking parameters, which later can be returned either via Validate Pending or bespoke reporting.


[+] Single Custom Tracking Parameter


[+] Multiple Custom Tracking Parameters


[+] Product Level Tracking

Product Level Tracking enables an advertiser to produce much more in-depth reporting where the performance of individual products easily can be measured.

From an implementation perspective, as long as you are already utilising the Mastertag, it is as simple as adding a hidden HTML form element to the confirmation page that contains individual rows in a specific format outlining which products are included in the order.


[-] PLT Via Conversion Pixel

As an alternative, if the implementation does not utilise JavaScript based tracking (refer to the topic Conversion Pixel Only Tracking), it is possible to declare Product Level Tracking within the pixel's URL request string.


[+] Conversion Pixel Only Tracking

Please note Awin no longer support the use of pixel ony implementations due to various broswer updates


[+] Server To Server (S2S)

We recommend you implement one of these two tracking methods - either batched offline tracking or S2S requests.


[+] Reference Snippets


[+] General Template


[+] Native HMTL Example


[+] Container Tag Example


Privacy

Due to new European legislation regarding how websites store information about you, AWIN is updating its privacy policy. You can see the new version of our policy here. If you would like to see the information we capture on this website, please click here for further details. In order to accept cookies on this site please click the 'I ACCEPT' button