Skip to content

Commit f865e12

Browse files
authored
StackAdapt Bid Adapter: initial release (#5952)
merged :)
1 parent ba68d3a commit f865e12

File tree

1 file changed

+157
-0
lines changed

1 file changed

+157
-0
lines changed

dev-docs/bidders/stackadapt.md

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
---
2+
layout: bidder
3+
title: StackAdapt
4+
description: StackAdapt Prebid Bidder Adapter
5+
biddercode: stackadapt
6+
pbjs: true
7+
pbs: false
8+
gvl_id: 238
9+
tcfeu_supported: true
10+
usp_supported: true
11+
userId: all
12+
media_types: banner, video
13+
coppa_supported: true
14+
gpp_sids: tcfeu, tcfca, usnat, usstate_all, usp
15+
gpp_supported: true
16+
schain_supported: true
17+
dchain_supported: false
18+
deals_supported: true
19+
floors_supported: true
20+
fpd_supported: true
21+
ortb_blocking_supported: true
22+
multiformat_supported: will-bid-on-any
23+
privacy_sandbox: no
24+
prebid_member: false
25+
sidebarType: 1
26+
---
27+
28+
### Bid Params
29+
30+
{: .table .table-bordered .table-striped }
31+
| Name | Scope | Description | Example | Type |
32+
|---------------|----------|-----------------------------|--------------------|----------|
33+
| `publisherId` | required | StackAdapt provided id | `'4cd53a92ra91'` | `string` |
34+
| `placementId` | optional | StackAdapt provided id | `'e95365f397a7'` | `string` |
35+
| `banner` | optional | banner supporting expdir | `{expdir: [1, 3]}` | `object` |
36+
| `bidfloor` | optional | bid floor price | `1.01` | `float` |
37+
38+
The following banner parameters are supported:
39+
40+
{: .table .table-bordered .table-striped }
41+
| Name | Scope | Description | Example | Type |
42+
|----------|----------|-----------------------------------|----------|------------------|
43+
| `expdir` | optional | Directions the banner may expand. | `[1, 3]` | `Array[integer]` |
44+
45+
### Banner
46+
47+
#### `mediaTypes.banner` Parameters
48+
49+
The StackAdapt bid adapter requires `sizes` to be defined in valid format.
50+
See [mediaTypes.banner](https://docs.prebid.org/dev-docs/adunit-reference.html#adUnit.mediaTypes.banner) for defining mediaTypes parameters.
51+
52+
Below are banner ad unit examples with required and optional parameters:
53+
54+
```js
55+
var adUnits = [
56+
// Banner adUnit - required parameters
57+
{
58+
code: 'div-test-ad-1',
59+
mediaTypes: {
60+
banner: {
61+
sizes: [[300, 250]]
62+
}
63+
},
64+
bids: [{
65+
bidder: 'stackadapt',
66+
params: {
67+
publisherId: '4cd53a92ra91',
68+
}
69+
}]
70+
},
71+
// Banner adUnit - including optional parameters
72+
{
73+
code: 'div-test-ad-2',
74+
mediaTypes: {
75+
banner: {
76+
sizes: [[300, 250]],
77+
pos: 1
78+
}
79+
},
80+
bids: [{
81+
bidder: 'stackadapt',
82+
params: {
83+
publisherId: '4cd53a92ra91',
84+
placementId: 'e95365f397a7',
85+
bidfloor: 1.01,
86+
banner: {
87+
expdir: [1, 3]
88+
}
89+
}
90+
}]
91+
}
92+
];
93+
```
94+
95+
### Video
96+
97+
#### `mediaTypes.video` Parameters
98+
99+
The StackAdapt bid adapter requires `mimes`, `protocols`, `maxduration`, `api`, and `plcmt` to be defined in valid format.
100+
See [mediaTypes.video](https://docs.prebid.org/dev-docs/adunit-reference.html#adUnit.mediaTypes.video) for defining mediaTypes parameters.
101+
102+
Below are video ad unit examples with required and optional parameters:
103+
104+
```js
105+
var adUnits = [
106+
// Video adUnit - required parameters
107+
{
108+
code: 'div-test-ad-3',
109+
mediaTypes: {
110+
video: {
111+
mimes: ['video/mp4'],
112+
protocols: [2, 3, 5, 6],
113+
maxduration: 60,
114+
api: [1, 2],
115+
plcmt: 1
116+
}
117+
},
118+
bids: [{
119+
bidder: 'stackadapt',
120+
params: {
121+
publisherId: '4cd53a92ra91',
122+
}
123+
}]
124+
},
125+
// Video adUnit - including optional parameters
126+
{
127+
code: 'div-test-ad-4',
128+
mediaTypes: {
129+
video: {
130+
playerSize: [640, 360],
131+
mimes: ['video/mp4'],
132+
protocols: [2, 3, 5, 6],
133+
minduration: 1,
134+
maxduration: 60,
135+
api: [1, 2],
136+
playback_method: [1],
137+
plcmt: 1,
138+
startdelay: 1,
139+
pos: 1,
140+
minbitrate: 300,
141+
maxbitrate: 1500,
142+
skip: 1,
143+
skipmin: 5,
144+
skipafter: 15
145+
}
146+
},
147+
bids: [{
148+
bidder: 'stackadapt',
149+
params: {
150+
publisherId: '4cd53a92ra91',
151+
placementId: 'e95365f397a7',
152+
bidfloor: 1.01,
153+
}
154+
}]
155+
}
156+
];
157+
```

0 commit comments

Comments
 (0)