relevantDigital.loadVideoUrls()

Retrieve VAST URLs for video slots after their Prebid auctions complete.

Use relevantDigital.loadVideoUrls() to retrieve VAST XML URLs for instream video slots.

The function waits for the corresponding relevantDigital.loadPrebid() auction. It does not start an auction itself.

For a complete instream implementation, see Instream video with HBM and GAM.

How it works

• You can call loadVideoUrls() before or after loadPrebid().

• The callback runs only after the matching Prebid auction completes.

• For a single loadPrebid() call, only the first loadVideoUrls() call for the same slots completes.

The VAST URLs returned by this API target Google Ad Manager.

Parameters

ids

The IDs of VideoSlot objects created with relevantDigital.defineVideoSlots(). Use videoSlot.getSlotElementId() to retrieve a slot ID.

cb(urls)

The callback that receives VAST XML URLs. Pass these URLs to your video player.

settings

Optional settings.

onBuildVideoUrl

A callback that customizes the settings passed to pbjs.adServers.gam.buildVideoUrl(). For Prebid.js versions before 10, it applies to pbjs.adServers.dfp.buildVideoUrl().

Example

window.relevantDigital = window.relevantDigital || {};
relevantDigital.cmd = relevantDigital.cmd || [];
relevantDigital.cmd.push(() => {
    const videoSlots = relevantDigital.defineVideoSlots([
        {
           path: '/12345/articles/pre_roll',
           id: 'preroll_1',
           custParams: { 'section': 'articles' },
        },
        {
           path: '/12345/articles/pre_roll',
           id: 'preroll_2',
           custParams: { 'section': 'articles' },
           },
    ]);
    

    // Call relevantDigital.loadPrebid() "as normal"
    relevantDigital.loadPrebid({ ... });
    
    // Get the URLs with VAST XML that should be used with the video player
    relevantDigital.loadVideoUrls(['preroll_1', 'preroll_2'], (vastUrls, datas) => {
       console.info('VAST URLs:', vastUrls);
       // TODO: Invoke video player here
    });
});

Other ad servers

The returned vastUrls target Google Ad Manager. For another ad server, or for additional bid details, use the callback's datas parameter.

relevantDigital.loadVideoUrls(['preroll_1', 'preroll_2'], (vastUrls, datas) => {
    datas.forEach(({ unitData }) => {
         const highestBid = unitData.getHighestBid();
         if (highestBid) {
             console.info('Got bid for placement: ', unitData.slot.getAdUnitPath());
             console.info('Targeting key-values: ', highestBid.adserverTargeting);
             console.info('VAST URL: ', highestBid.vastUrl);
             console.info('VAST XML: ', highestBid.vastXml);

         } else {
             console.info('No bid for placement: ', unitData.slot.getAdUnitPath());
         }
    });
});