index.md

layout	title	description	sidebarType
page_v2	Prebid.js Modules	Module Documentation	1

Prebid.js Module Overview

{:.no_toc}

The core of Prebid.js contains only the foundational code needed for header bidding. Any functionality that could be considered an add-on is part of a module. These are the major categories:

• Bidder adapters

• Analytics adapters

• Any other extensible functionality - documented on this page

• TOC {:toc}

{% assign module_pages = site.pages | where: "page_type", "module" %}

Recommended Modules

Prebid.org highly recommends that publishers utilize the following modules:

{% for page in module_pages %}{% if page.recommended == true %} {% endif %}{% endfor %}

Module	Description
{{page.display_name}}	{{page.description}}

General Modules

Modules in the Real-Time Data (RTD) category conform to a consistent set of publisher controls. The publisher can choose to run multiple RTD modules, define an overall amount of time they're willing to wait for results, and even flag some of the modules as being higher priority than others. See the realTimeData setConfig reference for more details.

{% for page in module_pages %}{% if page.recommended == true or page.vendor_specific == true or page.enable_download == false %}{% continue %}{% endif %} {% if page.module_type == "rtd" %}{% else %}{% endif %} {% endfor %}

Module	Description	RTD?
{{page.display_name}}	{{page.description}}	yes	no

Vendor-Specific Modules

These modules may require accounts with a service provider.

{% for page in module_pages %}{% if page.recommended == true or page.enable_download == false %}{% continue %}{% endif %}{% if page.vendor_specific == true %} {% if page.module_type == "rtd" %}{% else %}{% endif %} {% endif %}{% endfor %}

Module	Description	RTD?
{{page.display_name}}	{{page.description}}	yes	no

User ID Modules

UserID modules conform to a consistent set of publisher controls. The publisher can choose to run multiple user id modules, define an overall amount of time they're willing to wait for results. See the userSync setConfig reference and the User ID Module for more details.

{% assign userid_module_pages = site.pages | where: "layout", "userid" %}

{% for page in userid_module_pages %} {% endfor %}

Module	Description	EID Source
{{page.title}}	{{page.description}}	{{page.eidsource}}

Further Reading

• Source code of all modules
• How to add a Bid Adapter
• How to add an Analytics Adapter
• How to add a Real Time Data Submodule