@segment/consent-manager
Advanced tools
Drop-in consent management plugin for analytics.js
The Segment Consent Manager is an analytics.js add-on with support to consent management.
At its core, the Consent Manager empowers your visitors to control and customize their tracking preferences on a website. They can opt out entirely of being tracked, or selectively opt out of tools in which they don’t want their information stored.
It works by taking control of the analytics.js load process to only load destinations that the user has consented to and not loading analytics.js at all if the user has opted out of everything. The user's tracking preferences are saved to a cookie and sent as an identify trait (if they haven't opted out of everything) so that you can also access them on the server-side and from destinations (warehouse).
Segment works to ensure the Consent Manager Tech Demo works with most of our product pipeline. We cannot ensure it works in your specific implementation or website. Please contact our Professional Services team for implementation support. Please see the License.txt included.
Please note, Consent Manager is not currently compatible with Personas. Personas may send user data to destinations the user has explicitly opted out of for data collection.
Track call message payloads will be extended to include Consent metadata in the context object:
{
"context": {
"campaign": {},
"consent": {
"categoryPreferences": {
"Amplitude": true,
"Customer.io": true,
"Google Analytics": true,
"Webhooks": true
},
"defaultDestinationBehavior": "disable",
"destinationPreferences": {
"Amplitude": true,
"Customer.io": true,
"Google Analytics": true,
"Webhooks": true
}
}
},
"event": "Send Track Event Clicked",
"integrations": {
"All": false,
"Amplitude": true,
"HubSpot": false,
"Salesforce": false,
"Segment.io": true
}
}
Breaking Changes: Version 5.0.0 and above require that your analytics.js snippet include the method addSourceMiddleware in the analytics.methods array:
analytics.methods = [
'trackSubmit',
'trackClick',
'trackLink',
'trackForm',
'pageview',
'identify',
'reset',
'group',
'track',
'ready',
'alias',
'debug',
'page',
'once',
'off',
'on',
'addSourceMiddleware' // This method is necessary for Consent Manager to forward consent metadata.
]
The Segment Consent Manager can be used in several ways, depending on how custom you want your visitor's experience to be.
To get started, make sure you're using the latest version of the analytics.js snippet (4.1.0 or above) and remove the analytics.load("YOUR_WRITE_KEY"); call (so the consent manager can manage the loading process). Then continue onto one of the implementation methods below.
The standalone script is a prebuilt bundle that uses the ConsentManager React component with Preact (a lightweight React alternative). It's best for if you want to get up and running quickly or you don't have a preexisting React setup.
Include the consent manager script tag after your analytic.js snippet and add your own custom copy. The standalone script can be configured in one of two ways, via data attributes for simple usage or via a global callback function for advanced usage. Both methods allow the consent manager script to be loaded async.
All of the ConsentManager options are supported with the addition of these options:
Type: string
CSS selector to the DOM element that will host the consent banner. It should be an empty DOM element (usually a <div>) because the consent manager will replace any existing DOM elements inside it. The element must also exist on the page before the script is executed.
You can also control the positioning of the consent banner by applying styles to the container element (optional). E.g:
#target-container {
position: fixed;
left: 0;
right: 0;
bottom: 0;
z-index: 100;
}
<div id="target-container"></div>
The following global variables are also exposed:
consentManager.version - Version of the consent manager.consentManager.openConsentManager() - Opens the consent manager preferences dialog.consentManager.doNotTrack() - Utility function that returns the user's Do Not Track preference (normalises the cross browser API differences). Returns true, false or null (no preference specified).consentManager.inEU() - The @segment/in-eu inEU() function.consentManager.preferences - Returns an instance of PreferencesManager with the following helper functions:
loadPreferences - returns the cookie value for consent preferencessavePreferences - allows for managing the consent cookie programatically (useful if you want to re-hydrate consent from your own database or prefill consent options)onPreferencesSaved(callback) - allows for subscribing to changes in preferences.All the options are supported. The callback function also receives these exports:
React - Reference to the Preact library (the API is React compatible). Useful for if you need to use virtual DOM in your content.version - Version of the consent manager.openConsentManager() - Opens the consent manager preferences dialog.doNotTrack() - Utility function that returns the user's Do Not Track preference (normalises the cross browser API differences). Returns true, false or null (no preference specified).inEU() - The @segment/in-eu inEU() function.consentManager.preferences - Returns an instance of PreferencesManager with the following helper functions:
loadPreferences - returns the cookie value for consent preferencessavePreferences - allows for managing the consent cookie programatically (useful if you want to re-hydrate consent from your own database or prefill consent options)onPreferencesSaved(callback) - allows for subscribing to changes in preferences.<script>
window.consentManagerConfig = function(exports) {
var React = exports.React
var inEU = exports.inEU
var bannerContent = React.createElement(
'span',
null,
'We use cookies (and other similar technologies) to collect data to improve your experience on our site. By using our website, you՚re agreeing to the collection of data as described in our',
' ',
React.createElement(
'a',
{ href: '/docs/legal/website-data-collection-policy/', target: '_blank' },
'Website Data Collection Policy'
),
'.'
)
var bannerSubContent = 'You can change your preferences at any time.'
var preferencesDialogTitle = 'Website Data Collection Preferences'
var preferencesDialogContent =
'We use data collected by cookies and JavaScript libraries to improve your browsing experience, analyze site traffic, deliver personalized advertisements, and increase the overall performance of our site.'
var cancelDialogTitle = 'Are you sure you want to cancel?'
var cancelDialogContent =
'Your preferences have not been saved. By continuing to use our website, you՚re agreeing to our Website Data Collection Policy.'
return {
container: '#target-container',
writeKey: '<your-segment-write-key>',
shouldRequireConsent: inEU,
bannerContent: bannerContent,
bannerSubContent: bannerSubContent,
preferencesDialogTitle: preferencesDialogTitle,
preferencesDialogContent: preferencesDialogContent,
cancelDialogTitle: cancelDialogTitle,
cancelDialogContent: cancelDialogContent
}
}
</script>
<script
src="https://unpkg.com/@segment/consent-manager@5.3.0/standalone/consent-manager.js"
defer
></script>
The ConsentManager React component is a prebuilt consent manager UI (it's the one we use on https://segment.com) that uses the ConsentManagerBuilder component under the hood. To use it, just mount the component where you want the consent banner to appear and pass in your own custom copy.
Note: Consent Manager is React-based so is not currently compatible with other frameworks such as Vue.js or Angular. In case you want to use it in another framework that is not React, you should use the Standalone implementation.
Using npm:
npm install @segment/consent-manager
Using yarn:
yarn add @segment/consent-manager
import React from 'react'
import { ConsentManager, openConsentManager } from '@segment/consent-manager'
import inEU from '@segment/in-eu'
export default function() {
const bannerContent = (
<span>
We use cookies (and other similar technologies) to collect data to improve your experience on
our site. By using our website, you’re agreeing to the collection of data as described in our{' '}
<a href="/docs/legal/website-data-collection-policy/" target="_blank">
Website Data Collection Policy
</a>
.
</span>
)
const bannerSubContent = 'You can change your preferences at any time.'
const preferencesDialogTitle = 'Website Data Collection Preferences'
const preferencesDialogContent =
'We use data collected by cookies and JavaScript libraries to improve your browsing experience, analyze site traffic, deliver personalized advertisements, and increase the overall performance of our site.'
const cancelDialogTitle = 'Are you sure you want to cancel?'
const cancelDialogContent =
'Your preferences have not been saved. By continuing to use our website, you՚re agreeing to our Website Data Collection Policy.'
return (
<div>
<ConsentManager
writeKey="<your-segment-write-key>"
shouldRequireConsent={inEU}
bannerContent={bannerContent}
bannerSubContent={bannerSubContent}
preferencesDialogTitle={preferencesDialogTitle}
preferencesDialogContent={preferencesDialogContent}
cancelDialogTitle={cancelDialogTitle}
cancelDialogContent={cancelDialogContent}
/>
<button type="button" onClick={openConsentManager}>
Website Data Collection Preferences
</button>
</div>
)
}
In Next.js we do not have an html file where to inject the script. Here we will use the Script component to inject the snippet provided by Segment.
import React from 'react'
import Script from 'next/script'
import { ConsentManager, openConsentManager } from '@segment/consent-manager'
export default function Home() {
const bannerContent = (
<span>
We use cookies (and other similar technologies) to collect data to improve your experience on
our site. By using our website, you’re agreeing to the collection of data as described in our{' '}
<a href="/docs/legal/website-data-collection-policy/" target="_blank">
Website Data Collection Policy
</a>
.
</span>
)
const bannerSubContent = 'You can change your preferences at any time.'
const preferencesDialogTitle = 'Website Data Collection Preferences'
const preferencesDialogContent =
'We use data collected by cookies and JavaScript libraries to improve your browsing experience, analyze site traffic, deliver personalized advertisements, and increase the overall performance of our site.'
const cancelDialogTitle = 'Are you sure you want to cancel?'
const cancelDialogContent =
'Your preferences have not been saved. By continuing to use our website, you՚re agreeing to our Website Data Collection Policy.'
return (
<div>
<Script
id="show-banner"
dangerouslySetInnerHTML={{
__html: `!function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","debug","page","once","off","on","addSourceMiddleware","addIntegrationMiddleware","setAnonymousId","addDestinationMiddleware"];analytics.factory=function(e){return function(){var t=Array.prototype.slice.call(arguments);t.unshift(e);analytics.push(t);return analytics}};for(var e=0;e<analytics.methods.length;e++){var key=analytics.methods[e];analytics[key]=analytics.factory(key)}analytics.load=function(key,e){var t=document.createElement("script");t.type="text/javascript";t.async=!0;t.src="https://cdn.segment.com/analytics.js/v1/" + key + "/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(t,n);analytics._loadOptions=e};;analytics.SNIPPET_VERSION="4.13.2";
analytics.page();
}}();`
}}
/>
<main>
<ConsentManager
writeKey="5V8KznnIFIDh1ejQLbmX7ikfSRa6r8bF"
bannerContent={bannerContent}
bannerSubContent={bannerSubContent}
preferencesDialogTitle={preferencesDialogTitle}
preferencesDialogContent={preferencesDialogContent}
cancelDialogTitle={cancelDialogTitle}
cancelDialogContent={cancelDialogContent}
bannerActionsBlock={true}
/>
<button type="button" onClick={openConsentManager}>
Website Data Collection Preferences
</button>
</main>
</div>
)
}
This section lists the configurable props you can change when loading the out of the box Consent Manager. In this demo, these are all the props you can pass into the returned preferences object.
Type: string
Default: none
The write key analytics.js should be loaded with.
You can find more information here. https://segment.com/docs/connections/find-writekey
Type: array<string>
Default: []
Write keys for other sources so you can include destinations they use in the Consent Manager tool list. This only displays destinations that are not connected to the primary writeKey.
The user’s consent preferences for these tools are not sent to these additional sources, but they are added to the identify call the Consent Manager sends to Segment. The user’s preferences can then be added to a raw data destination (like a data warehouse) or to a user profile in Personas.
Type: function
Default: () => true
Callback function that determines if consent is required before tracking begins. Set to true to show the consent banner, otherwise return false to not show consent banner and start tracking immediately.
The function can return a Promise that resolves to a boolean.
Type: object Default: {}
Object that opts into users into tracking for the different tracking categories. For example {‘Functional’:true}
Type: string or function
Default: dismiss
This option sets the default behavior for the x (close) button on the Consent Manager banner. Available options:
closeBehavior can also be customized - i.e. don't load some categories, but load everything else. For example, if you wanted to load everything except advertising, you could pass the following as closeBehavior:
closeBehavior={
(categories) => ({
...categories,
advertising: false
})
}
Breaking Change (versions < 3.0.0 will default this option true)
Type: boolean
Default: false (as of 3.0.0)
Determines whether or not consent should be implied if the user interacts with the website by clicking anywhere outside the Consent Manager banner.
Type: string
Default: disable
Determines what the Consent Manager does if the user has already made consent selections and it detects new destination tools. (This is determined by checking if the user already has a cookie set on their browser.)
This is relevant when you've added a connected a new destination to any of the sources managed by Consent Manager.
Options:
disable (default) - When you add new destinations, they are set to “disabled” unless a user updates their consent selections by default.enable - When you add new destinations, they are set to “enabled” unless a user updates their consent selections.imply - When you add new destinations, they are enabled or disabled based on the category to which they belong and the user's previous consent to that category.
For example, if a user already consented to the marketingAndAnalytics category, and you add a new destination which is in the Analytics category, that destination will be enabled until the user updates their consent selections.ask - When you add new destinations, the Consent Manager automatically opens the preferences dialog on initialization, and asks the user for their consent again.Type: string
Default: the top most domain and all sub domains
The domain the tracking-preferences cookie should be scoped to.
Type: PropTypes.node
The content of the consent banner.
Type: string
The call to action under the primary text in the Consent Manager banner.
Type: function(object) | boolean
The flag or function to render the actions block. If true value is passed - will render the default buttons block with Accept all and Deny all (required for the GDPR compliance). if the function is passed - will render the passed function into a actions block placeholder.
Function props:
acceptAll: () => void - accept all cookies and close the bannerdenyAll: () => void - deny all cookies and close the bannerchangePreferences: () => void - open the dialogType: string
Default: #fff
The color of the consent banner text.
Type: string
Default: #1f4160
The color of the consent banner background.
Type: boolean
Default: false
Hide the close button of the consent banner.
Type: boolean
Default: false
Show the consent banner as a modal, blocking the interaction while it is not accepted/rejected.
Type: PropTypes.node
Default: Website Data Collection Preferences
The title of the preferences dialog.
Type: PropTypes.node
The top descriptive content of the preferences dialog.
Type: PropTypes.node
Default: Are you sure you want to cancel?
The title of the cancel dialog.
Type: PropTypes.node
The text displayed in the cancel dialog box.
Type: PropTypes.object
Default: undefined
An object that represents custom consent categories, and which tools are included in these categories. For example, for CCPA compliance, you could create a custom “Do Not Sell” category and list relevant destinations to it.
Note: Calling the customCategories object will overwrite the prebuilt categories (Analytics, Functional, Targeting and Advertising) provided by Consent Manager. Those categories will need to be redeclared inside customCategories. You can find examples here and here.
const customCategories = {
'New Category': {
purpose: 'A new consent category to capture more granular consent groupings',
integrations: ['Google Adwords (Classic)', 'Amplitude', 'Slack']
}
}
The values for integrations should be an integration's creationName (integration.creationName). You can find examples of that by going to https://cdn.segment.com/v1/projects/<writeKey>/integrations
Type: PropTypes.object
Default:
{
headings: {
allowValue: 'Allow',
categoryValue: 'Category',
purposeValue: 'Purpose',
toolsValue: 'Tools'
},
checkboxes: {
noValue: 'No',
yesValue: 'Yes'
},
actionButtons: {
cancelValue: 'Cancel',
saveValue: 'Save'
},
cancelDialogButtons: {
cancelValue: 'Yes, Cancel',
backValue: 'Go Back'
},
categories: [
{
key: 'functional',
name: 'Functional',
description:
'To monitor the performance of our site and to enhance your browsing experience.',
example: 'For example, these tools enable you to communicate with us via live chat.'
},
{
key: 'marketing',
name: 'Marketing and Analytics',
description:
'To understand user behavior in order to provide you with a more relevant browsing experience or personalize the content on our site.',
example:
'For example, we collect information about which pages you visit to help us present more relevant information.'
},
{
key: 'advertising',
name: 'Advertising',
description:
'To personalize and measure the effectiveness of advertising on our site and other websites.',
example:
'For example, we may serve you a personalized ad based on the pages you visit on our site.'
},
{
key: 'essential',
name: 'Essential',
description: 'We use browser cookies that are necessary for the site to work as intended.',
example:
'For example, we store your website data collection preferences so we can honor them if you return to our site. You can disable these cookies in your browser settings but if you do the site may not work as intended.'
}
]
}
An object that represents the text fields of the preferences dialog and allows customizing them. We recommend copying the default object and changing the fields as necessary.
Note: All fields are optional. If they are not included in the template (object) the default fields will be used.
Note 2: For categories, you need to provide the key in order to map all the values properly.
The ConsentManagerBuilder React component is a low level render props component for building your own consent manager UI. It abstracts away all the logic for fetching destinations, checking/saving consent and loading analytics.js.
Note: ConsentManagerBuilder is React-based so is not currently compatible with other frameworks such as Vue.js or Angular. In case you want to use it in another framework that is not React, you should use the Standalone implementation.
Using npm:
npm install @segment/consent-manager
Using yarn:
yarn add @segment/consent-manager
For a more detailed/advanced example, checkout the ConsentManager implementation.
import React from 'react'
import { ConsentManagerBuilder } from '@segment/consent-manager'
export default function() {
return (
<ConsentManagerBuilder writeKey="<your-segment-write-key>">
{({ destinations, preferences, setPreferences, saveConsent }) => (
<div>
<h2>Tracking tools</h2>
<ul>
{destinations.map(destination => (
<li key={destination.id}>
<label>
<input
type="checkbox"
checked={Boolean(preferences[destination.id])}
onChange={() =>
setPreferences({
[destination.id]: !preferences[destination.id]
})
}
/>
{destination.name}
</label>
</li>
))}
</ul>
<button type="button" onClick={() => saveConsent()}>
Save
</button>
<button type="button" onClick={() => saveConsent(true)}>
Allow all
</button>
<button type="button" onClick={() => saveConsent(false)}>
Deny all
</button>
</div>
)}
</ConsentManagerBuilder>
)
}
Type: function
The render props function that returns your UI.
Type: string
The write key analytics.js should be loaded with.
Type: array<string>
Default: []
Other write keys that you want to load destination information for. This is useful for including your server-side destinations in the consent manager, so that you can easily apply the user's tracking preferences to your server-side analytics too. No data will be sent to these write keys.
Type: function
Default: () => true
Callback function that determines if consent is required before tracking can begin. Return true to show the consent banner and wait for consent (if no consent has been given yet). Return false to not show the consent banner and start tracking immediately (unless the user has opted out). The function can return a Promise that resolves to a boolean.
Type: object
Default: {}
The initial value of the preferences. By default it should be an object map of {destinationId: true|false|'N/A'}. If you're using mapCustomPreferences it should be an object map of your custom preferences' default values.
Type: string
Default: disable
Determines what the Consent Manager does if the user has already made consent selections and it detects new destination tools. (This is determined by checking if the user already has a cookie set on their browser.)
This is relevant when you've added a connected a new destination to any of the sources managed by Consent Manager.
Options:
disable (default) - When you add new destinations, they are set to “disabled” unless a user updates their consent selections by default.enable - When you add new destinations, they are set to “enabled” unless a user updates their consent selections.imply - When you add new destinations, they are enabled or disabled based on the category to which they belong and the user's previous consent to that category.
For example, if a user already consented to the marketingAndAnalytics category, and you add a new destination which is in the Analytics category, that destination will be enabled until the user updates their consent selections.ask - When you add new destinations, the Consent Manager automatically opens the preferences dialog on initialization, and asks the user for their consent again.This setting also also affects Replays to new destinations. Only disable and enable apply to these replays. If you set defaultDestinationBehavior to imply, Segment interprets this as enable during a replay.
Type: function
Default: undefined
Callback function allows you to use a custom preferences format (e.g: categories) instead of the default destination based one. The function gets called during the consent saving process and gets passed (destinations, preferences). The function should return {destinationPreferences, customPreferences} where destinationPreferences is your custom preferences mapped to the destinations format ({destiantionId: true|false}) and customPreferences is your custom preferences if you changed them in the callback (optional).
Type: string
Default: the top most domain and all sub domains
The domain the tracking-preferences cookie should be scoped to.
Type: boolean
Default: true
Reload the page if the trackers have already been initialized so that the user's new preferences can take effect.
Type: boolean
Default: false
Disable the analitics.load to make local testing.
Type: array<object>
Default: []
Destinations enabled for the provided write keys. Each destination contains these properties:
{
id,
name,
description,
website,
category
}
Type: array<object>
Default: []
New destinations that have been enabled since the user last gave consent.
Type: object
Default: {}
The current preferences in state. By default if should be in the format of {destinationId: true|false}, but if you're using mapCustomPreferences the object map can be in any format you want. Note: this isn't the saved preferences.
Type: object
Default: {}
The current destination specific preferences, i.e. {Amplitude: true}.
Type: boolean
Default: false
A boolean value representing whether or not the user has changed their preferences since opening the preferences modal. Will be set to true if the user interacts with the preferences modal by selecting "Yes" or "No" on any of the consent categories.
This is used to not reload the page if no preferences have changed, as to not create a disruptive user experience.
Type: boolean
Default: true
The result of shouldRequireConsent.
Type: boolean
Default: false
A boolean value representing whether or not there have been new destinations connected to the source(s) managed by Consent Manager, compared to the destinations set on the existing cookie.
Type: function(object|boolean)
Sets a preference to a new value in state. By default it takes an object map in the format of {destinationId: true|false}, but if you're using mapCustomPreferences the object map can be in any format you want. It behaves like setState() in that you can set one or more preferences at a time and they get merged with what's currently in state. You can also pass a boolean to set all destination preferences to true or false (you shouldn't do this if you're using mapCustomPreferences).
Type: function
Resets the preferences state to the value saved in the cookie. Useful for resetting the state when the preferences dialog is closed without saving for example.
Type: function(object|boolean)
Saves the preferences currently in state to a cookie called tracking-preferences, triggers an identify call with destinationTrackingPreferences and customTrackingPreferences traits and then reloads analytics.js using the new preferences. It can also be passed preferences like setPreferences to do a final update before saving.
Type: function(object)
Allows you to manually handle if there is an error when initializing - e.g. if there is an ad blocker that prevented fetching the destinations. This will prevent an uncaught error e.g. Failed to fetch.
openConsentManager() - Opens the ConsentManager preferences dialog.doNotTrack() - Returns the user's Do Not Track preference (normalises the cross browser API differences). Returns true, false or null (no preference specified).Analytics.js generates a universally unique ID (UUID) for the viewer during the library’s initialization phase, and sets this as anonymousId for each new visitor to your site. This happens before Analytics.js loads any device-mode destinations, and so before these destination-libraries can generate their own user IDs.
Example
ajs_anonymous_id=%2239ee7ea5-b6d8-4174-b612-04e1ef3fa952
You can override the default-generated anonymousID from the Segment snippet.
analytics.SNIPPET_VERSION = '4.13.2'
analytics.page()
analytics.setAnonymousId('YOUR_CUSTOM_ID')
Note: Keep in mind that setting the anonymousId in Analytics.js does not overwrite the anonymous tracking IDs for any destinations you’re using.
There are other ways to override the anonymousID, you can find more information here.
To run our storybook locally, simply do:
$ yarn dev
and the storybook should be opened in your browser. We recommend adding a new story for new features, and testing against existing stories when making bug fixes.
This package follows semantic versioning. To publish a new version:
$ npm version <new-version>
$ npm publish
consent-manager is released under the MIT license.
Copyright © 2021, Segment.io, Inc.
5.8.1 (May 30, 2023)
N/A.FAQs
Drop-in consent management plugin for analytics.js
The npm package @segment/consent-manager receives a total of 24,253 weekly downloads. As such, @segment/consent-manager popularity was classified as popular.
We found that @segment/consent-manager demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 275 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.