API del SDK de IMA de DAI de Google

    1. google.ima.dai.api.Ad
    2. google.ima.dai.api.AdPodInfo
    3. google.ima.dai.api.AdProgressData
    4. google.ima.dai.api.CompanionAd
    5. google.ima.dai.api.CuePoint
    6. google.ima.dai.api.LiveStreamRequest
    7. google.ima.dai.api.StreamData
    8. google.ima.dai.api.StreamEvent
    9. google.ima.dai.api.StreamEvent.Type
    10. google.ima.dai.api.StreamManager
    11. google.ima.dai.api.StreamRequest
    12. google.ima.dai.api.VODStreamRequest
    13. google.ima.VERSION

Clase google.ima.dai.api.Ad

Métodos

Clase que representa un objeto de anuncio durante la inserción de anuncios dinámicos. Esta clase expone un subconjunto de las propiedades de ima.Ad.

getAdId()


Devoluciones string:

getAdPodInfo()


Devoluciones google.ima.dai.api.AdPodInfo:

getAdSystem()


Devoluciones string:

getAdvertiserName()


Devoluciones string:

getApiFramework()


Devoluciones string:

getCompanionAds()


Devoluciones Array.<google.ima.dai.api.CompanionAd>:

getCreativeAdId()


Devoluciones string:

getCreativeId()


Devoluciones string:

getDealId()


Devoluciones string:

getDescription()


Devoluciones string:

getDuration()


Devoluciones number:

getTitle()


Devoluciones string:

getVastMediaHeight()


Devoluciones number:

getVastMediaWidth()


Devoluciones number:

getWrapperAdIds()


Devoluciones Array.<string>:

getWrapperAdSystems()


Devoluciones Array.<string>:

getWrapperCreativeIds()


Devoluciones Array.<string>:

Clase google.ima.dai.api.AdPodInfo

Métodos

Clase que representa un objeto de información del pod de anuncios durante la inserción dinámica de anuncios. Esta clase expone un subconjunto de las propiedades de ima.AdPodInfo.

getAdPosition()


Devoluciones number:

getMaxDuration()


Devoluciones number:

getPodIndex()


Devoluciones number:

getTimeOffset()


Devoluciones number:

getTotalAds()


Devoluciones number:

Clase google.ima.dai.api.AdProgressData

Campos

Es una clase para especificar datos de progreso del anuncio.

Propiedades

Nombre Tipo Descripción
adBreakDuration

adPosition

currentTime

duration

totalAds

Clase google.ima.dai.api.CompanionAd

Métodos

Clase que representa un objeto de anuncio complementario durante la inserción de anuncios dinámicos. Esta clase expone un subconjunto de las propiedades de ima.CompanionAd.

getAdSlotId()


Devoluciones string:

getContent()


Devoluciones string:

getContentType()


Devoluciones string:

getHeight()


Devoluciones number:

getWidth()


Devoluciones number:

Clase google.ima.dai.api.CuePoint

Campos

Clase para especificar las propiedades de un punto de referencia, que representa una pausa publicitaria en las transmisiones de VOD de DAI.

Propiedades

Nombre Tipo Descripción
end

Hora de finalización de este punto de referencia.
played

Indica si se reprodujo este punto de referencia.
start

Es la hora de inicio de este punto de referencia.

Clase google.ima.dai.api.LiveStreamRequest

Campos

Clase para especificar propiedades de la solicitud de transmisión en vivo.

Constructor:
Parámetro Tipo Descripción
opt_liveStreamRequest Object

Objeto que ya tiene propiedades de solicitud de transmisión asignadas.

Propiedades

Nombre Tipo Descripción
assetKey

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.

Clase google.ima.dai.api.StreamData

Campos

Es una clase para especificar datos de transmisión.

Propiedades

Nombre Tipo Descripción
adProgressData

Es la información relacionada con la sincronización del anuncio que se está reproduciendo.
cuepoints

Son los puntos de inserción de anuncios para la transmisión a pedido. Estos datos pueden cambiar a medida que avanza la transmisión. Este campo solo se completará en el objeto de escucha de eventos para CUEPOINTS_CHANGED AdEvent.
errorMessage

streamId

subtitles

url

Clase google.ima.dai.api.StreamEvent

Métodos

El administrador de transmisiones genera este tipo de evento como una notificación cuando cambia el estado de la transmisión.

getAd()


Devuelve google.ima.dai.api.Ad: Objeto de devolución con información del anuncio.

getStreamData()


Devuelve google.ima.dai.api.StreamData: Objeto de devolución con información de transmisión.

Enum google.ima.dai.api.StreamEvent.Type

Campos

Lista de los tipos de eventos que admite el SDK de IMA.

Valores

Valor Descripción
AD_BREAK_ENDED

Se activa cuando finaliza una pausa publicitaria.
AD_BREAK_STARTED

Se activa cuando comienza una pausa publicitaria.
AD_PROGRESS

Se activa cuando se actualiza el progreso de un anuncio.
CLICK

Se envía cuando se hace clic en el elemento de clic o se presiona mientras se reproduce un anuncio.
COMPLETE

Se activa cuando se completa un anuncio.
CUEPOINTS_CHANGED

Se envía para las transmisiones a pedido cuando cambian los puntos de referencia.
ERROR

Se activa cuando se produce un error.
FIRST_QUARTILE

Se activa cuando un anuncio alcanza su primer cuartil.
LOADED

Se activa cuando el manifiesto de la transmisión está disponible.
MIDPOINT

Se activa cuando un anuncio llega a su punto medio.
STARTED

Se activa cuando comienza un anuncio.
STREAM_INITIALIZED

Se activa cuando se inicializa la transmisión.
THIRD_QUARTILE

Se activa cuando un anuncio llega a su tercer cuartil.

Clase google.ima.dai.api.StreamManager

Métodos

Controla los flujos de inserción de anuncios dinámicos. Administra las interacciones con el backend de la DAI y controla los pings de seguimiento, además de reenviar los eventos de anuncios y transmisiones al publicador. Este administrador no hereda de BaseAdsManager, ya que no es un administrador para un anuncio específico, sino para toda la transmisión.

Constructor:
Parámetro Tipo Descripción
videoElement HTMLVideoElement

Es el elemento del reproductor de video real.

contentTimeForStreamTime(streamTime)

Devuelve el tiempo de contenido sin anuncios para un tiempo de transmisión determinado. Devuelve el tiempo de transmisión determinado para las transmisiones en vivo.

Devuelve number: El tiempo de contenido que corresponde al tiempo de transmisión determinado una vez que se quitan los anuncios.

Parámetro Tipo Descripción
streamTime number

Es el tiempo de transmisión con anuncios insertados (en segundos).

onTimedMetadata(metadata)

Pasa un diccionario de metadatos procesados. El diccionario espera la clave "TXXX" con la cadena de metadatos definida por el usuario como valor. Si tu reproductor proporciona metadatos sin procesar, llama a ima.dai.api.StreamManager.processMetadata.

Parámetro Tipo Descripción
metadata Object

Es el diccionario de metadatos.

previousCuePointForStreamTime(streamTime)

Devuelve el punto de referencia anterior para el tiempo de transmisión determinado. Devuelve nulo si no existe tal punto de referencia. Se usa para implementar funciones como la de volver a la posición original y se llama cuando el publicador detecta que el usuario buscó para volver a un corte publicitario.

Devuelve google.ima.dai.api.CuePoint: El punto de referencia anterior para el tiempo de transmisión determinado.

Parámetro Tipo Descripción
streamTime number

Es el tiempo de transmisión al que se buscó.

processMetadata(type, data, timestamp)

Procesa metadatos cronometrados para transmisiones en vivo. Úsalo si tu reproductor de video proporciona metadatos sin analizar junto con marcas de tiempo. De lo contrario, llama a ima.dai.api.StreamManager.onTimedMetadata.

Parámetro Tipo Descripción
type string

Es el tipo de metadatos. Debe ser "ID3".
data Uint8Array

Son los datos de etiquetas sin procesar. En el caso de ID3, debe ser la etiqueta completa.
timestamp number

Fecha y hora en que se deben procesar los datos.

requestStream(streamRequest)

Solicita que se cargue una transmisión con los parámetros proporcionados.

Parámetro Tipo Descripción
streamRequest google.ima.dai.api.StreamRequest

Contiene parámetros para cargar los metadatos de la transmisión.

setClickElement(clickElement)

Establece el elemento de clic de los anuncios. Este elemento se usa como receptor de clics o toques mientras se reproduce un anuncio y puede provocar la navegación fuera de la página actual.

Parámetro Tipo Descripción
clickElement Element

Es el elemento que se usa como clic en el anuncio.

streamTimeForContentTime(contentTime)

Devuelve el tiempo de transmisión con anuncios para un tiempo de contenido determinado. Devuelve el tiempo de contenido determinado para las transmisiones en vivo.

Devuelve number: El tiempo de transmisión que corresponde al tiempo de contenido determinado una vez que se insertan los anuncios.

Parámetro Tipo Descripción
contentTime number

El tiempo de contenido sin anuncios (en segundos).

Clase google.ima.dai.api.StreamRequest

Campos

Es una clase para especificar propiedades de la solicitud de transmisión.

Propiedades

Nombre Tipo Descripción
adTagParameters

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. 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.
apiKey

Es la clave de API de la solicitud de transmisión. Se configura a través de la IU de administrador de DFP y se proporciona al editor para que desbloquee su contenido. Verifica las aplicaciones que intentan acceder al contenido.
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.

Clase google.ima.dai.api.VODStreamRequest

Campos

Clase para especificar las propiedades de la solicitud de transmisión de VOD.

Constructor:
Parámetro Tipo Descripción
opt_VODStreamRequest Object

objeto que ya tiene propiedades de solicitud de transmisión asignadas.

Propiedades

Nombre Tipo Descripción
contentSourceId

Es el identificador único del contenido del publicador, proveniente de un CMS. Obligatorio para las transmisiones a pedido.
videoId

Es el identificador de la fuente de contenido de video. Obligatorio para las transmisiones a pedido.

Constante google.ima.VERSION

Es una cadena que contiene la versión completa del SDK.