Video.api

API frameworks the player supports for this slot, from AdCOM List: API Frameworks, such as 2 for VPAID 2.0, 7 for OMID 1.0, or 8 and 9 for SIMID 1.0 and 1.1. A framework not listed is assumed unsupported.

Currentinteger arrayOptionalSince 2.0

Field facts

Path: imp.video.api
Object: Video
Type: integer array
Requirement: Optional
Added: OpenRTB 2.0
Values: AdCOM list API Frameworks
Spec section: 3.2.7

How it is used

Buyers use it to decide whether an interactive or measurement-tagged creative can run. Ads stitched server-side cannot run VPAID JavaScript, so SSAI inventory should leave VPAID out. Values 500 and above are vendor-specific. Since 2.6 a bid declares the frameworks its markup needs in Bid.apis.

Allowed values

Value	Meaning
`1`	VPAID 1.0: VPAID 1.0, the first interactive video ad interface; superseded by VPAID 2.0 and rare in current players.
`2`	VPAID 2.0: VPAID 2.0, still listed by some web players but not runnable on most CTV and app players.
`3`	MRAID 1.0: MRAID 1.0 for in-app rich media; labeled MRAID until OpenRTB 2.2 renamed it MRAID-1.
`4`	ORMMA: ORMMA, an early open in-app rich media interface that MRAID replaced.
`5`	MRAID 2.0: MRAID 2.0, added in OpenRTB 2.2, with resizing, video playback, and other container features.
`6`	MRAID 3.0: MRAID 3.0, added in OpenRTB 2.5, with exposure and audio events for in-app measurement.
`7`	OMID 1.0: OMID 1.0: the player or SDK integrates the Open Measurement SDK for verification.
`8`	SIMID 1.0: SIMID 1.0, the interactive layer for video ads that replaced VPAID interactivity. An AdCOM addition.
`9`	SIMID 1.1: SIMID 1.1, a later version of the interactive video interface. An AdCOM addition.
`500+`	Vendor-specific codes: Vendor-specific frameworks, meaningful only between partners that agreed on them in advance.

Example

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

{
  "id": "req-1",
  "imp": [
    {
      "video": {
        "api": [
          7,
          8
        ]
      }
    }
  ]
}

Common mistakes

Listing VPAID on players that cannot execute it, which invites creatives that fail to render.
Leaving it out to mean unknown. Read literally, no list means no frameworks, including no OMID measurement.

Version history

Added in OpenRTB 2.0, 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.0	Array of teger Non	No	No
2.1	Array of integer, default Assume None	No	No
2.2	array of integers, default Assume None	No	No
2.3 to 2.4	integer array	No	No
2.5	integer array	No	No
2.6-202210 to 2.6-202606	integer array	No	No