Skip to content

Google Analytics

Orbee provides a way to integrate with Google Analytics, this functionality allows you to send events to both Orbee and Google Analytics if a tracking id is provided.

Installation

This plugin requires no additional installation to be used correctly.

Configuration

This plugin provides the following configuration variables:

Variable Type Required Description
ga string yes google analytics tracking id

Methods

This plugin provides the following function to drop a segment:

dropSegment

dropSegment ( segmentName: string, segmentID: string, token: string ): void

Drops a segment with the given params on the shopper

Parameter Type Required Description
segmentName string yes Name of segment
segmentID string yes ID of segment
token string yes Script token

Events

Generated

This plugin generates the following events:

Action Spec Trigger
marker 
{
 object: 'other',
 vendor: 'Google',
 product: 'Analytics',
 label: 'gaUid'
 gaUid: '<ga_uid>'
}
 on instantiation
marker 
{
 object: 'other',
 vendor: 'Google',
 product: 'Analytics',
 label: 'gclid'
 gaclid: '<gclid>'
}
 on instantiation and if gclid script is found
marker 
{
 object: 'visit',
 vendor: 'Orbee',
 product: 'Segments',
 implementations: ['Google Analytics'],
 label: '<segment_name>'
 segmentID: '<segment_id>'
 token: '<script_token>'
}
on drop segment
marker 
{
 object: 'other',
 vendor: 'Google',
 product: 'Analytics',
 label: '<hit_type>',
 eventCategory: '<event_category>'
 eventAction: '<event_action>'
 eventLabel: '<event_label>'
 eventValue: '<event_value>'
}
on pixel fire AND if trackEvent is true

Listening

This plugin does not listen for any events.

Dependencies

This plugin does not depend on any other services or plugins.

Last update: 2023-04-13