Get started
vue-gtag documentation page
The global site tag (gtag.js) is a JavaScript tagging framework and API that allows you to send event data to Google Analytics, Google Ads, and Google Marketing Platform. For general gtag.js documentation, read the gtag.js developer guide.
Before starting, make sure to know the basics of Google global site tag (gtag.js) already. Important parts of the plugin API have their link to the official documentation to help you out.
Whenever you don't understand something, and the documentation lacks information, create an issue on Github.
Requires Vue 3 installed
$ npm add vue-gtag
This is the basic installation required to start using the plugin
import { createApp } from "vue";
import App from "./App.vue";
import VueGtag from "vue-gtag";
createApp(App).use(VueGtag, {
config: { id: "GA_MEASUREMENT_ID" }
}).mount("#app");
This is just an example by using the Google Analytics domain ID as a configuration ID, but it is possible to use things like Google Adwords as well, so make sure to read the gtag documentation if you need more insights about what type of tracking code you need to use
After this, you will be able to use the
gtag
the library inside your components contextually by accessing it like this exampleexport default {
name: 'MyComponent',
methods: {
login () {
this.$gtag.event('login', { method: 'Google' })
}
}
}
Since in Vue 3, the setup method doesn't have access to
this.$gtag
but you can import the method you need like thisimport { event } from 'vue-gtag'
export default {
name: 'MyComponent',
setup() {
const login = () => {
event('login', { method: 'Google' })
}
return {
login
}
}
}
The config object also accepts a
params
property that will add additional parameters to your initial config callimport { createApp } from "vue";
import App from "./App.vue";
import VueGtag from "vue-gtag";
createApp(App).use(VueGtag, {
config: {
id: "GA_MEASUREMENT_ID",
params: {
anonymize_ip: true
}
}
}).mount("#app");
Last modified 1yr ago