Ima de la clase
Métodos
Funciones globales que controlan el SDK de IMA de DAI
disableLogging()
Inhabilita el registro del SDK. El registro se activará de forma predeterminada.
getStreamManager()
Devuelve un administrador de transmisiones si está disponible.
Si el administrador de transmisiones aún no está disponible, se muestra un mensaje Inválido.
Si se produjo un error cuando se creaba el administrador de transmisiones, se mostrará un objeto de error.
Muestra object
: El objeto de error o administrador de transmisiones.
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 regresa inmediatamente al reproductor después de llamar a este método.
Muestra object
: un error o no válido si no hay error
Parámetro | Tipo | Descripción |
---|---|---|
streamRequest |
object |
Clase ima.AdBreakInfo
Campos
Métodos
Contiene información sobre una pausa publicitaria. El SDK las 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 de una lista de reproducción. |
timeOffset |
|
Es la posición del grupo de anuncios en el contenido, expresada en segundos. El anuncio previo al video muestra 0, el anuncio final del video muestra -1 y los anuncios durante el video muestran la hora programada del grupo de anuncios. |
totalAds |
|
Es la cantidad total de anuncios incluidos en esta pausa publicitaria. Será 1 para los anuncios independientes. |
createAdBreakInfo()
Devuelve ima.AdBreakInfo
:
Clase ima.AdEvent
Campos
Eventos activados por el administrador de anuncios
Propiedades
Nombre | Tipo | Descripción |
---|---|---|
AD_PERIOD_ENDED |
|
Se activa cada vez que la transmisión pasa de publicidad o cortinilla de video a contenido. Se activará incluso cuando un anuncio se reproduzca por segunda vez o cuando se lo busque. |
AD_PERIOD_STARTED |
|
Se activa cada vez que la transmisión pasa de contenido a publicidad o lista. Se activará incluso cuando un anuncio se reproduzca por segunda vez o cuando se lo busque. |
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 de anuncios cruza el primer cuartil. |
MIDPOINT |
|
Se activa cuando el cabezal de reproducción de anuncios cruza el punto medio. |
PROGRESS |
|
Se activa cuando hay una actualización del 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 empieza a reproducir un anuncio. |
THIRD_QUARTILE |
|
Se activa cuando el cabezal de reproducción de anuncios cruza el tercer cuartil. |
Clase ima.AdInfo
Campos
Métodos
Contiene información sobre un anuncio. El SDK las pasa a las devoluciones de llamada de eventos.
Propiedades
Nombre | Tipo | Descripción |
---|---|---|
adBreakInfo |
|
Es la información relacionada con la pausa completa 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 definido por 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. |
universalAdIDRegistry |
|
Es una cadena que se usa para identificar la URL del sitio web de registro donde 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 interior. |
createAdInfo()
Devuelve ima.AdInfo
:
Clase ima.Companion
Campos
Métodos
Contiene información sobre los anuncios complementarios de un anuncio.
Propiedades
Nombre | Tipo | Descripción |
---|---|---|
apiFramework |
|
La API necesaria para ejecutar este anuncio o No válido si no está disponible. |
creativeType |
|
Representa el tipo de creatividad, que suele ser un tipo MIME. |
height |
|
Es la altura del elemento 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 |
|
Es la URL del recurso estático de este complemento. |
width |
|
Es el ancho del elemento complementario en píxeles. 0 si no está disponible. |
createCompanion()
Devuelve ima.Companion
:
Clase ima.CuePoint
Campos
Métodos
Contiene información sobre un punto de inserción.
Propiedades
Nombre | Tipo | Descripción |
---|---|---|
end |
|
Hora de finalización de un punto de inserción en segundos. Esto corresponde a una pausa publicitaria. |
hasPlayed |
|
Es un valor booleano que indica que ya se reprodujo el punto de inserción. |
start |
|
Hora de inicio de un punto de inserción en segundos. Esto corresponde a una pausa publicitaria. |
createCuePoint()
Devuelve ima.CuePoint
:
Clase ima.Error
Campos
Métodos
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()
Devuelve ima.Error
:
Clase ima.ErrorEvent
Campos
Todos los errores que el SDK pueda devolver.
Propiedades
Nombre | Tipo | Descripción |
---|---|---|
BAD_STREAM_REQUEST |
|
La solicitud de transmisión no se propagó correctamente. |
COULD_NOT_LOAD_STREAM |
|
No se pudieron cargar las Novedades. |
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. |
Clase ima.Player
Métodos
adBreakEnded(adBreakInfo)
Opcional. Se llama cuando finaliza 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 de IMA Player
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 comienza 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. |
Clase ima.StreamFormat
Campos
Define el formato de la transmisión.
Propiedades
Nombre | Tipo | Descripción |
---|---|---|
DASH |
|
|
HLS |
|
Clase ima.StreamInfo
Campos
Métodos
Información que se pasa del SDK al reproductor sobre la transmisión.
Propiedades
Nombre | Tipo | Descripción |
---|---|---|
format |
|
El formato del video: hls o raya Se define en ima.StreamFormat. |
manifest |
|
URL de la transmisión. |
streamId |
|
Un ID único para la transmisión. |
streamType |
|
Indica 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 será válido. |
createStreamInfo()
Devuelve ima.StreamInfo
:
Clase ima.StreamManager
Métodos
Objeto para administrar la reproducción de transmisión.
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)
Devuelve ima.StreamManager
:
Parámetro | Tipo | Descripción |
---|---|---|
streamRequest |
ima.StreamRequest |
|
streamInitResponse |
ima.StreamInitResponse |
enableInteractiveAds()
No se admite. En su lugar, deben pasar los datos del anuncio complementario al RAF directamente.
Esto es ahora una operación no.
getContentTime(streamTime)
Obtiene la hora 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 del tiempo de transmisión actual en -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 la transmisión. |
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 anterior a esta hora. 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. Se muestra
No válido si no hay un punto de inserción disponible.
Parámetro | Tipo | Descripción |
---|---|---|
time |
Float |
El tiempo para buscar; -1 indica la hora actual. |
getStreamTime(contentTime)
Obtiene el tiempo de la transmisión a partir del tiempo de contenido de VOD en milisegundos.
Consulta: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq
Muestra Integer
: Es el tiempo 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 proporcionados de streamManifestUrl
y streamSubtitle
. 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 |
Es la URL del manifiesto de la transmisión con anuncios unidos. |
streamSubtitle |
ifArray |
Los subtítulos asociados con la transmisión o |
onMessage(msg)
Controla todos los mensajes provenientes del objeto Video.
Se debe llamar para cada mensaje recibido en el roMessagePort.
Parámetro | Tipo | Descripción |
---|---|---|
msg |
object |
Es el mensaje del puerto roVideo. |
replaceAdTagParameters(adTagParameters)
Reemplaza todos los parámetros de la etiqueta de anuncio que se usarán en las próximas solicitudes de anuncios para una transmisión en vivo. Ten en cuenta que esta llamada no es operativa para transmisiones de VOD.
Parámetro | Tipo | Descripción |
---|---|---|
adTagParameters |
string |
Parámetros de la nueva etiqueta de anuncio |
start()
Inicia la reproducción de la transmisión.
Clase ima.StreamRequest
Campos
Métodos
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. Proporciona parámetros de segmentación al flujo para obtener más información. También puedes usar los parámetros Dai-ot y Dai-ov para elegir la preferencia de variante de transmisión. Consulta Cómo anular parámetros de variantes de transmisión para obtener más información. |
adUiNode |
|
Un nodo de gráfico de escena donde se muestra la IU del anuncio El 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 DoubleClick. |
assetKey |
|
Obligatorio 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 encuentra en la IU de DoubleClick. |
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 autorizaciones de transmisiones de contenido individuales basadas en este token. |
contentSourceId |
|
Obligatorio para las transmisiones on demand. El cmsid proviene de la fuente del contenido de video de DoubleClick en la IU de DoubleClick. |
customAssetKey |
|
La clave del activo personalizada se usa para determinar qué transmisión se debe reproducir. Las claves de recursos personalizadas son obligatorias para las solicitudes de transmisión de la entrega de Pods. |
format |
|
El formato de la transmisión. La configuración predeterminada es |
networkCode |
|
El código de red del publicador que realiza la solicitud de transmisión. Los códigos de red son obligatorios para los Pods que entregan solicitudes de transmisión. |
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 DoubleClick Audience. |
streamActivityMonitorId |
|
Es el ID que se usa para depurar la transmisión con el supervisor de actividad de transmisión. Esto 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 obtener varios datos que se usarán para sincronizar correctamente los eventos de HLS ID3 en vivo. |
createLiveStreamRequest(assetKey, apiKey)
Inicializa las propiedades requeridas de un StreamRequest
activo. El uso de esta API hace que se ignore cualquier otra propiedad específica de StreamType
.
Si alguno de los parámetros necesarios son strings vacías, se produce un registro de errores, y la API muestra un StreamRequest
genérico, sin ignorar las propiedades.
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 |
createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)
Inicializa las propiedades requeridas de un Pod activo ima.StreamRequest
.
El uso de esta API hace que se ignore cualquier otra propiedad específica de ima.StreamType
.
Si alguno de los parámetros necesarios son strings vacías, se produce un registro de errores, y la API muestra un StreamRequest
genérico, sin ignorar las propiedades.
Muestra StreamRequest
: objeto ima.StreamRequest
con las propiedades de PodLive requeridas.
Parámetro | Tipo | Descripción |
---|---|---|
customAssetKey |
string |
|
networkCode |
string |
|
apiKey |
string |
Parámetro opcional que se asignará a la propiedad |
createPodVodStreamRequest(networkCode)
Inicializa las propiedades requeridas de un ima.StreamRequest
para registrar una transmisión de VOD cuando se usa la publicación de un Pod 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 para los datos faltantes. Las validaciones con errores 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 requeridas de un StreamRequest
en vivo de Video Stitcher. El uso de esta API hace que se ignore cualquier otra propiedad específica de StreamType
.
Si alguno de los parámetros necesarios son strings vacías, se produce un registro de errores, y la API muestra un StreamRequest
genérico, sin ignorar las propiedades.
Muestra ima.StreamRequest
: un objeto ima.StreamRequest
con las propiedades de VideoStitcherLive obligatorias.
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 obligatorias de un VOD de Video Stitcher
StreamRequest
. El uso de esta API hace que se ignore cualquier otra propiedad específica de StreamType
.
Si alguno de los parámetros necesarios son strings vacías, se produce un registro de errores, y la API muestra un StreamRequest
genérico, sin ignorar las propiedades.
Muestra ima.StreamRequest
: un objeto ima.StreamRequest
con las propiedades requeridas de VideoStitcherVod.
Parámetro | Tipo | Descripción |
---|---|---|
adTagUrl |
string |
|
networkCode |
string |
|
contentSourceUrl |
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 ignore cualquier otra propiedad específica de ima.StreamType
.
Si alguno de los parámetros necesarios son strings vacías, se produce un registro de errores, y la API muestra un StreamRequest
genérico, sin ignorar las propiedades.
Muestra un objeto ima.StreamRequest
: ima.StreamRequest
con las propiedades de VOD obligatorias.
Parámetro | Tipo | Descripción |
---|---|---|
contentSourceId |
string |
|
videoId |
string |
|
apiKey |
string |
Parámetro opcional que se asignará a la propiedad |
Clase ima.StreamType
Campos
Define el tipo de transmisión que se le solicita al reproductor que reproduzca. Los anuncios previos al video y VOD deben reproducirse desde el inicio de la transmisión.
Propiedades
Nombre | Tipo | Descripción |
---|---|---|
LIVE |
|
El video está en vivo. |
VOD |
|
El video es on demand. |
Clase ima.WrapperInfo
Campos
Métodos
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 de 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()
Devuelve ima.WrapperInfo
: