gtag-ga

📊 gtag-ga

Google Analytics 4 (gtag.js) for Node.js ES Module. Simple installation to send page views or event tracking.

• ⚡️ Lightweight modules & quick setup & fast performance
• ⚡️ Zero dependency packages. ESM packages available everywhere
• ⚡️ Support for the latest Node.js, Google Analytics 4
• ⚡️ Support for TypeScript

Installation

gtag-ga requires Node.js 16.x or higher, and the repository is serviced through NPM.

After configuring the node environment, you can simply run the following command.

# via npm
$ npm install gtag-ga

# via yarn
$ yarn add gtag-ga

# via pnpm
$ pnpm install gtag-ga

How to use

import { initializeGtag } from 'gtag-ga';

initializeGtag('G-XXXXXXXXXX'); // Your tracking code

Methods

initializeGtag (void)

Enable gtag.js in your webpage environment. Ideally, it should only be called once at the start (but multiple calls won't hurt). The first argument value should include your Google Analytics tracking ID, which starts with G-.

• (Required) trackingId::string
• config::object

initializeGtag('G-XXXXXXXXXX'); // Your tracking code

gtag (void)

The usage of this function is the same as the gtag functions used in regular gtag.js.

Learn more in the official gtag.js documentation at: https://developers.google.com/tag-platform/gtagjs/configure#step_2_send_data_with_event

gtag('event', 'eventName', { 'key': 'value' });

Contributing

Anyone can contribute to the project by reporting new issues or submitting a pull request. For more information, please see CONTRIBUTING.md.

License

Please see the LICENSE file for more information about project owners, usage rights, and more.

Changelog

1.1.0 (2024-12-18)

• BREAKING CHANGES: To import an entire method, you must now use import * as GtagGA from 'gtag-ga' instead of import GtagGA from 'gtag-ga'.