Skip to content

Commit c5b85a7

Browse files
nickoglnickogl
committed
Bidboost: Add dev docs for analytics and RTD module
1 parent 5a08d3e commit c5b85a7

2 files changed

Lines changed: 140 additions & 0 deletions

File tree

‎dev-docs/analytics/bidboost.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
layout: analytics
3+
title: Bidboost
4+
description: Bidboost Analytics Adapter
5+
modulecode: bidboost
6+
prebid_member: false
7+
enable_download: true
8+
---
9+
10+
#### Registration
11+
12+
The Bidboost analytics adapter requires onboarding and approval from the Bidboost team.
13+
Publishers can request an evaluation pilot at [bidboost.net](https://www.bidboost.net).
14+
15+
For expected end-to-end behavior, enable this analytics adapter together with the Bidboost RTD module.
16+
17+
#### Analytics Options
18+
19+
{: .table .table-bordered .table-striped }
20+
| Name | Scope | Description | Type |
21+
|---|---|---|---|
22+
| `client` | required | Bidboost client code provided during onboarding. | `string` |
23+
| `site` | required | Site or entity key configured for your account. | `string` |
24+
| `collectorUrl` | optional | Data collector base URL. Defaults to `https://collect.bidboost.net`. | `string` |
25+
| `analyticsBatchWindowMs` | optional | Milliseconds to batch analytics events from an auction before posting. | `number` |
26+
| `ignoredBidders` | optional | Bidder codes excluded from Bidboost analytics processing. | `string[]` |
27+
| `bidderMapper` | optional | Maps Prebid bidder codes to Bidboost bidder codes for analytics payloads. | `function` |
28+
| `reverseBidderMapper` | optional | Reverse mapping helper for environments that use mapped bidder identifiers. | `function` |
29+
| `placementMapper` | optional | Maps ad units to Bidboost placement codes in analytics payloads. | `function` |
30+
31+
### Example Configuration
32+
33+
```javascript
34+
pbjs.enableAnalytics({
35+
provider: 'bidboost',
36+
options: {
37+
client: '11111111-2222-3333-4444-555555555555',
38+
site: 'example-site',
39+
collectorUrl: 'https://collect.bidboost.net',
40+
analyticsBatchWindowMs: 1000,
41+
ignoredBidders: ['sampleBidder'],
42+
bidderMapper: (bidderCode) => bidderCode,
43+
reverseBidderMapper: (mappedBidderCode) => mappedBidderCode,
44+
placementMapper: (adUnit) => adUnit.code
45+
}
46+
});
47+
```

‎dev-docs/modules/bidboostRtdProvider.md‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
layout: page_v2
3+
title: Bidboost Real-time Data Submodule
4+
display_name: Bidboost Real-time Data Submodule
5+
description: Privacy-first traffic shaping RTD module for fast-changing AI-driven buyer strategies
6+
page_type: module
7+
module_type: rtd
8+
module_code: bidboostRtdProvider
9+
enable_download: true
10+
vendor_specific: true
11+
sidebarType: 1
12+
---
13+
14+
# Bidboost Real-time Data Submodule
15+
{:.no_toc}
16+
17+
* TOC
18+
{:toc}
19+
20+
## Overview
21+
22+
The Bidboost RTD module helps publishers adapt auction traffic shaping as buyers increasingly use AI
23+
to test and change bidding behavior faster than manual workflows can track.
24+
It integrates into Prebid.js and applies real-time auction inputs to support stable monetization outcomes
25+
with privacy-first operation.
26+
27+
Access is currently provided through an evaluation pilot.
28+
Publishers can request access at [bidboost.net](https://www.bidboost.net).
29+
30+
## Build Prebid.js with Bidboost RTD
31+
32+
Compile the RTD module into your Prebid.js build:
33+
34+
```bash
35+
gulp build --modules=rtdModule,bidboostRtdProvider,bidboostAnalyticsAdapter
36+
```
37+
38+
Include and configure the Bidboost analytics adapter so predictor-driven shaping decisions can be evaluated against auction outcomes in Bidboost reporting.
39+
40+
## Configuration
41+
42+
Configure Bidboost under `realTimeData.dataProviders`:
43+
44+
```javascript
45+
pbjs.setConfig({
46+
realTimeData: {
47+
auctionDelay: 300,
48+
dataProviders: [{
49+
name: 'bidboost',
50+
waitForIt: true,
51+
params: {
52+
client: '11111111-2222-3333-4444-555555555555',
53+
site: 'example-site',
54+
predictorUrl: 'https://predict.bidboost.net',
55+
ignoredBidders: ['sampleBidder'],
56+
bidderMapper: (bidderCode) => bidderCode,
57+
reverseBidderMapper: (mappedBidderCode) => mappedBidderCode,
58+
placementMapper: (adUnit) => adUnit.code,
59+
additionalBidders: [
60+
{
61+
code: 'top-slot',
62+
bids: [{ bidder: 'sampleBidder' }]
63+
}
64+
]
65+
}
66+
}]
67+
}
68+
});
69+
```
70+
71+
## Parameters
72+
73+
{: .table .table-bordered .table-striped }
74+
| Name | Type | Description |
75+
|---|---|---|
76+
| `name` | `string` | RTD provider name. Must be `bidboost`. |
77+
| `waitForIt` | `boolean` | Set to `true` so Prebid can wait for this RTD module within your configured `auctionDelay`. |
78+
| `params` | `object` | Bidboost RTD configuration object. |
79+
| `params.client` | `string` | Bidboost client code provided during onboarding. |
80+
| `params.site` | `string` | Site or entity key configured for your account. |
81+
| `params.predictorUrl` | `string` | Predictor base URL. Defaults to `https://predict.bidboost.net`. |
82+
| `params.ignoredBidders` | `string[]` | Bidder codes excluded from Bidboost traffic shaping. |
83+
| `params.bidderMapper` | `function` | Maps Prebid bidder codes to Bidboost bidder codes before predictor requests. |
84+
| `params.reverseBidderMapper` | `function` | Maps Bidboost bidder codes back to Prebid bidder codes when applying predictor results. |
85+
| `params.placementMapper` | `function` | Maps ad units to Bidboost placement codes. |
86+
| `params.additionalBidders` | `object[]` | Optional bidder definitions merged by ad unit code for shaping coverage and fallback behavior. |
87+
| `params.additionalBidders[].code` | `string` | Ad unit code for the additional bidder definition. |
88+
| `params.additionalBidders[].bids` | `object[]` | Bid array using standard ad unit bid objects. |
89+
| `params.additionalBidders[].bids[].bidder` | `string` | Bidder code in each additional bid object. |
90+
91+
## Notes
92+
93+
For complete Bidboost results, enable the Bidboost analytics adapter alongside this RTD submodule.

0 commit comments

Comments
 (0)