AutoGineer
Generated banner for Ima Dai SDK
Generated logo for Ima Dai SDK

Ima Dai SDK

GoogleOfficialCreated by Google LLC

  • Skill
  • Tool integration
  • Software development
  • Apache-2.0
  • No issues found
Download ZIP

From the author

Integrates the Google Interactive Media Ads (IMA) Dynamic Ad Insertion (DAI) SDK into websites, web apps, mobile apps, or TV apps. Use when: - A video player needs to load and play HLS or DASH streams in web apps, Android apps, iOS apps, tvOS apps, Cast (CAF) receivers, or Roku channels. - The app needs to make use of a Google DAI livestream event asset key, or content source CMS ID, video ID for video on demand. Don't use this skill to load and play a VAST or VMAP URL.
— the description by Google LLC

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

The ima-dai-sdk provides the necessary implementation patterns to integrate Google's Dynamic Ad Insertion (DAI) technology into various platforms, including web, Android, iOS, tvOS, Cast, and Roku. It enables developers to load and play HLS or DASH streams with server-side ad insertion for both livestream events and video-on-demand (VOD) content managed via Google Ad Manager.

What it does

  • Initializes the IMA DAI SDK for platform-specific video players.
  • Supports livestream event requests using asset keys.
  • Supports VOD stream requests using CMS IDs and video IDs.
  • Provides event listeners for stream management and ad playback tracking.
  • Handles timed metadata forwarding for seamless ad transitions.
  • Facilitates resource cleanup to ensure stable application performance.

When to use it

  • When implementing server-side ad insertion for HLS or DASH video streams.
  • When managing ad-supported livestreams configured in Google Ad Manager.
  • When integrating VOD content with dynamic ads into mobile, web, or TV applications.
  • When building custom video player experiences that require Google DAI functionality.

Advantages

  • Enables seamless, server-side ad insertion for improved playback stability.
  • Provides consistent integration patterns across multiple platforms.
  • Supports both live and on-demand video content workflows.
  • Integrates directly with Google Ad Manager infrastructure.

Usage examples

“How do I initialize the IMA DAI SDK in an Android application?”
The agent provides the steps to use ImaSdkFactory to create and initialize ImaSdkSettings, followed by building an AdsLoader for the ExoPlayer instance.
“What parameters are needed to request a VOD stream on a Cast receiver?”
The agent explains that a VODStreamRequest requires the network code, content source ID (CMS ID), and video ID from Google Ad Manager.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/google/ima-dai-sdk/download

  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip ima-dai-sdk.zip -d .agents/skills

Documentation by Google LLC

IMA DAI SDK

Use the IMA DAI SDK to load HLS or DASH streams into the app for:

  • Livestream events configured in Google Ad Manager.

  • Video on demand (VOD) content ingested into Google Ad Manager.

Prerequisites

Review the platform-specific integration guides for the target platforms:

Quick start (general workflow)

  1. Import the SDK

  2. Initialize the SDK

  3. Add stream event listeners

  4. Set up timed metadata forwarding

  5. Make a stream request

  6. Clean up SDK resources when the stream fails or the user leaves the stream.

Files

references/android-ImaServerSideAdInsertionMediaSource-guide.md

Google IMA DAI SDK Android - ExoPlayer IMA Extension Guide

Use the ImaServerSideAdInsertionMediaSource class of the ExoPlayer IMA extension (androidx.media3:media3-exoplayer-ima) to request livestream or VOD stream from Google full-service DAI.

Table of Contents

  • Dependencies (Line 21)

  • IMA DAI SDK required permissions (Line 57)

  • UI Setup (Line 66)

  • Early SDK Initialization (Line 89)

  • Create a reusable AdsLoader (Line 104)

  • Listen to stream events and ad events (Line 123)

  • Initialize ExoPlayer with SSAI MediaSource Factory (Line 155)

  • Request a livestream (Line 180)

    • Video on Demand (VOD) Streams (Line 202)

  • Clean up SDK resources (Line 227)

  • Reference implementation (Line 240)

Dependencies

Add the Media3 ExoPlayer IMA extension in build.gradle. This component automatically imports the IMA DAI SDK.

apply plugin: "com.android.application"

android {
    compileOptions {
        // Required by IMA SDK v3.37.0+
        coreLibraryDesugaringEnabled = true
    }

    defaultConfig {
        minSdkVersion(23)
    }
}

repositories {
    google()
    mavenCentral()
}

dependencies {
    implementation("androidx.media3:media3-ui")
    implementation("androidx.media3:media3-exoplayer")
    implementation("androidx.media3:media3-exoplayer-hls")
    implementation("androidx.media3:media3-exoplayer-dash")
    implementation("androidx.media3:media3-exoplayer-ima")
}

Use latest versions as posted on Media3

IMA DAI SDK required permissions

Ensure to declare the permissions required by the IMA DAI SDK in AndroidManifest.xml:

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

UI Setup

Place the PlayerView inside the layout. For example:

<androidx.media3.ui.PlayerView android:id="@+id/player_view" />

If Jetpack Compose is used, create a PlayerView wrapping an exoplayer:

AndroidView(
  factory = { ctx ->
    PlayerView(ctx).apply {
      player = exoPlayer
    }
  },
  update = { playerView ->
    playerView.player = exoPlayer
  }
)

Early SDK Initialization

Initialize the IMA SDK as early as possible in the app lifecycle (such as inside onCreate() of Application or the main Activity) to minimize stream load times:

Create a ImaSdkSettings object to initialize the SDK. Save it for reuse with ImaServerSideAdInsertionMediaSource.

val imaSdkFactory = ImaSdkFactory.getInstance()
val sharedImaSdkSettings: ImaSdkSettings = imaSdkFactory.createImaSdkSettings()
imaSdkFactory.initialize(this, sharedImaSdkSettings)

Create a reusable AdsLoader

Provide the androidx.media3.ui.PlayerView to build a ImaServerSideAdInsertionMediaSource.AdsLoader.

Provide the same ImaSdkSettings from ImaSdkFactory.getInstance().initialize() the previous step.

val playerView = findViewById(R.id.player_view)
val adsLoaderBuilder =
    ImaServerSideAdInsertionMediaSource.AdsLoader.Builder(this, playerView)

val adsLoader = adsLoaderBuilder
    .setAdEventListener(buildAdEventListener())
    .setImaSdkSettings(sharedImaSdkSettings)
    .build()

Listen to stream events and ad events

Implement DAI stream event handling by creating an AdEventListener. Provide this listener to the AdsLoader builder during instantiation.

val adEventListener = AdEvent.AdEventListener { event ->
    when (event.type) {
      AdEvent.AdEventType.LOADED,
      AdEvent.AdEventType.CUEPOINTS_CHANGED,
      AdEvent.AdEventType.AD_BREAK_STARTED,
      AdEvent.AdEventType.AD_BREAK_ENDED,
      AdEvent.AdEventType.AD_PERIOD_STARTED,
      AdEvent.AdEventType.AD_PERIOD_ENDED,
      AdEvent.AdEventType.STARTED,
      AdEvent.AdEventType.FIRST_QUARTILE,
      AdEvent.AdEventType.MIDPOINT,
      AdEvent.AdEventType.THIRD_QUARTILE,
      AdEvent.AdEventType.COMPLETED,
      AdEvent.AdEventType.PAUSED,
      AdEvent.AdEventType.RESUMED,
      AdEvent.AdEventType.SKIPPABLE_STATE_CHANGED,
      AdEvent.AdEventType.SKIPPED,
      AdEvent.AdEventType.CLICKED -> Log.i(LOG_TAG, "Ad event: ${event.type}")
      AdEvent.AdEventType.AD_PROGRESS -> {
        // High-frequency event fired periodically during ad playback; ignore to prevent log spam
      }
      else -> Log.i(LOG_TAG, "Unhandled ad event: ${event.type}")
    }
  }

Initialize ExoPlayer with SSAI MediaSource Factory

Create DefaultMediaSourceFactory and ImaServerSideAdInsertionMediaSource.Factory objects to build the ExoPlayer instance.

Ensure to call AdsLoader.setPlayer(), providing the ExoPlayer instance above, before calling ExoPlayer.setMediaItem with a ImaServerSideAdInsertionUri.

val dataSourceFactory: DataSource.Factory = DefaultDataSource.Factory(this)
val mediaSourceFactory = DefaultMediaSourceFactory(dataSourceFactory)

val adsMediaSourceFactory =
    ImaServerSideAdInsertionMediaSource.Factory(adsLoader, mediaSourceFactory)

mediaSourceFactory.setServerSideAdInsertionMediaSourceFactory(adsMediaSourceFactory)

player = ExoPlayer.Builder(this)
    .setMediaSourceFactory(mediaSourceFactory)
    .build()
adsLoader.setPlayer(player)

Request a livestream

Build a live stream URI using ImaServerSideAdInsertionUriBuilder with the asset key:

val liveStreamUri: Uri = ImaServerSideAdInsertionUriBuilder()
      .setNetworkCode(<NETWORK_CODE_PLACEHOLDER>)
      .setAssetKey(<ASSET_KEY_PLACEHOLDER>)
      .setFormat(androidx.media3.common.C.CONTENT_TYPE_HLS)
      .build()

val liveStreamMediaItem: MediaItem = MediaItem.fromUri(liveStreamUri)
player.setMediaItem(liveStreamMediaItem)

Provide the following parameters:

  • <NETWORK_CODE_PLACEHOLDER>: The Google Ad Manager network code.

  • <ASSET_KEY_PLACEHOLDER>: The livestream asset key configured in Google Ad Manager.

Video on Demand (VOD) Streams

Build a VOD stream URI using ImaServerSideAdInsertionUriBuilder with content source ID (CMS ID) and video ID:

val vodStreamUri: Uri = ImaServerSideAdInsertionUriBuilder()
      .setNetworkCode(<NETWORK_CODE_PLACEHOLDER>)
      .setContentSourceId(<CONTENT_SOURCE_ID_PLACEHOLDER>)
      .setVideoId(<VIDEO_ID_PLACEHOLDER>)
      .setFormat(androidx.media3.common.C.CONTENT_TYPE_HLS)
      .build()
val vodStreamItem: MediaItem = MediaItem.fromUri(vodStreamUri)
player.setMediaItem(vodStreamItem)

Provide the following parameters:

  • <NETWORK_CODE_PLACEHOLDER>: The Google Ad Manager network code.

  • <CONTENT_SOURCE_ID_PLACEHOLDER>: The CMS ID in Google Ad Manager.

  • <VIDEO_ID_PLACEHOLDER>: The video ID in the CMS.

For testing purposes, use values of DAI sample streams from https://developers.google.com/ad-manager/dynamic-ad-insertion/streams.md.txt?utm_source=agent-skills&utm_medium=content&utm_campaign=adr-ss-ai&utm_content=ima-dai-sdk

Clean up SDK resources

Call ImaServerSideAdInsertionMediaSource.AdsLoader.release() when releasing the player or handling stream errors to tear down active DAI sessions.

Save the returned AdsLoader.State object to restore player during configuration changes like screen rotations.

adsLoader?.setPlayer(null)
adsLoaderState = adsLoader?.release()

Reference implementation

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Security

No issues found by our static scan· No issues found

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
Google LLC
Publisher
Google (Official)
Source
google/skills · skills/ads/ima-dai-sdk · commit 2194d3b
Licence
Apache License 2.0 (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Google LLC or Google.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download ima-dai-sdk.zip