pohnean/vue-gtm

Simple implementation of Google Tag Manager in Vue.js 2.0

Vue Google Tag Manager

Simple implementation of Google Tag Manager in Vue.js

This plugin will helps you in your common GTM tasks.

Note: If you are looking to track all Vuex mutations, you can use Vuex GTM plugin

Requirements

• Vue.js. >= 2.0.0
• Google Tag Manager account. To send data to

Optionnals dependencies

• Vue Router >= 2.x - In order to use auto-tracking of screens

Configuration

npm install vue-gtm -S or yarn add vue-ua if you use Yarn package manager

Here is an example of configuration, compose with it on your own :

You have to include Google GTM normally as you would in any other application. Directly inside index.html (root page) of your app.

For ex:

<noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-XXXXXX" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript> <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-XXXXXX');</script>

Then in your app.js of Vue project,

import VueGtm from 'vue-gtm'
import VueRouter from 'vue-router'
const router = new VueRouter({routes, mode, linkActiveClass})

Vue.use(VueGtm, {
  debug: true, // Whether or not display console logs debugs (optional)
  vueRouter: router, // Pass the router instance to automatically sync with router (optional)
  ignoredViews: ['homepage'], // If router, you can exclude some routes name (case insensitive) (optional)
})

Documentation

Once the configuration is completed, you can access vue gtm instance in your components like that :

export default {
    name: 'MyComponent',
    data () {
      return {
        someData: false
      }
    },
    methods: {
      onClick: function() {
        this.$gtm.trackEvent({
					category: 'Calculator',
					action: 'click',
					label: 'Home page SIP calculator',
					value: 5000
				});
      }
    },
    mounted () {
      this.$ua.trackView('MyScreenName', 'currentpath');
    }
}

You can also access the instance anywhere whenever you imported Vue by using Vue.gtm. It is especially useful when you are in a store module or somewhere else than a component's scope.

Sync gtm with your router

Thanks to vue-router guards, you can automatically dispatch new screen views on router change ! To use this feature, you just need to inject the router instance on plugin initialization.

This feature will generate the view name according to a priority rule :

• If you defined a meta field for you route named gtm this will take the value of this field for the view name.
• Otherwise, if the plugin don't have a value for the meta.gtm it will fallback to the internal route name.

Most of time the second case is enough, but sometimes you want to have more control on what is sent, this is where the first rule shine.

Example :

const myRoute = {
  path: 'myRoute',
  name: 'MyRouteName',
  component: SomeComponent,
  meta: {gtm: 'MyCustomValue'}
}

This will use MyCustomValue as the view name.

Credits

ScreamZ vue-analytics