Client-side ad-tracking schema and properties

Array

String

String of ad parameters from the VAST VPAID that MediaTailor passes to the player

Contains the resources and metadata required to execute third-party measurement code in order to verify creative playback

String

String

Array

String

Companion ads, which accompany the ad avail, provide content like a frame around the ad or a banner to display near the video.

Object

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

Array

MediaTailor creates an object for each companion-ad element-tracking event type.

Object

String

Length, in ISO 8601 seconds format

Length, in seconds format

Ad servers can use custom VAST extensions

MediaTailor creates an object for each child extension of the extensions element.

MediaTailor creates an object for each icon element within icons.

MediaTailor creates an object for each icon-click fallback-image node.

Video and other assets that the player needs for the ad avail

MediaTailor creates an object for each companion-ad element-tracking event type

MediaTailor creates an object for each tracking event for the creative

A comma-separated list of all tracking URLs for this event

Time position, in ISO 8601 seconds format, relative to the beginning of the playback session

Time position, in seconds format, relative to the beginning of the playback session

Program date time, in ISO 8601 seconds format, for the start of the ad avail

Contains all tracking-event data that was received in the VAST response, along with timing information

An array that carries VMAP tracking events from the VAST response. For more information, see section 2.3.3 of the VMAP 1.0 specification.

The avail duration observed from the ad marker in the manifest.

A string of ad parameters, from the VAST VPAID, that MediaTailor passes to the player.

An array containing the ad objects that make up the avail. The ads are listed in the order they appear in the manifest.

The name of the system that serves the ad.

The title of the ad.

Contains the resources and metadata required to execute third-party measurement code in order to verify creative playback. For more information about this property, see section 3.16 of the VAST 4.2 specification.

MediaTailor supports adVerifications as VAST 3 extension nodes.

The alternative text for an image of a companion ad. This text enables players with descriptive-audio support for the visually impaired to read back a description of the image.

Includes keys defined in the VAST specification for companion ads, such as adSlotId, pxratio, renderingMode, and so on.

Set to VPAID to tell the player that this ad is a VPAID ad.

An array containing ad-break objects, or avails, that are presented in the active manifest window. The avails are listed in the order they appear in the manifest.

The URL where MediaTailor sends the ad beacon.

The bitrate of the video asset. This property is not typically included for an executable asset.

One or more companion ad-content specifications, each of which specifies a resource file to use. Companion ads accompany the ad avail and provide content, like a frame around the ad or a banner, to display near the video.

A URL to the advertiser’s page that the media player opens when the viewer clicks the companion ad.

The tracking URL for the companionClickThrough property.

The Id attribute value of the Creative tag for the ad.

The sequence in which an ad should play, according to the Ad@id value in the VAST response.

For live/dynamic DASH, the MPD@availabilityStartTime of the origin manifest.

Indicates whether a progressive or streaming protocol is being used.

Length, in ISO 8601 seconds format. The response includes durations for the entire ad avail and for each ad and beacon, though beacon durations are always zero.

The type of beacon.

Custom extensions of VAST that ad servers use. For more information about extensions, see section 3.18 of the VAST 4.2 specification.

The height, in pixels, of the video asset.

The media-sequence number of the first/oldest media sequence seen in the HLS origin manifest.

The CDATA-encoded HTML that's inserted directly within the streaming provider's HTML page.

The URL to an HTML resource file that the streaming provider loads into an iframe.

Indicates whether to maintain the video's aspect ratio while scaling.

Specifies the video and other assets that the player needs for the ad avail.

URI that points to either an executable asset or a video asset.

The MIME type of the creative or companion asset.

The URL of the mezzanine MP4 asset, specified if the VPAID ad includes one.

The value of the token that points to the next page of results, when such a value exists.

Indicates whether to scale the video to other dimensions.

The sequence value specified for the creative in the VAST response.

The time value that identifies when the player makes skip controls available to the user.

The time position, in ISO 8601 seconds format, relative to the beginning of the playback session. The response includes start times for the entire ad avail and for each ad and beacon.

The time position, in seconds format, relative to the beginning of the playback session. The response includes start times for the entire ad avail and for each ad and beacon.

The URL to a static creative file that's used for the ad component.

The Id attribute value of the Ad tag.

The width, in pixels, of the video asset.