Skip to content

Commit 26a191f

Browse files
authored
added note about PBS rejecting auctions for bad params (prebid#1407)
1 parent b0a46ab commit 26a191f

File tree

2 files changed

+35
-16
lines changed

2 files changed

+35
-16
lines changed

dev-docs/bidders/prebidServer.md

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,30 @@ layout: bidder
33
title: Prebid Server
44
description: Prebid Server S2S Adaptor
55
biddercode: prebidServer
6-
biddercode_longer_than_12: true
76
hide: true
8-
media_types: video
7+
media_types: banner, video
98
gdpr_supported: true
109
---
1110

12-
### Sign up
11+
### Overview
1312

14-
Sign up for account on [prebid.adnxs.com](https://prebid.adnxs.com)
13+
The Prebid Server Adapter is a meta-adapter. It's not an actual bidder, but
14+
rather a way to get a batch of bids from other bidders with one request.
15+
A request for the set of auctions is sent to Prebid Server, which performs
16+
all the auctions server side (S2S), responding in time for Prebid.js to
17+
send the results to the ad server. This lightens the performance load on the user's device.
1518

1619
### Bid Params
1720

1821
Bid params are sourced from the adapter configurations set for client side. These do not need to change for Prebid Server.
1922

23+
{: .alert.alert-warning :}
24+
**Errors in bidder parameters will cause Prebid Server to reject the
25+
entire request.** The Prebid Server philosophy is to avoid silent failures --
26+
we assume you will test changes, and that it will be easier to notice a
27+
4xx error coming from the server than a silent failure where it skips just
28+
the bad parameter.
29+
2030
### Configuration
2131
To enable prebid server, set the following configuration.
2232

@@ -25,7 +35,8 @@ pbjs.setConfig({
2535
s2sConfig: {
2636
accountId : '12345',
2737
bidders : ['appnexus','pubmatic', 'rubicon'],
28-
defaultVendor: 'appnexus'
38+
defaultVendor: 'appnexus',
39+
timeout: 300
2940
}
3041
});
3142
```
@@ -34,16 +45,17 @@ Configuration options
3445
{: .table .table-bordered .table-striped }
3546
| Field | Type | Required? | Description |
3647
|--------------+---------------+-----------+--------------------------------------------------------------------------|
37-
| `accountId` | String | X | Prebid Server account ID. |
38-
| `bidders` | Array[String] | X | List of bidder codes; must have been enabled during Prebid.js build. |
39-
| `defaultVendor` | 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. |
40-
| `enabled` | Boolean | X | Enables S2S; default: `false`. |
41-
| `endpoint` | String | X | Set the endpoint. For example: `https://prebid.adnxs.com/pbs/v1/openrtb2/auction` |
42-
| `timeout` | Number | | Bidder timeout, in milliseconds; default: `1000`. |
43-
| `syncEndpoint` | String | | Configures the user-sync endpoint. Highly recommended. |
44-
| `adapter` | String | | Adapter code; default: `"prebidServer"`. |
45-
| `secure` | Integer | | Override Prebid Server's determination of whether the request needs secure assets. Set to `1` to force secure assets on the response, or `0` for non-secure assets. |
46-
| `adapterOptions` | Object | | Arguments will be added to resulting OpenRTB payload to Prebid Server. |
48+
| `accountId` | String | yes | Prebid Server account ID. |
49+
| `bidders` | Array[String] | yes | List of bidder codes; must have been enabled during Prebid.js build. |
50+
| `defaultVendor` | String | no | 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. |
51+
| `enabled` | Boolean | no | Enables S2S; default: `false` (`true` when defaultVendor is set). |
52+
| `endpoint` | String | no | Set the endpoint. For example: `https://prebid.adnxs.com/pbs/v1/openrtb2/auction` |
53+
| `timeout` | Number | no | Bidder timeout, in milliseconds; default: `1000`. |
54+
| `syncEndpoint` | String | no | Configures the user-sync endpoint. Highly recommended. |
55+
| `adapter` | String | no | Adapter code; default: `"prebidServer"`. |
56+
| `secure` | Integer | no | Override Prebid Server's determination of whether the request needs secure assets. Set to `1` to force secure assets on the response, or `0` for non-secure assets. |
57+
| `adapterOptions` | Object | no | Arguments will be added to resulting OpenRTB payload to Prebid Server. |
58+
| `extPrebid` | Object | no | Arguments will be added to resulting OpenRTB payload to Prebid Server. |
4759

4860
### Examples
4961

@@ -95,4 +107,4 @@ var adUnits = [{
95107
}
96108
}
97109
}];
98-
```
110+
```

dev-docs/publisher-api-reference.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1579,6 +1579,13 @@ Additional information of these properties:
15791579
- When using `defaultVendor` option, `accountId` and `bidders` properties still need to be defined.
15801580
- If the `s2sConfig` timeout is greater than the Prebid.js timeout, the `s2sConfig` timeout will be automatically adjusted to 75% of the Prebid.js timeout in order to fit within the auction process.
15811581

1582+
{: .alert.alert-warning :}
1583+
**Errors in bidder parameters will cause Prebid Server to reject the
1584+
entire request.** The Prebid Server philosophy is to avoid silent failures --
1585+
we assume you will test changes, and that it will be easier to notice a
1586+
4xx error coming from the server than a silent failure where it skips just
1587+
the bad parameter.
1588+
15821589
**Video via s2sConfig**
15831590

15841591
Supporting video through the Server-to-Server route can be done by providing a couple of extra arguments on the `extPrebid` object. e.g.

0 commit comments

Comments
 (0)