Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

@analytics/google-tag-manager

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@analytics/google-tag-manager

Google tag manager plugin for 'analytics' module

0.2.1
Source
npm

Version published: 5 years ago

Maintainers: 1

Created: 5 years ago

Source

Google Tag Manager plugin for analytics

Integration with google tag manager for analytics

This analytics plugin will load google tag manager into your application.

For more information see the docs.

Click to expand

Installation

Install analytics and @analytics/google-tag-manager packages

npm install analytics
npm install @analytics/google-tag-manager

How to use

The @analytics/google-tag-manager package works in the browser. To use, install the package, include in your project and initialize the plugin with analytics.

Below is an example of how to use the browser plugin.

import Analytics from 'analytics'
import googleTagManager from '@analytics/google-tag-manager'

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    googleTagManager({
      containerId: 'GTM-123xyz'
    })
  ]
})

/* Track a page view */
analytics.page()

/* Track a custom event */
analytics.track('cartCheckout', {
  item: 'pink socks',
  price: 20
})

After initializing analytics with the googleTagManager plugin, data will be sent into Google Tag Manager whenever analytics.page, or analytics.track are called.

See additional implementation examples for more details on using in your project.

Browser usage

The Google Tag Manager client side browser plugin works with these analytic api methods:

analytics.page - Sends page views into Google Tag Manager
analytics.track - Track custom events and send to Google Tag Manager

Browser API

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    googleTagManager({
      containerId: 'GTM-123xyz'
    })
  ]
})

Initialization arguments

pluginConfig object Plugin settings
pluginConfig.containerId string The Container ID uniquely identifies the GTM Container.

Platforms Supported

The @analytics/google-tag-manager package works in the browser

Additional examples

Below are additional implementation examples.

Using in HTML

Below is an example of importing via the unpkg CDN. Please note this will pull in the latest version of the package.

<!DOCTYPE html>
<html>
  <head>
    <title>Using @analytics/google-tag-manager in HTML</title>
    <script src="https://unpkg.com/analytics/dist/analytics.min.js"></script>
    <script src="https://unpkg.com/@analytics/google-tag-manager/dist/@analytics/google-tag-manager.min.js"></script>
    <script type="text/javascript">
      /* Initialize analytics */
      var Analytics = _analytics.init({
        app: 'my-app-name',
        plugins: [
          analyticsGtagManager({
            containerId: 'GTM-123xyz'
          })
        ]
      })

      /* Track a page view */
      analytics.page()

      /* Track a custom event */
      analytics.track('cartCheckout', {
        item: 'pink socks',
        price: 20
      })
    </script>
  </head>
  <body>
    ....
  </body>
</html>

Using in HTML via ES Modules

Using @analytics/google-tag-manager in ESM modules.

<!DOCTYPE html>
<html>
  <head>
    <title>Using @analytics/google-tag-manager in HTML via ESModules</title>
    <script>
      // Polyfill process.
      // **Note**: Because `import`s are hoisted, we need a separate, prior <script> block.
      window.process = window.process || { env: { NODE_ENV: 'production' } }
    </script>
    <script type="module">
      import analytics from 'https://unpkg.com/analytics/lib/analytics.browser.es.js?module'
      import analyticsGtagManager from 'https://unpkg.com/@analytics/google-tag-manager/lib/analytics-plugin-google-tag-manager.browser.es.js?module'
      /* Initialize analytics */
      const Analytics = analytics({
        app: 'analytics-html-demo',
        debug: true,
        plugins: [
          analyticsGtagManager({
            containerId: 'GTM-123xyz'
          })
          // ... add any other third party analytics plugins
        ]
      })

      /* Track a page view */
      analytics.page()

      /* Track a custom event */
      analytics.track('cartCheckout', {
        item: 'pink socks',
        price: 20
      })
    </script>
  </head>
  <body>
    ....
  </body>
</html>

Configuring GTM

Make sure you have your google tags manager setup to fire on Page views.

If you are using a SPA you want to listen to history changes as well.

See the full list of analytics provider plugins in the main repo.

Keywords

FAQs

What is @analytics/google-tag-manager?

Is @analytics/google-tag-manager well maintained?

Package last updated on 14 Oct 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install