hapi-gapi

hapi google analytics platform integration - updated for GA4

Cloning

Cloning via SSH from behind a firewall which blocks port 22:

git clone ssh://[email protected]:443/DEFRA/hapi-gapi

Installing the plugin

npm install --save @defra/hapi-gapi

Registering the plugin with hapi

const Hapi = require('@hapi/hapi')
const HapiGapi = require('@defra/hapi-gapi')

const server = Hapi.server({
  host: 'localhost',
  port: 3000
})

await server.register({
  plugin: HapiGapi,
  options: {
    propertySettings: [
      {
        id: 'G-YYYYYYY',
        hitTypes: ['page_view']
      }
    ],
    sessionIdProducer: async request => {
      // Would normally use the request object to retrieve the proper session identifier
      return 'test-session'
    }
  }
})

| Option | Description | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | propertySettings | Defines the Google Analytics properties and the type of hits which are allowed to be sent to each. If empty, analytics data is not recorded (useful if you want to enable/disable via environment variables but still want the request decorated) | | sessionIdProducer | A method to retrieve an identifier to differentiate each user session |

How to use

This plugin decorates the request object so that you can easily send data to Google Analytics. With the migration to GA4 this package sends basic pageview data with client ids and user ids generated by the session id producer. Page views can be sent as follows:

Page views

await request.ga.view(request)

NOTE: By default this is not necessary, the plugin will automatically send page-views by hooking into the onPreResponse lifecycle hook

Events with custom params

You can send any custom params you need:

await request.ga.view(request, {
  name: 'score'
  params: {
    test: 'test',
    page_url: request.route.url
  }
})

Contributing to this project

If you have an idea you'd like to contribute please log an issue.

All contributions should be submitted via a pull request.

License

THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:

http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3

The following attribution statement MUST be cited in your products and applications when using this information.

Contains public sector information licensed under the Open Government license v3

About the license

The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.

It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.