Para analizar nuestros productos y proporcionar comentarios sobre ellos, únete al canal oficial de Ad Manager en Discord, en el servidor Google Advertising and Measurement Community.

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

SDK de IMA de DAI para Roku

Clase ima

Métodos

disableLogging, getStreamManager, initSdk, requestStream

Son funciones globales que controlan el SDK de IMA.

`disableLogging()`

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

`getStreamManager()`

Devuelve un administrador de transmisiones si está disponible. Si el administrador de transmisiones aún no está disponible, se devuelve Invalid. Si se produjo un error al crear el administrador de transmisiones, se devuelve un objeto de error.

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

`initSdk(settings)`

Inicializa el SDK.

Parámetro	Tipo	Descripción
`settings`	`object`	Es un objeto de configuración de IMA opcional.

`requestStream(streamRequest)`

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

Devuelve object: un error o un valor no válido si no hay error

Parámetro	Tipo	Descripción
`streamRequest`	`object`

Nombre	Tipo	Descripción
`adPosition`		Es el índice del anuncio en la pausa publicitaria. El índice es `1` para los anuncios independientes.
`duration`		Es la duración máxima de la pausa en segundos o `-1` si se desconoce.
`podIndex`		En el caso de las transmisiones en vivo, devuelve el ID de la pausa como el índice del pod o `0` para un anuncio previo al video. No hay postrolls en las transmisiones en vivo. La configuración predeterminada es `-2`. Para el video on demand (VOD), devuelve el índice del grupo de anuncios. En el caso de un pod de anuncio previo al video, devuelve `0`. En el caso de los anuncios durante el video, devuelve `1`, `2`, …, n. Para un pod de post-roll, devuelve de n+1 a n+x. El valor predeterminado es `0` si este anuncio no forma parte de un grupo o si este grupo no forma parte de una playlist.
`timeOffset`		Es la posición del grupo de anuncios en el contenido, expresada en segundos. Los anuncios previos al video devuelven `0`, los anuncios al final del video devuelven `-1` y los anuncios durante el video devuelven la hora programada del pod.
`totalAds`		Es la cantidad total de anuncios que contiene esta pausa publicitaria. El valor es `1` para los anuncios independientes.

Nombre	Tipo	Descripción
`AD_PERIOD_ENDED`		Se activa cada vez que la transmisión cambia de publicidad o cortinilla de video a contenido. Este evento se activará incluso cuando se reproduzca un anuncio por segunda vez o cuando se busque un punto específico en un anuncio.
`AD_PERIOD_STARTED`		Se activa cada vez que la transmisión cambia de contenido a publicidad o a cortinilla de video. Este evento se activará incluso cuando se reproduzca un anuncio por segunda vez o cuando se busque un punto específico en un anuncio.
`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 alternativa del ícono.
`MIDPOINT`		Se activa cuando el cabezal de reproducción del anuncio cruza el punto medio.
`PROGRESS`		Se activa cuando se actualiza 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 se comienza a reproducir un anuncio.
`THIRD_QUARTILE`		Se activa cuando el cabezal de reproducción del anuncio cruza el tercer cuartil.

Nombre	Tipo	Descripción
`adBreakInfo`		Es la información relacionada con toda la pausa en la que se muestra 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 entidad de publicación.
`companions`		Son los anuncios complementarios especificados en la respuesta de VAST.
`creativeAdId`		Es el código ISCI (identificador comercial estándar de la industria) de un anuncio. Es el ID de anuncio de la creatividad seleccionada en la respuesta de VAST.
`creativeId`		Es el ID de la creatividad seleccionada para el anuncio.
`currentTime`		Es el tiempo actual dentro de un anuncio en segundos o -1 si se desconoce.
`dealId`		Devuelve el primer ID de oferta presente en la cadena de wrapper del anuncio actual, comenzando desde la parte superior.
`duration`		Duración de este anuncio único en segundos o -1 si se desconoce.
`skipOffset`		Es el tiempo que tarda el anuncio en poder omitirse o -1 si se desconoce.
`universalAdIDRegistry`		Es una cadena que se usa para identificar la URL del sitio web del registro en el que se cataloga el ID universal del anuncio de la creatividad seleccionada.
`universalAdIDValue`		Es el ID de anuncio universal de la creatividad seleccionada para el anuncio.
`wrappers`		Es un array de ima.WrapperInfo con información del wrapper para este anuncio. El orden será desde el envoltorio exterior hacia el interior.

Nombre	Tipo	Descripción
`adSlotId`		Es el ID del espacio publicitario del anuncio complementario. Estará vacío si no está disponible.
`apiFramework`		Es la API necesaria para ejecutar este anuncio o el valor "Invalid" si no está disponible.
`companionClickThrough`		Es la URL de clic del compañero.
`creativeType`		Representa el tipo de creatividad, que suele ser un tipo de MIME.
`height`		Es la altura del anuncio complementario en píxeles. 0 si no está disponible
`trackingEvents`		Es un mapa de eventos de seguimiento en el que la clave es el evento y el valor es una lista de URLs a las que se debe enviar un ping cuando se produce ese evento.
`url`		Es la URL del recurso estático de este compañero.
`width`		Es el ancho del anuncio complementario en píxeles. 0 si no está disponible

Nombre	Tipo	Descripción
`end`		Es la hora de finalización de un punto de referencia en segundos. Esto corresponde a una pausa publicitaria.
`hasPlayed`		Es un valor booleano que indica si el punto de referencia ya se reprodujo.
`start`		Es la hora de inicio de un punto de referencia en segundos. Esto corresponde a una pausa publicitaria.

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

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

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

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

Parámetro	Tipo	Descripción
`streamManifest`	`string`	Es la URL del manifiesto de la transmisión con anuncios insertados.
`streamSubtitle`	`ifArray>\|Invalid`	Subtítulos asociados con la transmisión, o `Invalid` si no hay ninguno.

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 Cómo agregar parámetros de segmentación a tu transmisión, se proporciona más información. También puedes usar los parámetros dai-ot y dai-ov para establecer la preferencia de variantes de transmisión. Consulta Cómo anular los parámetros de variantes de transmisión para obtener más información.
`adUiNode`		Es un nodo de gráfico de escena en el que se muestra la IU del anuncio. Durante los anuncios, el SDK de IMA coloca elementos como los botones Por qué este anuncio y Omitir en este elemento. 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 se deben configurar en la IU de DFP.
`assetKey`		Se requiere para las transmisiones en vivo. Se usa para determinar qué transmisión se debe reproducir. 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`		Es 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 publicador puede controlar las autorizaciones de transmisiones de contenido individuales según este token.
`contentSourceId`		Obligatorio para las transmisiones a pedido. El parámetro cmsid proviene de la fuente de contenido de video de DFP en la IU de DFP.
`customAssetKey`		La clave del activo personalizada se usa para determinar qué transmisión se debe reproducir. Se requieren claves de activos personalizadas para las solicitudes de transmisión de entrega de pods.
`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 publicación de grupos de anuncios realizadas con createPodLiveStreamRequest o createPodVodStreamRequest. Estos códigos también son necesarios para las solicitudes de transmisión de Cloud Stitching realizadas con createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest o createVideoStitcherVodStreamRequestWithVodConfig. Estos códigos son opcionales y se recomiendan para las solicitudes de transmisión de servicio completo realizadas con createLiveStreamRequest o createVodStreamRequest. Si agregas el código de red, se aplicará la configuración seleccionada en la IU de Ad Manager, como la habilitación de anuncios programáticos limitados. En el caso de la publicación de Pods y la unión de Cloud, agregar el código de red permite ubicar y reproducir la transmisión. Para encontrar el código de red, consulta este artículo.
`player`		Es una implementación de la interfaz del reproductor.
`ppid`		Obsoleta. Usa adTagParameters. Opcional. Es un identificador proporcionado por el publicador de un público de DFP.
`streamActivityMonitorId`		Es el ID que se usará para depurar la transmisión con el monitor 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 la actividad de transmisión.
`videoId`		Obligatorio para las transmisiones a pedido. Es el identificador de la fuente de contenido de video.
`videoObject`		Objeto de video (como el roSGNode de Video) responsable de la reproducción de video en la app del cliente. Se sondeará este objeto para obtener varios datos que se usarán en la sincronización adecuada de los eventos ID3 de HLS en vivo.
`videoStitcherSessionOptions`		Las opciones de sesión se usan para establecer parámetros específicos del VideoStitcher para las solicitudes de transmisión de VideoStitcher.

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

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

Nombre	Tipo	Descripción
`LIVE`		Se publicó el video.
`VOD`		El video está disponible on demand.

SDK de IMA de DAI para Roku Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Clase ima

disableLogging()

getStreamManager()

initSdk(settings)

requestStream(streamRequest)

Clase ima.AdBreakInfo

Propiedades

createAdBreakInfo()

Clase ima.AdEvent

Propiedades

Clase ima.AdInfo

Propiedades

createAdInfo()

Clase ima.Companion

Propiedades

createCompanion()

Clase ima.CuePoint

Propiedades

createCuePoint()

Clase ima.Error

Propiedades

createError()

Clase ima.ErrorEvent

Propiedades

Clase ima.Player

adBreakEnded(adBreakInfo)

adBreakStarted(adBreakInfo)

allVideoComplete()

createPlayer()

loadUrl(streamInfo)

streamInitialized(streamInfo)

Clase ima.StreamFormat

Propiedades

Clase ima.StreamInfo

Propiedades

createStreamInfo()

Clase ima.StreamManager

addEventListener(event, callback)

createStreamManager(streamRequest, streamInitResponse)

enableInteractiveAds()

getContentTime(streamTime)

getCuePoints()

getPreviousCuePoint(time)

getStreamTime(contentTime)

loadThirdPartyStream(streamManifest, streamSubtitle)

onMessage(msg)

replaceAdTagParameters(adTagParameters)

start()

Clase ima.StreamRequest

Propiedades

createLiveStreamRequest(assetKey, apiKey, networkCode)

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

createPodVodStreamRequest(networkCode)

createStreamRequest()

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

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

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

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

Clase ima.StreamType

Propiedades

Clase ima.WrapperInfo

Propiedades

createWrapperInfo()

SDK de IMA de DAI para Roku

`disableLogging()`

`getStreamManager()`

`initSdk(settings)`

`requestStream(streamRequest)`

`createAdBreakInfo()`

`createAdInfo()`

`createCompanion()`

`createCuePoint()`

`createError()`

`adBreakEnded(adBreakInfo)`

`adBreakStarted(adBreakInfo)`

`allVideoComplete()`

`createPlayer()`

`loadUrl(streamInfo)`

`streamInitialized(streamInfo)`

`createStreamInfo()`

`addEventListener(event, callback)`

`createStreamManager(streamRequest, streamInitResponse)`

`enableInteractiveAds()`

`getContentTime(streamTime)`

`getCuePoints()`

`getPreviousCuePoint(time)`

`getStreamTime(contentTime)`

`loadThirdPartyStream(streamManifest, streamSubtitle)`

`onMessage(msg)`

`replaceAdTagParameters(adTagParameters)`

`start()`

`createLiveStreamRequest(assetKey, apiKey, networkCode)`

`createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)`

`createPodVodStreamRequest(networkCode)`

`createStreamRequest()`

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

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

`createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)`

`createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)`

`createWrapperInfo()`