|
| 1 | +--- |
| 2 | +layout: page_v2 |
| 3 | +title: Bidboost Analytics Adapter |
| 4 | +description: Bidboost analytics adapter for auction telemetry. |
| 5 | +page_type: module |
| 6 | +module_type: analytics |
| 7 | +module_code: bidboost |
| 8 | +enable_download: true |
| 9 | +sidebarType: 1 |
| 10 | +--- |
| 11 | + |
| 12 | +# Bidboost Analytics Adapter |
| 13 | + |
| 14 | +## Overview |
| 15 | + |
| 16 | +Use this module together with `bidboostRtdProvider` to measure controlled traffic-shaping impact. |
| 17 | + |
| 18 | +## Build |
| 19 | + |
| 20 | +```bash |
| 21 | +gulp build --modules="bidboostAnalyticsAdapter" |
| 22 | +``` |
| 23 | + |
| 24 | +## Configuration |
| 25 | + |
| 26 | +```javascript |
| 27 | +pbjs.enableAnalytics({ |
| 28 | + provider: 'bidboost', |
| 29 | + options: { |
| 30 | + client: 'YOUR_CLIENT_CODE', |
| 31 | + site: 'YOUR_SITE_CODE', |
| 32 | + collectorUrl: 'https://collect.bidboost.net', |
| 33 | + analyticsBatchWindowMs: 1000, |
| 34 | + ignoredBidders: ['exampleBidder'], |
| 35 | + placementMapper: (adUnit) => adUnit.code, |
| 36 | + bidderMapper: (bidder) => bidder |
| 37 | + } |
| 38 | +}); |
| 39 | +``` |
| 40 | + |
| 41 | +## Analytics Parameters |
| 42 | + |
| 43 | +Set these fields in `pbjs.enableAnalytics({ provider: 'bidboost', options: ... })`: |
| 44 | + |
| 45 | +| Field | Type | Description | |
| 46 | +| --- | --- | --- | |
| 47 | +| `client` | `string` | UUID of the client account running Bidboost. Provided during onboarding. | |
| 48 | +| `site` | `string` | Site identifier configured in the Bidboost management UI. | |
| 49 | +| `collectorUrl` | `string` | Base URL of the Bidboost collector service. Default: `https://collect.bidboost.net`. | |
| 50 | +| `analyticsBatchWindowMs` | `number` | Batch window in milliseconds for auction/impression analytics dispatch. Default: `1000`. | |
| 51 | +| `ignoredBidders` | `string[]` | Bidders to exclude from analytics reporting. | |
| 52 | +| `placementMapper` | `(adUnit: object) => string` | Maps a Prebid ad unit to the placement identifier configured in Bidboost. Default maps to `adUnit.code`. | |
| 53 | +| `bidderMapper` | `(bidderCode: string) => string` | Maps a Prebid bidder code to the bidder identifier configured in Bidboost. Default is identity mapping. | |
0 commit comments