Prebid.js Module Overview

The core of Prebid.js contains only the foundational code needed for header bidding. Any functionality that could be considered an add-on or that covers a special case is being moved out into modules. Examples of this kind of code include:

  • Bidder adapters
  • Special auction logic
  • Ad server API integrations
  • Any other extensible functionality

This section of the site contains user-submitted module documentation. We’re hoping that it will grow over time.

To see all of the modules that are available, see the modules folder in the repo.

If you are looking for bidder adapter parameters, see Bidders’ Params.

Modules

Module Description
Currency Converts bid currency into ad server currency based on data in a supplied exchange rate file.
DFP Express A simplified installation mechanism for publishers that have DoubleClick Google Publisher Tag (GPT) ad calls in their pages.
DigiTrust A method of including the standard cross-domain ID in a DigiTrust package.
Server-to-Server Testing Adds A/B test support for easing into server-side header bidding.
DFP Video Required for serving instream video through DFP.
User ID Supports Unified ID, PubCommon ID, DigiTrust, and ID5 ID.
Publisher Common ID (Deprecated - please use User ID module) Adds a persisted user ID in the publisher’s domain.
GDPR ConsentManagement Facilitates collecting/passing consent information in support of the EU GDPR.
IAB Category Translation Converts IAB sub category to Ad server category for long-form videos.
Freewheel Passes key value targeting to Freewheel SDK
Ad Pod Enables developers to add support for a new adserver that handles ad pod (long-form) videos

Further Reading