Skip to content

Add configurable page view custom event name for Google Tag Manager #349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dobesv wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add configurable page view custom event name for Google Tag Manager #349

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions packages/analytics-plugin-google-tag-manager/src/browser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@ export const config = {
dataLayer: undefined,
preview: undefined,
auth: undefined,
execution: 'async'
// assumesPageview: true,
execution: 'async',
pageViewEvent: null
// assumesPageview: true
}

let initializedDataLayerName;

/**
* Google tag manager plugin
*
* @link https://getanalytics.io/plugins/google-tag-manager
* @link https://developers.google.com/tag-manager/
* @param {object} pluginConfig - Plugin settings
Expand All @@ -22,6 +24,9 @@ let initializedDataLayerName;
* @param {string} [pluginConfig.preview] - The preview-mode environment
* @param {string} [pluginConfig.auth] - The preview-mode authentication credentials
* @param {string} [pluginConfig.execution] - The script execution mode
* @param {string} [pluginConfig.pageViewEvent] - If configured, a custom event will be sent for each page view with the
* given name. This can be used to capture page view events consistently in a single page application where
* Google Tag Manager would only fire a page view on the first page load.
* @return {object} Analytics plugin
* @example
*
Expand Down Expand Up @@ -73,7 +78,9 @@ function googleTagManager(pluginConfig = {}) {
},
page: ({ payload, options, instance, config }) => {
if (typeof config.dataLayer !== 'undefined') {
config.dataLayer.push(payload.properties)
if(config.pageViewEvent) {
config.dataLayer.push({ event: config.pageViewEvent, ...payload.properties });
}
}
},
track: ({ payload, options, config }) => {
Expand Down