Error handling and error codes

Position

Both error classes (VMAP execution / ad response execution) fire error tracking; the [ERROR_CODE] and [ERROR_MESSAGE] macros must be replaced, codes taken from 900 and 1000–1008.

Spec section

§2.5

Error macros

[ERROR_CODE] · [ERROR_MESSAGE]

Error codes

900 · 1000–1008

Player behaviour

• 1Errors fall into two classes: VMAP execution errors (extracting payloads, calling the secondary ad server, parsing VMAP) and ad response execution errors (while processing an individual response)
• 2An error of either class should invoke the error tracking events associated with the break being executed
• 3The player must replace the [ERROR_CODE] and [ERROR_MESSAGE] macros when provided; messages are at the player's discretion and special characters must be percent-encoded
• 4Execution errors in VAST ads should report the same [ERROR_CODE] VMAP saw from VAST; non-VAST errors may use a discretionary code or 900
• 5On a response execution error the player should execute as much as possible: one failing ad in a pod should advance to the next rather than abort the whole pod

Invalid forms

• ✕No error tracking fired when an error occurs
• ✕Macros left unsubstituted in tracking URIs
• ✕Special characters in error messages not percent-encoded

Related chapters

• VMAP tracking
• Playback behaviour overview
• The AdSource element