Video.protocol
The single VAST protocol the player supported, as one integer. Required in OpenRTB 2.0 and 2.1, optional in 2.2, deprecated from 2.3 in favor of Video.protocols, and removed in 2.6.
Field facts
- Path
imp.video.protocol- Object
- Video
- Type
- integer
- Requirement
- Optional
- Added
- OpenRTB 2.0
- Deprecated
- OpenRTB 2.3
- Last version
- OpenRTB 2.5
- Spec section
- 3.2.7
How it is used
From 2.2 through 2.5 the spec asked for at least one protocol in either this field or Video.protocols. Old templates that still emit it should move the value into the array. The validator reports it as openrtb.field.deprecated against 2.3 to 2.5 and as openrtb.field.removed against any 2.6 snapshot.
Example
Where the field sits in a payload, with everything else left out:
{
"id": "req-1",
"imp": [
{
"video": {
"protocol": 3
}
}
]
}Common mistakes
- Sending only protocol on 2.6 traffic. Readers ignore the removed field, so the request appears to name no VAST version at all.
- Sending both fields with values that disagree.
Version history
Added in OpenRTB 2.0, deprecated in 2.3, last present in 2.5. The table shows how each version's spec text types the field.
| Versions | Type in the spec | Required | Deprecated |
|---|---|---|---|
| 2.0 | integer, default - See T Proto value | Yes | No |
| 2.1 | integer | Yes | No |
| 2.2 | integer | No | No |
| 2.3 to 2.4 | integer | No | Yes |
| 2.5 | integer | No | Yes |
Related fields
Other Video fields
apibattrboxingallowedcompanionadcompaniontypedeliverydurfloorsexthlinearitymaxbitratemaxdurationmaxextendedmaxseqmimesminbitratemincpmpersecmindurationplacementplaybackendplaybackmethodplcmtpoddedupepoddurpodidpodseqposprotocolsrqddurssequenceskipskipafterskipminslotinpodstartdelayw
For a walkthrough of the whole object, read Video object guide.