@bloomreach/segmentation

Segmentation

Javascript library that helps to connect Exponea segmentation with Bloomreach SPA SDK.

Prerequisite

You must have Exponea snippet injected in your app. To be able to use the segmentsSubscription and the latest API for fetching segments, the Exponea snippet should be at least 3.0.0 version.

Installing

npm install @bloomreach/segmentation

Usage

Run initializePersonalization({ path }) where path is part of the URL, including a query string with campaign parameters.

API methods

• initializePersonalization(configuration: CampaignConfiguration & SegmentationConfiguration) - initializes campaign and segmentation personalization.
• initializeCampaignPersonalization(configuration: CampaignConfiguration) - initializes campaign personalization.
• initializeSegmentation(configuration: SegmentationConfiguration) - initializes organic personalization.
• segmentsSubscription(callback, configuration: SegmentationConfiguration) - subscribes to segments changes. The Exponea snippet should be at least 3.0.0 version to be able to use this method.

Configuration

There are two types of configuration objects that you pass to API methods: CampaignConfiguration and SegmentationConfiguration described below.

Campaign configuration

• path: string(required) - path of the current page, including a query string with campaign parameters.
• campaignVariantUrlParameter: string - URL query parameter name with campaign id. Default: btm_campaign_id.
• campaignSegmentUrlParameter: string - URL query parameter name with segment id. Default: btm_segment.
• campaignTtlUrlParameter: string - URL query parameter name with TTL value. Default: btm_ttl.
• campaignCookieTtlMaxValue: number - Campaign cookie TTL max value in days. Default: 7.
• campaignVariantCookieName: string - Cookie name for campaign id. Default: __br__campaign_id.
• campaignSegmentCookieName: string - Cookie name for campaign segment. Default: __br__segment.

Segmentation configuration

• projectToken: string - Deprecated. Project token from Exponea that is used when setting event tracking on the website or in mobile apps. It can be found in Project Settings in Exponea admin panel.
• targetURL: string - Deprecated. Target url where the API is hosted.
• cacheMaxTime: string - Deprecated. Define in seconds how frequently the front-end needs to refresh the cache of the personalised segments.

Workflow and Release

• Create MR with changes.
• When the pipeline is green and MR is approved, merge it to master.
• Create a new commit with the new version number and push it to master.
• The pipeline will automatically publish the package to npm.