Instream video with HBM and GAM

Configure instream video auctions with HB Manager, Google Ad Manager, and a video player.

Run instream video auctions with HB Manager and Google Ad Manager.

One Prebid auction can load banner and instream placements together. This allows pre-roll inventory to load alongside display inventory.

Before you begin

Google Ad Manager needs separate line items for in-player video creatives. Contact Relevant Yield Support if you need them created.

1. Add Prebid modules

Your Prebid build needs these modules:

dfpAdServerVideo — Required for this integration.
instreamTracking — Optional. Enables instream revenue in Headerbid Analytics reports.

The IMA SDK may not report instream tracking automatically. Use relevantDigital.Auction.registerImpressionByAdId() when you must register impressions manually.

Select Global programmatic tag.
Select Manage builds.
Open the Prebid build you want to update.

Add dfpAdServerVideo and, optionally, instreamTracking under Extra modules.
Click Save. The build completes in a few minutes.

2. Create an instream placement type

Create a placement type with Instream video as its type.

Add a dimension to set the default playerSize.

Override it through Instream video settings in Prebid parameters when needed.

Instream settings describe inventory to SSPs. They do not control the video player.

3. Add instream placements

Add placements as usual, then select the instream placement type.

Add the placement to the site's normal Prebid configuration.

4. Implement the player integration

This example uses the Brid.TV player. The same workflow applies to other players.

Create video slots with relevantDigital.defineVideoSlots(). Create slots once per page. You can reuse a GAM ad-unit path for multiple pre-roll videos.
Load ads with relevantDigital.loadPrebid().
Use relevantDigital.loadVideoUrls() to receive VAST URLs for the player.

Brid.TV example

instream-video.html

<html>
<body>
<script src="//services.brid.tv/player/build/brid.min.js"></script> 
<script async src="https://zee-cdn.relevant-digital.com/static/tags/6204e5fa70e3ad10821b84ff.js"></script>
Instream Video
<div id="playerDiv" class="brid" style="width:640;height:408;"></div>
<script>
window.relevantDigital = window.relevantDigital || {};
relevantDigital.cmd = relevantDigital.cmd || [];
relevantDigital.cmd.push(() => {
    relevantDigital.addPrebidConfig({ consentManagement: { cmpApi: 'none' } }); // JUST for this test-page!!!
    
    /** Define "video slots", the concept is similar to using <div data-ad-unit-id="??"> or calling
     * googletag.pubads().defineSlot([path], ..) manually - except that they doesn't correspond to any <div>.
     * But the ids (obtained by getSlotElementId()) can be used e.g. as the allowedDivIds parameter to loadPrebid
     */
    const PRE_ROLL_IDS = relevantDigital.defineVideoSlots([
        { path: '/19968336/prebid_cache_video_adunit' },
    ]).map((s) => s.getSlotElementId());
    

    // Call relevantDigital.loadPrebid() "as normal", this will also load the video slots we created.
    relevantDigital.loadPrebid({
        configId: '6204e83a077c5825441b8508',
        manageAdserver: true,
        // allowedDivIds: PRE_ROLL_IDS, // uncomment this line to *only* load our pre-rolls
    });
    
    // Wait for the "video slots" to be loaded, order of this call and relevantDigital.loadPrebid() doesn't matter
    // Notice however that if no corresonding relevantDigital.loadPrebid() call is made, the callback will not be called
    relevantDigital.loadVideoUrls(PRE_ROLL_IDS, (urls) => $bp("playerDiv", {
        id: "33423",
        width: "640",
        height: "480",
        playlist: "18250",
        Ad: [{
            adType: "0", // pre-roll
            adTimeType: "s",
            // Use Brid parser, instead of IMA SDK to make header bid analytics (HBA) work out of the box.
            // With the IMA SDK, register impressions manually for HBA.
            adTagUrl: urls.map((url) => url + "&brid_parser=brid"), // Use Brid parser, instead of IMA SDK to make Header bid reports work (optional)
        }],
    }));
});
</script>
</body>
</html>

PreviousSetting up Prebid Video

NextNative Integration Guide

Last updated 1 month ago

Was this helpful?

instream-video.html

<html>
<body>
<script src="//services.brid.tv/player/build/brid.min.js"></script> 
<script async src="https://zee-cdn.relevant-digital.com/static/tags/6204e5fa70e3ad10821b84ff.js"></script>
Instream Video
<div id="playerDiv" class="brid" style="width:640;height:408;"></div>
<script>
window.relevantDigital = window.relevantDigital || {};
relevantDigital.cmd = relevantDigital.cmd || [];
relevantDigital.cmd.push(() => {
    relevantDigital.addPrebidConfig({ consentManagement: { cmpApi: 'none' } }); // JUST for this test-page!!!
    
    /** Define "video slots", the concept is similar to using <div data-ad-unit-id="??"> or calling
     * googletag.pubads().defineSlot([path], ..) manually - except that they doesn't correspond to any <div>.
     * But the ids (obtained by getSlotElementId()) can be used e.g. as the allowedDivIds parameter to loadPrebid
     */
    const PRE_ROLL_IDS = relevantDigital.defineVideoSlots([
        { path: '/19968336/prebid_cache_video_adunit' },
    ]).map((s) => s.getSlotElementId());
    

    // Call relevantDigital.loadPrebid() "as normal", this will also load the video slots we created.
    relevantDigital.loadPrebid({
        configId: '6204e83a077c5825441b8508',
        manageAdserver: true,
        // allowedDivIds: PRE_ROLL_IDS, // uncomment this line to *only* load our pre-rolls
    });
    
    // Wait for the "video slots" to be loaded, order of this call and relevantDigital.loadPrebid() doesn't matter
    // Notice however that if no corresonding relevantDigital.loadPrebid() call is made, the callback will not be called
    relevantDigital.loadVideoUrls(PRE_ROLL_IDS, (urls) => $bp("playerDiv", {
        id: "33423",
        width: "640",
        height: "480",
        playlist: "18250",
        Ad: [{
            adType: "0", // pre-roll
            adTimeType: "s",
            // Use Brid parser, instead of IMA SDK to make header bid analytics (HBA) work out of the box.
            // With the IMA SDK, register impressions manually for HBA.
            adTagUrl: urls.map((url) => url + "&brid_parser=brid"), // Use Brid parser, instead of IMA SDK to make Header bid reports work (optional)
        }],
    }));
});
</script>
</body>
</html>