SDK de IMA de DAI para Roku

1. 1. ima
   2. ima.AdBreakInfo
   3. ima.AdEvent
   4. ima.AdInfo
   5. ima.Companion
   6. ima.CuePoint
   7. ima.Error
   8. ima.ErrorEvent
   9. ima.Player
   10. ima.StreamFormat
   11. ima.StreamInfo
   12. ima.StreamManager
   13. ima.StreamRequest
   14. ima.StreamType
   15. ima.WrapperInfo

IMA de clase

Métodos

disableLogging, getStreamManager, initSdk y requestStream

Funciones globales que controlan el SDK de IMA.

disableLogging()

Inhabilita el registro del SDK. El registro estará activado de forma predeterminada.

getStreamManager()

Muestra un administrador de transmisiones si está disponible. Si el administrador de transmisiones aún no está disponible, se muestra “No válido”. Si se produjo un error cuando se creaba el administrador de transmisiones, se muestra un objeto de error.

Muestra object: El administrador de transmisiones o el objeto de error.

initSdk(settings)

Inicializa el SDK.

Parámetro	Tipo	Descripción
settings	object	Objeto de configuración de IMA opcional.

requestStream(streamRequest)

Inicia una solicitud de transmisión asíncrona. El control vuelve de inmediato al reproductor después de llamar a este método.

Muestra object: un error o no válido si no hay errores.

Parámetro	Tipo	Descripción
streamRequest	object

Volver al principio

Clase ima.AdBreakInfo

Campos

adPosition, duration, podIndex, timeOffset, totalAds

Métodos

createAdBreakInfo

Contiene información sobre una pausa publicitaria. El SDK los pasa a las devoluciones de llamada de eventos.

Propiedades

Nombre	Tipo	Descripción
adPosition		Es el índice del anuncio en la pausa publicitaria. será 1 para los anuncios independientes.
duration		La duración máxima de la pausa en segundos o -1 si se desconoce.
podIndex		Para las transmisiones en vivo, siempre muestra -1. Para video on demand (VOD), muestra el índice del grupo de anuncios. Para un grupo de anuncios previos al video, muestra 0. Para los anuncios durante el video, muestra 1, 2, ..., n. Para un grupo de anuncios al final del video, muestra n+1...n+x. El valor predeterminado es 0 si este anuncio no es parte de un grupo de anuncios o si este no es parte de una lista de reproducción.
timeOffset		Es la posición del Pod en el contenido, expresada en segundos. El anuncio previo al video muestra 0, el anuncio al final del video muestra -1 y los anuncios durante el video muestran la hora programada del grupo.
totalAds		Es la cantidad total de anuncios incluidos en esta pausa publicitaria. será 1 para los anuncios independientes.

createAdBreakInfo()

Muestra ima.AdBreakInfo:

Volver al principio

Clase ima.AdEvent

Campos

AD_PERIOD_ENDED, AD_PERIOD_STARTED, COMPLETE, ERROR, FIRST_QUARTILE, ICON_FALLBACK_IMAGE_CLOSED, ICON_FALLBACK_IMAGE_SHOWNSKIPPABLE_STATE_CHANGEDTHIRD_QUARTILE

Eventos activados por el administrador de anuncios

Propiedades

Nombre	Tipo	Descripción
AD_PERIOD_ENDED		Se activa cada vez que la transmisión cambia de publicidad o cortinilla de video a contenido. Se activará incluso cuando un anuncio se reproduzca por segunda vez o cuando se busque uno.
AD_PERIOD_STARTED		Se activa cada vez que la transmisión cambia del contenido a la publicidad o la lista. Se activará incluso cuando un anuncio se reproduzca por segunda vez o cuando se busque uno.
COMPLETE		Se activa cuando se completa la reproducción del anuncio.
ERROR		Se activa cuando se produce un error.
FIRST_QUARTILE		Se activa cuando el cabezal de reproducción del anuncio cruza el primer cuartil.
ICON_FALLBACK_IMAGE_CLOSED		Se activa cuando el usuario cierra el diálogo de la imagen de resguardo del ícono.
ICON_FALLBACK_IMAGE_SHOWN		Se activa cuando se muestra la imagen de resguardo del ícono.
MIDPOINT		Se activa cuando el cabezal de reproducción del anuncio cruza el punto medio.
PROGRESS		Se activa cuando hay una actualización en el progreso de un anuncio.
SKIPPABLE_STATE_CHANGED		Se activa cuando cambia el estado de un anuncio que se puede omitir.
SKIPPED		Se activa cuando se omite un anuncio.
START		Se activa cuando comienza a reproducirse un anuncio.
THIRD_QUARTILE		Se activa cuando el cabezal de reproducción del anuncio cruza el tercer cuartil.

Volver al principio

Clase ima.AdInfo

Campos

adBreakInfo, adDescription, adId, adSystem, adTitle, advertiserName, companions, currentTime, duration, skipOffset, universalAdIDRegistryuniversalAdIDValue

Métodos

createAdInfo

Contiene información sobre un anuncio. El SDK los pasa a las devoluciones de llamada de eventos.

Propiedades

Nombre	Tipo	Descripción
adBreakInfo		Información relacionada con toda la pausa en la que se encuentra este anuncio.
adDescription		Es la descripción del anuncio.
adId		Es el ID del anuncio o una cadena vacía si se desconoce.
adSystem		Es el sistema de anuncios que proporciona la creatividad.
adTitle		Es el título del anuncio.
advertiserName		Es el nombre del anunciante, tal como lo define la parte que publica los anuncios.
companions		Son los anuncios complementarios especificados en la respuesta de VAST.
currentTime		Indica la hora actual de un anuncio en segundos o -1 si se desconoce.
duration		Es la duración de este único anuncio en segundos o -1 si se desconoce.
skipOffset		Es el tiempo que tarda el anuncio en omitirse o -1 si se desconoce.
universalAdIDRegistry		Es una cadena que se usa para identificar la URL del sitio web de registro en el que se cataloga el ID del anuncio universal de la creatividad seleccionada.
universalAdIDValue		Es el ID del anuncio universal de la creatividad seleccionada para el anuncio.
wrappers		Un array de ima.WrapperInfo con información de wrapper para este anuncio. El orden será del wrapper externo al interno.

createAdInfo()

Muestra ima.AdInfo:

Volver al principio

Clase ima.Companion

Campos

apiFramework, creativeType, height, trackingEvents, url, width

Métodos

createCompanion

Contiene información sobre los anuncios complementarios.

Propiedades

Nombre	Tipo	Descripción
apiFramework		La API necesaria para publicar este anuncio, o No válida si no está disponible.
creativeType		Representa el tipo de creatividad que suele ser un tipo MIME.
height		Es la altura del anuncio complementario en píxeles. 0 si no está disponible.
trackingEvents		Un mapa de eventos de seguimiento en el que la clave es el evento y el valor es una lista de URLs para hacer ping en ese evento.
url		La URL del recurso estático de este complementario.
width		Es el ancho del anuncio complementario en píxeles. 0 si no está disponible.

createCompanion()

Muestra ima.Companion:

Volver al principio

Clase ima.CuePoint

Campos

end, hasPlayed, start

Métodos

createCuePoint

Contiene información sobre un punto de inserción.

Propiedades

Nombre	Tipo	Descripción
end		La hora de finalización de un punto de inserción en segundos. Esto corresponde a una pausa publicitaria.
hasPlayed		Un valor booleano que indica que ya se reprodujo el punto de inserción.
start		El tiempo de inicio de un punto de inserción en segundos. Esto corresponde a una pausa publicitaria.

createCuePoint()

Muestra ima.CuePoint:

Volver al principio

Clase ima.Error

Campos

id, info, tipo

Métodos

createError

El objeto se pasa al controlador de errores si hay un error.

Propiedades

Nombre	Tipo	Descripción
id		El ID del error. Consulta la constante ErrorEvent para obtener una lista de códigos de error.
info		Información adicional sobre el error.
type		Siempre se establece en error para indicar el tipo de este objeto.

createError()

Muestra ima.Error:

Volver al principio

Clase ima.ErrorEvent

Campos

BAD_STREAM_REQUEST, COULD_NOT_LOAD_STREAM, ERROR, INVALID_RESPONSE, STREAM_API_KEY_NOT_VALID

Todos los errores que el SDK podría devolver.

Propiedades

Nombre	Tipo	Descripción
BAD_STREAM_REQUEST		No se propagó correctamente la solicitud de transmisión.
COULD_NOT_LOAD_STREAM		No se pudieron cargar las Novedades.
ERROR		Se produjo un error desconocido.
INVALID_RESPONSE		La respuesta del servidor no es válida.
STREAM_API_KEY_NOT_VALID		El servidor no aceptó la clave de API proporcionada.

Volver al principio

Clase ima.Player

Métodos

adBreakEnded, adBreakStarted, allVideoComplete, createPlayer y loadUrl

adBreakEnded(adBreakInfo)

Opcional. Se llama cuando termina una pausa publicitaria.

Parámetro	Tipo	Descripción
adBreakInfo	ima.AdBreakInfo	Contiene información sobre la pausa publicitaria.

adBreakStarted(adBreakInfo)

Opcional. Se llama cuando comienza una pausa publicitaria.

Parámetro	Tipo	Descripción
adBreakInfo	ima.AdBreakInfo	Contiene información sobre la pausa publicitaria.

allVideoComplete()

Opcional. Se invoca cuando se completa todo el video.

createPlayer()

Crea un objeto Player de IMA vacío. Debes implementar la función loadUrl para reproducir anuncios. Otras funciones son opcionales.

Muestra ima.Player:

loadUrl(streamInfo)

Se invoca cuando el reproductor debe comenzar a reproducir una URL. Debes implementar este método para cargar la transmisión.

Parámetro	Tipo	Descripción
streamInfo	ima.StreamInfo	Contiene la información necesaria para reproducir contenido.

Volver al principio

Clase ima.StreamFormat

Campos

DASH, HLS

Define el formato de la transmisión.

Propiedades

Nombre	Tipo	Descripción
DASH
HLS

Volver al principio

Clase ima.StreamInfo

Campos

format, manifest, streamId, streamType y subtítulos

Métodos

createStreamInfo

Información que el SDK envía al reproductor sobre la transmisión.

Propiedades

Nombre	Tipo	Descripción
format		El formato del video: HL o guion. Se define en ima.StreamFormat.
manifest		URL de la transmisión.
streamId		Es un ID único para la transmisión.
streamType		El tipo de video: on demand o en vivo. Se define en ima.StreamType.
subtitles		Subtítulos, si están disponibles. Si no es así, no es válido.

createStreamInfo()

Muestra ima.StreamInfo:

Volver al principio

Clase ima.StreamManager

Métodos

addEventListener, createStreamManager, enableInteractiveAds, getContentTime, getCuePoints, getPreviousCuePoint, getStreamTime, loadThirdPartyStream, onMessage Parameters, replaceAd,replaceAdTag.replaceAdTagParameters

Objeto para administrar la reproducción de transmisiones.

addEventListener(event, callback)

Agrega un objeto de escucha para el evento especificado. Consulta la constante AdEvents para ver los eventos compatibles.

Parámetro	Tipo	Descripción
event	string
callback	function

createStreamManager(streamRequest, streamInitResponse)

Muestra ima.StreamManager:

Parámetro	Tipo	Descripción
streamRequest	ima.StreamRequest
streamInitResponse	ima.StreamInitResponse

enableInteractiveAds()

No compatible. En su lugar, pasa datos del anuncio complementario a RAF directamente. Esta ahora es una no op.

getContentTime(streamTime)

Obtiene un tiempo en milisegundos para una transmisión de VOD, que representa el tiempo en el contenido sin anuncios. Consulta: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq Para obtener el tiempo del contenido para el tiempo de transmisión actual, pasa -1.

Muestra Integer: La hora del contenido correspondiente a la hora de transmisión determinada.

Parámetro	Tipo	Descripción
streamTime	Integer	La hora en las novedades.

getCuePoints()

Muestra todos los puntos de inserción correspondientes a todas las pausas publicitarias. Esto solo es válido para el contenido de video on demand en el que todas las pausas publicitarias se conocen con anticipación. Todos los tiempos representan el tiempo de transmisión en segundos.

Muestra Object: Es un array con todos los puntos de inserción.

getPreviousCuePoint(time)

Muestra el punto de inserción que precede a este tiempo. El punto de inserción indica una pausa publicitaria. Todos los tiempos representan el tiempo de transmisión en segundos.

Muestra ima.CuePoint: Un objeto con start, end y hasPlayed. El resultado es no válido si no hay ningún punto de inserción disponible.

Parámetro	Tipo	Descripción
time	Float	El tiempo de búsqueda, -1 indica la hora actual.

getStreamTime(contentTime)

Obtiene el tiempo de la transmisión a partir de un tiempo de contenido de VOD en milisegundos. Consulta: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq

Muestra Integer: La hora de transmisión correspondiente al tiempo del contenido determinado.

Parámetro	Tipo	Descripción
contentTime	Integer	Es la hora del contenido.

loadThirdPartyStream(streamManifest, streamSubtitle)

Carga los metadatos del anuncio y llama a la función loadUrl con los datos de streamManifestUrl y streamSubtitle proporcionados. Esta función solo funciona cuando el tipo de solicitud de transmisión es ima.StreamType.POD_VOD.

Parámetro	Tipo	Descripción
streamManifest	string	La URL del manifiesto de la transmisión con anuncios unidos.
streamSubtitle	ifArray>|Invalid	Los subtítulos se asocian con la transmisión o Invalid si no hay ninguno.

onMessage(msg)

Maneja todos los mensajes que provienen del objeto de Video. Se debe llamar para cada mensaje recibido en roMessagePort.

Parámetro	Tipo	Descripción
msg	object	Mensaje del puerto roVideo.

replaceAdTagParameters(adTagParameters)

Reemplaza todos los parámetros de etiquetas de anuncios que se usarán en las próximas solicitudes de anuncios de una transmisión en vivo. Ten en cuenta que esta llamada es no-op para las transmisiones de VOD.

Parámetro	Tipo	Descripción
adTagParameters	string	Son los nuevos parámetros de la etiqueta de anuncio.

start()

Inicia la reproducción de la transmisión.

Volver al principio

Clase ima.StreamRequest

Campos

adTagParameters, adUiNode, apiKey, assetKey, authToken, contentSourceId, customAssetKey, format, networkCode, playerMonitor, streamActivityMonitorIdvideoIdvideoObjectvideoStitcherSessionOptions

Métodos

createLiveStreamRequest, createPodLiveStreamRequest, createPodVodStreamRequest, createStreamRequest, createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest, CreateVideoStitcherVodStreamRequestWithVodConfig y createVodStreamRequest

Se usa para especificar propiedades de la solicitud de transmisión.

Propiedades

Nombre	Tipo	Descripción
adTagParameters		Opcional. Puedes anular un conjunto limitado de parámetros de etiquetas de anuncios en tu solicitud de transmisión. En Proporcionar parámetros de segmentación a tu transmisión, encontrarás más información. También puedes usar los parámetros dai-ot y dai-ov para la preferencia de variantes de transmisión. Consulta Anula los parámetros de la variante de transmisión para obtener más información.
adUiNode		Un nodo de gráfico de escenas en el que se muestra la IU del anuncio. IMA coloca elementos como los botones ¿Por qué este anuncio? y Omitir en este elemento durante los anuncios. El elemento debe superponerse a todo el elemento de video.
apiKey		Opcional. Estas claves se pueden usar para autenticar solicitudes de transmisión. Las claves de autenticación de DAI deben configurarse en la IU de DFP.
assetKey		Obligatorio para las transmisiones en vivo. Se usa para determinar qué transmisión debe reproducirse. La clave del activo de la solicitud de transmisión en vivo es un identificador que se puede encontrar en la IU de DFP.
authToken		El token de autorización de la solicitud de transmisión. Se usa en lugar de la clave de API para una autorización de contenido más estricta. El editor puede controlar las autorizaciones de transmisiones de contenido individuales basadas en este token.
contentSourceId		Obligatorio para las transmisiones on demand. El valor de cmsid proviene de la fuente de contenido de video de DFP en la IU de este producto.
customAssetKey		La clave del activo personalizada se usa para determinar qué transmisión se debe reproducir. Se requieren claves de recursos personalizadas para las solicitudes de transmisión de entrega de grupos de anuncios.
format		Es el formato de la transmisión. La configuración predeterminada es ima.StreamFormat.HLS.
networkCode		Es el código de red del publicador que realiza la solicitud de transmisión. Los códigos de red son obligatorios para las solicitudes de transmisión de entrega de Pods.
player		Es una implementación de la interfaz del reproductor.
ppid		Ya no está disponible. Usa adTagParameters. Opcional. Un identificador proporcionado por el publicador de DFP Audience.
streamActivityMonitorId		El ID que se usará para depurar la transmisión con el supervisor de actividad de transmisión. Se usa para proporcionar una forma conveniente de permitir que los publicadores encuentren un registro de transmisión en la herramienta de supervisión de actividad de transmisión.
videoId		Obligatorio para las transmisiones on demand. Es el identificador de la fuente del contenido de video.
videoObject		El objeto de video (como el roSGNode de video) responsable de la reproducción de video en la app cliente. Este objeto se sondeará para detectar varios datos que se usarán para sincronizar correctamente los eventos ID3 de HLS en vivo.
videoStitcherSessionOptions		Las opciones de sesión se usan para establecer parámetros específicos de las calcomanías de video para las solicitudes de transmisión de VideoStitcher.

createLiveStreamRequest(assetKey, apiKey)

Inicializa las propiedades requeridas de un StreamRequest publicado. El uso de esta API hace que se ignoren otras propiedades específicas de StreamType. Si alguno de los parámetros obligatorios son strings vacías, se produce un registro de errores y la API muestra un StreamRequest genérico, sin propiedades ignoradas.

Muestra ima.StreamRequest: un objeto ima.StreamRequest con las propiedades publicadas obligatorias.

Parámetro	Tipo	Descripción
assetKey	string
apiKey	string	Parámetro opcional que se asignará a la propiedad apiKey de StreamRequest que se muestra. El valor predeterminado es una string vacía.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Inicializa las propiedades requeridas de un Pod activo ima.StreamRequest. El uso de esta API hace que se ignoren otras propiedades específicas de ima.StreamType. Si alguno de los parámetros obligatorios son strings vacías, se produce un registro de errores y la API muestra un StreamRequest genérico, sin propiedades ignoradas.

Muestra StreamRequest: un objeto ima.StreamRequest con propiedades PodLive obligatorias.

Parámetro	Tipo	Descripción
customAssetKey	string
networkCode	string
apiKey	string	Parámetro opcional que se asignará a la propiedad ima.StreamRequest.apiKey de ima.StreamRequest que se muestra. El valor predeterminado es una string vacía.

createPodVodStreamRequest(networkCode)

Inicializa las propiedades requeridas de una ima.StreamRequest para registrar una transmisión de VOD cuando se usa la publicación de grupos de anuncios de DAI con una herramienta de unión de videos de terceros. Esta función establece el tipo de solicitud en ima.StreamType.POD_VOD y valida todas las propiedades obligatorias de los datos faltantes. Las validaciones fallidas registrarán un error en la consola de depuración.

Muestra StreamRequest: un objeto ima.StreamRequest. Si se especifican todas las propiedades obligatorias, el tipo de solicitud se establece en ima.StreamType.POD_VOD.

Parámetro	Tipo	Descripción
networkCode	string	el código de red de Google Ad Manager

createStreamRequest()

Muestra ima.StreamRequest: un objeto ima.StreamRequest vacío.

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

Inicializa las propiedades obligatorias de un StreamRequest de Video Stitcher en vivo. El uso de esta API hace que se ignoren otras propiedades específicas de StreamType. Si alguno de los parámetros obligatorios son strings vacías, se produce un registro de errores y la API muestra un StreamRequest genérico, sin propiedades ignoradas.

Muestra ima.StreamRequest: un objeto ima.StreamRequest con las propiedades VideoStitcherLive requeridas.

Parámetro	Tipo	Descripción
customAssetKey	string
networkCode	string
liveConfigId	string
region	string
projectNumber	string
oAuthToken	string

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)

Inicializa las propiedades requeridas de un StreamRequest de VOD de Video Stitcher. El uso de esta API hace que se ignoren otras propiedades específicas de StreamType. Si alguno de los parámetros obligatorios son strings vacías, se produce un registro de errores y la API muestra un StreamRequest genérico, sin propiedades ignoradas.

Muestra ima.StreamRequest: un objeto ima.StreamRequest con las propiedades VideoStitcherVod requeridas.

Parámetro	Tipo	Descripción
adTagUrl	string
networkCode	string
contentSourceUrl	string
region	string
projectNumber	string
oAuthToken	string

CreateVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)

Inicializa las propiedades necesarias de un StreamRequest de VOD de Video Stitcher mediante vodConfigId creado desde la herramienta de unión de videos en la nube. El uso de esta API hace que se ignoren otras propiedades específicas de StreamType. Si alguno de los parámetros obligatorios son strings vacías, se produce un registro de errores y la API muestra un StreamRequest genérico, sin propiedades ignoradas.

Muestra ima.StreamRequest: un objeto ima.StreamRequest con las propiedades VideoStitcherVod requeridas.

Parámetro	Tipo	Descripción
vodConfigId	string
networkCode	string
region	string
projectNumber	string
oAuthToken	string

createVodStreamRequest(contentSourceId, videoId, apiKey)

Inicializa las propiedades requeridas de un ima.StreamRequest de VOD. El uso de esta API hace que se ignoren otras propiedades específicas de ima.StreamType. Si alguno de los parámetros obligatorios son strings vacías, se produce un registro de errores y la API muestra un StreamRequest genérico, sin propiedades ignoradas.

Muestra ima.StreamRequest: un objeto ima.StreamRequest con las propiedades de VOD requeridas.

Parámetro	Tipo	Descripción
contentSourceId	string
videoId	string
apiKey	string	Parámetro opcional que se asignará a la propiedad ima.StreamRequest.apiKey de ima.StreamRequest que se muestra. El valor predeterminado es una string vacía.

Volver al principio

Clase ima.StreamType

Campos

EN VIVO, VOD

Define el tipo de transmisión que se le pide al reproductor que reproduzca. Los anuncios previos al video y VOD deben reproducirse desde el principio de la transmisión.

Propiedades

Nombre	Tipo	Descripción
LIVE		El video está publicado.
VOD		El video está on demand.

Volver al principio

Clase ima.WrapperInfo

Campos

adId, adSystem, creativeAdId, creativeId y dealId

Métodos

createWrapperInfo

Contiene información sobre un wrapper.

Propiedades

Nombre	Tipo	Descripción
adId		Es el ID del anuncio o una cadena vacía si se desconoce.
adSystem		Es el nombre declarado del sistema de anuncios o la cadena vacía si se desconoce.
creativeAdId		Es el ID del anuncio en la creatividad o una cadena vacía si se desconoce.
creativeId		Es el ID de la creatividad o una cadena vacía si se desconoce.
dealId		El ID del acuerdo o una cadena vacía si se desconoce.

createWrapperInfo()

Muestra ima.WrapperInfo:

Volver al principio