@nuxtjs/gtm

Google Tag Manager Module for Nuxt.js

📖 Release Notes

ℹ️ If coming from v1 (@nuxtjs/google-tag-manager) please read v2 release notes.

Setup

1. Add @nuxtjs/gtm dependency to your project

yarn add @nuxtjs/gtm # or npm install @nuxtjs/gtm

2. Add @nuxtjs/gtm to the buildModules section of nuxt.config.js

{
  buildModules: [
    '@nuxtjs/gtm',
  ],
  gtm: {
    id: 'GTM-XXXXXXX'
  }
}

Options

Defaults:

{
  // Set to false to disable module in development mode
  dev: true,

  id: null,
  layer: 'dataLayer',
  variables: {},

  pageTracking: false,
  pageViewEventName: 'nuxtRoute',

  autoInit: true,
  respectDoNotTrack: true,

  scriptId: 'gtm-script',
  scriptDefer: false,
  scriptURL: 'https://www.googletagmanager.com/gtm.js',

  noscript: true,
  noscriptId: 'gtm-noscript',
  noscriptURL: 'https://www.googletagmanager.com/ns.html'
}

Manual GTM Initialization

🚨 IMPORTANT 🚨

There is a known issue with Nuxt < 2.12.0 fixed by nuxt/nuxt#6807 which causes shared state and adding multiple tags. Please use nuxt-edge for now if want to use init on server-side.

There are several use cases that you may need more control over initialization:

• Block Google Tag Manager before user directly allows (GDPR realisation or other)
• Dynamic ID based on request path or domain
• Initialize with multi containers
• Enable GTM on page level

nuxt.config.js:

export default {
 modules: [
  '@nuxtjs/gtm'
 ],
 plugins: [
  '~/plugins/gtm'
 ]
}

plugins/gtm.js:

export default function({ $gtm, route }) {
  $gtm.init('GTM-XXXXXXX')
}

• Note: All events will be still buffered in data layer but won't send until init() method getting called.
• Note: Please consult with Google Tag Manager Docs for more information caveats using multiple containers.

Router Integration

You can optionally set pageTracking option to true to track page views.

Note: This is disabled by default to prevent double events when using alongside with Google Analytics so take care before enabling this option.

The default event name for page views is nuxtRoute, you can change it by setting the pageViewEventName option.

Usage

Pushing events

You can push events into the configured layer:

this.$gtm.push({ event: 'myEvent', ...someAttributes })

Development

1. Clone this repository
2. Install dependencies using yarn install or npm install
3. Start development server using yarn dev or GTM_ID=<your gtm id> yarn dev if you want to provide custom GTM_ID.

License

MIT License

Copyright (c) Nuxt.js Community