Skip to content

Commit

Permalink
VIS.X: update docs (#3402)
Browse files Browse the repository at this point in the history
Update the VIS.X documentation under the latest adapter changes.
  • Loading branch information
rrelict authored Nov 19, 2021
1 parent dd45221 commit f9934ab
Showing 1 changed file with 8 additions and 18 deletions.
26 changes: 8 additions & 18 deletions dev-docs/bidders/visx.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Best practices:

### Configuration: Video

The YOC VIS.X adapter responds with VAST XML (in the 'vastXml' field) and expects client-side caching enabled.
The YOC VIS.X Prebid.js adapter responds with VAST XML (in the `vastXml` field) and expects client-side caching enabled. To enable it, use the following settings:

```javascript
pbjs.setConfig({
Expand Down Expand Up @@ -103,12 +103,7 @@ pbjs.setConfig({
|-------|----------|-------------------------------------|------------|----------|
| `context` | required | The video context, only 'instream' is allowed. | `'instream'` | `string` |
| `playerSize` | required | The size (width, height) of the video player on the page, in pixels. | `[640, 480]` | `integer array` |
| `mimes` | required | Content MIME types supported. | `['video/mp4', 'video/x-ms-wmv']` | `string array` |
| `protocols` | required | Array of supported video protocols. Refer to List 5.8 of IAB OpenRTB 2.5 (e.g., VAST 3.0 Wrapper). | `[2,3,5,6]` | `integer array` |
| `api` | optional | List of supported API frameworks for this impression. Refer to List 5.6 of IAB OpenRTB 2.5 (e.g., VPAID 2.0). If an API is not explicitly listed, it is assumed not to be supported. | `[2]` | `integer array` |
| `minduration` | optional | Minimum video ad duration in seconds. | `5` | `integer` |
| `maxduration` | optional | Maximum video ad duration in seconds. | `30` | `integer` |
| `skip` | optional | Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes. | `1` | `integer` |
| `mimes` | optional | Content MIME types supported. | `['video/mp4', 'video/x-ms-wmv']` | `string array` |

### Example of Banner Ad unit

Expand All @@ -117,13 +112,13 @@ var bannerAdUnit = {
code: 'bannerAdUnit1',
mediaTypes: {
banner: {
sizes: [[320, 480], [728, 90]] // required
sizes: [[320, 480], [728, 90]] // required
}
},
bids: [{
bidder: 'visx',
params: {
uid: '903536' // required
uid: '903536' // required
}
}]
};
Expand All @@ -136,20 +131,15 @@ var videoAdUnit = {
code: 'videoAdUnit1',
mediaTypes: {
video: {
context: 'instream', // required
playerSize: [400, 300], // required
mimes: ['video/mp4', 'video/x-ms-wmv'], // required
protocols: [2, 3, 5, 6], // required
api: [2], // optional
minduration: 5, // optional
maxduration: 30, // optional
skip: 1 // optional
context: 'instream', // required
playerSize: [400, 300], // required
mimes: ['video/mp4'] // optional, required by Prebid Server
}
},
bids: [{
bidder: 'visx',
params: {
uid: '921068' // required
uid: '921068' // required
}
}]
};
Expand Down

0 comments on commit f9934ab

Please sign in to comment.