Skip to content

Commit 2023e41

Browse files
New adapter - Playstream (#6454)
* New adapter - Playstream * update Playstream bidder documentation: add missing gvl_id and remove deprecated params * add missing line break in Playstream bidder documentation --------- Co-authored-by: Yash Chotaliya <yashc@adsolut.in>
1 parent 52d6aed commit 2023e41

1 file changed

Lines changed: 137 additions & 0 deletions

File tree

dev-docs/bidders/playstream.md

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
---
2+
layout: bidder
3+
title: Playstream Media
4+
description: Prebid.js Playstream Media Bid Adapter
5+
biddercode: playstream
6+
pbjs: true
7+
media_types: video, banner
8+
multiformat_supported: will-bid-on-one
9+
userIds: all
10+
fpd_supported: true
11+
tcfeu_supported: true
12+
gvl_id: 1524
13+
usp_supported: some
14+
coppa_supported: some
15+
schain_supported: true
16+
prebid_member: false
17+
ortb_blocking_supported: some
18+
floors_supported: true
19+
sidebarType: 1
20+
---
21+
22+
## Description
23+
24+
**Playstream Media** Prebid.js adapter supports **banner** and **video** demand using an **OpenRTB 2.x** request/response flow.
25+
26+
The adapter sends a **POST** request to:
27+
28+
- `https://<host>/server/adserver/hb?adUnitId=<adUnitId>&publisherId=<publisherId>`
29+
30+
> Note: `host` should be a hostname only (no protocol, no path). The adapter uses HTTPS.
31+
>
32+
> Note: `getUserSyncs()` currently returns an empty array (no user sync pixels are triggered by this adapter).
33+
34+
## Bid Params
35+
36+
{: .table .table-bordered .table-striped }
37+
38+
| Name | Scope | Description | Example | Type |
39+
|:----------------|:---------|:-------------------------------------------------------------------------|:-------------------------------|:---------|
40+
| `host` | required | Playstream bidder host (hostname only; no protocol/path) | `'exchange.ortb.net'` | `string` |
41+
| `adUnitId` | required | adUnit ID from Playstream Platform | `'697871ac0ec1c6100e1f9121'` | `string` |
42+
| `publisherId` | required | Publisher ID from Playstream Platform | `'697871ac0ec1c6100e1f9122'` | `string` |
43+
| `type` | required | Type of request: `'video'` or `'banner'` | `'banner'` | `string` |
44+
| `price` | optional | Bid floor in `USD` only (defaults to Playstream dashboard configuration) | `0.5` | `number` |
45+
| `ip` | optional | User IP (targeting) | `'192.168.1.1'` | `string` |
46+
| `maxAdDuration` | optional | Max ad pod duration (seconds) | `120` | `number` |
47+
| `maxSlotPerPod` | optional | Max ad slots per pod | `3` | `number` |
48+
49+
## Required Params
50+
51+
Playstream Media client-side Prebid.js adapter requires only:
52+
53+
- `host`
54+
- `adUnitId`
55+
- `publisherId`
56+
- `type`
57+
58+
## Supported Media Types
59+
60+
This adapter supports only:
61+
62+
- `banner`
63+
- `video`
64+
65+
It does **not** support `native` or `audio`.
66+
67+
## First Party Data and User IDs
68+
69+
- **FPD (First Party Data):** When available, the adapter forwards `bidderRequest.ortb2` and impression-level `bidRequest.ortb2Imp` into the OpenRTB request (`site/app/user/device/regs/ext`).
70+
- **User IDs:** If your Prebid build includes User ID modules, their EIDs typically appear under `ortb2.user.ext.eids` and are forwarded in the OpenRTB request.
71+
72+
## Privacy Support Notes
73+
74+
- **TCF-EU (GDPR):** If Prebid populates consent into `ortb2.regs` / `ortb2.user.ext.consent`, the adapter forwards it.
75+
- **USP/CCPA & COPPA:** If these signals are present in `ortb2.regs` (or related fields), they will be forwarded as part of the OpenRTB request.
76+
77+
## schain Support
78+
79+
If the `schain` module is enabled in Prebid, the adapter forwards supply chain information in the OpenRTB request (typically `source.ext.schain`).
80+
81+
## Sample Bids
82+
83+
### Display
84+
85+
Replace the values below with the Host / Ad Unit ID / Publisher ID shared by the Admin/Support team. Do not use the sample IDs in production.
86+
87+
```javascript
88+
var adUnits = [
89+
{
90+
code: 'div-1',
91+
mediaTypes: {
92+
banner: {
93+
sizes: [[300, 250], [728, 90]]
94+
}
95+
},
96+
sizes: [[300, 250], [728, 90]],
97+
bids: [{
98+
bidder: 'playstream',
99+
params: {
100+
host: 'asia-southeast.ortb.net', // Provided by Admin/Support team
101+
adUnitId: '697871ac0ec1c6100e1f9121', // Provided by Admin/Support team
102+
publisherId: '697871ac0ec1c6100e1f9122', // Provided by Admin/Support team
103+
type: 'banner',
104+
}
105+
}]
106+
}
107+
];
108+
```
109+
110+
### Video
111+
112+
Replace the values below with the Host / Ad Unit ID / Publisher ID shared by the Admin/Support team. Do not use the sample IDs in production.
113+
114+
```javascript
115+
var adUnits = [
116+
{
117+
code: 'div-2',
118+
mediaTypes: {
119+
video: {
120+
context: 'instream',
121+
playerSize: [640, 360]
122+
}
123+
},
124+
sizes: [640, 360],
125+
bids: [{
126+
bidder: 'playstream',
127+
params: {
128+
host: 'asia-southeast.ortb.net', // Provided by Admin/Support team
129+
adUnitId: '697871ac0ec1c6100e1f9121', // Provided by Admin/Support team
130+
publisherId: '697871ac0ec1c6100e1f9122', // Provided by Admin/Support team
131+
type: 'video',
132+
price: 0.4
133+
}
134+
}]
135+
}
136+
];
137+
```

0 commit comments

Comments
 (0)