Skip to content

Commit 09eda77

Browse files
committed
updated docs text
1 parent be6c257 commit 09eda77

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

dev-docs/publisher-api-reference/setConfig.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1411,15 +1411,15 @@ The Previous Auction Info module enables functionality to collect prior auction
14111411
* Publisher's who would like to participate must explicitly configure PBJS to do so:
14121412

14131413
```javascript
1414-
pbjs.setConfig({previousAuctionInfo: true})
1414+
pbjs.setConfig({previousAuctionInfo: { enabled: true, bidders: [], maxQueueLength: 10 }})
14151415
```
14161416

1417-
* Only bid adapters who have enabled this feature will be able to utilize it. To do this, a bid adapter must add the following to their bidAdapter.js file:
1418-
1419-
```javascript
1420-
import { enablePreviousAuctionInfo } from '../libraries/previousAuctionInfo/previousAuctionInfo.js';
1421-
enablePreviousAuctionInfo({ bidderCode: 'some bidder code' });
1422-
```
1417+
{: .table .table-bordered .table-striped }
1418+
| Field | Required? | Type | Description |
1419+
|---|---|---|---|
1420+
| previousAuctionInfo.enabled | yes | boolean | Enables/disables the module. |
1421+
| previousAuctionInfo.bidders | no | array of strings | Array of bidder codes to determine which bidders are allowed to receive collected previous auction info. Leaving the array empty will enable all bidders. By default, all bidders will be allowed to collect previous auction info. |
1422+
| previousAuctionInfo.maxQueueLength | no | integer | The number of previous auction info payloads to store per bidder before injecting these payloads into the bidstream. Any payloads collected for a bidder during one auction will be injected into the bidstream during the next auction that the same bidder participates in with valid bids. By default, the value of this field is 10. |
14231423

14241424
* Only valid bid requests submitted by bidders who have enabled the Previous Auction Info module will be permitted.
14251425

@@ -1428,7 +1428,7 @@ If the requirements above are met, the flow for how the module works is as follo
14281428
1. A Prebid.js auction runs and completes
14291429
1. At the end of an auction, details about the auction are collected from each bidder using the module
14301430
1. If a Prebid bid wins, then the `rendered` field is updated to `1` to indicate this in the collected auction data for all bidders who bid on the same adunit
1431-
1. During the next Prebid.js auction, if a bidder has this module enabled AND submits a valid bid request, then previous auction info data will be injected into the bid request of the new auction within the following path: `ortb2.ext.prebid.previousAuctionInfo`
1431+
1. During the next Prebid.js auction, if a bidder has this module enabled AND submits a valid bid request, then previous auction info data will be injected into the bid request of the new auction within the following path: `ortb2.ext.prebid.previousauctioninfo`
14321432

14331433
`previousAuctionInfo` is an array of prior auction data catered to a specific bidder (if present, it will be added to a bidder's bid request), the structure of the data looks like this (Note: Once collected previous auction data has been injected into the bid stream, then it is removed from storage):
14341434

@@ -1440,17 +1440,17 @@ ortb2: {
14401440
{
14411441
bidderRequestId: "123abc",
14421442
bidId: "456def",
1443-
rendered: 1,
1443+
rendered: 1, // default is 0
14441444
source: "pbjs",
14451445
adUnitCode: "div-gpt-ad-123-0",
1446-
highestTargetedBidCpm: "0.05",
1447-
targetedBidCpm: "0.04",
1448-
highestBidCpm: 0.052275935,
1449-
bidderCpm: 0.04,
1450-
bidderOriginalCpm: 0.04,
1451-
bidderCurrency: "USD",
1452-
bidderOriginalCurrency: "USD",
1453-
bidderErrorCode: -1,
1446+
highestTargetedBidCpm: "0.05", // default is null
1447+
targetedBidCpm: "0.04", // default is null
1448+
highestBidCpm: 0.052275935, // default is 0
1449+
bidderCpm: 0.04, // default is null
1450+
bidderOriginalCpm: 0.04, // default is null
1451+
bidderCurrency: "USD", // default is null
1452+
bidderOriginalCurrency: "USD", // default is null
1453+
bidderErrorCode: -1, // default is -1
14541454
timestamp: 1739400860310
14551455
}
14561456
]

0 commit comments

Comments
 (0)