IMA DAI SDK スタートガイド

IMA SDK を使用すると、マルチメディア広告をウェブサイトやアプリに簡単に統合できます。IMA SDK は、 VAST 準拠の任意の広告サーバーから広告をリクエストし、アプリ内の広告再生を管理できます。IMA DAI SDK を使用すると、アプリは広告とコンテンツ動画（VOD またはライブ コンテンツ）のストリーム リクエストを行います。SDK は統合された動画ストリームを返すため、アプリ内で広告動画とコンテンツ動画を切り替える必要はありません。

関心のある DAI ソリューションを選択する

Pod Serving DAI

このガイドでは、動画プレーヤーで IMA DAI SDK for iOS を使用して、DAI Pod Serving のライブ ストリームまたは VOD ストリームを再生する方法について説明します。完了したサンプルの統合を確認または追跡するには、Objective-C または Swift の Pod Serving サンプルをダウンロードします。

IMA DAI Pod Serving の概要

iOS 向け IMA DAI SDK を使用して Pod Serving を実装するには、次の 2 つの主要コンポーネントが必要です。

  • StreamRequest: Google の広告サーバーのストリーム リクエストを定義するオブジェクト。Pod サービングを有効にするには、IMAPodStreamRequest または IMAPodVODStreamRequest を使用して作成する必要があります。どちらの方法でもネットワーク コードが必要です。IMAPodStreamRequest の場合はカスタム アセットキーも必要です。API キーは省略可能です。

  • IMAStreamManager: 動画ストリームと IMA DAI SDK 間の通信を処理するオブジェクト（トラッキング ピングの発行、ストリーム イベントのパブリッシャーへの転送など）。

前提条件

始める前に、次のものが必要になります。

  • Xcode 13 以降。
  • CocoaPods（推奨）、Swift Package Manager、または IMA DAI SDK for iOS のダウンロード コピー。
  • DAI 広告付きの動画ストリームを再生するように IMA DAI SDK ですでに設定されている iOS アプリ。このようなアプリをまだお持ちでない場合は、iOS DAI BasicExample を参考にすることをおすすめします。BasicExample には、このガイドで参照されているコードベースがあります。IMA DAI SDK の実装方法について詳しくは、クイック スタート ガイドをご覧ください。

Pod Serving 変数を設定する

Pod サービングに必要なすべての変更は、Swift の ViewController.swift または Objective-C の ViewController.m で行います。このガイドのスニペットは、デフォルトで Swift 言語を使用します。最初のステップは、定数変数を更新することです。

追加する広告連続配信ストリーム リクエスト定数は次のとおりです。

  • STREAM_URL（ライブ配信にのみ使用）: Pod Serving を使用するマニフェスト マニピュレーターまたはサードパーティ パートナーが提供する動画ストリーミング URL。リクエストを行う前に、IMA DAI SDK から提供されたストリーム ID を挿入する必要があります。この場合、ストリーム URL にはプレースホルダ "[[STREAMID]]" が含まれており、リクエストの送信前にストリーム ID に置き換えられます。
  • NETWORK_CODE: アド マネージャー 360 アカウントのネットワーク コード。
  • CUSTOM_ASSET_KEY（ライブ配信にのみ使用）: アド マネージャー 360 で Pod 配信イベントを識別するカスタム アセットキー。これは、マニフェスト マニピュレータまたはサードパーティの Pod Serving パートナーによって作成できます。
  • API_KEY（ライブ配信にのみ使用）: IMA DAI SDK からストリーム ID を取得するために必要なオプションの API キー。

サンプルの変数セクションを次のように変更します。

...
class ViewController:
  UIViewController,
  IMAAdsLoaderDelegate,
  IMAStreamManagerDelegate,
  AVPlayerViewControllerDelegate
{
  static let streamUrl =
    "https://encodersim.sandbox.google.com/masterPlaylist/9c654d63-5373-4673-8c8d-6d92b66b9d46/master.m3u8?gen-seg-redirect=true&network=51636543&event=google-sample&pids=devrel4628000,devrel896000,devrel3528000,devrel1428000,devrel2628000,devrel1928000&seg-host=dai.google.com&stream_id=[[STREAMID]]"
  static let networkCode = "51636543"
  static let customAssetKey = "google-sample"
  static let APIKey = ""
  static let backupStreamURLString =
    "http://googleimadev-vh.akamaihd.net/i/big_buck_bunny/bbb-,480p,720p,1080p,.mov.csmil/master.m3u8"

  var adsLoader: IMAAdsLoader?
  ...

ライブまたは VOD の連続配信広告ストリーム リクエストを作成する

ライブ配信 Pod サービング

requestStream メソッドを変更して、IMAPodStreamRequest をインスタンス化してライブ Pod ストリーム リクエストを作成します。

  ...

  func requestStream() {
    guard let playerViewController = self.playerViewController else return
    guard let adContainerView = self.adContainerView else return
    guard let adsLoader = self.adsLoader else return

    self.videoDisplay = IMAAVPlayerVideoDisplay(avPlayer: playerViewController.player)
    adDisplayContainer = IMAAdDisplayContainer(
      adContainer: adContainerView, viewController: self)

    // Create a podserving stream request.
    request = IMAPodStreamRequest(
      networkCode: self.networkCode,
      customAssetKey: self.customAssetKey,
      adDisplayContainer: adDisplayContainer,
      videoDisplay: self.videoDisplay,
      userContext: nil)

    adsLoader.requestStream(with: request)
  }

  ...

VOD ストリームの Pod Serving

requestStream メソッドを変更して、IMAPodVODStreamRequest をインスタンス化して VOD Pod ストリーム リクエストを作成します。

  ...

  func requestStream() {
    guard let playerViewController = self.playerViewController else return
    guard let adContainerView = self.adContainerView else return
    guard let adsLoader = self.adsLoader else return

    self.videoDisplay = IMAAVPlayerVideoDisplay(avPlayer: playerViewController.player)
    adDisplayContainer = IMAAdDisplayContainer(
      adContainer: adContainerView, viewController: self)

    // Create a podserving stream request.
    request = IMAPodVODStreamRequest(
      networkCode: self.networkCode,
      adDisplayContainer: adDisplayContainer,
      videoDisplay: self.videoDisplay,
      userContext: nil)

    adsLoader.requestStream(with: request)
  }

  ...

ストリーム URL を編集して設定する

ライブ配信 Pod サービング

IMAAdsLoaderDelegate メソッドを変更し、streamManager.streamId を使用してストリーム ID を取得します。次に、"[[STREAMID]]" に代わるストリーム ID を STREAM_URL に挿入します。この変更を加えると、videoDisplay.loadStream() を使用して新しいストリーム URL を設定できます。

  ...

  // MARK: - IMAAdsLoaderDelegate

  func adsLoader(_ loader: IMAAdsLoader!, adsLoadedWith adsLoadedData: IMAAdsLoadedData!) {
    let streamManager = adsLoadedData.streamManager
    let streamId = streamManager.streamId
    let urlString = streamUrl.replacingOccurrences(of: "[[STREAMID]]", with: streamId)
    let loadedStreamUrl = URL(string:urlString)
    self.videoDisplay.loadStream(loadedStreamUrl, subtitles:@[])
    self.videoDisplay.play()
    streamManager.delegate = self
    streamManager.initialize(with: nil)
    self.streamManager = streamManager
  }

  ...

VOD ストリームの Pod Serving

IMAAdsLoaderDelegate メソッドを変更し、streamManager.streamId を使用してストリーム ID を取得します。次に、動画技術パートナー（VTP）からストリーミング URL をリクエストします。次に、IMAStreamManager.loadThirdPartyStream() を呼び出して、IMA が TVP から返されたストリーム URL と字幕を読み込むようにします。

  ...

  // MARK: - IMAAdsLoaderDelegate

  func adsLoader(_ loader: IMAAdsLoader!, adsLoadedWith adsLoadedData: IMAAdsLoadedData!) {
    let streamManager = adsLoadedData.streamManager
    let streamId = streamManager.streamId
    // 'vtpInterface' is a place holder for your own video technology partner
    // (VTP) API calls.
    let streamUrl = vtpInterface.requestStreamURL(streamID)
    self.streamManager.loadThirdPartyStream(streamUrl, streamSubtitles:@[])
    streamManager.delegate = self
    streamManager.initialize(with: nil)
    self.streamManager = streamManager
  }

これで、これで、iOS 向け IMA DAI SDK を使用して、Pod Serving ストリームで広告をリクエストして表示できるようになりました。IMA DAI SDK の使用例については、GitHub のサンプルをご覧ください。