@williamdasilva/gtag-module
v1.0.3
Published
Google GTag for Nuxt.js
Downloads
3
Readme
@williamdasilva/gtag-module
[![npm version][npm-version-src]][npm-version-href] [![npm downloads][npm-downloads-src]][npm-downloads-href] [![Circle CI][circle-ci-src]][circle-ci-href] [![Codecov][codecov-src]][codecov-href] [![License][license-src]][license-href]
Note
This module is a fork of https://github.com/nuxt-community/google-gtag-module. Using it to be compatible with latest version of Nuxt including runtime configs.
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
@williamdasilva/gtag-module
dependency to your project
yarn add @williamdasilva/gtag-module # or npm install @williamdasilva/gtag-module
- Add
@williamdasilva/gtag-module
to themodules
section ofnuxt.config.js
{
modules: [
// Simple usage
'@williamdasilva/gtag-module',
// With options
['@williamdasilva/gtag-module', { /* module options */ }]
]
}
Using top level options
{
modules: [
'@williamdasilva/gtag-module'
],
'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
}
}]
}
}
Using runtime config
{
modules: [
'@williamdasilva/gtag-module'
],
'google-gtag': {
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
}
}]
},
publicRuntimeConfig: {
gtag: {
id: 'UA-XXXX-XX'
}
}
}
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
Repo not actively maintained. See https://github.com/nuxt-community/gtm-module/issues/82 for future usages.