API frameworks value 2 means VPAID 2.0
VPAID 2.0, still listed by some web players but not runnable on most CTV and app players.
When to send it
Send 2 when the player can execute VPAID 2.0 JavaScript creatives. For years it was the standard way to deliver interactive video and to wrap video in verification code, so many older web players still list it.
Verification vendors used VPAID 2.0 to run measurement inside the ad, which is why VPAID tags still show up in auctions. On CTV and in most mobile apps the player cannot run it, and declaring 2 there produces render failures. For new integrations, 7 (OMID 1.0) handles verification and 8 or 9 (SIMID) handles interactivity. On the response, a bidder that returns VPAID markup declares it with 2 in Bid.apis. It is often confused with 1.
Example
{
"imp": [
{
"audio": {
"api": [
2
]
}
}
]
}Fields that carry it
Other values in api frameworks
| Value | Name |
|---|---|
1 | VPAID 1.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.