Banner.vcm
Companion rendering mode, meaningful only for Banner objects in a companion array: 0 means the companion shows alongside the video, 1 means it shows as an end card once the video ends. Added in OpenRTB 2.5.
Field facts
- Path
imp.banner.vcm,imp.audio.companionad.vcm,imp.video.companionad.vcm- Object
- Banner
- Type
- integer
- Requirement
- Optional
- Added
- OpenRTB 2.5
- Spec section
- 3.2.6
How it is used
An end card takes over the player area after the video, so it usually needs the player's size rather than a sidebar size. Video.companiontype lists the resource types the companion may use.
Allowed values
0, 1.
Example
Where the field sits in a payload, with everything else left out:
{
"id": "req-1",
"imp": [
{
"banner": {
"vcm": 1
}
}
]
}Common mistakes
- Sending vcm on a display banner at
imp.banner, where it has no meaning. - Sending true or false; in spec JSON it is an integer flag.
Version history
Added in OpenRTB 2.5, and present in the latest snapshot. The table shows how each version's spec text types the field.
| Versions | Type in the spec | Required | Deprecated |
|---|---|---|---|
| 2.5 to 2.6-202606 | integer | No | No |