Prebid.org provides step-by-step instructions for manually configuring Prebid in the following ad servers:
If you’re using a different ad server, you can use the general instructions provided here and adapt them to your ad server.
Prebid.org documentation is open source, so if you would like to add instructions for your ad server, create a PR in our Github repository.
We recommend reviewing the Ad Ops Planning Guide before adding items to your ad server.
At a high level, configuring an ad server to work with Prebid involves creating a set of always-on objects in your ad server that listen for bids and, when chosen, return the appropriate ad creative that will render the ad for the winning bid.
For the purposes of this discussion, we’re going to refer to the elements in your ad server that contain the details of the bid, such as the price, priority, and media format, as “line items.” Line Items live in a container that we’ll refer to as an “order”. These elements may have different names in your ad server.
Ad servers typically work in a hierarchical structure, with advertisers containing orders, which in turn contain line items. You need to have your advertisers and orders set up before you can start creating line items and creatives. The advertisers you create for Prebid will typically depend on whether you’re sending all bids or only the top price bid to the ad server.
If you’re working with native inventory, you’ll most likely need to have your native template created and stored before you begin creating your line item. Follow your ad server’s instructions for setting up native creative templates.
When you create your line item, you’ll be targeting key-value pairs that are being sent with the ad request to the ad server. You may need to predefine these keys and values before targeting them in your line items.
See Key Values for information on the keys you’ll need.
The exact order of the following steps will differ depending on your ad server.
Prebid – banner - BidderA – 1.50.hb_pb_cat_dur key. See Targeting below for more information.You’ll need to apply custom targeting specific to the Prebid values that are passed in with the ad request.
These instructions assume you’re sending all bids to the ad server (the default). If you’re sending only the top price bid, your targeting keys will not include the bidder code. For example, rather than targeting price buckets with hb_pb_BidderA, you’ll target hb_pb. See Send All Bids vs Top Price for more information.
Target the price bucket key: hb_pb_BIDDERCODE (where BIDDERCODE is the actual code for your bidder, such as BidderA) with the value of the price bucket you entered as the price for this line item.
The following additional keys must be added for the corresponding formats:
Banner/Non-InstreamVideo/Native:
You can use the same line item for banner, non-instream (formerly called “outstream”), and/or native creatives. If your ad slot could be filled by two or more of these formats, you should include the hb_format_BIDDERCODE key with values specifying all expected formats.
If you combine native with another format in a single line item, you’ll need to add creative-level targeting to designate which creatives target which format. If your ad server doesn’t support creative-level targeting, you may need to break out a separate set of line items.
In-Player and In-Renderer Video:
Both in-player (instream) and in-renderer (formatly “outstream”) video ads receive the hb_format_BIDDERCODE=video key-value pair, so targeting on that key alone is not enough to choose the correct line items. If you’re running both in-player and in-renderer video ads, they will most likely be separate line items, so you will need to target non-instream line items to a “display” inventory type, or perhaps separate them by adunits.
Long-Form (OTT) Video:
For long-form video the custom key hb_pb_cat_dur_BIDDERCODE is required. The value of this key breaks down like this:
For example, for a line item with a $10.00 CPM as the price, a competitive exclusion of “news”, and 30s entered for the video duration, you would enter the following in the custom key-value field: hb_pb_cat_dur_BIDDERCODE = 10.00_news_30s. If you’re not using competitive exclusion, you can have a value such as this: hb_pb_cat_dur_BIDDERCODE = 10.00_30s.
For deals, the price bucket portion of this value will contain the dealID if deals are prioritized. See Getting Started with Long Form Video for more information.
Engineers will need to include the Adpod module and the Category Translation module in Prebid.js to implement long-form video bidding.
If your ad server supports targeting creatives within the line item, it could come in handy. For example, if you’re going to use a single line item for multiple formats, or if you have multiple video cache locations, you’d need to set additional targeting that’s specific to the creative rather than at the line item level.
You’ve now added all fields required for targeting Prebid line items. You can add any other line item options you would normally use, such as additional targeting for geography. When you’ve filled in all the appropriate fields, save your line item.
The process of creating your creatives will differ based on the type of creative.
In general, you can interpret the instructions for setting up creatives in Google Ad Manager with some modifications; specifically, to the MACROs used in the ad tag. (See below for details.) Refer to the following for GAM documentation:
We recommend using the Prebid Universal Creative and targeting an ad unit size of 1x1.
If you’re working with banner or in-renderer creatives, the HTML you’ll enter in the creatives will be similar to the following (utilizing whatever macro format is supported by your ad server):
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@latest/dist/%%PATTERN:hb_format%%.js"></script>
<script>
var ucTagData = {};
ucTagData.adServerDomain = "";
ucTagData.pubUrl = "%%MACRO:url%%";
ucTagData.adId = "%%MACRO:hb_adid_BIDDERCODE%%";
ucTagData.cacheHost = "%%MACRO:hb_cache_host_BIDDERCODE%%";
ucTagData.cachePath = "%%MACRO:hb_cache_path_BIDDERCODE%%";
ucTagData.uuid = "%%MACRO:hb_cache_id_BIDDERCODE%%";
ucTagData.mediaType = "%%MACRO:hb_format_BIDDERCODE%%";
ucTagData.env = "%%MACRO:hb_env%%";
ucTagData.size = "%%MACRO:hb_size_BIDDERCODE%%";
ucTagData.hbPb = "%%MACRO:hb_pb_BIDDERCODE%%";
try {
ucTag.renderAd(document, ucTagData);
} catch (e) {
console.log(e);
}
</script>
%%MACRO%% with the appropriate macro for your ad server. (Refer to your ad server’s documentation or consult with a representative for specific details regarding the proper macros and how to use them.)ucTagData.adId = "%%PATTERN:hb_adid_BidderA%%";.%%PATTERN:hb_format%%.js with creative.js.The example above uses the jsdelvr CDN as the domain from which the creative will serve. However, you may obtain the creative from a managed service or host it yourself. You might need to edit the creative and make adjustments to your creative settings depending on the CDN you’re using.
The final steps in configuring Prebid on your ad server are to do the following: