` element. |
If you are using Index's outstream ad unit and have placed the video object at the bidder level, you must include the Index required parameters at the bidder level. You can include the optional parameters to specify the outstream player configurations.
{: .table .table-bordered .table-striped }
| Name | Scope | Type | Description |
| --- | --- | --- | --- |
| `video.w` | Required | Integer | The width of the video player in pixels that will be passed to demand partners. You must define the size of the video player using the `video.w` and `video.h` parameters. We strongly recommend video sizes to be `256 x 256` or greater, `300 x 250`, or `320 x 180`. |
| `video.h` | Required | Integer | The height of the video player in pixels that will be passed to demand partners. You must define the size of the video player using the `video.w` and `video.h` parameters. We strongly recommend video sizes to be `256 x 256` or greater, `300 x 250`, or `320 x 180`. |
| `video.playerSize` | Required | Integer[] | The video player size that will be passed to demand partners. |
| `video.playerConfig` | Optional | Hash | The Index-specific outstream player configurations. |
| `video.playerConfig.floatOnScroll` | Optional | Boolean | A boolean specifying whether you want to use the player's floating capabilities, where:
- `true`: Use the Index player's float capabilities.
**Note:** If you set `floatOnScroll` to `true`, Index updates the placement value to `5`.
**Note:** We do not recommend using the player's default float capabilities if you have more than one outstream ad unit per page.
- `false`: Do not use the Index player's float capabilities (default). |
| `video.playerConfig.floatSize` | Optional | Integer[] | The height and width of the floating player in pixels. If you do not specify a float size, the player adjusts to the aspect ratio of the player size that is defined when it is not floating. Index recommends that you review and test the float size to your user experience preference. |
| `video.plcmt` | Required | Integer[] | The video's placement type, where:
- `1` = Instream
- `2` = Accompanying Content
- `3` = Interstitial
- `4` = No Content/Standalone |
## Native
Index supports the same set of native assets that Prebid.js recognizes. For the list of native assets, see [Prebid.js Native Implementation Guide on the Prebid site.](https://docs.prebid.org/prebid/native-implementation.html#3-prebidjs-native-adunit-overview)
## Multi-format ad units
Index supports multi-format ad units, see [Show Multi-Format Ads with Prebid.js](https://docs.prebid.org/dev-docs/show-multi-format-ads.html). For multi-format ad units, you can optionally specify a different siteId for each multi-format type at the bidder level. This is useful if you have deals set up with Index at the siteId level. See the [multi-format examples](#examples).
The following are the parameters that you can specify for each multi-format type at the bidder level.
{: .table .table-bordered .table-striped }
| Name | Scope | Type | Description |
| --- | --- | --- | --- |
| `siteId` | Required | String | An Index-specific identifier that is associated with this ad unit. This is similar to a placement ID or an ad unit ID that some other modules have. For example, `'9999990'`, `'9999991'`, `'9999992'`.
Note: This will also act as the default siteID for multi-format adunits if a format specific siteId is not provided. |
| `banner.siteId` | Optional | String | An Index-specific identifier that is associated with this ad unit. This siteId will be prioritized over the default siteID for `banner` format in the multi-format ad unit. |
| `video.siteId` | Optional | String | An Index-specific identifier that is associated with this ad unit. This siteId will be prioritized over the default siteID for `video` format in the multi-format ad unit. |
| `native.siteId` | Optional | String | An Index-specific identifier that is associated with this ad unit. This siteId will be prioritized over the default siteID for `native` format in the multi-format ad unit. |
## Examples
**Banner**
```javascript
var adUnits = [{
code: 'banner-div-a',
mediaTypes: {
banner: {
sizes: [
[300, 250],
[300, 600]
]
}
},
bids: [{
bidder: 'ix',
params: {
siteId: '9999990'
}
}
]
}];
```
**Video (instream):**
**Note**: `context` can either be `'instream'` or `'outstream'`.
```javascript
var adUnits = [{
code: 'video-div-a',
mediaTypes: {
video: {
// Preferred location as of version 4.43
context: 'instream',
playerSize: [300, 250],
api: [2],
protocols: [2, 3, 5, 6],
minduration: 5,
maxduration: 30,
mimes: ['video/mp4', 'application/javascript'],
placement: 3,
plcmt: 1
}
},
bids: [{
bidder: 'ix',
params: {
siteId: '9999990',
video: {
// openrtb v2.5 compatible video obj
// If required, use this to override mediaTypes.video.XX properties
}
}
}]
}];
```
**Video (outstream)**
```javascript
var adUnits = [{
code: 'div-gpt-ad-1571167646410-1',
mediaTypes: {
video: {
playerSize: [640, 360],
context: 'outstream',
api: [2],
protocols: [2, 3, 5, 6],
minduration: 5,
maxduration: 30,
mimes: ['video/mp4', 'application/javascript'],
placement: 3,
plcmt: 4,
playbackmethod: 6
}
},
bids: [{
bidder: 'ix',
params: {
siteId: '9999990'
video: {
playerConfig: {
floatOnScroll: true,
floatSize: [300,250]
}
}
}
}]
}];
```
**Prebid Native**
```javascript
pbjs.addAdUnits({
code: slot.code,
mediaTypes: {
native: {
ortb: {
assets: [{
id: 1,
required: 1,
img: {
type: 3,
w: 150,
h: 50,
}
},
{
id: 2,
required: 1,
title: {
len: 80
}
},
{
id: 3,
required: 1,
data: {
type: 1
}
},
{
id: 4,
required: 1,
data: {
type: 2
}
},
{
id: 6,
required: 1,
img: {
type: 1,
w: 50,
h: 50,
}
}]
}
}
},
bids: [{
bidder: 'ix',
params: {
siteId: '9999990'
}
}]
});
```
**Multi-format SiteId Overrides**
```javascript
var adUnits = [{
code: slot.code,
mediaTypes: {
banner: {
sizes: [300,250]
},
native: {
title: {
required: false
},
image: {
required: true
},
sponsoredBy: {
required: false
},
body: {
required: false
}
},
video: {
playerSize: sizes,
context: 'outstream',
api:[2],
protocols: [2, 3, 5, 6],
minduration: 5,
maxduration: 30,
mimes: ['video/mp4','application/javascript']
}
},
bids: [
{
bidder: 'ix',
params: {
siteId: '9999990',
video: {
siteId: '9999991'
},
native: {
siteId: '9999992'
},
banner: {
siteId: '9999993'
}
}
},
]
}];
```