From 28f288acf98f545b53e6defe4acb638a45302098 Mon Sep 17 00:00:00 2001 From: Patrick McCann Date: Mon, 2 Jun 2025 14:23:14 -0400 Subject: [PATCH 1/4] docs: add gvlMapping configuration --- .gitignore | 1 + dev-docs/publisher-api-reference/setConfig.md | 20 +++++++++++++++++++ 2 files changed, 21 insertions(+) diff --git a/.gitignore b/.gitignore index 3c50b583af..85aad93921 100755 --- a/.gitignore +++ b/.gitignore @@ -17,3 +17,4 @@ node_modules/ /.vs/prebid.github.io/v17/.suo /.vs/slnx.sqlite /.vs +Prebid.js/ 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 From 413f522fc77b6640d0ba8e517f210108d0fff7c0 Mon Sep 17 00:00:00 2001 From: Patrick McCann Date: Mon, 2 Jun 2025 14:23:31 -0400 Subject: [PATCH 2/4] Update .gitignore --- .gitignore | 1 - 1 file changed, 1 deletion(-) diff --git a/.gitignore b/.gitignore index 85aad93921..3c50b583af 100755 --- a/.gitignore +++ b/.gitignore @@ -17,4 +17,3 @@ node_modules/ /.vs/prebid.github.io/v17/.suo /.vs/slnx.sqlite /.vs -Prebid.js/ From a5b9b6c0929d3516f19878313b940f72a442c12a Mon Sep 17 00:00:00 2001 From: Patrick McCann Date: Mon, 2 Jun 2025 14:29:38 -0400 Subject: [PATCH 3/4] Update prebidServer.md --- dev-docs/modules/prebidServer.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/dev-docs/modules/prebidServer.md b/dev-docs/modules/prebidServer.md index 15aeb0b171..e16540b0b8 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. + ### Video via s2sConfig Supporting video through the Server-to-Server route can be done by providing a couple of extra arguments on the `extPrebid` object. e.g. From 30d883461c8aa2ecd04e58f24c599c9fdf7dec7b Mon Sep 17 00:00:00 2001 From: Muki Seiler Date: Tue, 3 Jun 2025 08:34:27 +0200 Subject: [PATCH 4/4] fix markdown lint --- dev-docs/modules/prebidServer.md | 1 - 1 file changed, 1 deletion(-) diff --git a/dev-docs/modules/prebidServer.md b/dev-docs/modules/prebidServer.md index dcda3ca6bc..462fa31719 100644 --- a/dev-docs/modules/prebidServer.md +++ b/dev-docs/modules/prebidServer.md @@ -204,7 +204,6 @@ 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