Setting up and working with the Prebid User ID

Add, configure, and manage Prebid User ID modules in HB Manager.

Use Prebid User ID modules to work with supported identity vendors.

Configure each module at the global or site level.

1. Add a User ID module

First, add the identity vendor to your Prebid.js build.

1. Go to Configuration → Integrations.

2. Select New User ID Module.

3. Select the identity vendor.

Add a new User ID module

Some vendors require credentials, such as a partner ID or custom URL. Obtain these from the vendor before configuration.

2. Enable and configure the module

Enable the module where it should apply. Use global settings for all traffic. Use site settings for a specific site.

1. Go to HB Management → Global HB Management → Prebid parameters.

2. Select User ID Modules.

3. Enable the module and enter its settings.

Enable User ID modules

3. Configure module settings

Set the vendor fields and storage behavior for the enabled module.

Setting	Description	Prebid.js equivalent
Required and optional fields	Add vendor-specific credentials, such as a partner ID or key.	modules[].params
Storage type	Choose where the browser stores the ID, such as local storage or a cookie.	storage.type
Storage time	Set how long the ID remains valid, in days.	storage.expires
Refresh interval	Set how often the module checks or generates an ID, in seconds.	storage.refreshInSeconds

Save the settings to activate the module for the selected scope.

Vendor requirements

Review the Prebid User ID sub-modules reference for supported vendors and required fields.

For other implementation options, see Formats and channels.