Skip to content

Commit bf16513

Browse files
leonardlabatbretg
leonardlabat
authored and
bretg
committed
Updated Criteo adapter documentation with Video params description & sample (prebid#1414)
1 parent a5fb31e commit bf16513

File tree

1 file changed

+55
-2
lines changed

1 file changed

+55
-2
lines changed

‎dev-docs/bidders/criteo.md

Lines changed: 55 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,11 @@ description: Prebid Criteo Bidder Adaptor
55
hide: true
66
biddercode: criteo
77
bidder_supports_deals: false
8-
media_types: native
8+
media_types: display, native, video
99
gdpr_supported: true
1010
prebid_member: true
1111
---
1212

13-
1413
### Bid Params
1514

1615
{: .table .table-bordered .table-striped }
@@ -20,3 +19,57 @@ prebid_member: true
2019
| `networkId` | optional | The network ID from Criteo.Please reach out your Criteo representative for more details. | `456456` | `integer` |
2120
| `nativeCallback` | optional | Callback to perform render in native integrations. Please reach out your Criteo representative for more details. | `function(payload) { console.log(payload); }` | `function` |
2221
| `integrationMode` | optional | Integration mode to use for ad render (none or 'AMP'). Please reach out your Criteo representative for more details. | `'AMP'` | `string` |
22+
23+
### Video Object
24+
25+
{: .table .table-bordered .table-striped }
26+
| Name | Scope | Description | Example | Type |
27+
|-------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-----------|
28+
| `minduration` | optional | Minimum ad duration in seconds | `5` | `integer` |
29+
| `startdelay` | optional | Duration offset (in second) from the start of the content for showing the video ad before the start of the Video. Pre-roll: `0` (default); Mid-roll: `>0`; Default mid-roll: `-1`; Post-roll: `-2`; | `5` | `integer` |
30+
| `playbackmethod` | required | Defines how is initiated the video inventory. Page Load with Sound On: `1`; Page Load with Sound Off: `2`; Click with Sound On: `3`; Mouse-Over with Sound On: `4`; Entering Viewport with Sound On: `5`; Entering Viewport with Sound Off by Default: `6`; | `1` | `integer` |
31+
| `placement` | optional | Video placement type. In-Stream: `1`; In-Banner: `2`; In-Article: `3`: In-Feed: `4`; Interstitial: `5`; | `1` | `integer` |
32+
| `skip` | required | Ability from the video player for the user to skip the video. Not skippable: `0`; Skippable: `1`; | `1` | `integer` |
33+
34+
In addition, Criteo adapter relies on parameters specified in the mediaTypes.video definition of the video ad-units, namely:
35+
36+
{: .table .table-bordered .table-striped }
37+
| Name | Scope | Description | Example | Type |
38+
|-------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------------------|
39+
| `context` | required | `outstream`, `instream` or `long-form` | `instream` | `string` |
40+
| `mimes` | required | List of the content MIME types supported by the player | `["video/mp4"]` | `Array<string>` |
41+
| `playerSize` | required | Width and height of the player | `[640, 480]` | `Array<integer>` |
42+
| `protocols` | required | Supported video bid response protocols. VAST 1.0: `1`; VAST 2.0: `2`; VAST 3.0: `3`; VAST 1.0 Wrapper: `4`; VAST 2.0 Wrapper: `5`; VAST 3.0 Wrapper: `6`; | `|5, 6]` | `Array<integer>` |
43+
| `maxduration` | required | Maximum ad duration in seconds | `20` | `integer` |
44+
| `api` | required | API frameworks supported. VPAID 1.0: `1`; VPAID 2.0: `2`; MRAID-1: `3`; ORMMA: `4`; MRAID-2: `5`; | `[1, 2]` | `Array<integer>` |
45+
46+
#### Example of Video Ad-unit
47+
```
48+
var videoAdUnits = [
49+
{
50+
code: 'test-div-video',
51+
mediaTypes: {
52+
video: {
53+
playerSize: [640, 480],
54+
context: 'instream' ,
55+
mimes: ['video/mp4','video/x-flv'],
56+
maxduration: 30,
57+
api: [ 1, 2 ],
58+
protocols: [ 2, 3 ],
59+
}
60+
},
61+
bids: [{
62+
bidder: 'criteo',
63+
params: {
64+
zoneid: '32572',
65+
video: {
66+
skip: 1,
67+
minduration: 5,
68+
startdelay: 5,
69+
playbackmethod: 1,
70+
placement: 2
71+
}
72+
}
73+
}]
74+
}]
75+
```

0 commit comments

Comments
 (0)