API frameworks value 1 means VPAID 1.0
VPAID 1.0, the first interactive video ad interface; superseded by VPAID 2.0 and rare in current players.
When to send it
Send 1 in Video.api only if the player can still run VPAID 1.0 creatives, the first version of the interface that let interactive code run inside a video ad. Very few players need it today. VAST 4 separated interactive code from the media file, and SIMID and OMID now cover the jobs VPAID used to do.
Buyers that see 1 may return an interactive unit or a VPAID wrapper, and on a player that cannot run it the slot stays blank. It is confused with 2 (VPAID 2.0), which almost all remaining VPAID creative targets, and with 7 (OMID 1.0), the measurement interface that replaced VPAID as a verification wrapper.
Example
{
"imp": [
{
"audio": {
"api": [
1
]
}
}
]
}Fields that carry it
Other values in api frameworks
| Value | Name |
|---|---|
2 | VPAID 2.0 |
3 | MRAID 1.0 |
4 | ORMMA |
5 | MRAID 2.0 |
6 | MRAID 3.0 |
7 | OMID 1.0 |
8 | SIMID 1.0 |
9 | SIMID 1.1 |
500+ | Vendor-specific codes |
The api frameworks list page explains the whole list and its common mistakes.