Premiers pas avec le SDK IMA DAI

Les SDK IMA facilitent l'intégration d'annonces multimédias dans vos sites Web et applications. Les SDK IMA peuvent demander des annonces à partir de n'importe quel ad server compatible avec la norme VAST et gérer la lecture des annonces dans vos applications. Avec les SDK IMA DAI, les applications envoient une demande de flux pour des annonces et des contenus vidéo (VOD ou en direct). Le SDK renvoie ensuite un flux vidéo combiné pour vous éviter d'avoir à gérer le basculement entre l'annonce et la vidéo de contenu dans votre application.

Sélectionnez la solution d'insertion dynamique d'annonce qui vous intéresse

Insertion dynamique de séries d'annonces

Ce guide explique comment lire un flux en direct ou de vidéo à la demande avec diffusion de séries d'annonces pour l'insertion dynamique d'annonces à l'aide du SDK IMA DAI pour iOS avec un simple lecteur vidéo. Si vous souhaitez suivre un exemple terminé, téléchargez l'exemple de diffusion de pods.

Présentation de l'insertion dynamique de séries d'annonces d'IMA

L'implémentation de la diffusion de séries d'annonces à l'aide du SDK IMA DAI pour iOS implique deux composants principaux:

  • StreamRequest: objet qui définit une requête de flux adressée aux serveurs publicitaires de Google. Doit être créé à l'aide de IMAPodStreamRequest ou de IMAPodVODStreamRequest pour activer la diffusion de pods. Les deux méthodes nécessitent un code de réseau et IMAPodStreamRequest nécessite également une clé d'élément personnalisée. Une clé API est facultative.

  • IMAStreamManager: objet qui gère la communication entre le flux vidéo et le SDK IMA pour l'insertion dynamique d'annonces, par exemple le déclenchement de pings de suivi et le transfert d'événements de flux à l'éditeur.

Conditions préalables

Avant de commencer, vous avez besoin des éléments suivants :

  • Xcode 13 ou version ultérieure.
  • CocoaPods (recommandé), Swift Package Manager ou une copie téléchargée du SDK IMA DAI pour iOS.
  • Une application iOS déjà configurée avec le SDK IMA DAI pour lire des flux vidéo avec des annonces pour l'insertion dynamique d'annonce Si vous ne disposez pas encore d'une application de ce type, nous vous recommandons d'utiliser BasicExample pour l'insertion dynamique d'annonce iOS comme point de départ. L'exemple de base utilise le codebase référencé dans ce guide. Pour en savoir plus sur la mise en œuvre du SDK IMA DAI, consultez le guide de démarrage rapide.

Configurer les variables de diffusion de pods

Toutes les modifications nécessaires à la diffusion des pods sont effectuées dans ViewController.swift dans swift ou dans ViewController.m dans Objective-C. Par défaut, les extraits de ce guide utilisent le Swift. La première étape consiste à mettre à jour les variables constantes.

Voici les constantes des demandes de flux de séries d'annonces à ajouter:

  • STREAM_URL (uniquement utilisé pour les diffusions en direct): URL de flux vidéo fournie par votre outil de manipulation du fichier manifeste ou par un partenaire tiers utilisant la diffusion de séries d'annonces. Vous devez insérer l'ID de flux fourni par le SDK IMA DAI avant d'envoyer une demande. Dans ce cas, l'URL de flux inclut un espace réservé, "[[STREAMID]]", qui est remplacé par l'ID de flux, avant l'envoi d'une requête.
  • NETWORK_CODE: code de réseau de votre compte Ad Manager 360.
  • CUSTOM_ASSET_KEY (Utilisé uniquement pour les diffusions en direct): clé d'élément personnalisée qui identifie l'événement de diffusion de séries d'annonces dans Ad Manager 360. Elle peut être créée par votre outil de manipulation du fichier manifeste ou par un partenaire tiers de diffusion de pods.
  • API_KEY (utilisée uniquement pour les diffusions en direct): clé API facultative qui peut être requise pour récupérer un ID de flux à partir du SDK IMA DAI.

Modifiez la section des variables de l'exemple pour qu'elle corresponde à ce qui suit:

...
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?
  ...

Créez une demande de flux de séries d'annonces en direct ou à la demande.

Diffusion de séries d'annonces en direct

Modifiez la méthode requestStream pour créer une requête de flux de pods en direct en instanciant IMAPodStreamRequest.

  ...

  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)
  }

  ...

Diffusion de séries d'annonces de flux de vidéo à la demande

Modifiez la méthode requestStream pour créer une requête de flux de pods VOD en instanciant IMAPodVODStreamRequest.

  ...

  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)
  }

  ...

Modifier et définir l'URL du flux

Diffusion de séries d'annonces en direct

Modifiez les méthodes IMAAdsLoaderDelegate à l'aide de streamManager.streamId pour obtenir l'ID de flux. Insérez ensuite l'ID de flux dans STREAM_URL, en remplaçant "[[STREAMID]]". Une fois cette modification effectuée, la nouvelle URL de flux peut être définie à l'aide de videoDisplay.loadStream().

  ...

  // 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
  }

  ...

Diffusion de séries d'annonces de flux de vidéo à la demande

Modifiez les méthodes IMAAdsLoaderDelegate à l'aide de streamManager.streamId pour obtenir l'ID de flux. Demandez ensuite une URL de flux à votre partenaire technologique vidéo (VTP). Appelez ensuite IMAStreamManager.loadThirdPartyStream() pour que IMA charge l'URL du flux et tous les sous-titres renvoyés par votre téléviseur.

  ...

  // 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
  }

Et voilà ! Vous demandez et affichez désormais des annonces dans un flux de diffusion de séries d'annonces avec le SDK IMA DAI pour iOS. Pour voir d'autres exemples du SDK IMA DAI en cours d'utilisation, consultez les exemples sur GitHub.