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 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 del framework de la aplicación de Chromecast. En esta guía, se asume un nivel básico de conocimiento de los conceptos del receptor de CAF, como los interceptores de mensajes y los objetos mediaInformation, y también el uso de la herramienta de comandos y control de transmisión para emular un remitente de CAF.

Para usar la DAI 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. Si quieres obtener información para 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 SDK de IMA del cliente, consulta SDK 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. Existen dos variedades principales de solicitudes de transmisión:
- LiveStreamRequest: Especifica una clave del 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, así como otros parámetros opcionales.
StreamManager: Es un objeto que controla la comunicación entre la transmisión de video por Internet y el SDK de DAI de IMA, 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 tu Play Console de Cast y que se pueda modificar para alojar el código que se proporciona en 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 comando y control de transmisión como remitente.

Configurar los objetos MediaInfo del remitente

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

`contentId`		Un identificador único para este elemento multimedia
`contentUrl`		La URL de transmisión de resguardo que se debe cargar si StreamRequest de DAI falla por algún motivo
`streamType`		Para las transmisiones en vivo, este valor se debe establecer como "LIVE". Para 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 contiene la transmisión solicitada.
	`videoId`	Solo transmisiones de VOD. Identifica la transmisión solicitada dentro del feed multimedia especificado.
	`ApiKey`	Una clave de API opcional que se puede requerir para recuperar la URL de transmisión del SDK de IMA de DAI
	`senderCanSkip`	Un valor booleano que informa al receptor si el dispositivo emisor tiene la capacidad de mostrar un botón de omisión, lo que habilita la compatibilidad con anuncios que se pueden omitir.

Para configurar estos valores en la herramienta de comando y control de transmisión, haz clic en la pestaña Load Media (Load Media) y establece el tipo de solicitud de carga personalizado 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 personalizado se puede enviar al receptor para probar los siguientes pasos.

Cómo crear un receptor CAF básico

Sigue las indicaciones de la Guía básica del receptor del SDK de CAF para crear un receptor web básico.

El código de tu 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 de DAI y obtén el Administrador del reproductor

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

Inicializa el Stream Manager 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 utiliza 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 se encarga de 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>

Compila la solicitud de transmisión

Para completar tu 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.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 puede solicitar y reproducir transmisiones de DAI con el SDK de DAI de CAF de Google. Para obtener información sobre funciones del SDK más avanzadas, consulta las otras guías o descarga nuestras aplicaciones de receptor de muestra.