Logo

Data dictionaries

Ad Framework Data Dictionary

Along with any custom event or custom metadata you want to capture, Datazoom Application Collectors configured with a Media Player Extension and an Ad Framework Extension make the following events, metadata and fluxdata automatically collectable from the ad framework, known as the Datazoom Ad Framework Data Dictionary.

The Ad Framework Data Dictionary extends the Media Player Data Dictionary.

Events

Ad Break End

When an advertising break ends and content resumes.

Supported Collectors 25

Ad Break Start

When content halts and an advertising break begins.

Supported Collectors 24

Ad Click

When the user invokes the ad click URL associated with an advertisement.

Supported Collectors 16

Ad Impression

When an ad impression is recorded by the video player or ad framework. https://help.datazoom.io/hc/en-us/sections/360000536792-How-to-enable-ad-data-collection

Supported Collectors 25

Ad Skip

When the user chooses to skip the currently playing ad.

Supported Collectors 20

Audio Track Changed

When the user has chosen to switch to a different audio track in the video player.

Supported Collectors 1
Supported Media Types
Ad
Notes
For the HTML5 collector, this is currently only supported by Safari.

Buffer End

When media plays after Buffer Start or when the player state changes during buffer due to user action or an error.

Supported Collectors 18
Supported Media Types
Ad
Notes
A buffering event has just completed. The player fires this event which returns a value of 1 to indicate that playback has resumed.

Buffer Start

When the player has to wait for the video buffer to fill with video segments.

Supported Collectors 18
Supported Media Types
Ad
Notes
When the Buffer Start event is thrown and a value received, it is correlated to a specific playback time by comparing it to the playback length within the manifest. Once the Buffer End event has thrown, the delta between the two can be used to forensically analyze a series of chunks to determine the veracity of the content files. If the issue is corrupt chunks, a new encode can be produced.

Error

This event fires if a error causes content or ad playback or retrieval of the video to fail.

Supported Collectors 23
Supported Media Types
Ad

Media Loaded

Triggered when player is ready to begin playback after playback is invoked.

Supported Collectors 22
Supported Media Types
Ad

Media Object Request

Fired after the player has requested an object related to video playback. This object may be a manifest, audio / video segment or subtitle file. The player will fire this event after the full roundtrip of request and response has completed.

Supported Collectors 2
Supported Media Types
Ad
Notes
Primarily intended for open tracing via CMCD.

Media Request

When media type is 'content', this is triggered when playback is invoked. When the media type is 'ad', this is triggered when VAST request is made.

Supported Collectors 25
Supported Media Types
Ad
Notes
Identify problems that may be occurring in the video player which prevent successful playback after a user requests playback.

Milestone

When the playhead position plays through a customer configurable percentile milestone of the video's duration (seeking through the milestone does not trigger the event). The event fires no more than once per ad or content session.

Supported Collectors 22
Supported Media Types
Ad
Notes
Configure milestones by visiting your collector configurations pages from the Collectors page, scroll to the Milestones setting in the Event Control section. By default, for content, milestones fire when the user passes 5%, 10%, 25%, 50%, 75%, 90%, & 95% point in the content playback timeline and, for ads, when the user passes 25%, 50%, & 75% point in the ad playback timeline.

Pause

When playback is intentionally halted.

Supported Collectors 22
Supported Media Types
Ad

Playback Complete

When the video player reaches the end of the currently playing content. The event can be triggered multiple times if the user reaches the end of the currently playing content, scrubs back and then reaches the end of the content again.

Supported Collectors 25
Supported Media Types
Ad

Playback Start

When the video starts playing for the user, also known as "first frame".

Supported Collectors 25
Supported Media Types
Ad

Playing

The media is no longer blocked from playback, and has started playing. Fired when playback resumes from Stall, Buffering or Seek.

Supported Collectors 23
Supported Media Types
Ad

Qualified View

When playback duration surpasses customer configurable thresholds of time in seconds.

Supported Collectors 22
Supported Media Types
Ad
Notes
Configure qualified view thresholds by visiting your collector configurations pages from the Collectors page, scroll to the Qualified View setting in the Event Control section. By default, for content, qualified view thresholds are 30 seconds and 60 seconds and, for ads, the qualified view threshold is 5 seconds.

Rendition Change

When the player's Adaptive Bitrate Streaming upshifts or downshifts during playback to a different quality level available in the manifest. This event includes absShift attribute identifying the direction of the change.

Supported Collectors 9
Supported Media Types
Ad

Resume

When the user begins playing again after pausing the video during playback.

Supported Collectors 21
Supported Media Types
Ad

Seek End

When a user stops seeking.

Supported Collectors 6
Supported Media Types
Ad
Notes
This event includes attributes Seek Start Point & Seek End Point to mark the starting & ending points of a seek event.

Seek Start

When a user begins seeking.

Supported Collectors 6
Supported Media Types
Ad

Stall End

Event fired when video starts playing again after a stall

Supported Collectors 18
Supported Media Types
Ad

Stall Start

When there is an unexpected playback interruption because the buffer has been depleted.

Supported Collectors 18
Supported Media Types
Ad

Stop

Triggered when: 1. A playback error results in the termination of content playback. 2. The context (or the logical equivalent) corresponding to a specific player is destroyed: 2(a). The application may destroy the context when playback is stopped by the user. 2(b). The application may destroy the context after playback has reached the end of content (and the player isn’t going to be reused any further). 2(c). The collector (in certain cases) may be able to detect when the application is terminated (e.g., user closes the browser tab) and destroy all player contexts automatically. 3. If a change in the content URL is detected by the collector, a new content session should begin and a `stop` event should be triggered for the previous content session.

Supported Collectors 5
Supported Media Types
Ad
Notes
Notable condition where the `stop` events is not triggered: When playback reaches the end of the content timeline (i.e., the same condition for triggering `playback_complete`), the content session remains open, unaffected by the fact that playback has reached the end of content so if post-roll ads are played or play-head is rewinded afterward, the subsequent events belong to the same content session.

Subtitle Change

When the user enables or disables subtitles or closed captioning.

Supported Collectors 1
Supported Media Types
Ad

Metadata

Ad

Ad Break ID

Datazoom genertated UUID to denote the specific ad break. To collect this data point, Datazoom collectors require ad framework integration unless media player supports ad framework natively.

Supported Collectors 24
Data type
string
Number Type
Not set
Notes
This can be used to tie events together that occurred during a specific ad break.
Permitted Values
UUID

Ad Click URL

URL opened when the user interacts with an ad during playback. To collect this data point, Datazoom collectors require ad framework integration unless media player supports ad framework natively.

Supported Collectors 8
Data type
string
Number Type
Not set
Permitted Values
URL

Ad Creative ID

The ad server’s unique identifier for the creative. To collect this data point, Datazoom collectors require ad framework integration unless media player supports ad framework natively.

Supported Collectors 19
Data type
string
Number Type
Not set

Ad Duration

The length of the advertisement in seconds. To collect this data point, Datazoom collectors require ad framework integration unless media player supports ad framework natively.

Supported Collectors 22
Data type
number
Number Type
Not set
Unit
seconds

Ad Partner

The name of the ad server that returned the ad. To collect this data point, Datazoom collector requires ad framework integration unless media player supports ad framework natively.

Supported Collectors 3
Data type
string
Number Type
Not set

Ad Position

Where the ad break appears in relation to the video content. -- Pre-roll ads run before the content -- Mid-roll ads run during the middle of the content -- Post-roll ads run after the content has completed To collect this data point, Datazoom collectors require ad framework integration unless media player supports ad framework natively.

Supported Collectors 23
Data type
string
Number Type
Not set
Permitted Values
value list

Ad Session ID

A Datazoom generated UUID to denote a playback session of a single ad. To collect this data point, Datazoom collectors require ad framework integration unless media player supports ad framework natively.

Supported Collectors 23
Data type
string
Number Type
Not set
Notes
This can be used to tie events together that occurred during a specific ad.
Permitted Values
UUID

Ad System

The source ad server information included in the ad response. Datazoom collector will require ad framework integration unless media player supports ad framework natively.

Supported Collectors 20
Data type
string
Number Type
Not set

Ad Time Offset

The point in time during the content playback at which the current ad break was scheduled to appear. For ad breaks in VOD streams with dynamically inserted ads, playhead position in the content timeline is returned. To collect this data point, Datazoom collectors require ad framework integration unless media player supports ad framework natively.

Supported Collectors 16
Data type
number
Number Type
Not set
Unit
seconds

Advertiser Name

The advertiser name as defined and supported by the integrated ad framework. To collect this data point, Datazoom collectors require ad framework integration unless media player supports ad framework natively.

Supported Collectors 15
Data type
string
Number Type
Not set

Deal ID

The first deal ID present in the wrapper chain for the current ad, starting from the top. To collect this data point, Datazoom collectors require ad framework integration unless media player supports ad framework natively.

Supported Collectors 11
Data type
string
Number Type
Not set

Skip Time Offset

The number of seconds of playback before the ad becomes skippable. -1 is returned for non skippable ads or if this is unavailable.

Supported Collectors 18
Data type
number
Number Type
Short
Unit
seconds

Wrapper Creative IDs

Selected creative IDs used for wrapper ads. The creative IDs returned starts at the inline ad and traverses to the outermost wrapper ad. To collect this data point, Datazoom collectors require ad framework integration unless media player supports ad framework natively.

Supported Collectors 15
Data type
array of string
Number Type
Not set

Wrapper ID

Ad IDs used for wrapper ads. The IDs returned starts at the inline ad (innermost) and traverses to the outermost wrapper ad. To collect this data point, Datazoom collectors require ad framework integration unless media player supports ad framework natively.

Supported Collectors 15
Data type
array of string
Number Type
Not set

Wrapper Systems

Ad systems used for wrapper ads. The ad systems returned starts at the inline ad and traverses to the outermost wrapper ad. To collect this data point, Datazoom collectors require ad framework integration unless media player supports ad framework natively.

Supported Collectors 16
Data type
array of string
Number Type
Not set

FluxData

Buffer Duration - Ads

Cumulative buffering time during a content session when 'media type' equals 'ad'

Supported Collectors 14
Device Platforms
Browser,Console,DTV,Mobile

Number of Ad Break Plays

Count of 'playback start' events where 'media type' equals 'ad' during an ad break

Supported Collectors 14
Device Platforms
Browser,DTV,Mobile

Number of Ad Plays

Count of 'playback start' events where 'media type' equals 'ad' during an app session

Supported Collectors 23
Device Platforms
Browser,Console,DTV,Mobile

Number of Errors - Ads

Count of errors during an app session where 'media type' equals 'ad'

Supported Collectors 19
Device Platforms
Browser,Console,DTV,Mobile

Pause Duration - Ads

The cumulative amount of time elapsed where the player was in a paused state during ad playback of content session.

Supported Collectors 19
Device Platforms
Browser,Console,DTV,Mobile

Playback Duration - Ads

Cumulative playback time where media type equals 'ad' during the current content session regardless of playback rate, excluding stalls, buffers or pauses.

Supported Collectors 20
Device Platforms
Browser,Console,DTV,Mobile

Playback Duration - Ad Session

Cumulative playback time of an ad session regardless of playback rate, excluding stalls, buffers or pauses.

Supported Collectors 16
Device Platforms
Browser,Console,DTV,Mobile

Stall Count - Ads

Count of stall events in a content session where 'media type' equals 'ad'

Supported Collectors 12
Device Platforms
Browser,Console,DTV,Mobile

Stall Duration - Ads

Cumulative stall time during a content session when 'media type' equals 'ad'

Supported Collectors 13
Device Platforms
Browser,Console,DTV,Mobile

Time Since Last Ad Break Start

Time since last "Ad Break Start" event where "Media Type" equals "ad".

Supported Collectors 20
Device Platforms
Browser,Console,DTV,Mobile

Time Since Last Ad Completed

Time since the last "Playback Complete" event where "Media Type" equals "ad" for the current content session

Supported Collectors 18
Device Platforms
Browser,Console,DTV,Mobile

Time Since Last Ad Request

Time since last "Media Request" event where "Media Type" equals "ad" for the current content session

Supported Collectors 20
Device Platforms
Browser,Console,DTV,Mobile

Time Since Last Ad Started

Time since last "Playback Start" event where "Media Type" equals "ad" for the current content session

Supported Collectors 22
Device Platforms
Browser,Console,DTV,Mobile

Previous
Media Player Data Dictionary
Next
CDN Data Dictionary