ORTB
Volume navigation

The AdSource element

Element
On this page

Position

Where a break's ads come from: inline VASTAdData, a referenced AdTagURI, or non-VAST CustomAdData — exactly one of the three.

Spec section
§2.3.2
Parent
AdBreak
Cardinality
0..1
Children
VASTAdData | AdTagURI | CustomAdData(三选一)

Attributes and values

AttributeTypeRequiredValuesNotes
idintegerNoIdentifier for the ad source
allowMultipleAdsbooleanNoWhether a VAST ad pod or a multi-ad buffet may be served into the break; when absent the player accepts multiple ads; non-VAST ad pods may be ignored
followRedirectsbooleanNoWhether the player should honour wrappers/redirects inside the ad response; when absent it is at the player's discretion

CustomAdData/@templateType

  • vast1VAST 1.x template
  • vast2VAST 2.x template
  • proprietaryProprietary template

AdTagURI/@templateType

  • vast1VAST 1.x template
  • vast2VAST 2.x template
  • vast3VAST 3.0 template
  • proprietaryProprietary template

Children and structure

  • VASTAdDatachoiceAn inline VAST 3.0 document, not wrapped in CDATA, though a VAST namespace should be declared
  • AdTagURIchoiceA URI referencing an ad response from another system, must be in CDATA; carries the required templateType
  • CustomAdDatachoiceArbitrary string data for a non-VAST ad response, must be in CDATA; carries the required templateType

XML snippet

<AdSource allowMultipleAds="true" followRedirects="true" id="1">
  <AdTagURI templateType="vast3"><![CDATA[https://ads.example.com/vast?slot=mid1]]></AdTagURI>
</AdSource>

Player behaviour

  • 1If an AdSource is provided it must declare its source with one of the three child elements
  • 2templateType lets the player identify the ad response template; VASTAdData is reserved for VAST and therefore needs none
  • 3The digits are the VAST version number: vast3 means VAST 3.0

Invalid forms

  • An AdSource present without any source child
  • AdTagURI / CustomAdData without templateType (required)
  • Non-VAST content not wrapped in CDATA
This chapter's body is data-driven from the IAB VMAP 1.0.1 official PDF and the official repository XSD, cross-checked against each other.