A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://github.com/nuxt-community/gtm-module below:

nuxt-community/gtm-module: Google Tag Manager Module for Nuxt.js

Google Tag Manager Module for Nuxt.js

📖 Release Notes

â„šī¸ If coming from v1 (@nuxtjs/google-tag-manager) please read v2 release notes.

  1. Add @nuxtjs/gtm dependency to your project
yarn add @nuxtjs/gtm # or npm install @nuxtjs/gtm
  1. Add @nuxtjs/gtm to the modules section of nuxt.config.js
export default {
  modules: [
    '@nuxtjs/gtm',
  ],
  gtm: {
    id: 'GTM-XXXXXXX'
  }
}

You can use runtime config if need to use dynamic environment variables in production. Otherwise, the options will be hardcoded during the build and won't be read from nuxt.config anymore.

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

  gtm: {
    id: 'GTM-XXXXXXX', // Used as fallback if no runtime config is provided
  },

  publicRuntimeConfig: {
    gtm: {
      id: process.env.GOOGLE_TAG_MANAGER_ID
    }
  },
}

Defaults:

export default {
  gtm: {
    enabled: undefined, /* see below */
    debug: false,

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

    pageTracking: false,
    pageViewEventName: 'nuxtRoute',

    autoInit: true,
    respectDoNotTrack: true,

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

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

GTM module uses a debug-only version of $gtm during development (nuxt dev).

You can explicitly enable or disable it using enabled option:

export default {
  gtm: {
    // Always send real GTM events (also when using `nuxt dev`)
    enabled: true
  }
}

Whether $gtm API calls like init and push are logged to the console.

Manual GTM Initialization

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

nuxt.config.js:

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

plugins/gtm.js:

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

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.

You can push events into the configured layer:

this.$gtm.push({ event: 'myEvent', ...someAttributes })
  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.

MIT License

Copyright (c) Nuxt.js Community


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4