Electron-google-analytics4 NPM

Google Analytics 4 - Measurement Protocol API

Supports event tracking for GA4 in Electron built apps.
Currently, it supports the event sending function.

NPM

Github Page - Docs

https://github.com/hajeonghun/electron-google-analytics4

Features

Event

Getting started

Installation

npm i electron-google-analytics4
or
yarn add electron-google-analytics4

Init
Analytics(trackingID, secretKey, clientID?, sessionID?)
```
import Analytics from 'electron-google-analytics4'; // esm
// or
const Analytics = require('electron-google-analytics4').default; // cjs

const analytics = new Analytics('G-XXXXXX', 'xxxxx-xxxxx');
```
Usage
To use the Analytics module, create a new instance of the Analytics class by providing the required parameters: trackingID and secretKey. (secretKey Issuance Guide)
The clientID and sessionID parameters are optional and can be omitted if not needed.
clientID default: machineId (node-machine-id)
sessionID default: uuidv4 (uuid v4)
Set Single parameter (custom params)
Analytics#set(key, value)
```
analytics.set('user', 'jeonghun');
```
Remove Single parameter (custom params)
Analytics#set(key, null)
```
analytics.set('user', null);
```

Set Multiple parameter (custom params)

Analytics#setParams(obj)

const params = {name: 'hun', age: 28};
analytics.setParams(params);

Remove Multiple parameter (custom params)
Analytics#setParams()
```
analytics.setParams(); // customParams: {}
```

Set User Properties

Analytics#setUserProperties(obj)

analytics.setUserProperties({userId: 'ha', page_path: location.href});

Remove User Properties
Analytics#setUserProperties()
```
analytics.setUserProperties();
```

Send Event

Analytics#event(eventName)

analytics.event('page_view');
// Return Promise

Notes

Method chaining is available.

analytics.set('name', 'jeonghun').set('age', 28);
// or
analytics.set('name', 'jeonghun').event('page_view');

Verification Steps

1. Log in to your GA4 account.
2. Navigate to the "Real-time" section from the left-hand menu.
3. Go to the "Overview" tab.
4. Verify if the real-time data is being displayed:
  - Check if the number of active users, page views, and events are updating in real-time.
  - If the data is not being displayed correctly, double-check your code and troubleshoot any issues.