VMAP ad calls

This endpoint that can be called with dedicated parameters to receive a VMAP response.

Basically, the VMAP response is a list of <vmap:AdBreak> nodes. The timeOffset attribute of each <vmap:AdBreak> node specifies the position of the ad break within the content video.
Each <vmap:AdBreak> node contains one or multiple <Wrapper> nodes which include a <VASTAdTagURI> node containing a valid video ad call. This ad call needs to be triggered by the player to obtain the actual VAST ad to be played before (pre-roll), within (mid-roll) or after (post-roll) the video content.
 

The VMAP endpoint https://vmap.smartadserver.com/ supports the following parameters:

Parameter name	Necessity____	Description
cuepoints	mandatory	a comma separated list of cue points in random order — there is no need to pass them in chronological order;  Each cue point can have the following values: for pre-rolls: start for post-rolls: end for mid-rolls*:     a timestamp (in milliseconds) of the video content; example:  1500000,6050000 a percentage of the content video duration with suffix “%”; example: 15%,55% a position number with prefix “#”; example: #3,#7; the prefix must be encoded — e.g. #2 =>  %232 * Keep in mind: Make sure you use a format (timestamp, percentage, position number) the player supports.  In a VMAP ad call, multiple mid-roll cue points must all have the same format: either timestamps or percentages or position numbers; mixing the formats of mid-roll cue points is not possible!
acparams	mandatory	a URL encoded string of all the ad call parameters; these will be passed in the <VASTAdTagURI> to build a valid video ad call mandatory parameters: siteid — website pgid  — page fmtid  — format about other parameters: out —  if it is missing, out=vast is used as a fallback ab — is replaced by a calculated value based on the parsed cue points oc — is replaced by a hardcoded value of 1 see full list of parameters available in the Ad API article
ctd	optional	the content duration — not used, currently; the value -1 indicates a live stream

 

Examples

Example VMAP call

The example below calls a VMAP with the cue points start,1000000,end
 
Note that the value 1000000 is in milliseconds.

Example VMAP response — one VAST ad

The VMAP response below contains one VAST ad.

Color legend:

• green — the timeOffset attribute of the <vmap:AdBreak> node; this attribute is the equivalent of the cue points passed in the VMAP call; in this example, only one VAST ad is returned; it targets the pre-roll ad break ("start") 
• blue — the VAST ad 

   

Example VMAP response — multiple VAST ads

The VMAP response below contains 3 VAST ads.

Color legend:

• green — the timeOffset attribute of each <vmap:AdBreak> node; this attribute is the equivalent of the cue points passed in the VMAP call; in this example, 3 VAST ads are returned; they target the pre-roll ad break ("start") , a mid-roll ad break after 1000 seconds ("00:16:40.000") and the post-roll ad break ("end")
• blue — the VAST ads

 

Example VMAP response — no VAST ads

The example below shows the response in case no VAST ad was found for delivery— e. g. because there is no insertion that matches with the parameters or because there is no activated (online) insertion ready to be delivered etc.