Client-Side Tracking

Google Tag Manager (GTM) offers a more efficient integration process compared to a direct integration of our Tracking code.

Note

This article covers the integration of client-side tracking. For information on installing Server-to-Server (S2S) in Google Tag Manager, please see S2S via GTM.

If you wish to review the source code of our tags before adding them to your container, you may view them here:

These tags are published and maintained by Awin employees.

Step 1 - The Advertiser MasterTag

The Awin MasterTag (also referred to as the Journey Tag) is a JavaScript library that contains all the necessary functions for our tracking solution.

For more information on this tag’s function, please see the Advertiser MasterTag.

1. In Google Tag Manager, navigate to “Tags”.

2. Click “New” and choose “Discover more tag types in the Community Template Gallery”.
   
   

3. Searching for “Awin” will reveal the Advertiser MasterTag. Select this tag published by Edin Cuturic.

   
   
   

4. 

   Add this tag to your workspace, accepting any notices. This tag will need permission to inject scripts on your site on your behalf.

5. 

   Please configure the tag with your program’s associated Advertiser ID (MID) and the relevant triggers.

Step 2 - The Conversion Tag

Now that you’ve configured the MasterTag, we’re ready to begin the integration of the Conversion Tag. Before we integrate the tag itself, we’ll need to add automatic deduplication and the Channel Parameter.

Last Click Identifier

The AW Last Click Identifier tag will allow our tag and, thus, our systems to determine who the last paid click referrer was before a customer completed checkout. In the case that this referral came from an Awin Publisher, we can ensure that they’re rewarded for their action.

1. Start by adding the tag in the same fashion as before. This time, select “Awin - AW Last Click Identifier” published by Allan Urique.

2. Add this tag to your workspace and accept any applicable notices.

3. Configure your tag as shown below, taking special note of the variable configurations.

4. 

   With the correct configuration, you can save this tag.

Next, we’ll create a variable to read the value of the Cookie created by this tag. While “AwinChannelCookie” is the default, you’re welcome to define your own or refer to another.

1. Navigate to “Variables”.

2. Create a new “User-Defined Variable”.

3. Set the cookie name based on the previously determined name in the last step.

   
   

4. 

   Keep note of this new variable as you’ll need to reference it in your Conversion Tag.

The Conversion Tag

For specific information on each of the parameters’ uses, please see our article on the Conversion Tag.

As a quick reference, the only optional fields in this tag are Customer Acquisition, Custom Parameters, and Product Level Tracking.

1. Start by adding the tag in the same fashion as before. This time, select “Awin Conversion Tag” published by Edin Cuturic.

2. Add this tag to your workspace and accept any applicable notices.

3. 

   Assign your variables as noted. If you’re unsure of best practices for these variables, please see the table in our Conversion Tag article.
   

4. Although not depicted, please ensure that your Awin MasterTag is configured as a “Clean up tag” for the Conversion Tag. This enforces a proper triggering order during your Transaction event.

Notice

The variables shown in the above screenshot are not how they should be configured in your Tag. These are solely abstract references for the kinds of data we expect in these fields.

For the expected variable types and formats, please refer to the Parameter Guidance article.

Take special care to assign the correct variable for your Channel parameter. This will be the variable defined earlier on in this process.

Server-to-Server Tracking

You’ve completed the client-side integration of Awin tracking! From here, we recommend that you test your integration and continue on with integrating the mandatory server-to-server portion of our tracking.

You’re welcome to choose from any of the below-linked integration methods for Server-to-Server. You should choose this route based on the most convenient for your infrastructure configuration.

• Server-side GTM

• Server-side tracking via Conversion API

• Server-side tracking via Direct Implementation

Consent

As an Advertiser, it is your responsibility to obtain cookie consent for Awin’s tracking and inform us of the consent status. We strongly recommend making use of Awin Consent Signals in Google Tag Manager. Further information regarding consent can be found on Consent Framework.

Practical Tips (GTM Custom Codes)

In some cases, it can be helpful to use customer-specific solutions via custom code.

GTM Custom Javascript Example

Custom JavaScript to create an array for custom parameters:

function() {
  return [
    "{{value1}}",
    "{{value2}}",
    "{{value3}}",
  ];
}

Setup Data Layer Variables

<script>
dataLayer = [{
'transactionTotal': "{transactionTotal}",
'transactionCurrency': "{transactionCurrency}",
'transactionID': "{transactionID}",
'transactionPromoCode': "{transactionPromoCode}",
'event': "awin.dl.ready"
}];
</script>

<script>
dataLayer = [{
'transactionTotal': "5.99",
'transactionCurrency': "GBP",
'transactionID': "4-815162342",
'transactionPromoCode': "HALFPRICE",
'event': "awin.dl.ready"
}];
</script>

Shop Content First Example

In cases where data is missing (resulting in "undefined" values) or loading delays occur, it can help to load the Awin ConversionTag or MasterTag only after all page content has finished loading. This ensures that all order data is available before being transmitted to Awin. GTM offer “content first” trigger events:

• "DOM Ready" or

• "Window Loaded".

related links for this loading event topic:

https://support.google.com/tagmanager/answer/7679319?hl=en

https://developer.mozilla.org/en-US/docs/Web/API/Window/load_event

Mastertag Integration In Single-Page Application

This solution will work if page url is changing when user moves to different sections of the Single-page Application (sometimes short: SPA).

use case: mastertag integration in single-page application using Google Tag Manager

• Create a Journey Tag to fire on a Landing page but not checkout page

• Create a History Change Trigger with exception (don't fire on checkout page)  

• Create a Custom HTML Tag, name it Awin Mastertag - History Change and use the code below (replace the XXXX with Advertiser ID)

<script>
AWIN.Tracking.scriptAppend('https://www.dwin1.com/XXXX.js?cb=' + Math.floor(Date.now() / 1000));
</script>

• Add the History Change Trigger to Awin Mastertag - History Change  and save the tag

Removing VAT Or Shipping Costs From Amount

Use case: reduce order total value by the amount of tax and shipping costs (target: net amount).

• Create a new Custom JavaScript

• Let’s make a code that takes the DataLayer variables for the total revenue, the VAT and the shipping fee, and run a subtraction equation using the “-“ (minus) JavaScript Subtraction Operator.

  Use the following code as a base, and edit to your needs:

function(){
  // UPDATE the {{}} variables to your DataLayer variables.
  
  var revenue = {{Transaction Revenue}};
  var vat = {{Transaction VAT}};
  var shipping = {{Transaction Shipping}};
  
  var totalAmount = revenue - (shipping + vat);
  
  return totalAmount.toFixed(2);
}

The above code will return the resulting value from the subtraction equation, rounded with 2 decimal cases using the .toFixed( ) method.

• Then simply use this custom JavaScript variable in the Awin Conversion Tag.