diff --git a/dev-docs/modules/prebidServer.md b/dev-docs/modules/prebidServer.md index e22a972cf4..462fa31719 100644 --- a/dev-docs/modules/prebidServer.md +++ b/dev-docs/modules/prebidServer.md @@ -204,6 +204,8 @@ Here's how it works: 1. The s2sConfig.bidders array contains 'tripleliftVideo' telling Prebid.js to direct bids for that code to the server 1. Finally, the extPrebid.aliases line tells Prebid Server to route the 'tripleliftVideo' biddercode to the 'triplelift' server-side adapter. +Make sure to register your aliases' [`gvlMapping`](/dev-docs/publisher-api-reference/setConfig.html#setConfig-gvlMapping) via setConfig as well. + ### Routing for Multiple PBS instances Bids: diff --git a/dev-docs/publisher-api-reference/setConfig.md b/dev-docs/publisher-api-reference/setConfig.md index 814c50982c..8c828a863a 100644 --- a/dev-docs/publisher-api-reference/setConfig.md +++ b/dev-docs/publisher-api-reference/setConfig.md @@ -982,6 +982,7 @@ The Prebid Video Module allows Prebid to directly integrate with a Video Player, To register a video player with Prebid, you must use `setConfig` to set a `video` config compliant with the following structure: {: .table .table-bordered .table-striped } + | Field | Required? | Type | Description | |---|---|---|---| | video.providers[] | yes | array of objects | List of Provider configurations. You must define a provider configuration for each player instance that you would like integrate with. | @@ -1333,6 +1334,7 @@ pbjs.setConfig({ The controls publishers have over the RTD modules: {: .table .table-bordered .table-striped } + | Field | Required? | Type | Description | |---|---|---|---| | realTimeData.auctionDelay | no | integer | Defines the maximum amount of time, in milliseconds, the header bidding auction will be delayed while waiting for a response from the RTD modules as a whole group. The default is 0 ms delay, which means that RTD modules need to obtain their data when the page initializes. | @@ -1386,6 +1388,7 @@ pbjs.setConfig({ ``` {: .table .table-bordered .table-striped } + | Field | Required? | Type | Description | |---|---|---|---| | topics.maxTopicCaller | no | integer | Defines the maximum numbers of Bidders Iframe which needs to be loaded on the publisher page. Default is 1 which is hardcoded in Module. Eg: topics.maxTopicCaller is set to 3. If there are 10 bidders configured along with their iframe URLS, random 3 bidders iframe URL is loaded which will call TOPICS API. If topics.maxTopicCaller is set to 0, it will load random 1(default) bidder iframe atleast. | @@ -1420,6 +1423,23 @@ Inversely, if you wish for the alias registry to be private you can do so by usi pbjs.setConfig({aliasRegistry: 'private'}) ``` + + +### Map modules to Global Vendor IDs + +Prebid modules sometimes need to know the [IAB Global Vendor List](https://iabeurope.eu/tcf-for-vendors/) (GVL) ID associated with a bidder alias or other module. The optional `gvlMapping` object lets publishers specify these IDs or override the ones declared by the module itself. + +```javascript +pbjs.setConfig({ + gvlMapping: { + appnexus: 4, + someModule: 123 + } +}); +``` + +Prebid Server uses this mapping when it sends `ext.prebid.aliasgvlids` for bidder aliases, and the [TCF Control Module](/dev-docs/modules/tcfControl.html) references it when enforcing consent. + ### Set Max Bid