Bid.apis
The API frameworks the markup supports, such as MRAID 2.0 or OMID 1.0, as values from the AdCOM API Frameworks list. Added in 2.6; any framework not listed is assumed unsupported.
Field facts
- Path
seatbid.bid.apis- Object
- Bid
- Type
- integer array
- Requirement
- Optional
- Added
- OpenRTB 2.6-202204
- Values
- AdCOM list API Frameworks
- Spec section
- 4.2.3
How it is used
It replaces the single-valued Bid.api, which 2.6 deprecated. Check the list against the frameworks the impression allows in Banner.api, Video.api, or Native.api.
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:
{
"seatbid": [
{
"bid": [
{
"apis": [
5,
7
]
}
]
}
]
}Common mistakes
- Sending a single integer instead of an array.
- Listing a framework, such as VPAID, that the impression's API list did not include.
Version history
Added in OpenRTB 2.6-202204, 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.6-202204 | Added in the first 2.6 release, published without a structured text archive; the 2.6-202210 republication is the first tagged text. | ||
| 2.6-202210 to 2.6-202606 | integer array | No | No |
Related fields
Other Bid fields
adidadmadomainapiattrbundleburlcatcattaxcidcriddealiddurexpexthhratioidimpidiurllangblanguagelurlmtypenurlpriceprotocolqagmediaratingslotinpodtacticwwratio
For a walkthrough of the whole object, read Bid response anatomy.