Vendor specific (RTD) Prebid Modules

Last edited: 2024/12/09

Vendor-specific modules are optional add-ons that extend Prebid's functionality with features tailored to specific ad tech vendors or services. These modules typically provide:

1. Integration with proprietary ad technologies
2. Custom bidding algorithms
3. Specialized reporting or analytics
4. Unique ad format support
5. Vendor-specific data enrichment

Examples include modules for specific consent management platforms, viewability measurement providers, or ad quality scanners. These modules allow publishers to incorporate vendor-specific capabilities into their Prebid setup without modifying the core Prebid code. Vendor-specific modules are usually developed and maintained by the vendors themselves, adhering to Prebid's module development guidelines. They provide a way for vendors to offer their unique services within the Prebid ecosystem while maintaining compatibility with the overall header bidding process.

In the Yieldbird Platform 2.0, Vendor Specific Modules include also Analytics Adapters (they are used to gather and analyze data related to the performance and behavior of header bidding auctions managed through the Prebid.js framework).

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

• Vendor specific ID modules: link
• Analytics adapters: link </aside>

Adding a Vendor specific module

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

We can add any Vendor specific module that is currently compatible with Prebid. Simply ask your Customer Success Manager for the Vendor specific module 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 Vendor specific modules currently available in Prebid.org that can be added.

</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 provider.

</aside>

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

The list of currently integrated:

• Vendor specific Prebid modules: see list.
• Analytics Adapters: see list. </aside>

In the Old Platform

1. Adding your Vendor specific modules on workspace level

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

1. Go to Prebid Stack > Setup > Modules > Vendor specific

   

2. Select the adapter from the dropdown of either Brand protection or Analytics and click ‘Add’.

3. Input the necessary parameters, click Confirm, and later ‘Save’.

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

</aside>

2. Activating your Own vendor specific modules on Domain level

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

1. Once you have the module added on the workspace level, 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 module 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 Vendor specific 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 > Vendor Specific Modules 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 Vendor Specific Module 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 Vendor Specific Modules 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 ‘Send request’.
     2. The Yieldbird team will handle the whitelisting process and add your Domains to the selected vendor. Once completed, you will be notified and can start using the module.

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

     Please note that some Vendor Specific Modules may decline the whitelisting of your Domains for use with Yieldbird’s accounts. If this occurs, we will inform you.

     </aside>

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).

Activating Vendor specific modules on specific Domains

To enable a Vendor Specific Module for specific Domains:

1. Go to Global setup > Prebid > Modules > Vendor Specific Modules 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 Vendor Specific 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 Vendor Specific Module for that Domain.
3. Click ‘Save’.

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

Attention: Remember - the Module will be active on a given Domain only if it is toggled <on> on Workspace.

</aside>

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

Some Vendor specific modules may require adjusting auctionDelay. Learn more about how to do this.

</aside>