@nuxtjs/google-gtag
Attention
This project is looking for maintainers. Please see RFC for future of module.
Features
The module includes Google googletagmanager.com/gtag/js into your project and enables it with config you pass in as options.
- Check the official reference gtagjs
Setup
- Add
@nuxtjs/google-gtagdependency to your project
yarn add @nuxtjs/google-gtag # or npm install @nuxtjs/google-gtag- Add
@nuxtjs/google-gtagto themodulessection ofnuxt.config.js
{
modules: [
// Simple usage
'@nuxtjs/google-gtag',
// With options
['@nuxtjs/google-gtag', { /* module options */ }]
]
}Using top level options
{
modules: [
'@nuxtjs/google-gtag'
],
'google-gtag': {
id: 'UA-XXXX-XX',
config: {
anonymize_ip: true, // anonymize IP
send_page_view: false, // might be necessary to avoid duplicated page track on page reload
linker: {
domains: ['domain.com','domain.org']
}
},
debug: true, // enable to track in dev mode
disableAutoPageTrack: false, // disable if you don't want to track each page route with router.afterEach(...).
additionalAccounts: [{
id: 'AW-XXXX-XX', // required if you are adding additional accounts
config: {
send_page_view: false // optional configurations
}
}]
}
}Options
id (required)
Google Analytics property ID.
config
- Default:
{}
Config options for gtagjs
debug
- Default:
false
Enable to track in dev mode.
disableAutoPageTrack
- Default:
false
Disable if you don't want to track each page route with router.afterEach(...).
additionalAccounts
- Default:
[]
You can add more configuration like AdWords
Usage
This module includes Google gtag in your NuxtJs project and enables every page tracking by default. You can use gtag inside of your components/functions/methods like follow:
this.$gtag('event', 'your_event', { /* track something awesome */})To make sure that every page is tracked correctly
As the router code sometimes runs before head data is set correctly you can use following approach to make sure that everything is set correctly:
// make sure to set disableAutoPageTrack: true inside of nuxt.config.js
// inside of your Page.vue/Layout.vue file
mounted() {
if (process.browser) {
this.$gtag('config', 'UA-XXXX-XXX', {
page_title: this.$metaInfo.title,
page_path: this.$route.fullPath,
})
}
}See official docs:
Check functionalities
Install Google Tag Assistant and see if your page is being tracked.
Development
- Clone this repository
- Install dependencies using
yarn installornpm install - Start development server using
npm run dev
License
Copyright (c) Nuxt Community