Skip to main content

Roku Advertising Framework (RAF)

IMA SDKs simplify the process of incorporating multimedia advertisements into your web pages and applications. They can request ads from any VAST-compliant ad server and handle the playback of the ads within the app. By using the IMA client-side SDKs, you retain control of the content video playback while the SDK manages the ad playback. The ads are displayed in a separate video player that is overlaid on top of the app's content video player.

Clientside Configuration​

AttributeTypeRequiredDescription
enabledbooleanYesEnable the plugin (Defaults to false if no value is given.)
adUrlstringNoAd Tag URL of the advertisement. (VAST, VPAID, VMAP, SIMID)

VAST Example

m.player.callFunc("setConfig", {
    ...
    ads: {
      clientSide: {
        provider: "raf",
        raf: {
          enabled: true,
          adUrl:
            "https://pubads.g.doubleclick.net/gampad/ads?iu=/21775744923/external/single_ad_samples&sz=640x480&cust_params=sample_ct%3Dlinear&ciu_szs=300x250%2C728x90&gdfp_req=1&output=vast&unviewed_position_start=1&env=vp&impl=s&correlator=[LURA_CORRELATOR]",
        }
      }
    }
    ...
})

VMAP - Pre-roll Single Ad, Mid-roll Standard Pod with 3 ads, Post-roll Single Ad Example

m.player.callFunc("setConfig", {
    ...
    ads: {
      clientSide: {
        provider: "raf",
        raf: {
          enabled: true,
          adUrl:
            "https://pubads.g.doubleclick.net/gampad/ads?iu=/21775744923/external/vmap_ad_samples&sz=640x480&cust_params=sample_ar%3Dpremidpostpod&ciu_szs=300x250&gdfp_req=1&ad_rule=1&output=vmap&unviewed_position_start=1&env=vp&impl=s&cmsid=496&vid=short_onecue&correlator=[LURA_CORRELATOR]",
        }
      }
    }
    ...
})