Impactify Bid Adapter: add instream support

dev-docs/bidders/impactify.md

@@ -10,47 +10,198 @@ tcf2_supported: true
 usp_supported: true
 schain_supported: true
 coppa_supported: true
-media_types: video
+floors_supported: true
+media_types: banner, video
 userIds: criteo, id5Id, pubCommonId, unifiedId, uid2, netId
 gvl_id: 606
 sidebarType: 1
 ---
 
-### Note
+## Note
 
-The Impactify adaptator requires setup and validation from the Impactify team. Simply email us your contact details at <support@impactify.io> and we'll make sure we'll connect you within 48h.
+The Impactify adapter requires setup and validation from the Impactify team. Simply email us your contact details at <support@impactify.io> and we'll make sure we connect with you within 48 hours.
 
 ### Bid Params
 
 {: .table .table-bordered .table-striped }
-| Name          | Scope    | Description                                        | Example        | Type      |
-|---------------|----------|----------------------------------------------------|----------------|-----------|
-| `appId`       | required | Impactify publisher id  (Contact us)               | `'example.com'`  | `string`  |
-| `format`      | required | Impactify ad format (screen or display)            | `'screen'`       | `string`  |
-| `style`       | required | Impactify ad style (inline, impact or static)      | `'impact'`       | `string`  |
+| Name        | Scope    | Description                                                                                            | Example                          | Type     |
+| ----------- | -------- | ------------------------------------------------------------------------------------------------------ | -------------------------------- | -------- |
+| `accountId` | required | Impactify publisher ID.                                                                                | `'1234'`                         | `string` |
+| `appId`     | required | Impactify inventory ID.                                                                                | `'example.com'`                  | `string` |
+| `format`    | required | Impactify ad format. Use `screen` for rich media and banner, and `player` for instream video.          | `'screen'`                       | `string` |
+| `style`     | required | Impactify ad style. Supported values depend on the integration type. See below.                        | `'impact'`                       | `string` |
+| `size`      | optional | Impactify ad size.                                                                                     | `'300x250'`                      | `string` |
+| `render`    | optional | Render options. See sub-options below.                                                                 | `{ bottom: 10, expandAd: true }` | `object` |
+
+#### `render` sub-options
+
+{: .table .table-bordered .table-striped }
+| Name              | Scope    | Description                                                  | Example                | Type      |
+| ----------------- | -------- | ------------------------------------------------------------ | ---------------------- | --------- |
+| `top`             | optional | Top offset used for ad rendering.                            | `10`                   | `number`  |
+| `bottom`          | optional | Bottom offset used for ad rendering.                         | `10`                   | `number`  |
+| `expandAd`        | optional | Enables ad expansion behavior when supported.                | `true`                 | `boolean` |
+| `location`        | optional | Changes the position of the player.                          | `'top-left'`           | `string`  |
+| `onAdEventName`   | optional | Name of the browser event fired when an ad is rendered.      | `'impactifyAdLoaded'`  | `string`  |
+| `onNoAdEventName` | optional | Name of the browser event fired when no ad is returned.      | `'impactifyNoAd'`      | `string`  |
+
+### Integration Types
+
+Impactify supports three integration types:
+
+- **Rich media formats**: for Impactify rich media experiences using `format: "screen"` with styles such as `impact`, `inline`, `skyline`, or `static`.
+- **Instream Video**: for standard instream video using `format: "player"`.
+- **Banner**: for standard banner placements, typically using `format: "screen"` with `style: "static"`.
+
+### Rich media formats
+
+Use this integration for rich media placements.
+
+#### Supported styles
+
+- **impact**: sticky at the bottom.
+- **inline**: in-content, then sticky at the bottom on scroll.
+- **skyline**: in-content, then sticky at the top on scroll.
+- **static**: in-content, non-sticky.
+
+```javascript
+var impactAdUnit = [
+  {
+    code: "Publisher DIV",
+    mediaTypes: {
+      banner: {
+        sizes: [[1, 1]]
+      }
+    },
+    bids: [
+      {
+        bidder: "impactify",
+        params: {
+          accountId: "YOUR_ACCOUNTID_HERE",
+          appId: "YOUR_APPID_HERE",
+          format: "screen",
+          style: "impact"
+        }
+      }
+    ]
+  }
+];
+
+//For inline, skyline or static style placements
+var richMediAdUnit = [
+  {
+    code: "Publisher DIV",
+    mediaTypes: {
+      banner: {
+        sizes: [[336, 280]]
+      }
+    },
+    bids: [
+      {
+        bidder: "impactify",
+        params: {
+          accountId: "YOUR_ACCOUNTID_HERE",
+          appId: "YOUR_APPID_HERE",
+          format: "screen",
+          style: "inline" // or "skyline" or "static"
+        }
+      }
+    ]
+  }
+];
+```
+
+### Instream Video
+
+Use this integration for instream video only.
+
+```javascript
+var instreamAdUnit = [
+  {
+    code: "Publisher DIV",
+    mediaTypes: {
+      video: {
+        context: "instream",
+        playerSize: [640, 360],
+        mimes: ["video/mp4", "video/webm", "application/javascript"],
+        minduration: 1,
+        maxduration: 35,
+        protocols: [2, 3, 5, 6, 7, 8, 11, 12, 13, 14],
+        api: [2, 7, 8],
+        placement: 1,
+        plcmt: 1,
+        startdelay: 0,
+        playbackmethod: [1, 2, 6],
+        skip: 1
+      }
+    },
+    bids: [
+      {
+        bidder: "impactify",
+        params: {
+          accountId: "YOUR_ACCOUNTID_HERE",
+          appId: "YOUR_APPID_HERE",
+          format: "player"
+        }
+      }
+    ]
+  }
+];
+```
+
+### Banner
+
+Use this integration for standard banner placements with standard IAB sizes.
+
+```javascript
+var bannerAdUnit = [
+  {
+    code: "Publisher DIV",
+    mediaTypes: {
+      banner: {
+        sizes: [
+          [300, 250],
+          [336, 280]
+        ]
+      }
+    },
+    bids: [
+      {
+        bidder: "impactify",
+        params: {
+          accountId: "YOUR_ACCOUNTID_HERE",
+          appId: "YOUR_APPID_HERE",
+          format: "screen",
+          style: "static"
+        }
+      }
+    ]
+  }
+];
+```
 
 ### Configuration
 
 Impactify recommends the UserSync configuration below. Without it, the Impactify adapter will not be able to perform user syncs, which lowers match rate and reduces monetization.
 
-Note : Impactify adapter needs storage access to work properly (Do not forget to set storageAllowed to true).
+Note: Impactify adapter needs storage access to work properly. Do not forget to set `storageAllowed` to `true`.
 
 {% include dev-docs/storageAllowed.md %}
 
 For Prebid.js v1.15.0 and later:
 
 ```javascript
 pbjs.bidderSettings = {
-    impactify: {
-        storageAllowed: true // Mandatory
-    }
+  impactify: {
+    storageAllowed: true // Mandatory
+  }
 };
 
 pbjs.setConfig({
   userSync: {
     filterSettings: {
       iframe: {
-        bidders: '*',      // '*' represents all bidders
+        bidders: '*',
         filter: 'include'
       }
     }
@@ -61,18 +212,18 @@ pbjs.setConfig({
 For Prebid.js v1.14.0 and before:
 
 ```javascript
-
 pbjs.bidderSettings = {
-    impactify: {
-        storageAllowed: true // Mandatory
-    }
+  impactify: {
+    storageAllowed: true // Mandatory
+  }
 };
 
 pbjs.setConfig({
-   userSync: {
+  userSync: {
     iframeEnabled: true,
     enabledBidders: ['impactify']
- }});
+  }
+});
 ```
 
-Note: Combine the above configuration with any other UserSync configuration. Multiple setConfig() calls overwrite each other and only the last call for a given attribute will take effect.
+Note: Combine the above configuration with any other UserSync configuration. Multiple `setConfig()` calls overwrite each other and only the last call for a given attribute takes effect.