Google analytics v4 plugin for 'analytics' module
npm install @analytics/google-analyticsThis analytics plugin will load google analytics v.4 into your application.
For more information see the docs.
Click to expand
- Installation
- How to use
- Platforms Supported
- Browser usage
- Browser API
- Configuration options for browser
- Additional examples
- Fix "double page views"
- Legacy Google analytics v3
- Using GA3 and GA4 together
``bash`
npm install analytics
npm install @analytics/google-analytics
The @analytics/google-analytics 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.
`js
import Analytics from 'analytics'
import googleAnalytics from '@analytics/google-analytics'
const analytics = Analytics({
app: 'awesome-app',
plugins: [
googleAnalytics({
measurementIds: ['G-abc123']
})
]
})
/ Track a page view /
analytics.page()
/ Track a custom event /
analytics.track('cartCheckout', {
item: 'pink socks',
price: 20
})
/ Identify a visitor /
analytics.identify('user-id-xyz', {
firstName: 'bill',
lastName: 'murray'
})
`
After initializing analytics with the googleAnalytics plugin, data will be sent into Google Analytics whenever analytics.identify, analytics.page, or analytics.track are called.
See additional implementation examples for more details on using in your project.
The @analytics/google-analytics package works in the browser
The Google Analytics client side browser plugin works with these analytic api methods:
- analytics.identify - Identify visitors and send details to Google Analytics
- analytics.page - Sends page views into Google Analytics
- analytics.track - Track custom events and send to Google Analytics
`js
import Analytics from 'analytics'
import googleAnalytics from '@analytics/google-analytics'
const analytics = Analytics({
app: 'awesome-app',
plugins: [
googleAnalytics({
measurementIds: ['G-abc123']
})
]
})
`
| Option | description |
|:----------------------------------------------------|:-----------|
| measurementIds debug
required - Array.
| dataLayerName
_optional_ - boolean | Enable Google Analytics debug mode |
| gtagName
_optional_ - string | The optional name for dataLayer object. Defaults to ga4DataLayer. |
| gtag
_optional_ - string | The optional name for dataLayer object. Defaults to . |gtagConfig.anonymize_ip
| gtagConfig.cookie_domain
_optional_ - boolean | Enable Anonymizing IP addresses sent to Google Analytics. |
| gtagConfig.cookie_expires
_optional_ - object | Additional cookie properties for configuring the ga cookie |
| gtagConfig.cookie_prefix
_optional_ - object| Additional cookie properties for configuring the ga cookie |
| gtagConfig.cookie_update
_optional_ - object | Additional cookie properties for configuring the ga cookie |
| gtagConfig.cookie_flags
_optional_ - object | Additional cookie properties for configuring the ga cookie |
| customScriptSrc
_optional_ - object | Additional cookie properties for configuring the ga cookie |
| nonce
_optional_ - string | Custom URL for google analytics script, if proxying calls |
|
_optional_ - string | Content-Security-Policy nonce value |
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.
`html
....
`
Using in HTML via ES Modules
Using @analytics/google-analytics in ESM modules.
`html
....
`
Google analytics 4 sometimes automatically sends a page view for single page applications. To disable this you will need to go into the settings of your stream and click into "enhanced measurement" section and uncheck the "Page changes based on browser history events" setting. This will make sure only analytics.page() calls will send page views to Google analytics v4.

For the older version of google analytics please see the @analytics/google-analytics-v3 package or the GA3 plugin docs
It is possible to use both GA3 and GA4 together shown below. Just remember GA3 will be deprecated starting in July of 2023
`js
import Analytics from 'analytics'
import googleAnalyticsPlugin from '@analytics/google-analytics'
import googleAnalyticsV3Plugin from '@analytics/google-analytics-v3'
/ Initialize analytics instance /
const analytics = Analytics({
app: 'my-app',
plugins: [
/ Load Google Analytics v4 /
googleAnalyticsPlugin({
measurementIds: ['G-abc123'],
}),
/ Load Google Analytics v3 /
googleAnalyticsV3Plugin({
trackingId: 'UA-11111111-2',
}),
],
})
analytics.page()
``