Review SIMID support

The Google Dynamic Ad Insertion (DAI) SDK for HTML5 supports Secure Interactive Media Interface Definition (SIMID) version 1.1. This guide covers the specific SIMID features and messages that DAI SDK supports.

Understand creative to player messages

The following table lists the messages that the SIMID creative can send to IMA DAI:

Message Description
clickThru DAI SDK pings the click-through tracking URLs configured in the DAI ad tag. DAI SDK ignores any custom URI or navigation options the creative provides.
getMediaState Returns the current state of the media player, including the currentTime, duration, volume, muted, paused, and fullscreen properties. The currentSrc property always returns null because DAI uses server-side stitched streams.
log Forwards creative log messages to DAI SDK debug console logging for troubleshooting.
reportTracking Requests that DAI SDK ping tracking URLs for the creative.
requestPause Requests that DAI SDK pause the media player.
requestPlay Requests that DAI SDK resume playback on the media player.
requestSkip Requests that DAI SDK skip the current ad. Supported only for VOD streams. Rejects if the creative sends this message for a livestream.

Review unsupported creative to player messages

DAI SDK doesn't handle the following CreativeMessage types:

  • fatalError
  • requestChangeAdDuration
  • requestFullscreen
  • requestExitFullscreen
  • handleSkipShown
  • requestFocus
  • requestNavigation: always rejected. The player expects the creative to handle navigation.
  • requestResize: always rejected. DAI SDK doesn't support creative resizing.
  • requestStop: always rejected. This type is for extended duration use cases, which DAI doesn't support.
  • requestChangeVolume: DAI SDK resolves this event successfully, but doesn't perform volume changes for the creative.

Understand player to creative messages

The following table lists messages DAI SDK supports sending to the SIMID creative:

Message Description
init Sent during session setup with environment data and ad parameters.
startCreative Notifies the creative to initiate and display the creative iframe.
adStopped Notifies that the ad session has ended, including a reason code.
adSkipped Notifies the creative that the user or DAI SDK skipped the ad. Supported only for VOD streams.

Review unsupported player to creative messages

DAI SDK doesn't support or send the following messages to the creative:

  • resize
  • appBackgrounded
  • appForegrounded
  • log

Review media state updates

DAI SDK sends mediaStateUpdate messages to the creative for the following events:

  • play
  • pause
  • stalled (buffering)
  • seeking
  • seeked
  • timeupdate (periodically)
  • volumechange (including mute status)

DAI SDK doesn't support the following events and doesn't send media state updates when the events occur:

  • ended
  • durationchange
  • error