Note: This should only be implemented if Userlane is on an external application for private individuals (B2C) and only the Userlane analytics (not guidance) is in use.
Userlane should be configured as a functional cookie in the cookie banner. If a user opts out of the functional cookie, Userlane won’t load, and no Userlane content will be available for this specific user.
Please complete the following instructions:
1. Executing Userlane after the user has provided cookie consent
- The Userlane ‘init’ (short for initialize) command is used in conjunction with a Userlane-specific property ID to execute a customer instance of Userlane.
- Trigger the ‘init’ command after the user has accepted Userlane cookies. This can be done by configuring a logic where the ‘init’ command is only triggered if and when the user has accepted the cookies.
- The Userlane API ‘init’ command Userlane(‘init’, your_property_id); is customer-specific and requires your specific property ID, which can be found in the Userlane Portal.
2. Removing Userlane if a user has adjusted their cookie preferences
The Userlane ‘remove’ command can be used to withdraw the initialization of the Userlane product.
Trigger the ‘remove’ command after the user has adjusted their cookie settings. This can be done by configuring logic that triggers the ‘remove’ command if the user changes their cookie preferences and chooses not to accept Userlane cookies if they have been classified as functional.
Notably, the customer must also ensure that this user's cookie preferences are stored and that the Userlane ‘init’ command is not executed for that user again at a later time.
The Userlane API ‘remove’ command Userlane('removeUserlane'); is global and does not require the use of a specific id in order to withdraw the Userlane product from the application.
More information on working with the Userlane API can be found in the Userlane API documentation.
