Skip to content

Commit 6171fff

Browse files
v0idxyzmuuki88
andauthored
Add Revantage Bidder Adapter documentation (prebid#6414)
* Add Revantage Bidder Adapter documentation Added documentation for the Revantage Bidder Adapter, including registration, bid parameters, configuration for banner and video ads, user syncing, privacy support, and price floors. * Remove notes about bid requests and sync URLs Removed notes section detailing bid requests and notifications. * Update dev-docs/bidders/revantage.md Co-authored-by: Muki Seiler <muuki88@users.noreply.github.com> * Update dev-docs/bidders/revantage.md Co-authored-by: Muki Seiler <muuki88@users.noreply.github.com> * Change tcfeu_supported to false for Revantage * Update Revantage documentation with code examples --------- Co-authored-by: Muki Seiler <muuki88@users.noreply.github.com>
1 parent 51f6ebd commit 6171fff

1 file changed

Lines changed: 257 additions & 0 deletions

File tree

dev-docs/bidders/revantage.md

Lines changed: 257 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,257 @@
1+
---
2+
layout: bidder
3+
title: Revantage
4+
description: Prebid Revantage Bidder Adapter
5+
biddercode: revantage
6+
tcfeu_supported: false
7+
gvl_id: none
8+
usp_supported: true
9+
gpp_sids: tcfeu, tcfca, usnat, usstate_all, usp
10+
coppa_supported: false
11+
schain_supported: true
12+
dchain_supported: false
13+
userId: all
14+
media_types: banner, video
15+
safeframes_ok: true
16+
deals_supported: true
17+
floors_supported: true
18+
fpd_supported: true
19+
pbjs: true
20+
pbs: false
21+
prebid_member: false
22+
multiformat_supported: will-bid-on-one
23+
ortb_blocking_supported: false
24+
privacy_sandbox: no
25+
sideload_disabled: false
26+
---
27+
28+
### Registration
29+
30+
To use the Revantage adapter, you need to register for an account and obtain a Feed ID. Please contact [adops@revantage.io](mailto:adops@revantage.io) to get started.
31+
32+
### Bid Params
33+
34+
{: .table .table-bordered .table-striped }
35+
| Name | Scope | Description | Example | Type |
36+
|---------------|----------|-----------------------------------------------|----------------------|----------|
37+
| `feedId` | required | Unique identifier for your feed configuration | `'abc123xyz'` | `string` |
38+
39+
### Banner Configuration
40+
41+
Revantage supports standard banner ad units. The adapter will automatically use the sizes defined in your ad unit configuration.
42+
43+
```javascript
44+
var adUnits = [
45+
{
46+
code: 'banner-div',
47+
mediaTypes: {
48+
banner: {
49+
sizes: [[300, 250], [300, 600], [728, 90]]
50+
}
51+
},
52+
bids: [
53+
{
54+
bidder: 'revantage',
55+
params: {
56+
feedId: 'your-feed-id'
57+
}
58+
}
59+
]
60+
}
61+
];
62+
```
63+
64+
### Video Configuration
65+
66+
Revantage supports instream and outstream video. The following video parameters are supported:
67+
68+
{: .table .table-bordered .table-striped }
69+
| Name | Scope | Description | Example | Type |
70+
|------------------|-------------|--------------------------------------------------|--------------------------|-----------------|
71+
| `playerSize` | required | Video player dimensions | `[[640, 480]]` | `array` |
72+
| `mimes` | recommended | Supported video MIME types | `['video/mp4']` | `array<string>` |
73+
| `protocols` | recommended | Supported VAST protocols | `[2, 3, 5, 6]` | `array<int>` |
74+
| `api` | optional | Supported API frameworks | `[1, 2]` | `array<int>` |
75+
| `placement` | optional | Video placement type (1=instream, 2=outstream) | `1` | `int` |
76+
| `minduration` | optional | Minimum video duration in seconds | `5` | `int` |
77+
| `maxduration` | optional | Maximum video duration in seconds | `30` | `int` |
78+
| `skip` | optional | Whether video is skippable (0=no, 1=yes) | `1` | `int` |
79+
| `skipmin` | optional | Minimum duration before skip is allowed | `5` | `int` |
80+
| `skipafter` | optional | Seconds until skip button appears | `5` | `int` |
81+
| `startdelay` | optional | Start delay (0=pre-roll, -1=mid-roll, -2=post) | `0` | `int` |
82+
| `playbackmethod` | optional | Playback methods | `[1, 2]` | `array<int>` |
83+
| `linearity` | optional | Linearity (1=linear, 2=non-linear) | `1` | `int` |
84+
85+
#### Video Example
86+
87+
```javascript
88+
var adUnits = [
89+
{
90+
code: 'video-div',
91+
mediaTypes: {
92+
video: {
93+
playerSize: [[640, 480]],
94+
context: 'instream',
95+
mimes: ['video/mp4', 'video/webm'],
96+
protocols: [2, 3, 5, 6],
97+
api: [1, 2],
98+
placement: 1,
99+
minduration: 5,
100+
maxduration: 30,
101+
skip: 1,
102+
skipmin: 5,
103+
skipafter: 5
104+
}
105+
},
106+
bids: [
107+
{
108+
bidder: 'revantage',
109+
params: {
110+
feedId: 'your-feed-id'
111+
}
112+
}
113+
]
114+
}
115+
];
116+
```
117+
118+
### User Syncing
119+
120+
Revantage supports both iframe and pixel-based user syncing. Enable user syncing in your Prebid.js configuration:
121+
122+
```javascript
123+
pbjs.setConfig({
124+
userSync: {
125+
filterSettings: {
126+
iframe: {
127+
bidders: ['revantage'],
128+
filter: 'include'
129+
},
130+
image: {
131+
bidders: ['revantage'],
132+
filter: 'include'
133+
}
134+
},
135+
syncsPerBidder: 1,
136+
syncDelay: 3000
137+
}
138+
});
139+
```
140+
141+
### Privacy Support
142+
143+
Revantage fully supports the following privacy frameworks:
144+
145+
- **GDPR (TCF 2.0)**: The adapter reads consent data from the `gdprConsent` object and passes it to the bidding endpoint.
146+
- **US Privacy (CCPA)**: The adapter reads the USP consent string and includes it in bid requests.
147+
- **GPP**: Global Privacy Platform consent strings and applicable sections are supported.
148+
149+
### First Party Data
150+
151+
Revantage supports First Party Data via the standard `ortb2` configuration:
152+
153+
```javascript
154+
pbjs.setConfig({
155+
ortb2: {
156+
site: {
157+
name: 'Example Site',
158+
domain: 'example.com',
159+
cat: ['IAB1'],
160+
content: {
161+
language: 'en'
162+
}
163+
},
164+
user: {
165+
data: [
166+
{
167+
name: 'example.com',
168+
ext: {
169+
segtax: 600
170+
},
171+
segment: [
172+
{ id: '1' },
173+
{ id: '2' }
174+
]
175+
}
176+
]
177+
}
178+
}
179+
});
180+
```
181+
182+
### Price Floors
183+
184+
Revantage supports the [Prebid.js Price Floors Module](/dev-docs/modules/floors.html). Configure floors as usual and the adapter will include floor data in bid requests.
185+
186+
```javascript
187+
pbjs.setConfig({
188+
floors: {
189+
enforcement: {
190+
floorDeals: true
191+
},
192+
data: {
193+
currency: 'USD',
194+
schema: {
195+
fields: ['mediaType', 'size']
196+
},
197+
values: {
198+
'banner|300x250': 0.50,
199+
'banner|728x90': 0.75,
200+
'video|640x480': 2.00
201+
}
202+
}
203+
}
204+
});
205+
```
206+
207+
### Supply Chain (schain)
208+
209+
Revantage passes supply chain information to demand partners. Configure schain in your Prebid.js setup:
210+
211+
```javascript
212+
pbjs.setConfig({
213+
schain: {
214+
validation: 'relaxed',
215+
config: {
216+
ver: '1.0',
217+
complete: 1,
218+
nodes: [
219+
{
220+
asi: 'yoursite.com',
221+
sid: 'your-seller-id',
222+
hp: 1
223+
}
224+
]
225+
}
226+
}
227+
});
228+
```
229+
230+
### User ID Modules
231+
232+
Revantage supports all Prebid.js User ID modules. User IDs are automatically passed in the bid request when available.
233+
234+
### Test Parameters
235+
236+
Use these parameters to test the Revantage adapter:
237+
238+
```javascript
239+
var adUnits = [
240+
{
241+
code: 'test-banner',
242+
mediaTypes: {
243+
banner: {
244+
sizes: [[300, 250]]
245+
}
246+
},
247+
bids: [
248+
{
249+
bidder: 'revantage',
250+
params: {
251+
feedId: 'test-feed-123'
252+
}
253+
}
254+
]
255+
}
256+
];
257+
```

0 commit comments

Comments
 (0)