VAST macros / Player and device
[INVENTORYSTATE] VAST macro
Short answer: Inventory characteristics such as autoplay, muted, or skippable. Introduced in VAST 4.1.
What it means
A list of tokens describing the inventory and how the ad is being served: autoplay, optimized-for-autoplay, muted, skippable, and similar.
Example value
After the player substitutes the macro, [INVENTORYSTATE] becomes something like:
autoplay%2CmutedWhere it is valid
Impression and tracking URLs.
Macros are case-sensitive and substituted only inside URL fields. A macro written in the wrong case, or placed where it has no defined value, is sent to the server as literal text instead of a value.
Using it in a tag
<Impression><![CDATA[https://t.example.com/i?val=[INVENTORYSTATE]&cb=[CACHEBUSTING]]]></Impression>VAST XML fragment only. This excerpt belongs inside a complete VAST document, so standalone validation will fail until it is wrapped in a full <VAST>response.
Related vastlint rules
- VAST-2.0-macro-unknown: URL contains a [MACRO] that is not a recognised IAB VAST macro
- VAST-2.0-macro-lowercase: Recognised macro is not uppercase — players match macro names case-sensitively
- VAST-2.0-macro-uri-unencoded: Macro-bearing URL contains characters that must be percent-encoded per RFC 3986
Related macros
- [PLACEMENTTYPE]: The placement type for the ad (in-stream, in-banner, in-article, etc.).
- [SERVERSIDE]: Whether the request was made client-side (0), server-side (1), or hybrid (2).
- [PLAYERSTATE]: The player state at request time (e.g. muted, fullscreen).
Validate your macros
vastlint flags unknown, mis-cased, deprecated, out-of-context, and unencoded macros in any tracking, click, error, impression, or media URL:
# CLI: exits non-zero on errors, ideal for pipelines
vastlint check creative.xmlUse the right tool for this failure
If you already have the resolved XML, run a pure spec check. If you only have a live tag URL, test that endpoint first. If the failure happens in the wrapper chain, inspect each hop.