ExoPlayer IMA 拡張機能を使ってみる

ExoPlayer は、Android 用のアプリレベルのメディア プレーヤーです。このガイドでは、IMA DAI SDK をラップする ExoPlayer IMA 拡張機能を使用して、広告とコンテンツの両方のメディア ストリームをリクエストし、再生する方法を説明します。

この拡張機能には次のようなメリットがあります。

• IMA を機能と統合するために必要なコードが簡略化されています。
• 新しいバージョンの IMA に更新するために必要な開発時間を短縮できます。

ExoPlayer IMA 拡張機能は、HLS および DASH ストリーミング プロトコルをサポートしています。概要は次のとおりです。

ExoPlayer-IMA 拡張機能のストリームのサポート
	ライブ配信	VOD ストリーム
HLS
DASH

DASH ライブ ストリームは ExoPlayer-IMA バージョン 1.1.0 以降でサポートされています。

このガイドは ExoPlayer ガイドに基づいており、完全なアプリを作成して拡張機能を統合する方法について説明します。完全なサンプルアプリの例については、GitHub の ExoPlayerExample をご覧ください。

キーポイント: ExoPlayer IMA 拡張機能は ExoPlayer に依存します。別のプレーヤーを使用する場合は、スタートガイドに沿って IMA DAI SDK をアプリに統合してください。

前提条件

• Android Studio
• AndroidX Media3 ExoPlayer バージョン 1.0.0 以降（DAI サポート）。

新しい Android Studio プロジェクトの作成

Android Studio プロジェクトを作成する手順は次のとおりです。

• Android Studio を起動します。
• [Start a new Android Studio project] を選択します。
• [Choose your project] ページで [No Activity] テンプレートを選択します。
• [次へ] をクリックします。

• [プロジェクトの構成] ページで、プロジェクトに名前を付け、言語として Java を選択します。

  注: IMA DAI SDK は Kotlin に対応しています。ただし、このガイドで説明する例では Java を使用しています。

• [完了] をクリックします。

プロジェクトに ExoPlayer IMA 拡張機能を追加する

拡張機能のインポートをアプリケーション レベルの build.gradle ファイルの dependencies セクションに追加します。

Multidex を使用するようにアプリを設定し、有効にします。これは、拡張機能のサイズにより必要であり、minSdkVersion が Android 4.4W（API レベル 20）以下に設定されているアプリでは必須です。

次の例をご覧ください。

app/build.gradle

android {

  ...

  defaultConfig {
      applicationId "com.google.ads.interactivemedia.v3.samples.videoplayerapp"
      minSdkVersion 19
      targetSdkVersion 34
      multiDexEnabled true
      versionCode 1
      versionName "1.0"
  }

    ...
}
dependencies {
    implementation 'androidx.multidex:multidex:2.0.1'
    implementation 'androidx.media3:media3-ui:1.1.1'
    implementation 'androidx.media3:media3-exoplayer:1.1.1'
    implementation 'androidx.media3:media3-exoplayer-hls:1.1.1'
    implementation 'androidx.media3:media3-exoplayer-dash:1.1.1'

    // Adding the ExoPlayer IMA extension for ads will also include the IMA
    // SDK as a dependency.
    implementation 'androidx.media3:media3-exoplayer-ima:1.1.1'
}

IMA DAI SDK で広告のリクエストに必要なユーザー権限を追加します。

app/src/main/AndroidManifest.xml

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.project name">

    <!-- Required permissions for the IMA DAI SDK -->
    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

    ...

</manifest>

インテントの宣言を追加する

Android 11（API レベル 30）以降をターゲットとするアプリの場合、IMA DAI SDK の最新バージョンと最新バージョンでは、ウェブリンクを開くインテントを明示的に宣言する必要があります。広告のクリックスルー（ユーザーが [詳細] ボタンをクリック）を有効にするには、以下のスニペットをアプリのマニフェスト ファイルに追加します。

注: IMA DAI SDK の今後のバージョンには、こうした宣言が自動的に組み込まれ、アプリのマニフェスト ファイルと統合される予定です。

  <?xml version="1.0" encoding="utf-8"?>
  <manifest xmlns:android="http://schemas.android.com/apk/res/android"
      package="com.example.project name">

      ...

    </application>

    <queries>
      <intent>
          <action android:name="android.intent.action.VIEW" />
          <data android:scheme="https" />
      </intent>
      <intent>
          <action android:name="android.intent.action.VIEW" />
          <data android:scheme="http" />
      </intent>
    </queries>
  </manifest>

ExoPlayer の UI を設定する

ExoPlayer が使用する PlayerView オブジェクトを作成します。

androidx.constraintlayout.widget.ConstraintLayout を LinearLayout に変更します。これは、ExoPlayer IMA 拡張機能で推奨されている値です。

次の例をご覧ください。

app/src/main/res/layout/activity_my.xml

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:background="@android:color/black"
    android:id="@+id/container"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical"
    tools:context=".MyActivity"
    tools:ignore="MergeRootFrame">

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

</LinearLayout>

ストリーム パラメータを追加する

プロジェクトで使用するストリーム アセットのサンプルについては、IMA のサンプル ストリーム ページをご覧ください。独自のストリームの設定については、DAI のアド マネージャーのセクションもご覧ください。

この手順はライブ ストリームの設定を示していますが、ExoPlayer IMA 拡張機能は DAI VOD ストリームもサポートしています。VOD ストリームを処理するためにアプリで必要となる変更については、ビデオ オンデマンド（VOD）ストリームの手順をご覧ください。

ExoPlayer IMA 拡張機能をインポートする

ExoPlayer 拡張機能のインポート ステートメントを追加します。

次のプライベート変数を MyActivity.java に追加します。

• PlayerView
• ExoPlayer
• ImaServerSideAdInsertionMediaSource.AdsLoader
• ImaServerSideAdInsertionMediaSource.AdsLoader.State

Big Buck Bunny (Live) HLS ストリームのアセットキーを追加して、このストリームでテストします。IMA のサンプル ストリーム ページでは、他にもテストできるストリームがあります。

AdsLoader の状態を保存および取得するために、KEY_ADS_LOADER_STATE 定数を作成します。

次の例をご覧ください。

app/src/main/java/com/example/project name/MyActivity.java

import static androidx.media3.common.C.CONTENT_TYPE_HLS;

import android.app.Activity;
import android.net.Uri;
import android.os.Bundle;
import androidx.annotation.Nullable;
import androidx.annotation.OptIn;
import androidx.media3.common.MediaItem;
import androidx.media3.common.util.Util;
import androidx.media3.datasource.DataSource;
import androidx.media3.datasource.DefaultDataSource;
import androidx.media3.exoplayer.ExoPlayer;
import androidx.media3.exoplayer.ima.ImaServerSideAdInsertionMediaSource;
import androidx.media3.exoplayer.ima.ImaServerSideAdInsertionUriBuilder;
import androidx.media3.exoplayer.source.DefaultMediaSourceFactory;
import androidx.media3.exoplayer.util.EventLogger;
import androidx.media3.ui.PlayerView;
import androidx.multidex.MultiDex;

...

public class MyActivity extends Activity {

  private static final String KEY_ADS_LOADER_STATE = "ads_loader_state";
  private static final String SAMPLE_ASSET_KEY = "c-rArva4ShKVIAkNfy6HUQ";

  private PlayerView playerView;
  private ExoPlayer player;
  private ImaServerSideAdInsertionMediaSource.AdsLoader adsLoader;
  private ImaServerSideAdInsertionMediaSource.AdsLoader.State adsLoaderState;

}

adsLoader インスタンスを作成する

onCreate メソッドを上書きして PlayerView を探し、adsLoader オブジェクトの開始時に使用できる保存済み AdsLoader.State を確認します。

また、アプリのメソッド数と minSdkVersion で必要な場合は multidex を有効にします（ステップ 2 を参照）。

次の例をご覧ください。

app/src/main/java/com/example/project name/MyActivity.java

...

public class MyActivity extends Activity {

  private static final String KEY_ADS_LOADER_STATE = "ads_loader_state";
  private static final String SAMPLE_ASSET_KEY = "c-rArva4ShKVIAkNfy6HUQ";

  private PlayerView playerView;
  private ExoPlayer player;
  private ImaServerSideAdInsertionMediaSource.AdsLoader adsLoader;
  private ImaServerSideAdInsertionMediaSource.AdsLoader.State adsLoaderState;

  @Override
  protected void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_my);
    MultiDex.install(this);

    playerView = findViewById(R.id.player_view);

    // Checks if there is a saved AdsLoader state to be used later when
    // initiating the AdsLoader.
    if (savedInstanceState != null) {
      Bundle adsLoaderStateBundle = savedInstanceState.getBundle(KEY_ADS_LOADER_STATE);
      if (adsLoaderStateBundle != null) {
        adsLoaderState =
            ImaServerSideAdInsertionMediaSource.AdsLoader.State.fromBundle(
                adsLoaderStateBundle);
      }
    }
  }

}

プレーヤーを初期化するメソッドを追加する

プレーヤーを初期化するメソッドを追加し、次のことを行います。

• AdsLoader インスタンスを作成します。
• ExoPlayer を作成します。
• ライブ配信のアセットキーで MediaItem を作成します。
• MediaItem をプレーヤーに設定します。

注: このセクションでは、サーバーサイド広告挿入（SSAI）のコンセプトを参照する名前のメソッドを使用します。

• Google アド マネージャー DAI は SSAI のインスタンスです。
• このガイドの ExoPlayer IMA 拡張機能の実装は、特にアド マネージャー DAI と連携するように設計されています。ExoPlayer IMA 拡張機能は、このガイドでは説明しない、Google Cloud Platform などの他の SSAI インスタンスもサポートしています。

次の例をご覧ください。

app/src/main/java/com/example/project name/MyActivity.java

public class MyActivity extends Activity {

  ...

  
  // Create a server side ad insertion (SSAI) AdsLoader.
  private ImaServerSideAdInsertionMediaSource.AdsLoader createAdsLoader() {
    ImaServerSideAdInsertionMediaSource.AdsLoader.Builder adsLoaderBuilder =
        new ImaServerSideAdInsertionMediaSource.AdsLoader.Builder(this, playerView);

    // Attempt to set the AdsLoader state if available from a previous session.
    if (adsLoaderState != null) {
      adsLoaderBuilder.setAdsLoaderState(adsLoaderState);
    }

    return adsLoaderBuilder.build();
  }

  private void initializePlayer() {
    adsLoader = createAdsLoader();

    // Set up the factory for media sources, passing the ads loader.
    DataSource.Factory dataSourceFactory = new DefaultDataSource.Factory(this);
    DefaultMediaSourceFactory mediaSourceFactory = new DefaultMediaSourceFactory(dataSourceFactory);

    // MediaSource.Factory to create the ad sources for the current player.
    ImaServerSideAdInsertionMediaSource.Factory adsMediaSourceFactory =
        new ImaServerSideAdInsertionMediaSource.Factory(adsLoader, mediaSourceFactory);

    // 'mediaSourceFactory' is an ExoPlayer component for the DefaultMediaSourceFactory.
    // 'adsMediaSourceFactory' is an ExoPlayer component for a MediaSource factory for IMA server
    // side inserted ad streams.
    mediaSourceFactory.setServerSideAdInsertionMediaSourceFactory(adsMediaSourceFactory);

    // Create an ExoPlayer and set it as the player for content and ads.
    player = new ExoPlayer.Builder(this).setMediaSourceFactory(mediaSourceFactory).build();
    playerView.setPlayer(player);
    adsLoader.setPlayer(player);

    // Build an IMA SSAI media item to prepare the player with.
    Uri ssaiLiveUri =
        new ImaServerSideAdInsertionUriBuilder()
            .setAssetKey(SAMPLE_ASSET_KEY)
            .setFormat(CONTENT_TYPE_HLS) // Use CONTENT_TYPE_DASH for dash streams.
            .build();

    // Create the MediaItem to play, specifying the stream URI.
    MediaItem ssaiMediaItem = MediaItem.fromUri(ssaiLiveUri);

    // Prepare the content and ad to be played with the ExoPlayer.
    player.setMediaItem(ssaiMediaItem);
    player.prepare();

    // Set PlayWhenReady. If true, content and ads will autoplay.
    player.setPlayWhenReady(false);
  }
}

プレーヤーを解放するメソッドを追加する

次の順序でプレーヤーを解放するメソッドを追加します。

• プレーヤーの参照を null に設定し、プレーヤーのリソースを解放します。
• adsLoader の状態を解放します。

app/src/main/java/com/example/project name/MyActivity.java

public class MyActivity extends Activity {

  ...

  private void releasePlayer() {
    // Set the player references to null and release the player's resources.
    playerView.setPlayer(null);
    player.release();
    player = null;

    // Release the adsLoader state so that it can be initiated again.
    adsLoaderState = adsLoader.release();
  }

プレーヤー イベントを処理する

最後に、アクティビティのライフサイクル イベントのコールバックを作成して、ストリームの再生を処理します。

Android SDK バージョン 24 以降をサポートするには:

• onStart()
• onStop()

バージョン 24 より前の Android SDK をサポートする場合: - onResume() - onPause()

onStart() と onResume() は playerView.onResume() にマッピングされ、onStop() と onPause() は playerView.onPause() にマッピングされます。

キーポイント: この例では、Android SDK バージョン 24 以降と 24 より前のバージョンの両方をサポートすることを目的としています。Android SDK バージョン 24 以降のサポートには onStart()/onStop() を使用し、バージョン 24 未満のサポートには onResume()/onPause() を使用します。

また、このステップでは onSaveInstanceState() イベントを使用して adsLoaderState の保存を試みます。

app/src/main/java/com/example/project name/MyActivity.java

public class MyActivity extends Activity {

  ...

  @Override
  public void onStart() {
    super.onStart();
    if (Util.SDK_INT > 23) {
      initializePlayer();
      if (playerView != null) {
        playerView.onResume();
      }
    }
  }

  @Override
  public void onResume() {
    super.onResume();
    if (Util.SDK_INT <= 23 || player == null) {
      initializePlayer();
      if (playerView != null) {
        playerView.onResume();
      }
    }
  }

  @Override
  public void onPause() {
    super.onPause();
    if (Util.SDK_INT <= 23) {
      if (playerView != null) {
        playerView.onPause();
      }
      releasePlayer();
    }
  }

  @Override
  public void onStop() {
    super.onStop();
    if (Util.SDK_INT > 23) {
      if (playerView != null) {
        playerView.onPause();
      }
      releasePlayer();
    }
  }

  @Override
  public void onSaveInstanceState(Bundle outState) {
    // Attempts to save the AdsLoader state to handle app backgrounding.
    if (adsLoaderState != null) {
      outState.putBundle(KEY_ADS_LOADER_STATE, adsLoaderState.toBundle());
    }
  }

  ...

}

VOD ストリームの設定（省略可）

アプリで広告付きの VOD コンテンツを再生する必要がある場合は、以下を行う必要があります。

1. VOD テスト ストリームの CMS ID と Video ID を追加します。
2. ImaServerSideAdInsertionUriBuilder() を使用して SSAI VOD URI を作成します。
3. この新しい URI をプレーヤーのメディア アイテムとして使用します。

app/src/main/java/com/example/project name/MyActivity.java

public class MyActivity extends Activity {

  private static final String KEY_ADS_LOADER_STATE = "ads_loader_state";
  private static final String SAMPLE_ASSET_KEY = "c-rArva4ShKVIAkNfy6HUQ";
  private static final String SAMPLE_CMS_ID = "2548831";
  private static final String SAMPLE_VIDEO_ID = "tears-of-steel";

  ...

  private void initializePlayer() {

     ...

    Uri ssaiVodUri =
        new ImaServerSideAdInsertionUriBuilder()
            .setContentSourceId(SAMPLE_CMS_ID)
            .setVideoId(SAMPLE_VIDEO_ID)
            .setFormat(CONTENT_TYPE_HLS)
            .build();

    // Create the MediaItem to play, specifying the stream URI.
    MediaItem ssaiMediaItem = MediaItem.fromUri(ssaiVodUri);

    // Prepare the content and ad to be played with the ExoPlayer.
    player.setMediaItem(ssaiMediaItem);
    player.prepare();

    // Set PlayWhenReady. If true, content and ads will autoplay.
    player.setPlayWhenReady(false);
  }

これで、これで、ExoPlayer IMA 拡張機能を使用してメディア ストリームをリクエストし、再生できるようになりました。コード全体については、GitHub の Android DAI サンプルをご覧ください。