gtm-module

gtm-module

Facilitates the usage of Google Tag Manager. Supports Google Tag Manager Server Side loading.

1. Instance Configuration

import GTM from 'gtm-module'

const gtmConfig = {
  gtmId: 'GTM-1234567', // required
  serverSideDomain: 'data.mydomain.com', // optional
  resetDataLayerObjects: true, // optional
  sanitizeDataLayerObjects: true, // optional
  defer: true // optional
}

const gtm = new GTM(gtmConfig)

Option	Required?	Type	Default Value	Description
gtmId	Yes	String	-	Google Tag Manager Client Side container ID.
serverSideDomain	No	String	-	Google Tag Manager Server Side domain. If provided, the google tag manager client side library will be loaded from your GTM server side container. In order for this to work properly, you must have the GTM Client Side setted up as a client on your GTMss container.
resetDataLayerObjects	No	Boolean	false	If true, after each push there will be a new push reseting all the keys with null value. This helps to keep the dataLayer parameters controlled across different pushes.
sanitizeDataLayerObjects	No	Boolean	false	If true, it sanitizes the object values. It is a good practice to normalize characters to ease future data treatments.
defer	No	Boolean	false	If true, it will load the google tag manager script as a defer HTML script instead of async.

2. Methods

gtm.initialize() // load the container

const dataLayerObject = {
  event: 'click',
  element: 'cta-bottom',
  text: 'buy-now'
}

gtm.dataLayerPush(dataLayerObject) // Push the object to the dataLayer.

// using the optional second parameter
gtm.dataLayerPush(dataLayerObject, true) // push the object to the dataLayer and then push another object reseting the properties first sent. It has priority over the initial configuration 'resetDataLayerObjects'.

Method	Parameters	Description
initialize	-	Load the Google Tag Manager Client Side container
dataLayerPush	object, resetPush	Pushes the object to the dataLayer. If the second parameter is passed, it overwrites the instance configuration resetDataLayerObjects property.

Changelog

1.0.9

Jun 27, 2023

-> Add jsdocs