Skip to content

Commit f059dec

Browse files
authored
Start.io: documentation updated (#6492)
* Update Start.io bidder documentation: add GPP and user sync support, enhance examples * Fix table formatting in Start.io bidder documentation for userSync parameters * Update Start.io bidder docs: mark GPP as unsupported
1 parent 658de00 commit f059dec

1 file changed

Lines changed: 116 additions & 12 deletions

File tree

dev-docs/bidders/startio.md

Lines changed: 116 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ description: Prebid Start.io Adapter
66
tcfeu_supported: true
77
coppa_supported: true
88
gpp_supported: false
9+
userIds: startioId
910
floors_supported: true
1011
media_types: banner, video, native
1112
multiformat_supported: will-bid-on-any
@@ -15,7 +16,7 @@ gvl_id: 1216
1516
usp_supported: true
1617
pbjs: true
1718
pbs: true
18-
prebid_member: false
19+
prebid_member: true
1920
fpd_supported: false
2021
privacy_sandbox: no
2122
ortb_blocking_supported: true
@@ -29,41 +30,144 @@ The Start.io bidder adapter requires additional setup and approval from the Star
2930
### Bid Params
3031

3132
{: .table .table-bordered .table-striped }
32-
| Name | Scope | Description | Example | Type |
33-
|---------------|----------|-----------------------------------|------------------------|--------------|
34-
| `publisherId` | required | Publisher ID | `'publisher-1234'` | `string` |
33+
34+
| Name | Scope | Description | Example | Type |
35+
| --- | --- | --- | --- | --- |
36+
| `publisherId` | required | Publisher ID | `'publisher-1234'` | `string` |
37+
| `testAdsEnabled` | optional | Enable test ads during development | `true` | `boolean` |
3538

3639
#### Configuration
3740

38-
Sample banner setup:
41+
##### Banner
3942

4043
```js
4144
var adUnits = [
4245
{
43-
code: "div-gpt-ad-12345-0",
46+
code: 'test-div',
4447
mediaTypes: {
4548
banner: {
46-
sizes: [[300, 250]]
49+
sizes: [[300, 250], [728, 90]]
4750
}
4851
},
4952
bids: [
5053
{
51-
bidder: "startio",
54+
bidder: 'startio',
5255
params: {
53-
publisherId: "publisher-12345"
56+
publisherId: 'your-account-id',
57+
testAdsEnabled: true
5458
}
5559
}
5660
]
5761
}
58-
]
62+
];
63+
```
64+
65+
##### Instream Video
5966

60-
pbjs.que.push(function() {
61-
pbjs.addAdUnits(adUnits);
67+
```js
68+
var videoAdUnits = [
69+
{
70+
code: 'test-div-video',
71+
mediaTypes: {
72+
video: {
73+
context: 'instream',
74+
placement: 1,
75+
playerSize: [640, 360],
76+
mimes: ['video/mp4'],
77+
protocols: [2, 3, 5, 6],
78+
api: [2],
79+
maxduration: 30,
80+
linearity: 1,
81+
playbackmethod: [2]
82+
}
83+
},
84+
bids: [
85+
{
86+
bidder: 'startio',
87+
params: {
88+
publisherId: 'your-account-id',
89+
testAdsEnabled: true
90+
}
91+
}
92+
]
93+
}
94+
];
95+
```
96+
97+
##### Native
98+
99+
```js
100+
var nativeAdUnits = [
101+
{
102+
code: 'test-div-native',
103+
mediaTypes: {
104+
native: {
105+
title: { required: true, len: 80 },
106+
body: { required: true },
107+
image: { required: true, sizes: [150, 150] },
108+
icon: { required: false, sizes: [50, 50] },
109+
sponsoredBy: { required: true }
110+
}
111+
},
112+
bids: [
113+
{
114+
bidder: 'startio',
115+
params: {
116+
publisherId: 'your-account-id',
117+
testAdsEnabled: true
118+
}
119+
}
120+
]
121+
}
122+
];
123+
```
124+
125+
### User Sync and User ID Module
126+
127+
The Start.io User ID submodule generates and persists a unique user identifier by fetching it from a Start.io-managed endpoint. The ID is stored in both cookies and local storage for subsequent page loads and is made available to other Prebid.js modules via the standard `eids` interface.
128+
129+
To enable iframe-based user syncing and the Start.io User ID module, include the following configuration:
130+
131+
```javascript
132+
pbjs.setConfig({
133+
userSync: {
134+
userIds: [{
135+
name: 'startioId',
136+
storage: {
137+
type: 'cookie&html5',
138+
name: 'startioId',
139+
expires: 90
140+
}
141+
}],
142+
filterSettings: {
143+
iframe: {
144+
bidders: ['startio'],
145+
filter: 'include'
146+
}
147+
}
148+
}
62149
});
63150
```
64151

152+
For integration support, contact <prebid@start.io>.
153+
154+
#### User ID Parameters
155+
156+
{: .table .table-bordered .table-striped }
157+
158+
| Param under userSync.userIds[] | Scope | Type | Description | Example |
159+
| --- | --- | --- | --- | --- |
160+
| `name` | required | String | The name of this module. | `"startioId"` |
161+
| `storage` | required | Object | Storage configuration for the user ID. | |
162+
| `storage.type` | required | String | Type of storage: `"cookie"`, `"html5"`, or `"cookie&html5"`. | `"cookie&html5"` |
163+
| `storage.name` | required | String | The name used to store the user ID. | `"startioId"` |
164+
| `storage.expires` | optional | Number | Number of days before the stored ID expires. Defaults to `90`. | `90` |
165+
65166
### Additional Notes
66167

67168
#### Request and Response Attributes
68169

69170
- Bids are returned in **net** - that is, the bids returned reflect the bid amount with revenue sharing already taken into account. No adjustment is necessary.
171+
- The adapter processes requests via OpenRTB 2.5 standards.
172+
- Ensure that the `publisherId` parameter is set correctly for your integration.
173+
- Test ads can be enabled using `testAdsEnabled: true` during development.

0 commit comments

Comments
 (0)