Se usó la API de Cloud Translation para traducir esta página.

Cómo comenzar a usar el SDK de IMA de DAI

Selecciona la solución de DAI que te interesa

DAI de servicio completo

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

Antes de usar esta guía, asegúrate de familiarizarte con el protocolo Web Receiver del framework de aplicaciones de Chromecast. En esta guía, se supone que tienes un nivel básico de familiaridad con los conceptos de los receptores 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 la inserción de anuncios dinámicos de IMA, 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 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 activo y una clave de API opcional, así como otros parámetros opcionales.
- VODStreamRequest: especifica un ID de fuente de contenido, un ID de video y una clave de API opcional, además de otros parámetros opcionales.
StreamManager: Es un objeto que controla la comunicación entre la transmisión de video y el SDK de IMA DAI, como activar pings de seguimiento y reenviar eventos de transmisión al publicador.

Requisitos previos

Una cuenta de Cast Developer Console con un dispositivo de prueba registrado
Una app de receptor web alojada que esté registrada en Play Console de Cast y que se pueda modificar para alojar el código que proporciona esta guía.
Una app de envío que está configurada para usar tu app de receptor web. En este ejemplo, se usa la herramienta de control y comando de Cast como remitente.

Configura los objetos MediaInfo del remitente

Primero, configura el objeto MediaInfo de tu app de remitente 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 de transmisión de DAI falla por algún motivo.
`streamType`		Para las transmisiones en vivo, este valor debe establecerse en "LIVE". Para las transmisiones de VOD, este valor debe establecerse en "BUFFERED".
`customData`	`assetKey`	Solo en transmisiones en vivo. Identifica la transmisión en vivo que se cargará
	`contentSourceId`	Solo transmisiones de VOD. Identifica el feed de contenido multimedia que contiene la transmisión solicitada.
	`videoId`	Solo transmisiones de VOD. Identifica la transmisión solicitada dentro del feed de contenido multimedia especificado.
	`ApiKey`	Una clave de API opcional que puede ser necesaria para recuperar la URL de transmisión del SDK de DAI de IMA
	`senderCanSkip`	Es un valor booleano que le permite al receptor saber si el dispositivo de envío tiene la capacidad de mostrar un botón para omitir, lo que habilita la compatibilidad con los anuncios que se pueden omitir.

Para configurar estos valores en la herramienta de control y comando de transmisión, 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": "sN_IYUG8STe1ZzhIIE_ksA",
      "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",
      "ApiKey": "",
      "senderCanSkip": true
    }
  },
  "credentials": "testCredentials"
}

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

Crea un receptor de CAF básico

Sigue las instrucciones de la Guía de receptores básicos 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 DAI de IMA y obtén el Administrador de reproductores

Agrega una etiqueta de secuencia de comandos para importar el SDK de IMA DAI para CAF a tu receptor web, justo después de que la secuencia de comandos cargue CAF. El SDK de DAI de CAF es permanente, por lo que no es necesario configurar una versión específica. Luego, en la etiqueta de secuencia de comandos que sigue, almacena el contexto del receptor y el administrador de jugadores 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>

Cómo inicializar el administrador de transmisiones de IMA

Inicializa el administrador de flujos 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 de CAF usa el interceptor de mensajes de carga de CAF para realizar solicitudes de transmisión y reemplazar la URL del 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, la solicitud de la transmisión y el reemplazo del contentURL existente.

Solo puede haber un interceptor de mensajes de carga, por lo que, si tu app requiere el uso del interceptor, debes incorporar las funciones personalizadas 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>

Compila la solicitud de transmisión

Para completar la integración de la 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.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 DAI de CAF de Google. Para obtener información sobre las funciones más avanzadas del SDK, consulta las otras guías o descarga nuestras aplicaciones de receptor de ejemplo.