strapi-plugin-measurement-protocol

Strapi Measurement Protocol

Send data to Google Analytics with Measurement Protocol.

Table of Contents

• 🚦 Current Status
• ✨ Features
• 🖐 Installation
• 🚚 Usage
• Contributing
• License

🚦 Current Status

This package is currently under development and should be consider ALPHA in terms of state. I/We are currently accepting contributions and/or dedicated contributors to help develop and maintain this package.

For more information on contributing please see the contrib message below.

✨ Features

The Google Analytics Measurement Protocol for Google Analytics 4 allows developers to make HTTP requests to send events directly to Google Analytics servers. This allows developers to measure how users interact with their business from any HTTP-enabled environment. Notably, this makes it easy to measure interactions that happen server-to-server.

🖐 Installation

Add plugin dependency

yarn add strapi-plugin-measurement-protocol

Configure the plugin

// file: config/plugins.js
module.exports = ({ env }) => ({
  // ...
  "measurement-protocol": {
    config: {
      apiSecret: '',
      measurementId: '',
      useValidationServer: false,
    }
  },
  // ...
}

• apiSecret - Required. An API SECRET generated in the Google Analytics UI. To create a new secret, navigate to:

Admin > Data Streams > choose your stream > Measurement Protocol > Create

• measurementId - Required. The measurement ID associated with a stream. Found in the Google Analytics UI under:

Admin > Data Streams > choose your stream > Measurement ID

🚚 Usage

Full event list: https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events

Frontend usage

gtag('event', 'add_payment_info');

gtag('get', 'G-XXXXXXXXX', 'client_id', (clientId) => {
  fetch('https://strapi.example.com/api/measurement-protocol/collect', {
    method: 'POST',
    body: JSON.stringify({
      client_id: clientId, 
      events: [{name: "add_payment_info"}]
    })
  })
});

The /api/measurement-protocol/collect endpoint will bind the client_id with the connected strapi user id more info: https://developers.google.com/analytics/devguides/collection/protocol/ga4/user-properties?client_type=gtag

Backend usage

strapi
  .plugin('measurement-protocol')
  .service('gtag')
  .send({
    // payload
  });

full event reference: https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events

Contributing

I/We are actively looking for contributors, maintainers, and others to help shape this package. As this plugins sole purpose within the Strapi community is to be used by other developers and plugin maintainers to get fast responses time.

If interested please feel free to email the lead maintainer Sacha at: [e-mail] or ping stf#3254 on Discord.

License

See the LICENSE file for licensing information.