Comenzar

Los SDK de IMA facilitan la integración de anuncios multimedia en sus sitios web y aplicaciones. Los SDK de IMA pueden solicitar anuncios de cualquier servidor de anuncios compatible con VAST y administrar la reproducción de anuncios en sus aplicaciones. Con los SDK de DAI de IMA, las aplicaciones realizan una solicitud de transmisión para anuncios y video de contenido, ya sea VOD o contenido en vivo. Luego, el SDK muestra una transmisión de video combinada, de modo que no tienes que administrar el cambio entre el anuncio y el video de contenido dentro de tu app.

En esta guía, se muestra cómo integrar el SDK de IMA en una app simple de reproductor de video. Si quieres ver o seguir una integración de muestra completa, descarga el ejemplo básico de GitHub.

Nota: El SDK de DAI de IMA para Roku admite transmisiones HLS y DASH, sin diferencias en la implementación.

Para usar la DAI de IMA, debes tener una cuenta de Ad Manager 360 Advanced. Si tiene una cuenta de Ad Manager, comuníquese con él para obtener más detalles. Para obtener información sobre cómo registrarse en Ad Manager, visite el Centro de ayuda de Ad Manager.

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

Descripción general de la DAI de IMA

La implementación de la DAI de IMA implica dos componentes principales del SDK, que se muestran en esta guía:

• StreamRequest: Un objeto que define una solicitud de transmisión. Las solicitudes de transmisión pueden ser para video on demand o transmisiones en vivo. Las solicitudes especifican un ID de contenido, así como una clave de API o un token de autenticación y otros parámetros.
• StreamManager: Es un objeto que controla las transmisiones de inserción de anuncios dinámicos y las interacciones con el backend de la DAI. El administrador de transmisiones también controla los pings de seguimiento y reenvía eventos de transmisión y anuncios al publicador.

Requisitos previos

Antes de comenzar, debes hacer lo siguiente:

• Lee nuestra página de compatibilidad para asegurarte de que se admita tu caso de uso previsto.
• Descarga nuestro código de muestra de Roku.
• Implementa el código de reproductor de muestra anterior en un dispositivo Roku para verificar que funcione la configuración de desarrollo.

Reproduce el video

El reproductor de video de muestra que se muestra reproduce un video de contenido listo para usar. Implementa el reproductor de muestra en tu reproductor de Roku para asegurarte de que el entorno de desarrollo esté configurado de forma correcta.

Convierta su reproductor de video en un reproductor de transmisión de inserción de anuncios dinámicos de IMA

Crea Sdk.xml

Agrega un archivo nuevo a tu proyecto junto con MainScene.xml llamado Sdk.xml y agrega el siguiente código estándar:

SDK.xml

<?xml version = "1.0" encoding = "utf-8" ?>

<component name = "imasdk" extends = "Task">
<interface>
</interface>
<script type = "text/brightscript">
<![CDATA[
  ' Your code goes here.
]]>
</script>
</component>

Debes editar ambos archivos en esta guía. Un encabezado arriba de cada fragmento de código indica en qué archivo debes agregar ese fragmento.

Carga el framework publicitario de Roku

El SDK de IMA depende del framework publicitario de Roku. Para cargar el framework, agrega lo siguiente a manifest y Sdk.xml:

manifiesto

bs_libs_required=roku_ads_lib,googleima3

SDK.xml

Library "Roku_Ads.brs"
Library "IMA3.brs"

Cargue el SDK de IMA

El primer paso para cargar la transmisión de inserción de anuncios dinámicos de IMA es cargar e inicializar el SDK de IMA. Con el siguiente comando, se carga la secuencia de comandos del SDK de IMA.

SDK.xml

<interface>
  <field id="sdkLoaded" type="Boolean" />
  <field id="errors" type="stringarray" />
</interface>

sub init()
  m.top.functionName = "runThread"
End Sub

sub runThread()
  if not m.top.sdkLoaded
    loadSdk()
  End If
End Sub

sub loadSdk()
    If m.sdk = invalid
      m.sdk = New_IMASDK()
    End If
    m.top.sdkLoaded = true
End Sub

Ahora inicia esta tarea en MainScene.xml y quita la llamada para cargar el flujo de contenido.

MainScene.xml.

function init()
  m.video = m.top.findNode("myVideo")
  m.video.notificationinterval = 1
  loadImaSdk()
end function

function loadImaSdk() as void
  m.sdkTask = createObject("roSGNode", "imasdk")
  m.sdkTask.observeField("sdkLoaded", "onSdkLoaded")
  m.sdkTask.observeField("errors", "onSdkLoadedError")

  m.sdkTask.control = "RUN"
end function

Sub onSdkLoaded(message as Object)
  print "----- onSdkLoaded --- control ";message
End Sub

Sub onSdkLoadedError(message as Object)
  print "----- errors in the sdk loading process --- ";message
End Sub

Cree un reproductor de transmisión de IMA

A continuación, debe usar su roVideoScreen existente para crear un reproductor de transmisión de IMA. Este reproductor de transmisión implementa tres métodos de devolución de llamada: loadUrl, adBreakStarted y adBreakEnded. Además, inhabilita la reproducción del truco cuando se carga la transmisión. De esta manera, se evita que los usuarios omitan un anuncio previo al video cuando comience, antes de que se active el evento de inicio de la pausa publicitaria.

SDK.xml

<interface>
  <field id="sdkLoaded" type="Boolean" />
  <field id="errors" type="stringarray" />
  <field id="urlData" type="assocarray" />
  <field id="adPlaying" type="Boolean" />
  <field id="video" type="Node" />
</interface>

...
sub setupVideoPlayer()
  sdk = m.sdk
  m.player = sdk.createPlayer()
  m.player.top = m.top
  m.player.loadUrl = Function(urlData)
    m.top.video.enableTrickPlay = false
    m.top.urlData = urlData
  End Function
  m.player.adBreakStarted = Function(adBreakInfo as Object)
    print "---- Ad Break Started ---- "
    m.top.adPlaying = True
    m.top.video.enableTrickPlay = false
  End Function
  m.player.adBreakEnded = Function(adBreakInfo as Object)
    print "---- Ad Break Ended ---- "
    m.top.adPlaying = False
    m.top.video.enableTrickPlay = true
  End Function
End Sub

Crea y ejecuta una solicitud de transmisión

Ahora que tienes un reproductor de transmisión, puedes crear y ejecutar solicitudes de transmisión. Este ejemplo tiene datos para una transmisión en vivo y una de VOD. En este momento, se está usando la transmisión de VOD. Para usar en vivo en lugar de VOD, cambia selectedStream de m.testVodStream a m.testLiveStream.

Para poder admitir AdUI, como los íconos de AdChoices, también debes pasar una referencia al nodo que contiene tu video de contenido como parte de tu solicitud.

MainScene.xml.

function init()
  m.video = m.top.findNode("myVideo")
  m.video.notificationinterval = 1
  m.testLiveStream = {
    title: "Live Stream",
    assetKey: "sN_IYUG8STe1ZzhIIE_ksA",
    apiKey: "",
    type: "live"
  }
  m.testVodStream = {
    title: "VOD stream"
    contentSourceId: "2528370",
    videoId: "tears-of-steel",
    apiKey: "",
    type: "vod"
  }
  loadImaSdk()
end function

function loadImaSdk() as void
  m.sdkTask = createObject("roSGNode", "imasdk")
  m.sdkTask.observeField("sdkLoaded", "onSdkLoaded")
  m.sdkTask.observeField("errors", "onSdkLoadedError")

  selectedStream = m.testVodStream
  m.videoTitle = selectedStream.title
  m.sdkTask.streamData = selectedStream

  m.sdkTask.video = m.video
  m.sdkTask.control = "RUN"
end function

SDK.xml

<interface>
  <field id="sdkLoaded" type="Boolean" />
  <field id="errors" type="stringarray" />
  <field id="urlData" type="assocarray" />
  <field id="adPlaying" type="Boolean" />
  <field id="video" type="Node" />
  <field id="streamData" type="assocarray" />
  <field id="streamManagerReady" type="Boolean" />
</interface>

sub runThread()
  if not m.top.sdkLoaded
    loadSdk()
  End If
  if not m.top.streamManagerReady
    loadStream()
  End If
End Sub

Sub loadStream()
  sdk = m.sdk
  sdk.initSdk()
  setupVideoPlayer()

  request = {}
  streamData = m.top.streamData
  if streamData.type = "live"
    request = sdk.CreateLiveStreamRequest(streamData.assetKey, streamData.apiKey)
  else if streamData.type = "vod"
    request = sdk.CreateVodStreamRequest(streamData.contentSourceId, streamData.videoId, streamData.apiKey)
  else
    request = sdk.CreateStreamRequest()
  end if

  request.player = m.player
  request.videoObject = m.top.video
  ' Required to support UI elements for 'Why This Ad?' and skippability
  request.adUiNode = m.top.video

  requestResult = sdk.requestStream(request)
  If requestResult <> Invalid
    print "Error requesting stream ";requestResult
  Else
    m.streamManager = Invalid
    While m.streamManager = Invalid
      sleep(50)
      m.streamManager = sdk.getStreamManager()
    End While
    If m.streamManager = Invalid or m.streamManager["type"] <> Invalid or m.streamManager["type"] = "error"
      errors = CreateObject("roArray", 1, True)
      print "error ";m.streamManager["info"]
      errors.push(m.streamManager["info"])
      m.top.errors = errors
    Else
      m.top.streamManagerReady = True
      addCallbacks()
      m.streamManager.start()
    End If
  End If
End Sub

Agrega objetos de escucha de eventos y comienza la transmisión

Después de solicitar la transmisión, solo debes realizar algunas acciones: agregar objetos de escucha de eventos para hacer un seguimiento del progreso de los anuncios, iniciar la transmisión y reenviar mensajes de Roku al SDK. Es sumamente importante que reenvíes todos los mensajes al SDK para garantizar que se reproduzca correctamente el anuncio.

MainScene.xml.

function loadImaSdk() as void
  m.sdkTask = createObject("roSGNode", "imasdk")
  m.sdkTask.observeField("sdkLoaded", "onSdkLoaded")
  m.sdkTask.observeField("errors", "onSdkLoadedError")

  selectedStream = m.testVodStream
  m.videoTitle = selectedStream.title
  m.sdkTask.streamData = selectedStream

  m.sdkTask.observeField("urlData", "urlLoadRequested")
  m.sdkTask.video = m.video
  m.sdkTask.control = "RUN"
end function

Sub urlLoadRequested(message as Object)
  print "Url Load Requested ";message
  data = message.getData()

  playStream(data.manifest)
End Sub

Sub playStream(url as Object)
  vidContent = createObject("RoSGNode", "ContentNode")
  vidContent.url = url
  vidContent.title = m.videoTitle
  vidContent.streamformat = "hls"
  m.video.content = vidContent
  m.video.setFocus(true)
  m.video.visible = true
  m.video.control = "play"
  m.video.EnableCookies()
End Sub

SDK.xml

sub runThread()
  if not m.top.sdkLoaded
    loadSdk()
  End If
  if not m.top.streamManagerReady
    loadStream()
  End If
  If m.top.streamManagerReady
    runLoop()
  End If
End Sub

Sub runLoop()
  m.top.video.timedMetaDataSelectionKeys = ["*"]

  m.port = CreateObject("roMessagePort")

  ' Listen to all fields.

  ' IMPORTANT: Failure to listen to the position and timedmetadata fields
  ' could result in ad impressions not being reported.
  fields = m.top.video.getFields()
  for each field in fields
    m.top.video.observeField(field, m.port)
  end for

  while True
    msg = wait(1000, m.port)
    if m.top.video = invalid
      print "exiting"
      exit while
    end if

    m.streamManager.onMessage(msg)
    currentTime = m.top.video.position
    If currentTime > 3 And not m.top.adPlaying
       m.top.video.enableTrickPlay = true
    End If
  end while
End Sub

Function addCallbacks() as Void
  m.streamManager.addEventListener(m.sdk.AdEvent.ERROR, errorCallback)
  m.streamManager.addEventListener(m.sdk.AdEvent.START, startCallback)
  m.streamManager.addEventListener(m.sdk.AdEvent.FIRST_QUARTILE, firstQuartileCallback)
  m.streamManager.addEventListener(m.sdk.AdEvent.MIDPOINT, midpointCallback)
  m.streamManager.addEventListener(m.sdk.AdEvent.THIRD_QUARTILE, thirdQuartileCallback)
  m.streamManager.addEventListener(m.sdk.AdEvent.COMPLETE, completeCallback)
End Function

Function startCallback(ad as Object) as Void
  print "Callback from SDK -- Start called - "
End Function

Function firstQuartileCallback(ad as Object) as Void
  print "Callback from SDK -- First quartile called - "
End Function

Function midpointCallback(ad as Object) as Void
  print "Callback from SDK -- Midpoint called - "
End Function

Function thirdQuartileCallback(ad as Object) as Void
  print "Callback from SDK -- Third quartile called - "
End Function

Function completeCallback(ad as Object) as Void
  print "Callback from SDK -- Complete called - "
End Function

Function errorCallback(error as Object) as Void
  print "Callback from SDK -- Error called - "; error
  m.errorState = True
End Function

Cómo agregar compatibilidad con anuncios que se pueden omitir (opcional)

Para admitir anuncios que se pueden omitir, deberá agregar un método seek al objeto player del SDK de IMA que busca de manera programática el video en la ubicación especificada, en segundos de punto flotante.

Nota: Para admitir anuncios que se pueden omitir, también debes asegurarte de configurar adUiNode en tu solicitud.

SDK.xml

  ...

  m.player.loadUrl = Function(urlData)
    m.top.video.enableTrickPlay = false
    m.top.urlData = urlData
  End Function

  m.player.seek = Function(timeSeconds as Float)
     print "---- SDK requested seek to ----" ; timeSeconds
     m.top.video.seekMode = "accurate"
     m.top.video.seek = timeSeconds
  End Function

  m.player.adBreakStarted = Function(adBreakInfo as Object)
    print "---- Ad Break Started ---- "
    m.top.adPlaying = True
    m.top.video.enableTrickPlay = false
  End Function

  ...