yieldmo.md: video support is documented (prebid#2532)

* yieldmo.md: video support is documented * Update yieldmo.md
onfocusio · Jan 21, 2021 · ab26826 · ab26826
1 parent 5960172
commit ab26826
Showing 1 changed file with 62 additions and 3 deletions.
diff --git a/dev-docs/bidders/yieldmo.md b/dev-docs/bidders/yieldmo.md
@@ -3,7 +3,7 @@ layout: bidder
 title: Yieldmo
 description: Prebid Yieldmo Bidder Adaptor
 biddercode: yieldmo
-media_types: banner
+media_types: banner, video
 userIds: pubCommonId, unifiedId, criteo
 gdpr_supported: true
 usp_supported: true
@@ -18,7 +18,66 @@ pbs: true
 ### Bid Params
 
 {: .table .table-bordered .table-striped }
-| Name          | Scope    | Description          | Example                   | Type     |
-|---------------|----------|----------------------|---------------------------|----------|
+| Name          | Scope    | Description          | Example                | Type     |
+|---------------|----------|----------------------|------------------------|----------|
 | `placementId` | required | Yieldmo placement id | `'825209316101005155'` | `string` |
 | `bidFloor`    | optional |      Bid Floor       |         `0.1`          |  `float` |
+
+### video parameters
+The Yieldmo adapter supports video as of Prebid v4.18.
+
+{: .table .table-bordered .table-striped }
+| Name              | Scope    | Description                                            | Example         | Type      |
+|-------------------|----------|--------------------------------------------------------|-----------------|-----------|
+| `placement`       | required | Video placement type. In-Stream: `1`; In-Banner: `2`; In-Article: `3`: In-Feed: `4`; Interstitial: `5`; see [OpenRTB 2.5 specification](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf), List 5.9 for more details | `1` | `integer` |
+| `maxduration`     | required | Maximum ad duration in seconds                         | `20`            | `integer` |
+| `minduration`     | optional | Minimum ad duration in seconds                         | `5`             | `integer` |
+| `pos`             | optional | Ad position on screen; see [OpenRTB 2.5 specification](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf), List 5.4 for more details | `1`  | `integer` |
+| `startdelay`      | required if placement == 1 | 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` |
+| `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`; | `[2, 3]`        | `Array<integer>` |
+| `api`             | required | API frameworks supported. VPAID 1.0: `1`; VPAID 2.0: `2`; MRAID-1: `3`; ORMMA: `4`; MRAID-2: `5`; MRAID-3: `6`;                                           | `[1, 2]`        | `Array<integer>` |
+| `playbackmethod`  | required | Playback methods that may be in use; see [OpenRTB 2.5 specification](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf), List 5.10 for more details | `[2,6]`  | `Array<integer>` |
+| `skippable`       | optional | If 'true', user can skip ad                            | `true`          | `boolean` |
+| `skipafter`       | optional | Number of seconds a video must play before skipping is enabled; only applicable if the ad is `skippable` | `5`  | `integer` |
+
+In addition, Yieldmo adapter relies on parameters specified in the `mediaTypes.video` definition of the video ad-units, namely:
+
+{: .table .table-bordered .table-striped }
+| Name              | Scope    | Description                                            | Example         | Type             |
+|-------------------|----------|--------------------------------------------------------|-----------------|------------------|
+| `playerSize`      | required | Width and height of the player                         | `[640, 480]`    | `Array<integer>` |
+| `context`         | required | Only `instream` is supported                           | `instream`      | `string`         |
+| `mimes`           | required | List of the content MIME types supported by the player | `["video/mp4"]` | `Array<string>`  |
+
+
+### Example of Video Ad-unit
+```javascript
+var videoAdUnits = [{
+  code: 'div-video-ad-1234567890',
+  mediaTypes: {
+    video: {
+      playerSize: [640, 480], // required
+      context: 'instream',
+      mimes: ['video/mp4']    // required, array of strings
+    }
+  },
+  bids: [{
+    bidder: 'yieldmo',
+    params: {
+      placementId: '1524592390382976659', // required
+      video: {
+        placement: 1,       // required, integer
+        maxduration: 30,    // required, integer
+        minduration: 15,    // optional, integer
+        pos: 1,             // optional, integer
+        startdelay: 10,     // required if placement == 1
+        protocols: [2, 3],  // required, array of integers
+        api: [2, 3],        // required, array of integers
+        playbackmethod: [2,6], // required, array of integers
+        skippable: true,    // optional, boolean
+        skipafter: 10       // optional, integer
+      }
+    }
+  }]
+}];
+```