Logo

Application collectors

Akamai AMP Media Player

Javascript collector v2.17.0

The Akamai amp media player is a configuration option for the Javascript collector by Datazoom that makes the following additional data points automatically collectable in real time.

Events

Buffer End

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

Supported Media Types
Content
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 Media Types
Content
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.

Cast End

When a user ends casting.

Cast Start

When a user casts video to a remote screen.

Error

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

Supported Media Types
Content

Exit Fullscreen

When user exits fullscreen mode during video playback

Fullscreen

When the user enters fullscreen mode during video playback

Heartbeat

When configurable interval of time passes during video playback within a content session, or right after video playback is interrupted within a content session.

Notes
Configure heartbeats by visiting your collector configurations pages from the Collectors page, scroll to the Heartbeats setting in the Event Control section. By default, heartbeats fire every 60 seconds.

Media Loaded

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

Supported Media Types
Content

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 Media Types
Content
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 Media Types
Content
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.

Mute

When the player volume has been reduced to zero. If observable, mute is also triggered when the device volume is muted.

Pause

When playback is intentionally halted.

Supported Media Types
Content

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 Media Types
Content

Playback Start

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

Supported Media Types
Content

Player Ready

Signifies when the player instance is made available to Datazoom, independent of any media selection.

Notes
“player has been initialized” independent of any media selection and when the player instance is handed over to us. A player can remain idle waiting for the next event which may or may not happen.

Playing

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

Supported Media Types
Content

Qualified View

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

Supported Media Types
Content
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 Media Types
Content

Resume

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

Supported Media Types
Content

Seek End

When a user stops seeking.

Supported Media Types
Content
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 Media Types
Content

Stall End

Event fired when video starts playing again after a stall

Supported Media Types
Content

Stall Start

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

Supported Media Types
Content

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 Media Types
Content
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 Media Types
Content

Unmute

When the player audio has been reactivated.

Volume Change

When the player audio level increases or decreases.

Metadata

Attributes

ABS Shift

The direction of the rendition change relative to the previous rendition. An attribute of the Rendition Change event.

Data type
string
Number Type
Not set
Required
true
Permitted Values
value list

Error Code

Error code emitted by the player

Data type
string
Number Type
Not set
Required
true

Error Message

Error message emitted by the player

Data type
string
Number Type
Not set
Required
true

Heartbeat Count

Count of Heartbeat events per content session.

Data type
number
Number Type
Int
Unit
count
Required
true

Milestone Percent

The point represented by the customer configurable percentage relative to the duration. Attribute of the Milestone event.

Data type
number
Number Type
Short
Unit
percentage
Required
true

Qualified View Trigger

The point represented by the customer configurable duration of playback. Attribute of the Qualified View event.

Data type
number
Number Type
Not set
Unit
seconds
Required
true

Seek End Point

The point within in the content timeline at which the Seek End event is triggered.

Data type
number
Number Type
Not set
Unit
milliseconds
Required
true

Seek Start Point

The point within in the content timeline at which the Seek Start event is triggered.

Data type
number
Number Type
Not set
Unit
milliseconds
Required
true

Startup Duration - Content

The total time a user spent waiting for content to begin playback excluding any time related to requesting, loading or playing pre-roll ads.

Data type
number
Number Type
Not set
Unit
milliseconds
Required
true

Startup Duration - Total

The total time a user spent waiting for content to begin playback excluding any time spent viewing pre-roll ads.

Data type
number
Number Type
Not set
Unit
milliseconds
Required
true

Video

Asset ID

Unique identifier of the content shown according to the player. This may be produced by the CMS or publishing system.

Data type
string
Number Type
Not set

Description

Description of the content (e.g., provided by the CMS, VAST response, etc) emitted by the media player

Data type
string
Number Type
Not set

Duration

The length of VOD content or ad media. Value is absent for live content.

Data type
number
Number Type
Double
Unit
seconds

Media Type

Whether the event relates to an Ad or Content asset.

Data type
string
Number Type
Not set
Required
true
Permitted Values
value list

Player Height

Height of the display port.

Data type
number
Number Type
Not set
Unit
pixels

Player Width

Width of the display port.

Data type
number
Number Type
Not set
Unit
pixels

Source

The URL of the current media file

Data type
string
Number Type
Not set
Permitted Values
URL

Title

The title of the content as reported by the media player.

Data type
string
Number Type
Not set

Player

Autostart

Returns whether the player is configured to autostart. Generally, when autostart is configured, video will start playing as soon as it is loaded; however, in some cases, browsers will prevent it.

Data type
bool
Number Type
Not set
Permitted Values
value list

Default Muted

Identifies whether the audio/video should be muted by default

Data type
bool
Number Type
Not set
Permitted Values
value list

Default Playback Rate

The default speed of the audio / video playback in relation to normal playback time (e.g., .5x, 1x, 1.5x, 2x).

Data type
number
Number Type
Float
Unit
percentage

Fullscreen

Whether the player is in fullscreen mode or not.

Data type
bool
Number Type
Not set
Permitted Values
value list

Loop

Whether the media player is configured to start over again when the content finishes.

Data type
bool
Number Type
Not set
Permitted Values
value list

Muted

Whether the player is muted or if the device volume is muted and observable.

Data type
bool
Number Type
Not set
Permitted Values
value list

Player Name

The name of the media player.

Data type
string
Number Type
Not set
Required
true

Player Version

The version of the media player.

Data type
string
Number Type
Not set

Preload

The way in which the media player is configured to preload the content. -- "none": the media should not be preloaded; -- "metadata": only metadata (e.g. length) is fetched; -- "auto": the whole video file can be downloaded, even if the user is not expected to use it.

Data type
string
Number Type
Not set
Permitted Values
value list

Ready State

Identifies the current ready state of the audio/video

Data type
number
Number Type
Short
Permitted Values
value list

Streaming Protocol

The streaming protocol used to deliver the content; if not collectable, then it is the container type.

Data type
string
Number Type
Not set
Permitted Values
value list

Streaming Type

Whether the content is Live, VOD or DVR as reported by the media player.

Data type
string
Number Type
Not set
Permitted Values
value list

Subtitles

Whether subtitles are currently enabled.

Data type
bool
Number Type
Not set
Permitted Values
value list

User

Content Session ID

A unique id for the current video playback session.

Data type
string
Number Type
Not set
Required
true
Permitted Values
UUID

FluxData

Bandwidth

Estimated network bandwidth as derived from the player

Device Platforms
Browser,Console,DTV,Mobile

Buffer Duration

Cumulative buffering time during a content session

Device Platforms
Browser,Console,DTV,Mobile

Buffer Duration - Content

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

Device Platforms
Browser,Console,DTV,Mobile

Buffer Length

The buffer length associated with the media objects being requested.

Device Platforms
Browser,Console,DTV,Mobile,Server API

Content Session Start Timestamp

Start time of a new content session within an app session.

Device Platforms
Browser,Console,DTV,Mobile

Current Subtitles

The active subtitle or closed captioning track

Device Platforms
Browser,Console,DTV,Mobile

Number of Content Plays

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

Device Platforms
Browser,Console,DTV,Mobile

Number of Content Requests

Count of 'media request' events where 'media type' equals 'content' during an app session

Device Platforms
Browser,Console,DTV,Mobile

Number of Errors

Count of errors during an app session.

Device Platforms
Browser,Console,DTV,Mobile

Number of Errors - Content

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

Device Platforms
Browser,Console,DTV,Mobile

Pause Duration

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

Device Platforms
Browser,Console,DTV,Mobile

Pause Duration - Content

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

Device Platforms
Browser,Console,DTV,Mobile

Playback Duration

Elapsed time spent watching content and ads, regardless of playback rate, excluding stalls, buffers or pauses.

Device Platforms
Browser,Console,DTV,Mobile

Playback Duration - Content

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

Device Platforms
Browser,Console,DTV,Mobile

Playback Rate

Playback speed relative to normal playback time (e.g., .5x, 1x, 1.5x, 2x)

Device Platforms
Browser,Console,DTV,Mobile

Player State

The player's playback state (idle, buffering, playing, paused, seeking)

Device Platforms
Browser,Console,DTV,Mobile
Permitted Values
value list

Player Viewable

Percentage of player visible is 50% or more

Device Platforms
Browser,Console
Permitted Values
value list

Player Viewable Percent

Percentage of the player that is viewable on the screen

Device Platforms
Browser,Console

Playhead Position

The point in the video timeline in seconds.

Device Platforms
Browser,Console,DTV,Mobile
Required
true

Rendition Height

Height in pixels of the current video rendition

Device Platforms
Browser,Console,DTV,Mobile

Rendition Name

Name of the current rendition from the player if available. If not, "[height]p".

Device Platforms
Browser,Console,DTV,Mobile

Rendition Video Bitrate

Target bitrate of the current video rendition from the manifest.

Device Platforms
Browser,Console,DTV,Mobile

Rendition Width

Width in pixels of the current video rendition

Device Platforms
Browser,Console,DTV,Mobile

Stall Count

Count of stall events in a content session

Device Platforms
Browser,Console,DTV,Mobile

Stall Count - Content

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

Device Platforms
Browser,Console,DTV,Mobile

Stall Duration

Cumulative stall time during a content session

Device Platforms
Browser,Console,DTV,Mobile

Stall Duration - Content

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

Device Platforms
Browser,Console,DTV,Mobile

Time Since Content Request

Time since "Media Request" event where "Media Type" equals "content"

Device Platforms
Browser,Console,DTV,Mobile

Time Since Content Started

Time since "Playback Start" event where "Media Type" equals "content"

Device Platforms
Browser,Console,DTV,Mobile

Time Since Last Buffer Start

Time since last "Buffer Start" event for the current content session

Device Platforms
Browser,Console,DTV,Mobile

Time Since Last Buffer Start - Content

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

Device Platforms
Browser,Console,DTV,Mobile

Time Since Last Heartbeat

Time since last "Heartbeat" event for the current content session.

Device Platforms
Browser,Console,DTV,Mobile

Time Since Last Milestone - Ad

Time since last "Milestone" event where "Media Type" equals "ad".

Device Platforms
Browser,Console,DTV,Mobile

Time Since Last Milestone - Content

Time since last "Milestone" event where "Media Type" equals "content"

Device Platforms
Browser,Console,DTV,Mobile

Time Since Last Pause

Time since last "Pause" event

Device Platforms
Browser,Console,DTV,Mobile

Time Since Last Rendition Change

Time since last "Rendition Change" event

Device Platforms
Browser,Console,DTV,Mobile

Time Since Last Seek Start

Time since last "Seek Start" event.

Device Platforms
Browser,Console,DTV,Mobile

Time Since Last Stall Start

Time since last "Stall Start" event.

Device Platforms
Browser,Console,DTV,Mobile

Time Since Last Stall Start - Ad

Time since last "Stall Start" event where "Media Type" equals "ad"

Device Platforms
Browser,Console,DTV,Mobile

Time Since Last Stall Start - Content

Time since last "Stall Start" event where "Media Type" equals "content"

Device Platforms
Browser,Console,DTV,Mobile

Volume

The current playback volume

Device Platforms
Browser,Mobile

Ad frameworks

Freewheel Ad Framework

Google IMA Ad Framework

Google IMA DAI Ad Framework

MediaTailor Ad Framework

Yospace Ad Framework

Player Default Ad Framework

Akamai Player: Plugin Integration

Datazoom provides plugins for data collection through our Beacon Services. Integrate the Akamai Player plugin into your web application with the following snippet:

<script src='https://platform.datazoom.io/beacon/v1/config?configuration_id=CONFIG_ID'></script>

  • Insert this JS line into your HTML

  • Replace the CONFIG_ID value with collector configuration ID.

This inserts Datazoom's data collection SDK into the page.

Option 1: Activate Data Collection for an Existing Akamai Player Instance

This is the standard option for customers who only need to collect data from the video player and are not concerned with joining player events with CDN logs or sending CMCD data to a CDN.

To activate data collection for an Akamai player instance, create a Datazoom context which references the player instance with the following snippet:

datazoom_context = datazoom.createContext(player);

For example:

<html>

<head>
    <script src="https://amp.akamaized.net/hosted/1.1/player.esi?apikey=YOUR_API_KEY&&format=script&version=9.0.21"></script>
    <script src='https://platform.datazoom.io/beacon/v1/config?configuration_id=CONFIG_ID'></script>
</head>

<body>

<div class="vid-container">
    <div id="akamai_player" style="width : 40% ;height : 290px">
    </div>
</div>

<script>
    var amp_player;
    var datazoom_context;
    var config = {
        media: {
            src: "https://video-dev.github.io/streams/x36xhzz/x36xhzz.m3u8",
            type: "application/x-mpegURL",
            poster: "https://upload.wikimedia.org/wikipedia/commons/thumb/7/70/Big.Buck.Bunny.-.Opening.Screen.png/320px-Big.Buck.Bunny.-.Opening.Screen.png",
            title: "BigBuckBunny® Product Video",
            autoplay: true,
            startTime: 0
        }
    };
    akamai.amp.AMP.create("akamai_player", config).then(
        function(player) {
            amp_player = player;
            datazoom_context = datazoom.createContext(player);
        }
    );
</script>

</body>

</html>

Option 2: Have Datazoom Create an Akamai Player with Data Collection Activated

This option is necessary if you are joining Player & CDN Log data together or want to send CMCD data to a CDN. In this option, Datazoom will handle instantiation of the player with the necessary hooks required to insert parameters like Content Session ID & Request ID in every media request the player makes.

An Akamai player instance can be created with Datazoom data collection activated, using the following snippet:

datazoom.createContextAndPlayer("akamai_player", config).then(
    function(context) {
        amp_player = context.getPlayer();
        datazoom_context = context;
    }
);

By creating a player instance through the datazoom.createContextAndPlayer() method, it enables Datazoom to collect more player information to assist QoE monitoring and distributed tracing.

For example:

<html>

<head>
    <script src="https://amp.akamaized.net/hosted/1.1/player.esi?apikey=datazoom&&format=script&version=9.0.21"></script>
    <script src='https://platform.datazoom.io/beacon/v1/config?configuration_id=CONFIG_ID'></script>
</head>

<body>

<div class="vid-container">
    <div id="akamai_player" style="width : 40% ;height : 290px">
    </div>
</div>

<script>
    var amp_player;
    var datazoom_context;
    var config = {
        media: {
            src: "https://video-dev.github.io/streams/x36xhzz/x36xhzz.m3u8",
            type: "application/x-mpegURL",
            poster: "https://upload.wikimedia.org/wikipedia/commons/thumb/7/70/Big.Buck.Bunny.-.Opening.Screen.png/320px-Big.Buck.Bunny.-.Opening.Screen.png",
            title: "BigBuckBunny® Product Video",
            autoplay: true,
            startTime: 0
        }
    };
    datazoom.createContextAndPlayer("akamai_player", config).then(
        function(context) {
            amp_player = context.getPlayer();
            datazoom_context = context;
        }
    );
</script>

</body>

</html>

Stop Data Collection

If the data collection must be stopped for any reason, for example after the destruction of the corresponding player instance, invoke the destroy() method of the Datazoom context object as in the following example:

if (akamai_player) {
    akamai_player.destroy();
    akamai_player = null;
}

if (datazoom_context) {
    datazoom_context.destroy();
    datazoom_context = null;
}

NPM (Node Package Manager)

We have made it convenient to manage your Akamai AMP Collector integration by providing NPM (Node Package Manager) support. Please see installation details here.



Ad Support - client side ads

Datazoom provides data collection options for Google IMA and Freewheel. By using the integration options described below you can collect a number of ad related events and related metadata to further understand ad performance.

Freewheel

To enable a Datazoom collector to capture the ad related data points, the required steps for a web application differ depending on how the ad framework (e.g., Freewheel) is integrated with the video player. In general, there are two types of integration method between the video player and ad framework:

1. Leverage ad framework integration supported by the video player

Players such as Akamai AMP player, JW Player, THEOplayer, … etc., support Freewheel ad integration as a part or an optional module of the player. Since the corresponding Datazoom collector for the player is prebuilt with knowledge of the player’s ad related features, for a web application who simply leverages the video player for ads, no additional code is required to enable ad data collection in this scenario.

A web application may choose to utilize the video player for the purpose of content presentation only, while building its own ad implementation by utilizing the ad framework directly. In these use cases, the video player has no awareness of the ad implementation and therefore it will fall under the second scenario described below.

2. Ad implementation external to the video player

Players that mainly focus on core playback/streaming functionalities, such as HLS.js player, Dash.js player, or the native HTML5 <video> element, often do not come with ad integration features. For a web application who likes to enable ads independent of the video player, it can choose to utilize the ad framework library (e.g., Freewheel MRM AdManager SDK) directly or bring in some third-party components. In either cases, since it is impossible for the corresponding Datazoom collector to gather ad information through the video player, some provisioning steps (see the section below: Attach the Freewheel Context) will be required to enable ad data collection.

Attach the Freewheel Context

For a web application who enables ads by utilizing Freewheel MRM AdManager SDK directly or through some third-party components, it will be interacting with the Freewheel Context object. This object is responsible for creating ad requests, parsing the ad request responses, and managing the presentation of the resulted ads. Besides, the Freewheel Context object also provides events and metadata regarding the resulted ads and the presentation status.

Therefore, for a Datazoom collector to gather ad information in this scenario, the application should give access by attaching the Freewheel Context object to the collector context as soon as it becomes available. The Datazoom collector context interface expose these methods for this purpose:

// share a Freewheel Context object with the collector context
context.attachFwContext(freewheel_context) {}

// unshare the Freewheel Context object as an optional cleanup step
context.detachFwContext() {}

For example, a video page using HTML5 <video> element and managing Freewheel MRM AdManager SDK directly can set everything up and attach the Freewheel Context object (to the collector context) as below:

// Create the video player and the collector context
var media_element = document.getElementById("video");
var datazoom_context = datazoom.createContext(media_element);

// Create the Freewheel AdManager
var fw_admanager = new tv.freewheel.SDK.AdManager();
fw_admanager.setNetwork(1234);
fw_admanager.setServer("ad_server_url");

// Create the Freewheel Context object
var fw_context = fw_admanager.newContext();
fw_context.setProfile("some_profile");
/* other Freewheel Context configurations
 fw_context.setVideoAsset(...);
 fw_context.setSiteSection(...);
 fw_context.addTemporalSlot(...);
 ...
 */

// Share the Freewheel Context object with the collector context
datazoom_context.attachFwContext(fw_context);

// Request ads
fw_context.submitRequest();

/* other code related to ad presentation and player coordination
 ...
 */

That’s it. The Datazoom collector is now provided with the required access to gather ad related information.

If some third-party component is used to add ad implementation, the best way to enable ad data collection is by querying the underlying Freewheel Context object and attaching it to the collector context in the same way as described above.

Google IMA

To enable a Datazoom collector to capture the ad related data points, the required steps for a web application differ depending on how the ad framework (e.g., IMA) is integrated with the video player. In general, there are two types of integration method between the video player and ad framework:

1. Leverage ad framework integration supported by the video player

Players such as Akamai AMP player, JW Player, Bitmovin Player, Shaka player, … etc., support IMA ad integration as a part or an optional module of the player. Since the corresponding Datazoom collector for the player is prebuilt with knowledge of the player’s ad related features, for a web application who simply leverages the video player for ads, no additional code is required to enable ad data collection in this scenario.

A web application may choose to utilize the video player for the purpose of content presentation only, while building its own ad implementation by utilizing the ad framework directly. In these use cases, the video player has no awareness of the ad implementation and therefore it will fall under the second scenario described below.

2. Ad implementation external to the video player

Players that mainly focus on core playback/streaming functionalities, such as HLS.js player, Dash.js player, or the native HTML5 <video> element, often do not come with ad integration features. For a web application who likes to enable ads independent of the video player, it can choose to utilize the ad framework library (e.g., IMA) directly or bring in some third-party components. In either cases, since it is impossible for the corresponding Datazoom collector to gather ad information through the video player, some provisioning steps (see the section below: Attach IMA Objects) will be required to enable ad data collection.

Attach IMA Objects

For a web application who enables ads by utilizing IMA directly or through some third-party components, it will be interacting with two primary IMA objects mostly:

  • adsLoader: Usually a singleton object, which handles ad-request (e.g., VAST) transactions based on ad tags given as inputs. Upon each successful completion of an ad-request, one adsManager object is created to oversee the presentation of the resulted ads.

  • adsManager: An object instance is created upon each successful completion of an ad-request. It provides events and metadata regarding the resulted ads and the presentation status.

Therefore, for a Datazoom collector to gather ad information in this scenario, the application should give access by attaching these IMA objects to the collector context as soon as they become available. The Datazoom collector context interface expose these methods for this purpose:

// share the adsLoader object with the collector context, usually once per context
context.attachImaAdsLoader(adsLoader) {}

// share a adsManager object with the collector context, once per ad-request
context.attachImaAdsManager(adsManager) {}

// unshare adsLoader as an optional cleanup step
context.detachImaAdsLoader() {}

// unshare adsManager as an optional cleanup step
context.detachImaAdsManager() {}

For example, a video page using HTML5 <video> element and managing IMA directly can set everything up and attach the adsLoader (to the collector context) as below:

// Create the video player and the collector context
var media_element = document.getElementById("video");
var datazoom_context = datazoom.createContext(media_element);

// Create the IMA adsLoader
var adContainer = document.getElementById("ad-container");
var adDisplayContainer = new google.ima.AdDisplayContainer(adContainer, media_element);
var adsLoader = new google.ima.AdsLoader(adDisplayContainer);

// Share the adsLoader object with the collector context
datazoom_context.attachImaAdsLoader(adsLoader);

Then, whenever an ad-request is successfully completed, an adsManager object is created and attached to the collector context as below:

adsLoader.addEventListener(google.ima.AdsManagerLoadedEvent.Type.ADS_MANAGER_LOADED,
    function(event) {
        // Create an IMA adsManager
        var adsManager = event.getAdsManager(media_element);
        // Share the adsManager object with the collector context
        datazoom_context.attachImaAdsManager(adsManager);
    }
);

That’s it. The Datazoom collector is now provided with the required access to gather ad related information.

If some third-party component is used to add ad implementation, the best way to enable ad data collection is by querying the underlying IMA adsLoader/adsManager objects and attaching them to the collector context in the same way as described above.

Previous
Javascript Collector
Next
Freewheel Ad Framework