@geins/ralph-module-gtm
v3.7.0
Published
Geins module for Google Tag Manager
Downloads
306
Readme
Google Tag Manager module for Geins PWA Storefront
Add google tag manager to your Geins PWA Storefront. A wrapper around the nuxt-gtm module.
Pre-requisites
- Geins Account and PWA Storefront Ralph. Get a free trial here
- Storefront with
@ralph/ralph-ui
19.4.0 or higher.
Installation
1. Install the module
npm i @geins/ralph-module-gtm
2. Add the module to your Geins PWA Storefront Ralph
Add the module to your Geins PWA Storefront Ralph by adding the following lines to your nuxt.config.json
file:
// nuxt.config.js
module.exports = {
modules: [
[
'@geins/ralph-module-gtm',
// Configuration defaults for the module
{
// Set to true to enable debug mode
debug: false,
// Set to false to disable the module
enabled: true,
// Settings for the GTM module, see https://github.com/nuxt-community/gtm-module for more information
gtm: {},
// What to use as the item_id for the product, for example 'productId' or 'articleNumber'
itemId: 'productId',
// If you want to override some properties of the product, you can do so here , for example: [{ override: 'price_campaign', name: 'green_price' }]
propOverrides: []
}
]
]
}
Events
The following events are pushed to gtm by this module:
add_to_cart
- One or more products are added to the cartremove_from_cart
- One or more products are removed from the cartview_item
- A product page is viewedview_item_list
- A product in a list is scrolled into viewselect_item
- A product in a list is clickedbegin_checkout
- The checkout page has been enteredpurchase
- A purchase has been madeoriginal_location
- The page where the user enters the sitevirtual_page_view
- A new navigation has been madepage_data
- A page has been loadedadd_to_wishlist
- A product has been added to the wishlist
Cookies
The following cookies are set by this module:
ralph-gtm-user
- This is a HttpOnly cookie with a random value (guid) plus a UNIX timestamp that is used to identify the user. It is set to expire in 2 years.
Note This cookie can be used as the
master-cookie
for serverside tracking. Read more about serverside tracking with master-cookies here.
Note
Since this module is based on the [@nuxtjs/gtm](https://github.com/nuxt-community/gtm-module)
module, it will conflict with it.
If you are already using the @nuxtjs/gtm
module, you should uninstall it and use this module instead, which will include the @nuxtjs/gtm
module as a dependency. If you are using the internal GTM events of Ralph, you should disable them by setting useExternalGtm
to true in the publicRuntimeConfig
of you nuxt.config.js file.