The Prebid Server Adapter is a meta-adapter. It’s not an actual bidder, but rather a way to get a batch of bids from other bidders with one request. A request for the set of auctions is sent to Prebid Server, which performs all the auctions server-to-server (S2S), responding in time for Prebid.js to send the results to the ad server. This lightens the performance load on the user’s device.
Video notes:
Here’s an example config enabling the AppNexus Prebid Server:
pbjs.setConfig({
s2sConfig: {
accountId : '12345',
bidders : ['appnexus','pubmatic', 'rubicon'],
defaultVendor: 'appnexus',
timeout: 300
}
});
To use multiple prebid servers, just define s2sConfig
as an array.
The same bidder cannot be set in both configs. For example:
pbjs.setConfig({
s2sConfig: [
{
name: "pbs-appnexus",
accountId: '12345',
bidders: ['appnexus','pubmatic'],
defaultVendor: 'appnexus',
timeout: 300,
},
{
name: "pbs-rubicon",
accountId: '678910',
bidders: ['rubicon'],
defaultVendor: 'rubicon',
timeout: 300,
},
],
});
There are many configuration options for s2sConfig:
Attribute | Scope | Type | Description |
---|---|---|---|
accountId |
Required | String | Your Prebid Server account ID. This is obtained from whoever’s hosting your Prebid Server. |
name |
Optional | String | A handle for this configuration, used to reference a specific server (when multiple are present) from ad unit configuration |
bidders |
Optional | Array of Strings | Which bidders auctions should take place on the server side |
allowUnknownBidderCodes |
Optional | Boolean | Allow Prebid Server to bid on behalf of bidders that are not explicitly listed in the adUnit. See important note below. Defaults to false . |
defaultVendor |
Optional | String | Automatically includes all following options in the config with vendor’s default values. Individual properties can be overridden by including them in the config along with this setting. See the Additional Notes below for more information. |
enabled |
Optional | Boolean | Enables this s2sConfig block - defaults to false |
timeout |
Optional | Integer | Number of milliseconds allowed for the server-side auctions. This should be approximately 200ms-300ms less than your Prebid.js timeout to allow for all bids to be returned in a timely manner. Defaults to 75% of bidderTimeout or 750ms, whichever is lesser. |
adapter |
Required | String | Adapter to use to connect to Prebid Server. Defaults to ‘prebidServer’ |
endpoint |
Required | URL or Object | Defines the auction endpoint for the Prebid Server cluster. See table below for object config properties. |
syncEndpoint |
Required | URL or Object | Defines the cookie_sync endpoint for the Prebid Server cluster. See table below for object config properties. |
userSyncLimit |
Optional | Integer | Max number of userSync URLs that can be executed by Prebid Server cookie_sync per request. If not defined, PBS will execute all userSync URLs included in the request. |
syncTimeout |
Optional | Integer | Maximum number of milliseconds allowed for each server-side userSync to load. Default is 1000. |
syncUrlModifier |
Optional | Object | Function to modify a bidder’s sync url before the actual call to the sync endpoint. Bidder must be enabled for s2sConfig. |
coopSync |
Optional | Boolean | Whether or not PBS is allowed to perform “cooperative syncing” for bidders not on this page. Publishers help each other improve match rates by allowing this. Default is true. |
defaultTtl |
Optional | Integer | Configures the default TTL in the Prebid Server adapter to use when Prebid Server does not return a bid TTL - 60 if not set |
adapterOptions |
Optional | Object | Arguments will be added to resulting OpenRTB payload to Prebid Server in every impression object at request.imp[].ext.BIDDER. See the example above. |
extPrebid |
Optional | Object | Arguments will be added to resulting OpenRTB payload to Prebid Server in request.ext.prebid. See the examples below. |
customHeaders |
Optional | Object | These custom headers will be included in the XHR call to the bidder’s endpoint. This will allow you to send data specific to your use case. The format consists of an object where the keys represent the header names and the values correspond to the respective header values. Here is an example how a customHeader object might look like - {"Header1": "Value1", "Header2": "Value2"} |
If endpoint
and syncEndpoint
are objects, these are the supported properties:
Attribute | Scope | Type | Description |
---|---|---|---|
p1Consent | Required | String | Defines the auction endpoint or the cookie_sync endpoint for the Prebid Server cluster for non-consent requests or users who grant consent. |
noP1Consent | Required | String | Defines the auction endpoint or the cookie_sync endpoint for the Prebid Server cluster for users who do not grant consent. (This is useful for a server configured to not accept any cookies to ensure compliance regulations.) |
Notes on s2sConfig properties
defaultVendor
option, accountId
still needs to be defined.bidders
is omitted, only adUnits that also omit bidders will be sent to Prebid Server. See the stored impressions example below.s2sConfig
timeout is not specified, Prebid Server will utilize a configured default for tmax
.endpoint
or syncEndpoint
object configs, you should define both properties. If either property is not defined, Prebid Server requests for that type of user will not be made. If you do not need to distinguish endpoints for consent reasons, you can simply define the same URL value in both fields or use the String version of the field (which is configured to use defined URL for all users).allowUnknownBidderCodes
is true
, bidders that have not been explicitly requested in adUnit.bids
may take part in the auction. This can break custom logic that relies on the availability of a bid request object for any given bid. Known scenarios where custom code won’t get the request when there’s an “unknown bidder”:
bidRequested
event.payload.bidRequest
will be undefined.Additional options for s2sConfig
may be enabled by including the Server-to-Server testing module.
Passing the Referrer to Server Side Adapters
extPrebid.origreferrer
will be recognized by some server-side adapters as the referring URL for the current page.Emitting SeatNonBid Data
extPrebid.returnallbidstatus
equal to true
. Note that client-side analytics adapters can receive this data by listening to the seatNonBid
event.Bid params are sourced from the adapter configurations set for client side. These do not need to change for Prebid Server.
Errors in bidder parameters will cause Prebid Server to reject the entire request. The Prebid Server philosophy is to avoid silent failures – we assume you will test changes, and that it will be easier to notice a 4xx error coming from the server than a silent failure where it skips just the bad parameter.
s2sConfig example with the endpoint attributes defined instead of using the ‘defaultVendor’ approach:
pbjs.setConfig({
s2sConfig: [{
accountId: '1001',
bidders: ['bidderA', 'bidderB'],
endpoint: 'https://mypbs.example.com/path',
syncEndpoint: 'https://mypbs.example.com/path',
timeout: 300
}]
})
A similar example with the endpoint attributes defined as objects:
pbjs.setConfig({
s2sConfig: [{
accountId: '1001',
bidders: ['bidderA', 'bidderB'],
endpoint: {
p1Consent: 'https://mypbs.example.com/path',
noP1Consent: 'https://mypbs2.example.com/path'
},
syncEndpoint: {
p1Consent: 'https://mypbs.example.com/path',
noP1Consent: 'https://mypbs2.example.com/path'
},
timeout: 300
}]
})
You may want to run a particular bidder on the client for banner, but that same bidder on the server for video. You would do this by setting a server-side alias. For example:
pbjs.setConfig({
s2sConfig: [{
accountId: '1',
bidders: ['tripleliftVideo'],
defaultVendor: 'appnexus',
timeout: 500,
extPrebid: {
aliases: {
tripleliftVideo: tripleLift
}
}
}]
})
Here’s how it works:
Supporting video through the Server-to-Server route can be done by providing a couple of extra arguments on the extPrebid
object. e.g.
pbjs.setConfig({
s2sConfig: [{
accountId: '1001',
bidders: ['rubicon', 'pubmatic'],
defaultVendor: 'rubicon',
timeout: 250,
extPrebid: {
cache: {
vastxml: {returnCreative: false}
},
targeting: {
pricegranularity: {"ranges": [{"max": 40.00, "increment": 1.00}]}
}
}
}]
})
Prebid Server stored requests can be requested through the adUnit ortb2Imp
property. This is useful to move the list of bidders and parameters from the page to blocks of JSON stored on the server. For these cases, it’s not necessary to specify bids
:
pbjs.addAdUnits([{
code: 'example-stored-request',
mediaTypes: {
banner: {
sizes: [[300, 250]]
}
},
ortb2Imp: {
ext: {
prebid: {
storedrequest: {
id: 'your-stored-request-id'
}
}
}
}
}])
For debugging purposes, it can be useful to have a page that retrieves a static value rather than running an actual auction. For this you can use PBS stored responses. Here’s an example:
pbjs.addAdUnits([{
code: 'example-stored-response',
mediaTypes: {
banner: {
sizes: [[300, 250]]
}
},
ortb2Imp: {
ext: {
prebid: {
storedauctionresponse: {
id: 'your-stored-response-id'
}
}
}
}
}])