Advertiser Tracking Guide

From Wiki

(Difference between revisions)
Jump to: navigation, search
Alex Searle (Talk | contribs)
m (Text edit per Nic Humphry's request)
Alex Searle (Talk | contribs)
(Moved tracking content into separate page at request of Jackson.)
Line 16: Line 16:
Please see our [https://www.youtube.com/channel/UCOmjtRJ45SxTA9gVAVHsZ8g YouTube Channel] for all How To videos on implementing Awin tracking and how to implement Awin tracking on some of the most popular ecommerce platforms.
Please see our [https://www.youtube.com/channel/UCOmjtRJ45SxTA9gVAVHsZ8g YouTube Channel] for all How To videos on implementing Awin tracking and how to implement Awin tracking on some of the most popular ecommerce platforms.
-
== Introduction ==
+
== [[Advertiser_Tracking_Guides|Advertiser Tracking Guides]] ==
-
Awin's tracking consists of five core elements, namely the '''[[#Journey_Tag_.2F_Mastertag|Advertiser MasterTag]]''', the '''[[#Conversion_Tag|Conversion Tag]]''', the '''[[#Server_To_Server_.28S2S.29|Server to Server (S2S)]]''' implementation, the '''[[#Fall-back_Conversion_Pixel|Fall-back Conversion Pixel]]''' and finally '''[[#Product_Level_Tracking|Product Level Tracking]]''' which is optional:
+
Please see full details of tracking instructions and features by following the link.
-
 
+
-
<table cellpadding="3" cellspacing="2" border="1">
+
-
<tr>
+
-
<td>'''Element'''
+
-
</td>
+
-
<td>'''Placement'''
+
-
</td>
+
-
<td>'''Description'''
+
-
</td>
+
-
<td>'''Dependency'''
+
-
</td>
+
-
</tr>
+
-
<tr>
+
-
<td>'''[[#Journey_Tag_.2F_Mastertag|Advertiser MasterTag]]''' ''also referred to as the '''Dwin1 Tag'''''
+
-
</td>
+
-
<td>All pages*
+
-
</td>
+
-
<td>JavaScript library which contains all functions required for the tracking solution
+
-
</td>
+
-
<td>'''<u>Mandatory</u>'''
+
-
</td>
+
-
</tr>
+
-
<tr>
+
-
<td>'''[[#Conversion_Tag|Conversion Tag]]''' ''also referred to as '''Tracking Code''' or '''Tracking Tag'''''
+
-
</td>
+
-
<td>Confirmation page
+
-
</td>
+
-
<td>JavaScript declaration which instructs the MasterTag a conversion has taken place
+
-
</td>
+
-
<td>'''<u>Mandatory</u>'''
+
-
</td>
+
-
</tr>
+
-
<tr>
+
-
<td>'''[[#Server_To_Server_.28S2S.29|Server to Server (S2S)]]'''
+
-
</td>
+
-
<td>Server side
+
-
</td>
+
-
<td>Browser-independent tracking method
+
-
</td>
+
-
<td>'''<u>Mandatory</u>'''
+
-
</td>
+
-
</tr>
+
-
<tr>
+
-
<td>'''[[#Fall-back_Conversion_Pixel|Fall-back Conversion Pixel]]''' ''also referred to as '''Image Pixel'''''
+
-
</td>
+
-
<td>Confirmation page
+
-
</td>
+
-
<td>Alternative tracking method
+
-
</td>
+
-
<td>'''<u>Mandatory</u>'''
+
-
</td>
+
-
</tr>
+
-
<tr>
+
-
<td>'''[[#Product_Level_Tracking|Product Level Tracking]]'''
+
-
</td>
+
-
<td>Confirmation page
+
-
</td>
+
-
<td>Allows the advertiser to utilise reporting down to each individually purchased product
+
-
</td>
+
-
<td>Optional
+
-
</td>
+
-
</tr>
+
-
</table>
+
-
<br>
+
-
"'''*'''" ''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.
+
-
 
+
-
 
+
-
== <span id="Standard_Implementation"></span>[[Advertiser_Tracking_Guide/Standard_Implementation|[+] Standard Implementation]] ==
+
-
 
+
-
 
+
-
=== <span id="Journey_Tag_.2F_Mastertag"></span>[[Advertiser_Tracking_Guide/Standard_Implementation#Journey_Tag_.2F_Mastertag|[+] Advertiser MasterTag]] ===
+
-
 
+
-
The '''MasterTag''' is a JavaScript library containing all functions required for our tracking solution and should be '''<u>unconditionally</u>''' appended to '''<u>every page</u>''' 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 <code>defer="defer"</code>.
+
-
 
+
-
 
+
-
'''Template'''
+
-
 
+
-
<div style="overflow: auto; padding: 4px .2em; word-spacing: 4px; border: 1px dashed #2F6FAB; background:#F9F9F9"><source lang="text">
+
-
https://www.dwin1.com/{{advertiserId}}.js
+
-
</source></div>
+
-
 
+
-
 
+
-
<ul>
+
-
<li> <code><nowiki>{{advertiserId}}</nowiki></code> must be replaced by the applicable Awin advertiser programme ID. Consult your account contact or assigned integrator if in any doubt</li>
+
-
</ul>
+
-
 
+
-
 
+
-
=== <span id="Conversion_Tag"></span>[[Advertiser_Tracking_Guide/Standard_Implementation#Conversion_Tag|[+] Conversion Tag]] ===
+
-
 
+
-
The '''Conversion Tag''', or '''Tracking Code''' as it also might be referred to, is the declaration of the <code>AWIN.Tracking.Sale</code> JavaScript object, which is done on the confirmation page to instruct the '''[[#Journey_Tag_.2F_Mastertag|MasterTag]]''' that a conversion has taken place. It will then subsequently perform the necessary tracking requests.
+
-
 
+
-
 
+
-
'''Template'''
+
-
 
+
-
<div style="overflow: auto; padding: 4px .2em; word-spacing: 4px; border: 1px dashed #2F6FAB; background:#F9F9F9"><source lang="text">
+
-
/*** 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 = "{{commissionGroupCode}}:{{totalAmount}}";
+
-
AWIN.Tracking.Sale.voucher = "{{voucherCode}}";
+
-
AWIN.Tracking.Sale.currency = "{{currencyCode}}";
+
-
AWIN.Tracking.Sale.test = "{{isTest}}";
+
-
</source></div>
+
-
 
+
-
 
+
-
<ul>
+
-
<li> <code><nowiki>{{totalAmount}}</nowiki></code> must be replaced by the order subtotal amount - after any relevant discounts are applied but prior to any additional fees such as taxes, delivery charges, or relevant service charges are added. 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: "<code>1083.29</code>"<br>If the transaction type is a lead, then instead declare the number of leads, for example: "<code>1</code>"</li>
+
-
<li> <code><nowiki>{{channel}}</nowiki></code> should be replaced with the name of the channel that is deemed as last click referrer. "<code>aw</code>" should always be utilised for Awin. Please refer to separate information about the [[Advertiser_Tracking_Guide/De-duplication#Channel_Parameter|Channel Parameter]] for more guidance</li>
+
-
<li> <code><nowiki>{{orderReference}}</nowiki></code> must be replaced by the unique booking / order reference</li>
+
-
<li> <code><nowiki>{{commissionGroupCode}}</nowiki></code> should be replaced by the code for the commission group you want to attribute the transaction to. If no commission group is specified this should be set to Default. Accepted characters for the commissionGroup code are alphanumerics (letter in upper case), underscore '_' , point '.' and minus '-'</li>
+
-
<li> <code><nowiki>{{voucherCode}}</nowiki></code> should be populated with the voucher code used in the transaction. Example: 10_OFF. The parameter value has to be URL-encoded.  </li>
+
-
<li> <code><nowiki>{{currencyCode}}</nowiki></code> should be populated with the ISO currency code of the currency that was used in the transaction. Example: GBP </li>
+
-
<li> <code><nowiki>{{isTest}}</nowiki></code> should be populated with "<code>0</code>" when tracking is in live mode or alternatively "<code>1</code>" if in test mode. When set to the latter, the incoming tracking requests will not be processed</li>
+
-
</ul>
+
-
 
+
-
 
+
-
=== <span id="Fall-back_Conversion_Pixel"></span>[[Advertiser_Tracking_Guide/Standard_Implementation#Fall-back_Conversion_Pixel|[+] Fall-back Conversion Pixel]] ===
+
-
 
+
-
It is '''<u>mandatory</u>''' 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'''
+
-
 
+
-
<div style="overflow: auto; padding: 4px .2em; word-spacing: 4px; border: 1px dashed #2F6FAB; background:#F9F9F9"><source lang="text">
+
-
https://www.awin1.com/sread.img?tt=ns&tv=2&merchant={{advertiserId}}&amount={{totalAmount}}&ch={{channel}}&parts={{commissionGroupCode}}:{{totalAmount}}&vc={{voucherCode}}&cr={{currencyCode}}&ref={{orderReference}}&testmode={{isTest}}
+
-
</source></div>
+
-
 
+
-
 
+
-
<ul>
+
-
<li> <code><nowiki>{{advertiserId}}</nowiki></code> must be replaced by the applicable Awin advertiser programme ID. Consult your account contact or assigned integrator if in any doubt</li>
+
-
<li> <code><nowiki>{{totalAmount}}</nowiki></code> must be replaced by the order subtotal amount - after any relevant discounts are applied but prior to any additional fees such as taxes, delivery charges, or relevant service charges are added. 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: "<code>1083.29</code>"<br>If the transaction type is a lead, then instead declare the number of leads, for example: "<code>1</code>"</li>
+
-
<li> <code><nowiki>{{channel}}</nowiki></code> should be replaced with the name of the channel that is deemed as last click referrer. "<code>aw</code>" should always be utilised for Awin. Please refer to separate information about the [[Advertiser_Tracking_Guide/De-duplication#Channel_Parameter|Channel Parameter]] for more guidance</li>
+
-
<li> <code><nowiki>{{commissionGroupCode}}</nowiki></code> should be replaced by the code for the commission group you want to attribute the transaction to. If no commission group is specified this should be set to Default. Accepted characters for the commissionGroup code are alphanumerics (letter in upper case), underscore '_' , point '.' and minus '-'</li>
+
-
<li> <code><nowiki>{{voucherCode}}</nowiki></code> should be populated with the voucher code used in the transaction. Example: 10_OFF. The parameter value has to be URL-encoded. </li>
+
-
<li> <code><nowiki>{{currencyCode}}</nowiki></code> should be populated with the ISO currency code of the currency that was used in the transaction. Example: GBP </li>
+
-
<li> <code><nowiki>{{orderReference}}</nowiki></code> must be replaced by the unique booking / order reference</li>
+
-
<li> <code><nowiki>{{isTest}}</nowiki></code> should be populated with "<code>0</code>" when tracking is in live mode or alternatively "<code>1</code>" if in test mode. When set to the latter, the incoming tracking requests will not be processed</li>
+
-
</ul>
+
-
 
+
-
== <span id="Cross-Device"></span>[[Advertiser_Tracking_Guide/Cross_Device_Tracking|[+] 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, [[Advertiser_Tracking_Guide/Cross_Device_Tracking| here]]. With a [[Advertiser_Tracking_Guide/Standard_Implementation|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.
+
-
 
+
-
 
+
-
== <span id="De-duplication"></span>[[Advertiser_Tracking_Guide/De-duplication|[+] 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.
+
-
 
+
-
 
+
-
=== <span id="Channel_Parameter"></span>[[Advertiser_Tracking_Guide/De-duplication#Channel_Parameter|[+] 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.
+
-
 
+
-
 
+
-
=== <span id="Example_Implementations"></span>[[Advertiser_Tracking_Guide/De-duplication#Example_Implementations|[+] Example Implementations]] ===
+
-
<br>
+
-
 
+
-
== <span id="Commission_Groups"></span>[[Advertiser_Tracking_Guide/Commission_Groups|[+] 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.
+
-
 
+
-
 
+
-
=== <span id="New_vs_Existing"></span>[[Advertiser_Tracking_Guide/Commission_Groups#New_vs_Existing|[+] 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.
+
-
 
+
-
 
+
-
=== <span id="Multiple_Commission_Groups"></span>[[Advertiser_Tracking_Guide/Commission_Groups#Multiple_Commission_Groups|[+] 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 ("<code>|</code>") character.
+
-
 
+
-
 
+
-
== <span id="Currency_Conversion"></span>[[Advertiser_Tracking_Guide/Currency_Conversion|[+] 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. Base currencies can be AUD, BRL, CAD, CHF, DKK, EUR, GBP, NOK, PLN, SEK or USD, depending on the region where your programme is running. If you are unsure what your programme’s base currency is, please contact your account manager.
+
-
 
+
-
 
+
-
== <span id="Discount_.2F_Voucher_Code_Tracking"></span>[[Advertiser_Tracking_Guide/Discount_.2F_Voucher_Code_Tracking|[+] 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.
+
-
 
+
-
 
+
-
== <span id="Custom_Tracking_Parameters"></span>[[Advertiser_Tracking_Guide/Custom_Tracking_Parameters|[+] Custom Tracking Parameters]] ==
+
-
 
+
-
It is possible to declare other information and associate it with the transaction using custom tracking parameters, which will appear in transaction reports available in the Awin UI, certain endpoints in the Awin Advertiser API, and via custom reports.
+
-
 
+
-
 
+
-
=== <span id="Single_Custom_Tracking_Parameter"></span>[[Advertiser_Tracking_Guide/Custom_Tracking_Parameters#Single_Custom_Tracking_Parameter|[+] Single Custom Tracking Parameter]] ===
+
-
<br>
+
-
 
+
-
=== <span id="Multiple_Custom_Tracking_Parameters"></span>[[Advertiser_Tracking_Guide/Custom_Tracking_Parameters#Multiple_Custom_Tracking_Parameters|[+] Multiple Custom Tracking Parameters]] ===
+
-
<br>
+
-
 
+
-
== <span id="Product_Level_Tracking"></span>[[Advertiser_Tracking_Guide/Product_Level_Tracking|[+] 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 '''[[#Journey_Tag_.2F_Mastertag|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.
+
-
 
+
-
 
+
-
=== <span id="PLT_Via_Conversion_Pixel"></span>[[Advertiser_Tracking_Guide/Product_Level_Tracking#PLT_Via_Conversion_Pixel|[-] PLT Via Conversion Pixel]] ===
+
-
 
+
-
As an alternative, if the implementation does not utilise JavaScript based tracking (refer to the topic '''[[#Conversion_Pixel_Only_Tracking|Conversion Pixel Only Tracking]]'''), it is possible to declare '''Product Level Tracking''' within the pixel's URL request string.
+
-
 
+
-
 
+
-
== <span id="Conversion_Pixel_Only_Tracking"></span>[[Advertiser_Tracking_Guide/Conversion_Pixel_Only_Tracking|[+] Conversion Pixel Only Tracking]] ==
+
-
 
+
-
<table border="0" cellpadding="0" cellspacing="0">
+
-
<tr>
+
-
<td valign="top">
+
-
[[File:Warning.png|37px]]
+
-
</td>
+
-
<td width="10">
+
-
</td>
+
-
<td valign="middle">
+
-
'''Please note Awin no longer support the use of pixel only implementations due to various broswer updates'''
+
-
</td>
+
-
</tr>
+
-
</table>
+
-
 
+
-
 
+
-
=== <span id="Server_To_Server_.28S2S.29"></span>[[Advertiser_Tracking_Guide/Conversion_Pixel_Only_Tracking#Server_To_Server_.28S2S.29|[+] Server To Server (S2S)]] ===
+
-
 
+
-
To alleviate browser-based tracking risks, sever-to-server should be implemented by the Advertiser as a fallback. If implementation of S2S tracking is not feasible, [[Advertiser_Offline_Tracking|batched offline tracking]] may be used.
+
-
 
+
-
== <span id="Reference_Snippets"></span>[[Advertiser_Tracking_Guide/Reference_Snippets|[+] Reference Snippets]] ==
+
-
<br>
+
-
 
+
-
=== <span id="General_Template"></span>[[Advertiser_Tracking_Guide/Reference_Snippets#General_Template|[+] General Template]] ===
+
-
<br>
+
-
 
+
-
=== <span id="Native_HTML_Example"></span>[[Advertiser_Tracking_Guide/Reference_Snippets#Native_HTML_Example|[+] Native HMTL Example]] ===
+
-
<br>
+
-
 
+
-
=== <span id="Container_Tag_Example"></span>[[Advertiser_Tracking_Guide/Reference_Snippets#Container_Tag_Example|[+] Container Tag Example]] ===
+
-
<br>
+

Revision as of 08:44, 22 June 2021

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


Advertiser Tracking Guide

Advertiser Tracking Video Guides

Please see our YouTube Channel for all How To videos on implementing Awin tracking and how to implement Awin tracking on some of the most popular ecommerce platforms.

Advertiser Tracking Guides

Please see full details of tracking instructions and features by following the link.

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