https://github.com/googleinterns/measurement-library
https://github.com/googleinterns/measurement-library
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/googleinterns/measurement-library
- Owner: googleinterns
- License: apache-2.0
- Created: 2020-06-05T23:06:40.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-06-24T09:04:30.000Z (11 months ago)
- Last Synced: 2025-07-31T04:37:14.357Z (10 months ago)
- Language: JavaScript
- Size: 316 MB
- Stars: 8
- Watchers: 4
- Forks: 4
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
- Code of conduct: docs/code-of-conduct.md
- Codeowners: docs/CODEOWNERS
Awesome Lists containing this project
README
# Measurement Library
Measurement library will provide an open source alternative for sites/apps to send events to Google Analytics.
**This is not an officially supported Google product.**
[](https://travis-ci.org/github/googleinterns/measurement-library/branches)
[](https://opensource.org/licenses/Apache-2.0)
## Table of contents
- [Overview](#overview)
- [Installation](#installation)
- [Usage](#usage)
- [Event Command](#event-command)
- [Set Command](#set-command)
# Overview
Measurement Library is a utility to help developers send data collected from their website to
other libraries for analytics. After specifying settings in a script tag, you can process any
sent events using a variety of built in event processors (e.g. sending data to Google Analytics).
Data from events or generated by event processors is automatically saved to persist between visits using your choice of
a variety of different storage options (e.g. cookies). [Read the docs](https://googleinterns.github.io/measurement-library/#) to learn more.
# Installation
First, install the package with your favorite package manager:
```bash
yarn add measurement-library
// or
npm install measurement-library
```
Next, choose [the event processor](https://googleinterns.github.io/measurement-library/#EventProcessors) and
[the storage implementation]((https://googleinterns.github.io/measurement-library/#StorageInterfaces))
to use and include this code in your `` tag. It should be placed as high up in the block as possible
in order to catch users who leave immediately after loading the page, then immediately leave.
```html
window.dataLayer = window.dataLayer || [];
function measure(){dataLayer.push(arguments);}
// One or more config commands. To send data to google analytics while
// using cookies for storage:
measure('config', 'googleAnalytics', {
'measurement_id': YOUR_MEASUREMENT_ID,
'api_secret': YOUR_API_SECRET,
}, 'cookies', {});
```
As an alternative, you can use the development version when testing your page. The dev version has a bigger file size,
but reports possible errors to the console.
```html
/* Configure script like last example. */
```
# Usage
After setting up the script tag using the `config` command, you can begin to use the library. All commands
are processed by passing arguments to the `measure()` function.
## Event command
When you run the command `measure('event', eventName, eventOptions)`, all registered
[event processors](https://googleinterns.github.io/measurement-library/#EventProcessors) will read the event and perform actions corresponding
to their API.
## Set command
To save parameters beyond the current page, you can call the command `measure('set', key, value)`.
The registered event processor will determine if the value should be saved, how long the value should
be saved for, and save it in the corresponding [storage](https://googleinterns.github.io/measurement-library/#StorageInterfaces).
To overwrite this behavior, you can specify a third time-to-live parameter:
`measure('set', key, value, secondsToLive)`. In particular, if `secondsToLive` is 0, no data will be saved to long term storage.