How to Integrate Google Tag Manager with Next.js
Recently I worked on establishing a framework for the implementation of Google Tag Manager on an enterprise level project built with Next.js. The project replaces a legacy J2EE application.
A key difference between the new and current platform, which came as a complete surprise to the team that initiated the transition, was client-side navigation. When tracking page views the existing triggers/tag events didn’t work as expected. Clicking a link to navigate to another page would only fire a click event, not the event used for tracking a page view, window.onLoad.
Next.js is a hybrid of a Single Page Application (SPA) and a website which has a backend running on a server, it has the concept of routes and pages like a typical React site, however routes are handled automatically by adding pages and directories, there’s no need to install React Router.
<Link /> component enables client-side navigation between pages. The behaviour at this point is that of an SPA, it’s a seamless way to navigate, and does not require a page load, but because window.onLoad does not fire the problem with tracking events occurs.
So how do you let GTM know you navigated to another page?
The key here is making use of next/router & React's useEffect hook, in order to let GTM know about a page view, I’ll cover how we do this later on, you can skip to it here.
Set Up Google Tag Manager (GTM)
To get up and running you’ll need to add the tag manager script to the
<head> of each page, Google recommend adding it as high up in the DOM as possible.
- Create a GTM account: https://tagmanager.google.com/
- GTM Quick Start: https://developers.google.com/tag-manager/quickstart
Prior to Next.js v11.0.0 the simplest way to do this was by using the
You’ll be given 2 code snippets, plus instructions, but essentially one goes in the
<head>, the other goes after the opening
Since Next.js v11.0.0 there is a new
<Script/> component, which is the recommended way to implement 3rd party scripts that are only needed client side after a page becomes interactive. In the following case you would add the following code to
_app.tsx and also add the code from fig. 3 to
Once the scripts have been implemented you can start to add customisations.
I previously mentioned that window.onLoad can’t be solely relied on for tracking page views, there are several ways this issue can be dealt with, here are 2 I've used:
Either way will work, which you choose depends upon how granular you want to be.
Create a History Event Change Trigger
After creating an account, navigate to the dashboard for the website—you'll have to specify a domain, I made up a domain for working locally with localhost—click on Triggers, then configure a trigger.
Choose a Trigger type.
Don't forget to hit save.
To see the history changes pushed into the
dataLayer in the preview, submit the latest version, otherwise your changes won't be visible.
This configuration will enable you to go on to create tags if you'd like to share data with Google Analytics, this article provides more detail.
Fire a Custom Event when a Page Changes
All the GTM examples kindly provided by Next.js focus solely on one thing, a url changing. The url is available to
next/router, however when you want to push anything from
pageProps into the
dataLayer, that approach won't help.
I tested this out using
console.log to see the order of events being fired,
pageProps fires after
router.events, so I added
pageProps into the dependency array of the effect (Fig. 12).
What I want to do is watch for the
pageProps changing, and then push the information into the
dataLayer for tracking purposes, things like product titles, product SKU information, and more.
As I fetch data on a page-by-page basis,
pageProps provides a global way to handle passing that data.
I created a function called
gtmVirtualPageView (catchy I know) with a single purpose, to push data as part of an event type called VirtualPageView.
The only caveat with this approach is that it won't work unless
pageProps is used. If you don't want to make use of
pageProps, there are other ways, for instance using Redux or Context, which I'm not overing this time around.
That's it, there's not a lot of code to write to create an initial setup, the biggest challenge is understanding how it all fits together in a practical sense, and getting your head around GTM and Analytics, which requires investigation.
Thanks for reading, if you have a question or spot a mistake, catch me on Twitter.
If you liked this then please share it.