google.analytics Plugin

Export dimensions to Google Analytics

google.analytics plugin

The Google Analytics plugin is for exporting dimensions to Google Analytics.

Google Analytics
namespace google.analytics
dimension push
disabled by default

Configuration

google: {
  analytics: {
    global: 'ga',
    properties: [],
    dimensionPush: {
      disabled: true,
      eventCategory: 'lytics'
    }
  }
}

google.analytics.properties

  • Type string[]
  • Optional
  • Defaults to []

An array of string properties to send into Google Analytics.

google.analytics.dimensionPush.disabled

  • Type boolean
  • Optional
  • Defaults to true

Set google.analytics.dimensionPush.disabled to false to enable this plugin.

google.analytics.dimensionPush.eventCategory

  • Type string
  • Optional
  • Defaults to "lytics"

The event category for this dimension.

Advanced options

Advanced options generally do not need to be configured.

google.analytics.global

  • Type string
  • Optional
  • Defaults to ga

The global variable of the Google Analytics SDK.

Learn more about configuration

Mechanism

This plugin works by integrating with the Google Analytics SDK. It pushes custom dimensions into Google Analytics.

Events

EventFires whenPayload
google.analytics.dimensionPush.failedPushing a dimension to Google Analytics failednone
google.analytics.dimensionPush.donePushing a dimension to Google Analytics is donenone
google.analytics.dimensionPush.set.requestedA dimension set is requested{ property, dimension, value }
google.analytics.dimensionPush.send.requestedA dimension send is requested{ property }

Learn more about events