Skip to content

Commit ccb57c9

Browse files
authored
Document additional module parameters (prebid#6088)
1 parent 4889951 commit ccb57c9

4 files changed

Lines changed: 15 additions & 1 deletion

File tree

dev-docs/modules/intersectionRtdProvider.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: page_v2
33
title: Intersection Module
44
display_name: Intersection
5+
56
description: Real Time Intersection
67
page_type: module
78
module_type: rtd
@@ -26,6 +27,7 @@ Implementation works like this:
2627
1. Build the Intersection module into the Prebid.js package with:
2728

2829
```bash
30+
2931
gulp build --modules=intersectionRtdProvider&...
3032
```
3133

@@ -36,6 +38,7 @@ Implementation works like this:
3638
This module is configured as part of the `realTimeData.dataProviders` object:
3739

3840
```javascript
41+
3942
pbjs.setConfig({
4043
"realTimeData": {
4144
auctionDelay: 100,
@@ -45,14 +48,18 @@ pbjs.setConfig({
4548
}]
4649
}
4750
});
51+
4852
```
4953

54+
The optional `waitForIt` flag instructs the module to delay the auction until intersection data is collected for all ad units or the `auctionDelay` timeout is reached. It defaults to `false`.
55+
5056
## Output
5157

5258
For each bidder, the module adds intersection in a JSON format.
5359
Example:
5460

5561
```javascript
62+
5663
{
5764
"intersection":{
5865
'boundingClientRect': {

dev-docs/modules/userid-submodules/unified.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ The Unified ID privacy is covered under the [TradeDesk Services Privacy Policy](
3838
| params.url | Required for UnifiedId if not using TradeDesk | String | If specified for UnifiedId, overrides the default Trade Desk URL. | "<https://unifiedid.org/somepath?args>" |
3939
| value | Optional | Object | Used only if the page has a separate mechanism for storing the Unified ID. The value is an object containing the values to be sent to the adapters. In this scenario, no URL is called and nothing is added to local storage | `{"tdid": "D6885E90-2A7A-4E0F-87CB-7734ED1B99A3"}` |
4040

41+
Either `params.partner` or `params.url` must be provided.
42+
4143
## Unified ID Examples
4244

4345
1. Publisher has a partner ID with The Trade Desk, and is using the default endpoint for Unified ID.

dev-docs/modules/userid-submodules/yandex.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,5 @@ pbjs.setConfig({
3939
},
4040
});
4141
```
42+
43+
**Storage Requirements**: Yandex ID requires the storage object to specify cookie `type`, name `_ym_uid`, and an expiration of at least 30 days.

identity/sharedid.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ SharedId is a convenient Prebid-owned first party identifier within the [Prebid
2121
There are multiple ways to integrate SharedId on your site. See the table below for a breakout of options, and the rest of this document for detailed integration instructions.
2222

2323
{: .table .table-bordered .table-striped }
24+
2425
| Implementation | Description | Cookie Lifetime | Safari Cookie Lifetime | Technical Difficulty | Revenue Benefit |
2526
| --- | --- | --- | --- | --- | --- |
2627
| 3rd Party Cookie Only | No first party cookie solution. | Some Blocked | Blocked | None | Low |
@@ -149,7 +150,7 @@ removed in Prebid.js 5.0.
149150

150151
### Configuration
151152

152-
You can find available configuration options for the SharedID module [here](https://docs.prebid.org/dev-docs/modules/userid-submodules/sharedid.html)
153+
You can find available configuration options for the SharedID module [in the SharedId user ID submodule documentation](https://docs.prebid.org/dev-docs/modules/userid-submodules/sharedid.html)
153154

154155
### Privacy Discussion
155156

@@ -211,13 +212,15 @@ If custom configurations are needed, define the pubcid_options object before inc
211212
Below are the available configuration options for the PubCID script.
212213

213214
{: .table .table-bordered .table-striped }
215+
214216
| Parameter Name | Type | Description | | Example |
215217
| --- | --- | --- | --- | --- |
216218
| create | boolean | If true, then an id is created automatically by the script if it's missing. Default is true. If your server has a component that generates the id instead, then this should be set to false | | `true` |
217219
| expInterval | decimal | Expiration interval in minutes. Default is 525600, or 1 year | | `525600` |
218220
| extend | boolean | If true, the the expiration time is automatically extended whenever the script is executed even if the id exists already. Default is true. If false, then the id expires from the time it was initially created. | For publisher server support only. If true, the publisher's server will create the (pubcid) cookie. Default is true. | `true` |
219221
| pixelUrl | string (optional) | For publisher server support only. Where to call out to for a server cookie. | | `/wp-json/pubcid/v1/extend/` |
220222
| type | string | Type of storage. It's possible to specify one of the following: 'html5', 'cookie'. Default is 'html5' priority, aka local storage, and fall back to cookie if local storage is unavailable. | If true, the expiration time of the stored IDs will be refreshed during each page load. Default is false. | `cookie` |
223+
| inserter | string (optional) | Adds this value into the EID object `inserter` field. | | `myPartner` |
221224

222225
#### Example Configurations
223226

0 commit comments

Comments
 (0)