Premiers pas avec le SDK IMA DAI

Les SDK IMA permettent d'intégrer facilement des annonces multimédias à vos sites Web et applications. Les SDK IMA peuvent demander des annonces à n'importe quel ad server conforme à 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 les annonces et les vidéos de contenu (VOD ou contenu en direct). Le SDK renvoie ensuite un flux vidéo combiné afin que vous n'ayez pas à gérer le basculement entre l'annonce et le contenu vidéo dans votre application.

Sélectionnez la solution de publicité display in-app qui vous intéresse.

Service complet Diffusion de séries API Cloud stitching en direct API Cloud stitching en VOD

Lire des flux VOD enregistrés avec l'API Google Cloud Video Stitcher

Ce guide explique comment utiliser le SDK IMA DAI pour HTML5 pour demander et lire une session de streaming VOD Google Cloud.

Ce guide développe l'exemple de base du guide de démarrage pour la DAI IMA.

Pour en savoir plus sur l'intégration à d'autres plates-formes ou sur l'utilisation des SDK côté client IMA, consultez la page SDK Interactive Media Ads.

Pour afficher ou suivre un exemple d'intégration terminée, téléchargez l'exemple de l'outil de montage vidéo Cloud pour HLS ou DASH.

Remarque:Le SDK IMA DAI pour HTML5 est compatible avec les flux HLS et DASH, mais la lecture de chacun d'eux nécessite un lecteur multimédia ou une extension différente, comme HLS.js ou DASH.js, avec des implémentations différentes.

Ce guide explique comment configurer HLS.js et le SDK IMA DAI pour lire un flux HLS, avec des remarques importantes sur les différences d'implémentation pour DASH.

Consultez l'exemple d'application IMA DASH.js pour commencer à implémenter des flux DAI DASH avec IMA.

Configurer un projet Google Cloud

Configurez un projet Google Cloud et des comptes de service pour y accéder.

Saisissez les variables suivantes à utiliser dans le SDK IMA:

Lieu

Région Google Cloud dans laquelle votre configuration VOD a été créée : LOCATION

Numéro du projet

Numéro du projet Google Cloud utilisant l'API Video Stitcher : PROJECT_NUMBER

Jeton OAuth

Le jeton OAuth de courte durée d'un compte de service avec le rôle utilisateur Video Stitcher :

OAUTH_TOKEN

Découvrez comment créer des jetons OAuth éphémères. Le jeton OAuth peut être réutilisé pour plusieurs requêtes tant qu'il n'a pas expiré.

Code de réseau

Code de réseau Ad Manager pour demander des annonces : NETWORK_CODE

ID de configuration de la vidéo à la demande

ID de configuration VOD du flux VOD : VOD_CONFIG_ID

Pour en savoir plus sur la création de l'ID de configuration VOD, consultez le guide de création d'un ID de configuration VOD pour le collage dans le cloud.

Configurer un environnement de développement

Important :La classe VideoStitcherVodStreamRequest de l'insertion dynamique d'annonces IMA est compatible à la fois avec les flux HLS et les flux DASH multipériodes. Les coupures publicitaires ne sont insérées que entre les périodes DASH.

Les exemples d'applications IMA ne présentent que des requêtes de flux HLS. Vous pouvez toujours utiliser des flux DASH lors de la création de la classe VideoStitcherVodStreamRequest. Lorsque vous configurez votre lecteur compatible avec DASH, vous devez configurer un écouteur pour les événements de progression de votre lecteur vidéo, qui peut fournir les métadonnées de la vidéo à StreamManager.processMetadata(). Cette fonction prend en compte trois paramètres:

1. type: chaîne qui doit être définie sur 'ID3' pour les flux HLS et sur 'urn:google:dai:2018' pour les flux DASH.

2. data: pour les messages d'événement DASH, il s'agit de la chaîne de données du message.

3. timestamp: nombre correspondant à l'heure de début du message d'événement pour les flux DASH.

Envoyez les métadonnées dès que possible et aussi souvent que possible, en fonction des événements de vos joueurs. Si les métadonnées sont manquantes ou incorrectes, le SDK IMA DAI peut ne pas déclencher d'événements d'annonces, ce qui entraîne des événements d'annonces mal signalés.

Téléchargez les exemples d'annonces display interactives IMA pour HTML5 et extrayez le fichier ZIP d'exemple hls_js/simple dans un nouveau dossier. Cet exemple est une application Web que vous pouvez héberger en local à des fins de test.

Pour héberger l'exemple localement, accédez au nouveau dossier et exécutez la commande Python suivante pour démarrer un serveur Web:

python3 -m http.server 8000

http.server n'est disponible que dans Python 3.x. Vous pouvez utiliser n'importe quel autre serveur Web, tel que le serveur HTTP Apache ou Node JS.

Ouvrez un navigateur Web et accédez à localhost:8000 pour afficher un lecteur vidéo. Votre navigateur doit être compatible avec la bibliothèque HLS.js.

Si tout fonctionne correctement, le court-métrage "Tears of Steel" commence à être diffusé en cliquant sur le bouton Play (Lecture) du lecteur vidéo, avec des coupures publicitaires toutes les 30 secondes.

Demander un flux de vidéo à la demande

Pour remplacer le flux d'échantillon par votre flux VOD tronqué par des annonces, utilisez la classe VideoStitcherVodStreamRequest pour créer automatiquement une session d'annonces avec Google Ad Manager. Vous pouvez utiliser l'interface utilisateur de Google Ad Manager pour localiser les sessions DAI générées à des fins de surveillance et de débogage.

Dans l'exemple existant, il existe des fonctions permettant de demander un flux VOD ou un flux en direct. Pour qu'il fonctionne avec l'API Google Cloud Video Stitcher, vous devez ajouter une fonction pour renvoyer un objet VideoStitcherVodStreamRequest.

Exemple :

// StreamManager which will be used to request DAI streams.
let streamManager;
...

function initPlayer() {
  videoElement = document.getElementById('video');
  adUiElement = document.getElementById('adUi');
  streamManager = new google.ima.dai.api.StreamManager(
    videoElement,
    adUiElement
  );
  streamManager.addEventListener(
    [
      google.ima.dai.api.StreamEvent.Type.LOADED,
      google.ima.dai.api.StreamEvent.Type.ERROR,
      google.ima.dai.api.StreamEvent.Type.AD_BREAK_STARTED,
      google.ima.dai.api.StreamEvent.Type.AD_BREAK_ENDED
    ],
    onStreamEvent, false);

  hls.on(Hls.Events.FRAG_PARSING_METADATA, function(event, data) {
    if (streamManager && data) {
      // For each ID3 tag in our metadata, we pass in the type - ID3, the
      // tag data (a byte array), and the presentation timestamp (PTS).
      data.samples.forEach(function(sample) {
        streamManager.processMetadata('ID3', sample.data, sample.pts);
      });
    }
  });

  videoElement.addEventListener('pause', () => {
    playButton.style.display = "block";
  });

  playButton.addEventListener('click', initiatePlayback);
}

function initiatePlayback() {
  requestVodVideoStitcherStream();

  playButton.style.display = "none";
  playButton.removeEventListener('click', initiatePlayback);
  playButton.addEventListener('click', resumePlayback);
}
...
function requestVodVideoStitcherStream() {
  const streamRequest = new google.ima.dai.api.VideoStitcherVodStreamRequest();
  streamRequest.vodConfigId = 'VOD_CONFIG_ID';
  streamRequest.region = 'LOCATION';
  streamRequest.projectNumber = 'PROJECT_NUMBER';
  streamRequest.oAuthToken = 'OAUTH_TOKEN';
  streamRequest.networkCode = 'NETWORK_CODE';

  streamManager.requestStream(streamRequest);
}

Actualisez la page. Vous pouvez ensuite demander et lire le flux VOD personnalisé.

(Facultatif) Ajouter des options de session de streaming

Personnalisez votre requête de flux en ajoutant des options de session pour remplacer la configuration par défaut de l'API Cloud Video Stitcher à l'aide de VideoStitcherVodStreamRequest.videoStitcherSessionOptions. Si vous fournissez une option non reconnue, l'API Cloud Video Stitcher répondra par une erreur HTTP 400. Pour obtenir de l'aide, consultez le guide de dépannage.

Par exemple, vous pouvez remplacer les options de fichier manifeste avec l'extrait de code suivant, qui demande deux fichiers manifestes de flux avec des rendus triés du débit le plus bas au plus élevé.

...

// The following session options are examples. Use session options
// that are compatible with your video stream.
streamRequest.videoStitcherSessionOptions = {
  "manifestOptions": {
    "includeRenditions": [
      {"bitrateBps": 3000, "codecs": "hvc1.1.4.L126.B0, mp4a.40.2"},
      {"bitrateBps": 2000, "codecs": "avc1.64001f, mp4a.40.2"},
    ],
    "bitrateOrder": "ascending"
  }
};

streamManager.requestStream(streamRequest);

Effectuer un nettoyage

Maintenant que vous avez hébergé un flux VOD à l'aide de l'API Google Cloud Video Stitcher et que vous l'avez demandé à l'aide du SDK IMA DAI pour HTML5, il est important de nettoyer toutes les ressources de diffusion.

Suivez le guide de nettoyage des contenus VOD pour supprimer toutes les ressources et composants inutiles.

Enfin, dans la fenêtre de terminal où vous avez démarré le serveur Web Python 3, utilisez la commande ctrl+C pour arrêter le serveur local.