User ID module

Last edited: 2024/12/09

The User ID module supports various methods of establishing pseudonymous IDs for users, which significantly increases the value of header bidding. Instead of multiple exchanges syncing IDs with numerous demand sources, you can integrate with several different ID schemes, streamlining the process.

<aside> <img src="/icons/link_yellow.svg" alt="/icons/link_yellow.svg" width="40px" /> See Prebid documentation on User ID modules: link

</aside>

You can use:

• Own accounts - meaning that you have direct contact signed with a given user ID module provider

• Yieldbird accounts - meaning you do not have a direct contract signed with an ID module provider, and want to use Yieldbird’s contract.

  <aside> <img src="/icons/arrow-right_green.svg" alt="/icons/arrow-right_green.svg" width="40px" /> Good practice: User ID providers are paid for by the buy side, so using Yieldbird accounts is completely free of charge. This can save you a lot of time spent on the legal process of signing a direct contract with the provider.

  </aside>

Is there privacy compliance with Prebid’s User ID Module?

When combined with the Consent Management module (Consent management), privacy regulations are enforced by User ID module as follows:

• The module verifies the GDPR consent string.
• If the consent string is absent or the user has not agreed to Purpose 1 (local storage):
  • No calls are made to external user ID vendors.
  • No data is stored in cookies or HTML5 local storage.

Adding a User ID modules

<aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" /> If you can’t find the User ID that you want to add on the list, please let us know!

We can add any User ID that is currently compatible with Prebid. Simply ask your Customer Success Manager for the User ID you need, and we will add it in the next development sprint.

<aside> <img src="/icons/link_yellow.svg" alt="/icons/link_yellow.svg" width="40px" /> See the list of User ID sub-modules that can be added in the Prebid.org documentation.

</aside>

Please mark that in case you need Yieldbird to provide you with the account, the process will take longer as we will have to sign a contract with the requested User ID provider.

</aside>

<aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" /> The list of currently integrated User Id sub-modules: see list.

</aside>

In the Old Platform

Adding User ID on Workspace level

First, you must add the User ID module to the workspace and define its basic parameters. To do that:

1. Go to Setup > Modules > User IDs

2. When you want to use Own account (meaning you do have a direct contract signed with the ID module provider):

   1. Go to section Own user ID accounts
   2. Select the User ID adapter from the dropdown list of available adapters and click ‘Add’.
   3. Fill in the required parameters and click Confirm. Optional parameters are available to view and fill in when you click More.

3. When you want to use Yieldbird’s account (meaning that you do not have a direct contract signed with the ID module provider):

   1. Go to section Yieldbird user ID accounts
   2. Select the User ID adapter from the dropdown list of available adapters and click ‘Add’

   <aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" /> Since all required parameters for Yieldbird accounts have already been added to the configuration, you can use the User ID immediately.

   </aside>

4. Click ‘Save’ at the bottom

<aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" /> To use the User ID on your inventory, you must activate it on specific Domains first (see paragraph below).

</aside>

Activating User ID on Domain level

Then, you must select the domains on which you want the module to work. To do that:

1. Go to Prebid Stack > Inventory > Domains > select the domain you want to edit

2. Go to the Module connectors section, and toggle it on.

3. Select the checkbox next to the User ID you want to activate on this domain and click Save.

   

In the New platform

In the new version of the Yieldbird Platform, you can select whether to use your own accounts or Yieldbird’s accounts within the Vendor Specific Modules. The flow is similar regardless of the account type you choose.

1. Adding User ID module on Workspace level

To add a Vendor Specific Module to the workspace and define its default parameters:

1. Go to Global setup > Prebid > Modules > User IDs and click ‘Add new’.
2. Based on your account type, follow the steps below:

   • For Your Own Account:

     1. Select Account type as Own, then choose the User ID you want to configure from the dropdown menu.

     2. Fill in the required parameters and click ‘Save’. You will be redirected to the overview table of all User IDs where the newly added module will appear at the top of the list.

        <aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" />

        In this view, you set Default Parameters that apply to all Domains. If you need to set different parameters for specific Domains you can do it later on (see the paragraph below).

        </aside>

   • For Yieldbird’s Account (used when you do not have a direct contract with the module provider):

     1. Select Account type as Yieldbird, choose the module from the dropdown menu, and click ‘Save’.
     2. The necessary params will be automatically handled by the Platform
3. To activate the module on your inventory:

   1. Toggle it <on> at the Workspace level:

      

   2. Activate it for specific Domains (see the instructions below).

      <aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" />

      In this view, you set Default Parameters that apply to all Domains. If you need to set different parameters for specific Domains you can do it later on (see the paragraph below).

      </aside>

Activating User ID modules on specific Domains

To enable a User ID Module for specific Domains:

1. Go to Global setup > Prebid > Modules > User IDs and click the module you want to activate for a specific Domain.
2. Navigate to the Module params & connection tab.
3. Use the On/off on Domain toggle to enable the module for your selected Domains.
4. Optionally, customize the module parameters for specific Domains:
   • Provide values in the input boxes for the parameters you wish to customize.
   • Leave the input boxes empty to apply the default workspace parameters.
   • For each Domain you can customize a single param or all params.
5. Click ‘Save’.

You can also manage User ID Modules connection directly within the Domains view:

1. Go to Inventory > Domains > select the Domain to edit > Prebid Stack.
2. Scroll down to the Modules paper and use the On/off on Domain toggle to enable the desired User ID Module for that Domain.
3. Click ‘Save’.

<aside> <img src="/icons/new-alert_red.svg" alt="/icons/new-alert_red.svg" width="40px" />

</aside>

<aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" />

</aside>