relevantDigital.defineVideoSlots()

Define Google Ad Manager video slots for Prebid auctions and VAST URL retrieval.

Define video slots before calling relevantDigital.loadPrebid(). Then use relevantDigital.loadVideoUrls() to retrieve VAST URLs for your player.

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

This API currently supports Google Ad Manager only.

Parameters

Pass an array of video slot settings.

path

Required. The Google Ad Manager ad unit path, such as "/12345/articles/pre_roll".

id

Optional. A unique slot ID for relevantDigital.loadVideoUrls(). An ID is generated when omitted.

custParams

Optional. Custom ad-server targeting parameters.

Return value

Returns a VideoSlot object for each input setting. Use videoSlot.getSlotElementId() to retrieve a slot ID.

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) => {
       console.info('VAST URLs:', vastUrls);
       // TODO: Invoke video player here
    });
});