Skip to content

Commit

Permalink
update to s2sconfig properties notes (#1043)
Browse files Browse the repository at this point in the history
* update to s2sconfig properties notes

* clarified recalculation process

* additional wording changes
  • Loading branch information
jsnellbaker authored and jeanstemp committed Dec 5, 2018
1 parent 0eaa3fa commit 62639c8
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions dev-docs/publisher-api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -1432,15 +1432,18 @@ Additional information of these properties:
|------------+---------+---------+---------------------------------------------------------------|
| `accountId` | Required | String | Your Prebid Server account ID |
| `bidders` | Required | Array of Strings | Which bidders support auctions on the server side |
| `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. |
| `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 S2S - defaults to `false` |
| `timeout` | Required | 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. |
| `timeout` | Required | 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. See the Additional Notes below for more information. |
| `adapter` | Required | String | Adapter code for S2S. Defaults to 'prebidServer' |
| `endpoint` | Required | URL | Defines the auction endpoint for the Prebid Server cluster |
| `syncEndpoint` | Required | URL | Defines the cookie_sync endpoint for the Prebid Server cluster |

*Currently supported vendors are: appnexus & rubicon
*Note - When using defaultVendor option, accountId and bidders properties still need to be defined.
**Additional Notes on s2sConfig properties**

- Currently supported vendors are: appnexus & rubicon
- When using `defaultVendor` option, `accountId` and `bidders` properties still need to be defined.
- 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.

Additional options for `s2sConfig` may be enabled by including the [Server-to-Server testing module]({{site.baseurl}}/dev-docs/modules/s2sTesting.html).

Expand Down

0 comments on commit 62639c8

Please sign in to comment.