API frameworks value 8 means SIMID 1.0
SIMID 1.0, the interactive layer for video ads that replaced VPAID interactivity. An AdCOM addition.
When to send it
Send 8 when the video player can host SIMID 1.0 creatives. SIMID (Secure Interactive Media Interface Definition) lets an interactive layer run beside a video ad while the player keeps control of the media file, which is why it was built to replace VPAID for interactivity. The value comes from the AdCOM list and is not in OpenRTB 2.5.
Buyers with interactive video, such as shoppable or choose-your-ad units, look for 8 or 9 before returning VAST that carries a SIMID interactive creative file. It is confused with 9 (SIMID 1.1), and with VPAID 2.0, which packed media and code into one unit and handed playback control to the ad.
Example
{
"imp": [
{
"audio": {
"api": [
8
]
}
}
]
}Fields that carry it
Other values in api frameworks
| Value | Name |
|---|---|
1 | VPAID 1.0 |
2 | VPAID 2.0 |
3 | MRAID 1.0 |
4 | ORMMA |
5 | MRAID 2.0 |
6 | MRAID 3.0 |
7 | OMID 1.0 |
9 | SIMID 1.1 |
500+ | Vendor-specific codes |
The api frameworks list page explains the whole list and its common mistakes.