Skip to content

Commit 56ac063

Browse files
committed
adquery: update bidder documentation with expanded specs and examples
1 parent a0eb7ad commit 56ac063

File tree

1 file changed

+104
-5
lines changed

1 file changed

+104
-5
lines changed

dev-docs/bidders/adquery.md

Lines changed: 104 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,112 @@ schain_supported: true
1111
gvl_id: 902
1212
userIds: adQuery QiD
1313
sidebarType: 1
14+
media_types: banner, video
1415
---
1516

1617
### Bid Params
1718

1819
{: .table .table-bordered .table-striped }
19-
| Name | Scope | Description | Example | Type |
20-
|---------------|----------|---------------|--------------------------------------------------------------------------|-----------|
21-
| `placementId` | required | Placement ID | `6d93f2a0e5f0fe2cc3a6e9e3ade964b43b07f897` | `string` |
22-
| `type` | required | Ad Type | `banner` | `string` |
23-
| `sizes` | required | Allowed sizes | `320x100,300x250,336x280,300x50,300x100,320x50,320x480,300x150,320x180` | `string` |
20+
| Name | Scope | Description | Example | Type |
21+
|---------------|----------|-----------------------------------------------------------------------------|--------------------------------------------------------------------------|-----------|
22+
| `placementId` | required | Placement ID provided by Adquery (must match the type/format in dashboard) | `d30f79cf7fef47bd7a5611719f936539bec0d2e9` | `string` |
23+
| `type` | required | Ad format/type – tells Adquery what kind of creative to return | `banner`, `video`, `interstitial`, `anchorad` | `string` |
24+
25+
**Notes:**
26+
27+
- `placementId` is always required and should correspond to a placement configured in the Adquery dashboard for the specific `type`.
28+
- `type` is mandatory in bidder params — it determines the creative format (banner, video, interstitial, anchorad).
29+
- For **banner** ads: Define sizes in `mediaTypes.banner.sizes`. The adapter automatically parses and sends them.
30+
- For **video** ( outstream ): Use `type: 'video'` + `mediaTypes.video.context: 'outstream'`. A renderer is required for rendering (e.g. InRenderer or similar). In-stream video is not currently supported by this adapter.
31+
- For **video** ( instream ): Use `type: 'video'` + `mediaTypes.video.context: 'instream'`. A renderer is required for rendering (e.g. InRenderer or similar). In-stream video is not currently supported by this adapter.
32+
- For special formats (`interstitial`, `anchorad`): A spetial size placeholder is reqired `[1x1]`.
33+
34+
### Example 1: Standard Banner Ad
35+
36+
```javascript
37+
{
38+
code: 'banner-div',
39+
mediaTypes: {
40+
banner: {
41+
sizes: [[300, 250], [320, 50], [728, 90]]
42+
}
43+
},
44+
bids: [{
45+
bidder: 'adquery',
46+
params: {
47+
placementId: '9e0a916215d99196f44821dfc348c2843ee5b5a7',
48+
type: 'banner'
49+
}
50+
}]
51+
}
52+
```
53+
54+
### Example 2: Outstream Video Ad (with renderer)
55+
56+
```javascript
57+
{
58+
code: 'video-outstream-1',
59+
mediaTypes: {
60+
video: {
61+
context: 'outstream',
62+
playerSize: [[640, 360]],
63+
mimes: ['video/mp4', 'video/webm'],
64+
protocols: [2, 3, 5, 6, 7, 8],
65+
api: [2],
66+
placement: 1,
67+
startdelay: 0,
68+
skip: 1
69+
}
70+
},
71+
renderer: {
72+
url: 'https://cdn.jsdelivr.net/npm/in-renderer-js@1/dist/in-renderer.umd.min.js',
73+
render: function(bid) {
74+
var renderer = new window.InRenderer();
75+
renderer.render('video-outstream-1', bid);
76+
}
77+
},
78+
bids: [{
79+
bidder: 'adquery',
80+
params: {
81+
placementId: 'd30f79cf7fef47bd7a5611719f936539bec0d2e9',
82+
type: 'video'
83+
}
84+
}]
85+
}
86+
```
87+
88+
### Example 3: Interstitial + Anchor Ad (no sizes)
89+
90+
```javascript
91+
// Interstitial (full-page overlay)
92+
{
93+
code: 'interstitial-div',
94+
mediaTypes: {
95+
banner: {
96+
sizes: [[1, 1]]
97+
}
98+
},
99+
bids: [{
100+
bidder: 'adquery',
101+
params: {
102+
placementId: 'd30f79cf7fef47bd7a5611719f936539bec0d2e9',
103+
type: 'interstitial'
104+
}
105+
}]
106+
},
107+
108+
// Anchor / fixed bottom bar
109+
{
110+
code: 'anchor-div',
111+
banner: {
112+
sizes: [[1, 1]]
113+
},
114+
bids: [{
115+
bidder: 'adquery',
116+
params: {
117+
placementId: 'd30f79cf7fef47bd7a5611719f936539bec0d2e9',
118+
type: 'anchorad'
119+
}
120+
}]
121+
}
122+
```

0 commit comments

Comments
 (0)