Configura con DAI de servicio completo

Selecciona la plataforma: HTML5 Android iOS tvOS Cast Roku

En esta guía, se muestra cómo reproducir una transmisión de DAI con el SDK de DAI para CAF de IMA. Si deseas ver o seguir una integración de muestra completa, descarga el ejemplo.

Antes de usar esta guía, asegúrate de familiarizarte con el protocolo del receptor web de Chromecast Application Framework. En esta guía, se supone que tienes un nivel básico de familiaridad con los conceptos del receptor de CAF, como los interceptores de mensajes y los objetos mediaInformation, así como con el uso de la herramienta de comando y control de Cast para emular un remitente de CAF.

Para usar IMA para DAI, debes tener una cuenta de Ad Manager 360. Si tienes una cuenta de Ad Manager, comunícate con tu administrador de cuentas para obtener más detalles. Para obtener información sobre cómo registrarte en Ad Manager, visita el Centro de ayuda de Ad Manager.

Para obtener información sobre la integración con otras plataformas o el uso de los SDKs del cliente de IMA, consulta los SDKs de anuncios multimedia interactivos.

Descripción general de la DAI de CAF

La implementación de la DAI con el SDK de DAI de CAF de IMA implica dos componentes principales, como se muestra en esta guía:

  • StreamRequest: Es un objeto que define una solicitud de transmisión a los servidores de publicidad de Google. Las solicitudes de transmisión se dividen en dos variedades principales:

    • LiveStreamRequest: Especifica una clave de recurso, así como otros parámetros opcionales.
    • VODStreamRequest: Especifica un ID de fuente de contenido, un ID de video y otros parámetros opcionales.
    • Ambos tipos de solicitud pueden incluir, de manera opcional, una clave de API necesaria para acceder a los flujos especificados y un código de red de Google Ad Manager para que el SDK de IMA controle los identificadores de anuncios según se especifica en la configuración de Google Ad Manager.

  • StreamManager: Es un objeto que controla la comunicación entre la transmisión de video y el SDK de IMA para DAI, como activar pings de seguimiento y reenviar eventos de transmisión al publicador.

Requisitos previos

Configura los objetos MediaInfo del remitente

Primero, configura el objeto MediaInfo de tu app emisora para que incluya los siguientes campos:

contentId Es un identificador único para este elemento multimedia.
contentUrl Es la URL de transmisión de resguardo que se cargará si la solicitud StreamRequest de DAI falla por algún motivo.
streamType En el caso de las transmisiones en vivo, este valor se debe establecer en "LIVE". En el caso de las transmisiones de VOD, este valor se debe establecer en "BUFFERED".
customData assetKey Solo transmisiones en vivo Identifica la transmisión en vivo que se cargará.
contentSourceId Solo transmisiones de VOD. Identifica el feed de contenido multimedia que incluye la transmisión solicitada.
videoId Solo transmisiones de VOD. Identifica la transmisión solicitada dentro del feed de contenido multimedia especificado.
networkCode Es tu código de red de Google Ad Manager (opcional).
ApiKey Es una clave de API opcional que se puede requerir para recuperar la URL de transmisión del SDK de IMA para DAI.
senderCanSkip Es un valor booleano que permite que el receptor sepa si el dispositivo de envío tiene la capacidad de mostrar un botón para omitir, lo que habilita la compatibilidad con anuncios que se pueden omitir.

Para configurar estos valores en la herramienta de comando y control de Cast, haz clic en la pestaña Load Media y establece el tipo de solicitud de carga personalizada en LOAD. Luego, reemplaza los datos JSON en el área de texto por uno de los siguientes objetos JSON:

EN VIVO

{
  "media": {
    "contentId": "bbb",
    "contentUrl": "https://storage.googleapis.com/interactive-media-ads/media/bbb.m3u8",
    "streamType": "LIVE",
    "customData": {
      "assetKey": "c-rArva4ShKVIAkNfy6HUQ",
      "networkCode": "21775744923",
      "ApiKey": "",
      "senderCanSkip": true
    }
  },
  "credentials": "testCredentials"
}

VOD

{
  "media": {
    "contentId": "tos",
    "contentUrl": "https://storage.googleapis.com/interactive-media-ads/media/tos.m3u8",
    "streamType": "BUFFERED",
    "customData": {
      "contentSourceId": "2548831",
      "videoId": "tears-of-steel",
      "networkCode": "21775744923",
      "ApiKey": "",
      "senderCanSkip": true
    }
  },
  "credentials": "testCredentials"
}

Este objeto de solicitud de carga personalizado se puede enviar al receptor para probar los siguientes pasos.

Crea un receptor de CAF básico

Sigue la guía del receptor básico del SDK de CAF para crear un receptor web básico.

El código del receptor debería verse de la siguiente manera:

<html>
<head>
  <script type="text/javascript"
      src="//www.gstatic.com/cast/sdk/libs/caf_receiver/v3/cast_receiver_framework.js">
  </script>
</head>
<body>
  <cast-media-player></cast-media-player>
  <script>
    cast.framework.CastReceiverContext.getInstance().start();
  </script>
</body>
</html>

Importa el SDK de IMA para DAI y obtén el administrador del reproductor

Agrega una etiqueta de secuencia de comandos para importar el SDK de IMA para DAI para CAF a tu receptor web, justo después de la secuencia de comandos que carga CAF. El SDK de DAI para CAF es de actualización continua, por lo que no es necesario establecer una versión específica. Luego, en la etiqueta de secuencia de comandos que sigue, almacena el contexto del receptor y el administrador de reproductores como constantes antes de iniciar el receptor.

<html>
<head>
  <script type="text/javascript"
      src="//www.gstatic.com/cast/sdk/libs/caf_receiver/v3/cast_receiver_framework.js"></script>
  <script src="//imasdk.googleapis.com/js/sdkloader/cast_dai.js"></script>
</head>
<body>
  <cast-media-player></cast-media-player>
  <script>
    const castContext = cast.framework.CastReceiverContext.getInstance();
    const playerManager = castContext.getPlayerManager();

    castContext.start();
  </script>
</body>
</html>

Inicializa el administrador de transmisiones de IMA

Inicializa el administrador de transmisiones del SDK de DAI de CAF.

<html>
<head>
  <script type="text/javascript"
      src="//www.gstatic.com/cast/sdk/libs/caf_receiver/v3/cast_receiver_framework.js"></script>
  <script src="//imasdk.googleapis.com/js/sdkloader/cast_dai.js"></script>
</head>
<body>
  <cast-media-player></cast-media-player>
  <script>
    const castContext = cast.framework.CastReceiverContext.getInstance();
    const playerManager = castContext.getPlayerManager();
    const streamManager = new google.ima.cast.dai.api.StreamManager();

    castContext.start();
  </script>
</body>
</html>

Crea el interceptor de mensajes de carga

El SDK de DAI para CAF usa el interceptor de mensajes de carga de CAF para realizar solicitudes de transmisión y reemplazar la URL de contenido por la transmisión de DAI final. El interceptor de mensajes llama a streamManager.requestStream(), que controla la configuración de las pausas publicitarias, solicita la transmisión y reemplaza el contentURL existente.

Solo puede haber un interceptor de mensajes de carga, por lo que, si tu app requiere el uso del interceptor, debes incorporar cualquier función personalizada en la misma devolución de llamada.

<html>
<head>
  <script type="text/javascript"
      src="//www.gstatic.com/cast/sdk/libs/caf_receiver/v3/cast_receiver_framework.js"></script>
  <script src="//imasdk.googleapis.com/js/sdkloader/cast_dai.js"></script>
</head>
<body>
  <cast-media-player></cast-media-player>
  <script>
    const castContext = cast.framework.CastReceiverContext.getInstance();
    const playerManager = castContext.getPlayerManager();
    const streamManager = new google.ima.cast.dai.api.StreamManager();

    const getStreamRequest = (request) => null;

    playerManager.setMessageInterceptor(
        cast.framework.messages.MessageType.LOAD, (request) => {
          return streamManager.requestStream(request, getStreamRequest(request))
              .then((request) => {
                this.broadcast('Stream request successful.');
                return Promise.resolve(request);
              })
              .catch((error) => {
                this.broadcast('Stream request failed.');
                return Promise.resolve(request);
              });
        });

    castContext.start();
  </script>
</body>
</html>

Crea la solicitud de transmisión

Para completar la integración de DAI de CAF, debes compilar tu solicitud de transmisión con los datos que se incluyeron en el objeto mediaInfo del remitente.

<html>
<head>
  <script type="text/javascript"
      src="//www.gstatic.com/cast/sdk/libs/caf_receiver/v3/cast_receiver_framework.js"></script>
  <script src="//imasdk.googleapis.com/js/sdkloader/cast_dai.js"></script>
</head>
<body>
  <cast-media-player></cast-media-player>
  <script>
    const castContext = cast.framework.CastReceiverContext.getInstance();
    const playerManager = castContext.getPlayerManager();
    const streamManager = new google.ima.cast.dai.api.StreamManager();

    const getStreamRequest = (request) => {
      const imaRequestData = request.media.customData;
      let streamRequest = null;
      if (imaRequestData.assetKey) {
        // Live stream
        streamRequest = new google.ima.cast.dai.api.LiveStreamRequest();
        streamRequest.assetKey = imaRequestData.assetKey;
      } else if (imaRequestData.contentSourceId) {
        // VOD stream
        streamRequest = new google.ima.cast.dai.api.VODStreamRequest();
        streamRequest.contentSourceId = imaRequestData.contentSourceId;
        streamRequest.videoId = imaRequestData.videoId;
      }
      if (streamRequest && imaRequestData.networkCode) {
        streamRequest.networkCode = imaRequestData.networkCode;
      }
      if (streamRequest && imaRequestData.ApiKey) {
        streamRequest.ApiKey = imaRequestData.ApiKey;
      }
      if (streamRequest && imaRequestData.senderCanSkip) {
        streamRequest.senderCanSkip = imaRequestData.senderCanSkip;
      }
      return streamRequest;
    };

    playerManager.setMessageInterceptor(
        cast.framework.messages.MessageType.LOAD, (request) => {
          return streamManager.requestStream(request, getStreamRequest(request))
              .then((request) => {
                return Promise.resolve(request);
              })
              .catch((error) => {
                this.broadcast('Stream request failed.');
                return Promise.resolve(request);
              });
        });

    castContext.start();
  </script>
</body>
</html>

Ahora puedes solicitar y reproducir transmisiones de DAI con el SDK de CAF para DAI de Google. Para obtener más información sobre las funciones avanzadas del SDK, consulta las otras guías o descarga nuestras aplicaciones de receptor de muestra.