Skip to content

Docs: add setConfig guidance for disableFingerprintingApis #6445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
muuki88 merged 2 commits into from
Feb 23, 2026
Merged

Docs: add setConfig guidance for disableFingerprintingApis #6445

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d45d832
Document disableFingerprintingApis setConfig option
patmmccann Feb 23, 2026
ff42e24
Update description for disableFingerprintingApis control
patmmccann Feb 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 27 additions & 7 deletions dev-docs/publisher-api-reference/setConfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,26 @@ This can be useful in GDPR, CCPA, COPPA or other privacy scenarios where a publi

Note that bid adapters are normally denied access to device storage even when `deviceAccess` is `true`; see the [`storageAllowed` bidder setting](/dev-docs/publisher-api-reference/bidderSettings.html#deviceAccess).

<a id="setConfig-disableFingerprintingApis"></a>

### Disable fingerprinting APIs

Prebid provides a privacy control named `disableFingerprintingApis` that lets publishers disable specific browser APIs commonly used for fingerprinting according to DuckDuckGo tracker radar.

When one of these APIs is disabled, Prebid returns a safe default value instead of reading the browser value:

* `devicepixelratio`: returns `1`
* `webdriver`: returns `false`
* `resolvedoptions`: returns an empty timezone string `''`

```javascript
pbjs.setConfig({
disableFingerprintingApis: ['devicepixelratio', 'webdriver', 'resolvedoptions']
});
```

Values are matched case-insensitively.

<a name="setConfig-Bidder-Timeouts"></a>

### Bidder Timeouts
Expand Down Expand Up @@ -1063,7 +1083,7 @@ To register a video player with Prebid, you must use `setConfig` to set a `video
{: .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. |
| video.providers[] .vendorCode | yes | number | The identifier of the Video Provider vendor (i.e. 1 for JW Player, 2 for videojs, etc). Allows Prebid to know which submodule to instantiate. |
| video.providers[].divId | yes | string | The HTML element id of the player or its placeholder div. All analytics events for that player will reference this ID. Additionally, used to indicate which HTLM element must contain the Video Player instance when instantiated. |
Expand Down Expand Up @@ -1427,7 +1447,7 @@ 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. |
| realTimeData.dataProviders[].waitForIt | no | boolean | Setting this value to true flags this RTD module as "important" enough to wait the full auction delay period. Once all such RTD modules have returned, the auction will proceed even if there are other RTD modules that have not yet responded. The default is `false`. |

Expand Down Expand Up @@ -1481,12 +1501,12 @@ 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. |
| topics.bidders | no | Array of objects | Array of topics callers with the iframe locations and other necessary informations like bidder(Bidder code) and expiry. Default Array of topics in the module itself.|
| topics.bidders[].bidder | yes | string | Bidder Code of the bidder(SSP). |
| topics.bidders[].iframeURL | yes | string | URL which is hosted on bidder/SSP/third-party domains which will call Topics API. |
| topics.bidders[].expiry | no | integer | Max number of days where Topics data will be persist. If Data is stored for more than mentioned expiry day, it will be deleted from storage. Default is 21 days which is hardcoded in Module. |
| topics.bidders | no | Array of objects | Array of topics callers with the iframe locations and other necessary informations like bidder(Bidder code) and expiry. Default Array of topics in the module itself. |
| topics.bidders[].bidder | yes | string | Bidder Code of the bidder(SSP). |
| topics.bidders[].iframeURL | yes | string | URL which is hosted on bidder/SSP/third-party domains which will call Topics API. |
| topics.bidders[].expiry | no | integer | Max number of days where Topics data will be persist. If Data is stored for more than mentioned expiry day, it will be deleted from storage. Default is 21 days which is hardcoded in Module. |

<a id="setConfig-performanceMetrics"></a>

Expand Down