Bid.protocol

The video or audio protocol of the markup, such as VAST 4.0 or a VAST wrapper, as a value from the AdCOM Creative Subtypes list for audio and video. Added in 2.4.

CurrentintegerOptionalSince 2.4

Field facts

Path
seatbid.bid.protocol
Object
Bid
Type
integer
Requirement
Optional
Added
OpenRTB 2.4
Values
AdCOM list Creative Subtypes - Audio/Video
Spec section
4.2.3

How it is used

It should be one of the protocols the impression accepts in Video.protocols or Audio.protocols. Do not confuse it with Video.protocol, the single-valued request field that 2.6 removed.

Allowed values

ValueMeaning
1VAST 1.0: VAST 1.0 inline documents; the oldest entry and rare in current traffic.
2VAST 2.0: VAST 2.0 inline documents, still a common baseline for web players.
3VAST 3.0: VAST 3.0 inline documents, which introduced ad pods, skip offsets, and standard error codes.
4VAST 1.0 Wrapper: VAST 1.0 Wrapper: a VAST 1.0 response that redirects to another VAST document.
5VAST 2.0 Wrapper: VAST 2.0 Wrapper: a VAST 2.0 response that redirects to another VAST document.
6VAST 3.0 Wrapper: VAST 3.0 Wrapper: a VAST 3.0 response that redirects to another VAST document.
7VAST 4.0: VAST 4.0 inline documents, added to the list in OpenRTB 2.4.
8VAST 4.0 Wrapper: VAST 4.0 Wrapper, added in OpenRTB 2.4.
9DAAST 1.0: DAAST 1.0 inline, the separate audio template; audio support moved into VAST as of 4.1.
10DAAST 1.0 Wrapper: DAAST 1.0 Wrapper: a DAAST response that redirects to another DAAST document.
11VAST 4.1: VAST 4.1 inline documents, the version that brought audio into VAST. An AdCOM addition.
12VAST 4.1 Wrapper: VAST 4.1 Wrapper. An AdCOM addition.
13VAST 4.2: VAST 4.2 inline documents. An AdCOM addition.
14VAST 4.2 Wrapper: VAST 4.2 Wrapper. An AdCOM addition.
15VAST 4.3: VAST 4.3 inline documents, the newest version in the list. An AdCOM addition.
16VAST 4.3 Wrapper: VAST 4.3 Wrapper. An AdCOM addition.

Example

Where the field sits in a payload, with everything else left out:

{
  "seatbid": [
    {
      "bid": [
        {
          "protocol": 7
        }
      ]
    }
  ]
}

Common mistakes

  • Declaring an inline VAST version for markup that is really a wrapper. The list has separate values for wrappers.

Version history

Added in OpenRTB 2.4, and present in the latest snapshot. The table shows how each version's spec text types the field.

VersionsType in the specRequiredDeprecated
2.4 to 2.5integer List 5.8.NoNo
2.6-202210 to 2.6-202303integerNoNo
2.6-202309 to 2.6-202606integerNoNo

Related fields

Other Bid fields

For a walkthrough of the whole object, read Bid response anatomy.