Skip to content

JS: documentation for FPD keywords configuration options #6364

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

Open
dgirardi wants to merge 3 commits into
base: master
Choose a base branch
from
+19 −4
Open

JS: documentation for FPD keywords configuration options #6364

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0dd5845
JS: documentation for FPD keywords configuration options
dgirardi Dec 10, 2025
a170fc4
lint
dgirardi Dec 10, 2025
062519e
add note on FPD set by modules
dgirardi Dec 17, 2025
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
23 changes: 19 additions & 4 deletions features/firstPartyData.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ If not specified through any of the methods above, Prebid.js attempts to automat
| `site.page` | Site URL, from `pageUrl` falling back to `location.href` | [`pageUrl` config](/dev-docs/publisher-api-reference/setConfig.html#setConfig-Page-URL) |
| `site.ref` | `document.referrer` | |
| `site.domain` | Domain portion of `site.page` | |
| `site.keywords` | Contents of `<meta name="keywords">`, if such a tag is present on the page | |
| `site.keywords` | Contents of `<meta name="keywords">` and `<script type="application/json+ld">`, if those tags are present on the page | See [configuration options](#config) |
| `site.publisher.domain` | Second level domain portion of `site.domain` | The second-level domain portion of `sub.example.publisher.com` is `publisher.com`|
| `device.w` | Width of the screen in pixels |
| `device.h` | Height of the screen in pixels |
Expand All @@ -70,21 +70,36 @@ If not specified through any of the methods above, Prebid.js attempts to automat
| `regs.coppa` | COPPA Regulation flag | [COPPA config](/dev-docs/publisher-api-reference/setConfig.html#setConfig-coppa)
| `regs.ext.gpc` | Global Privacy Control setting | [Navigator.globalPrivacyControl](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/globalPrivacyControl) |

Publisher-provided first party data always takes precedence for all fields; you can also set `null` to disable them. For example, the following discards the automatically collected `device.keywords`:
Publisher-provided first party data generally takes precedence for all fields; you can also set `null` to disable them. For example, the following discards the automatically collected `site.keywords`:

```javascript
pbjs.setConfig({
ortb2: {
device: {
site: {
keywords: null
}
}
})
```

Note however that this typically not the case for fields populated by optional modules: `consentManagementTcf` will override `regs.gdpr` and `user.consent`, `geolocationRtdProvider` will override `device.geo`, and so on.

<a id="config"></a>

## Configuration

{: .table .table-bordered .table-striped }
| Param | Type | Description |
| --- | --- | --- | --- |
| `firstPartyData` | Object | First party data automatic collection options |
| `firstPartyData.uaHints` | Array of strings | High entropy user agent hints to collect for `device.sua` (see below) |
| `firstPartyData.keywords` | Object | `site.kewyords` automatic collection options |
| `firstPartyData.keywords.meta` | Boolean | If true (the default), collect keywords from `<meta name="keyword">` tags found on the page |
| `firstPartyData.keywords.json` | Boolean | If true (the default), collect keywords from `<script type="application/json+ld">` tags found on the page |

<a id="uaHints"></a>

#### User Agent client hints
### User Agent client hints

`device.sua` is populated with UA client hints retrieved from [`navigator.userAgentData`](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/userAgentData). You can specify the list of hints using the `uaHints` option with [any available high entropy hint](https://developer.mozilla.org/en-US/docs/Web/API/NavigatorUAData#returning_high_entropy_values):

Expand Down