Skip to main content

Advertising

Audience and purpose​

Front-end developer: troubleshooting​

When integrating DIVA Player within your front-end, read this article to check the DIVA Player's configuration of advertisements.

Video engineer: guide​

When configuring advertisements within the video workflow, read this article to reflect the advertisement-related configuration into the DIVA Player settings.

Supported advertisements​

Types​

DIVA Player supports Client-Side Ad Insertion (CSAI) and Server-Side Ad Insertion (SSAI).

Workflows​

DIVA Player supports advertisements for live and VOD videos.

Placements​

DIVA Player supports preroll and midroll advertisements.

No platform-specific, behavior, code, and configuration​

The advertisement configuration is valid regardless of the platform. In addition, front-end developers have no platform-specific code to write and handle.

CSAI configuration​

Find the advertising configuration within the VideoMetadata. The ad field stores the VMAP file's URL (e.g., https://domain.com/vmap.xml):

{
    ...
    "ad": "https://domain.com/vmap.xml",
    ...
}

Note: VMAP stays for Video Multiple Ad Playlist. It's the video-related XML file that lists the placement of advertisements along the video. To check its URL and content, contact the video engineers team.

SSAI configurations​

Find the advertising configuration within the VideoMetadata. The daiType field stores the ad manager type (e.g., googleLive):

{
    "sources": [
        {
            ...
            "daiType": "googleLive",
            ...
        }
    ],
}

Find all possible values in the DaiType table.

SessionID and PlaybackSessionId​

DIVA Player leverages client session IDs and video playback session IDs to enhance ad targeting SSAI. Session Id and video playback session Id are configured as parameters into the entitlementCheck section in the settings file:

{
    ...
    "entitlementCheck": {
        ...
        "data": {
            "sessionId": "{Run.SessionID}",
            "playbackSessionId": "{Run.PlaybackSessionId}",
            ...
        }
    },
    ...
}

Client-side beaconing​

Beaconing manager configuration​

DIVA Player integrates the Open Measurement (OM) SDK as the advertisement-measurement manager.

In the settings file, in the openMeasurement subsection of the mediaAnalytics section, enable OM and set the measurements sender (partnerName):

{
    "settings": {
        "mediaAnalytics": {
            "openMeasurement": {
                "enabled": true,
                "partnerName": "<measurements sender>"
            }
        }
    },
    ...
}

Beaconing receiver configuration​

Client-side beaconing refers to the process where a user's device — such as a web browser or mobile app — sends data back to a server (the beaconing receiver) to report specific user interactions or events.

The type field within the ssai section in the settings file is the client-side beaconing configuration. It can value mediatailor or harmonic. E.g.:

{
    "settings": {
        "ssai": {
            "type": "harmonic",
            "interval": 2000,
            "threshold": 1000,
            "liveEdgeThreshold": 45000,
            "lookAhead": 5000,
            "enableGooglePAL": true,
        }
    },
    ...
}

Dictionary​

Ensure the dictionary file contains the relevant keys.

Analytics events​

Find here the available analytics events for the Advertisements.

Media Analytics events​

Coming soon!

Media Analytics Listeners​

  • Open Measurement SDK
  • Google PAL SDK
  • IAB Open Measurement SDK plugin
  • NPAW YOUBORA
  • Conviva