Ad Manager-Klasse erstellen

Definieren Sie in ads_manager.js eine Wrapper-Klasse für den IMA SDK StreamManager, mit der Streamanfragen gesendet, das Anzeigen-Pod-Manifest abgerufen, IMA-Streamereignisse abgehört und emsg-Ereignisse an das IMA SDK übergeben werden.

In ads_manager.js werden in der IMA HbbTV-Beispiel-App die folgenden Methoden eingerichtet:

  • requestStream()
  • onStreamEvent()
  • onEmsgEvent()
  • loadAdPodManifest()

Anzeigenmanager initialisieren

Initialisieren Sie die Ads Manager-Klasse und legen Sie Listener für die IMA-Streamereignisse fest. Legen Sie in diesem Aufruf den emsg-Event-Handler mit der Methode VideoPlayer.setEmsgEventHandler() fest.

/**
 * Wraps IMA SDK ad stream manager.
 * @param {!VideoPlayer} videoPlayer Reference an instance of the wrapper from
 * video_player.js.
 */
var AdManager = function(videoPlayer) {
  this.streamData = null;
  this.videoPlayer = videoPlayer;
  // Ad UI is not supported for HBBTV, so no 'adUiElement' is passed in the
  // StreamManager constructor.
  this.streamManager = new google.ima.dai.api.StreamManager(
      this.videoPlayer.videoElement);
  this.streamManager.addEventListener(
      [
        google.ima.dai.api.StreamEvent.Type.STREAM_INITIALIZED,
        google.ima.dai.api.StreamEvent.Type.ERROR,
        google.ima.dai.api.StreamEvent.Type.CLICK,
        google.ima.dai.api.StreamEvent.Type.STARTED,
        google.ima.dai.api.StreamEvent.Type.FIRST_QUARTILE,
        google.ima.dai.api.StreamEvent.Type.MIDPOINT,
        google.ima.dai.api.StreamEvent.Type.THIRD_QUARTILE,
        google.ima.dai.api.StreamEvent.Type.COMPLETE,
        google.ima.dai.api.StreamEvent.Type.AD_BREAK_STARTED,
        google.ima.dai.api.StreamEvent.Type.AD_BREAK_ENDED,
        google.ima.dai.api.StreamEvent.Type.AD_PROGRESS,
        google.ima.dai.api.StreamEvent.Type.PAUSED,
        google.ima.dai.api.StreamEvent.Type.RESUMED
      ],
      this.onStreamEvent.bind(this),
      false);

  this.videoPlayer.setEmsgEventHandler(this.onEmsgEvent, this);
};
ads_manager.js

Anfrage für einen Anzeigen-Pod-Stream stellen

Erstellen Sie die AdManager.requestStream()-Methode, um ein PodStreamRequest-Objekt mit Ihrem Google Ad Manager-Netzwerkcode und dem benutzerdefinierten Asset-Schlüssel des Streams zu erstellen. Testen Sie Ihre HbbTV-App mit dem IMA-Beispielstream für die Bereitstellung von DASH-Pods mit den folgenden Streamparametern:

  • Netzwerkcode: '21775744923'
  • Benutzerdefinierter Assetschlüssel: 'hbbtv-dash'
/**
 * Makes a pod stream request.
 * @param {string} networkCode The network code.
 * @param {string} customAssetKey The custom asset key.
 */
AdManager.prototype.requestStream = function (networkCode, customAssetKey) {
  var streamRequest = new google.ima.dai.api.PodStreamRequest();
  var secretKey = getStreamSecretKeys();

  streamRequest.networkCode = networkCode;
  streamRequest.customAssetKey = customAssetKey;
  streamRequest.format = 'dash';

  if (secretKey.STREAM_CREATE_SECRET) {
    var expirationTime = Math.trunc(new Date().getTime() / 1000) + 3600;
    var params = {
      custom_asset_key: customAssetKey,
      exp: expirationTime,
      network_code: networkCode
    };
    streamRequest.authToken =
        this.generateAuthToken(params, secretKey.STREAM_CREATE_SECRET);
    debugView.log('AdsManager: make Auth-PodStreamRequest');
  } else {
    debugView.log('AdsManager: make PodStreamRequest without auth');
  }

  this.streamManager.requestStream(streamRequest);
};
ads_manager.js

Auf Ereignisse im Anzeigenstream warten

Erstellen Sie die Methode AdManager.onStreamEvent(), um die Reaktion Ihrer App auf die IMA-Streamereignisse STREAM_INITIALIZED, AD_BREAK_STARTED und AD_BREAK_ENDED zu verarbeiten.

/**
 * Handles IMA playback events.
 * @param {!Event} event The event object.
 */
AdManager.prototype.onStreamEvent = function(event) {
  switch (event.type) {
    // Once the stream response data is received, generate pod manifest url
    // for the video stream.
    case google.ima.dai.api.StreamEvent.Type.STREAM_INITIALIZED:
      debugView.log('IMA SDK: stream initialized');
      this.streamData = event.getStreamData();
      break;
    case google.ima.dai.api.StreamEvent.Type.ERROR:
      break;
    // Hide video controls while ad is playing.
    case google.ima.dai.api.StreamEvent.Type.AD_BREAK_STARTED:
      debugView.log('IMA SDK: ad break started');
      this.adPlaying = true;
      this.adBreakStarted = true;
      break;
    // Show video controls when ad ends.
    case google.ima.dai.api.StreamEvent.Type.AD_BREAK_ENDED:
      debugView.log('IMA SDK: ad break ended');
      this.adPlaying = false;
      this.adBreakStarted = false;
      break;
    // Update ad countdown timers.
    case google.ima.dai.api.StreamEvent.Type.AD_PROGRESS:
      break;
    default:
      debugView.log('IMA SDK: ' + event.type);
      break;
  }
};
ads_manager.js

Metadaten des Anzeigenstreams verarbeiten

Wenn Sie die emsg-Ereignisinformationen an IMA übergeben möchten, erstellen Sie die AdManager.onEmsgEvent()-Methode mit der StreamManager.processMetadata()-Methode. Die Videoplayer-Klasse ruft diese Methode mit der Methode VideoPlayer.setEmsgEventHandler() auf.

/**
 * Callback on Emsg event.
 * Instructs IMA SDK to fire back VAST events accordingly.
 * @param {!Event} event The event object.
 */
AdManager.prototype.onEmsgEvent = function(event) {
  var data = event.event.messageData;
  var pts = event.event.calculatedPresentationTime;
  if ((data instanceof Uint8Array) && data.byteLength > 0) {
    this.streamManager.processMetadata('ID3', data, pts);
  }
};
ads_manager.js

Manifest für Anzeigen-Pod laden

Erstellen Sie die AdManager.loadAdPodManifest()-Methode, um das Anzeigen-Pod-Manifest mit dem Videoplayer vorab zu laden. Erstellen Sie eine authentifizierte Manifest-URL anhand der Struktur in Methode: DASH-Pod-Manifest.

/**
 * Creates DAI pod url and instructs video player to load manifest.
 * @param {string} networkCode The network code.
 * @param {string} customAssetKey The custom asset key.
 * @param {number} podDuration The duration of the ad pod.
 */
AdManager.prototype.loadAdPodManifest = function (networkCode, customAssetKey, podDuration) {
  if (!this.streamData) {
    debugView.log('AdsManager: No stream data available.');
    return;
  }

  var adBreakId = this.getAdBreakId();
  var expirationTime = Math.trunc(new Date().getTime() / 1000) + 3600;

  var params = {
    ad_break_id: adBreakId,
    custom_asset_key: customAssetKey,
    exp: expirationTime,
    network_code: networkCode,
    pd: podDuration
  };

  var secretKey = getStreamSecretKeys();
  var token = this.generateAuthToken(params, secretKey.MANIFEST_SECRET);
  var encodedToken = encodeURIComponent(token);

  var manifestUrl = 'https://dai.google.com/linear/pods/v1/dash/network/' +
    networkCode + '/custom_asset/' + customAssetKey + '/stream/' +
    this.streamData.streamId + '/ad_break_id/' + adBreakId +
    '/manifest.mpd?pd=' + podDuration + '&auth-token=' + encodedToken;

  this.videoPlayer.preload(manifestUrl);
};
ads_manager.js

In der HbbTV-Beispiel-App wird ein zufällig generierter eindeutiger adBreakId-Wert verwendet. In Produktions-Apps ist der adBreakId-Wert ein alphanumerischer String, z. B. ab-001, der für jede Werbeunterbrechung um eins erhöht wird. Prüfen Sie, ob der Wert für adBreakId für alle Zuschauer der Werbeunterbrechung derselbe ist. Wir empfehlen, den adBreakId-Wert mit der DAI Ad Break API abzurufen. Geben Sie in einer Produktionsumgebung den adBreakId-Wert und den podDuration-Wert im HbbTV-Stream-Ereignis AD_BREAK_ANNOUNCE an.

Erstellen Sie als Nächstes die Hauptanwendungsklasse für Ihre HbbTV-App, die mit der HbbTV-Übertragung interagiert.

Zurück
Player-Klasse einrichten
Weiter
Anwendungsklasse erstellen