Skip to content

Commit 90bd047

Browse files
authored
Document new userId and PBS parameters (#6124)
1 parent eebce06 commit 90bd047

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

dev-docs/modules/prebidServer.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,8 @@ There are many configuration options for s2sConfig:
9797
| `adapterOptions` | Optional | Object | Arguments will be added to resulting OpenRTB payload to Prebid Server in every impression object at request.imp[].ext.BIDDER. See the example above. |
9898
| `extPrebid` | Optional | Object | Arguments will be added to resulting OpenRTB payload to Prebid Server in request.ext.prebid. See the examples below. |
9999
| `customHeaders` | Optional | Object | These custom headers will be included in the XHR call to the bidder's endpoint. This will allow you to send data specific to your use case. The format consists of an object where the keys represent the header names and the values correspond to the respective header values. Here is an example how a customHeader object might look like - `{"Header1": "Value1", "Header2": "Value2"}`|
100+
| `endpointCompression` | Optional | Boolean | Enable gzip compression of outgoing requests when supported. | `true` |
101+
| `filterBidderlessCalls` | Optional | Boolean | When `true`, ad units that have no bidders defined are excluded from Prebid Server requests. Defaults to `false`. | `true` |
100102

101103
If `endpoint` and `syncEndpoint` are objects, these are the supported properties:
102104

dev-docs/modules/userId.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,9 @@ The PPID in GAM (which is unrelated to the PPID UserId Submodule) has strict rul
7575
| Param under userSync | Scope | Type | Description | Example |
7676
| --- | --- | --- | --- | --- |
7777
| ppid | Optional | String | Must be a source from the [pbjs.getUserIdsAsEids()](#getUserIdsAsEids) array | `"pubcid.org"` |
78+
| autoRefresh | Optional | Boolean | Refresh IDs automatically when their configuration changes. Defaults to `false`. | `true` |
79+
| retainConfig | Optional | Boolean | When set to `false`, previously configured IDs are removed if they are not present in updated configuration. Defaults to `true`. | `false` |
80+
| enforceStorageType | Optional | Boolean | Restrict submodules to storing IDs only in the location defined by `storage.type`. | `true` |
7881

7982
The table below has the options that are common across ID systems. See the sections below for specific configuration needed by each system and examples.
8083

0 commit comments

Comments
 (0)