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

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

getAdId()


Devuelve string:

getAdPodInfo()


Devuelve google.ima.dai.api.AdPodInfo:

getAdSystem()


Devuelve string:

getAdvertiserName()


Devuelve string:

getApiFramework()


Devuelve string:

getCompanionAds()


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

getCreativeAdId()


Devuelve string:

getCreativeId()


Devuelve string:

getDealId()


Devuelve string:

getDescription()


Devuelve string:

getDuration()


Devuelve number:

getTitle()


Devuelve string:

getVastMediaHeight()


Devuelve number:

getVastMediaWidth()


Devuelve number:

getWrapperAdIds()


Devuelve Array.<string>:

getWrapperAdSystems()


Devuelve Array.<string>:

getWrapperCreativeIds()


Devuelve Array.<string>:

Clase google.ima.dai.api.AdPodInfo

Métodos

Es una clase que representa un objeto de información de grupo de anuncios durante la inserción de anuncios dinámicos. Esta clase expone un subconjunto de las propiedades ima.AdPodInfo.

getAdPosition()


Devuelve number:

getMaxDuration()


Devuelve number:

getPodIndex()


Devuelve number:

getTimeOffset()


Devuelve number:

getTotalAds()


Devuelve 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

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

getAdSlotId()


Devuelve string:

getContent()


Devuelve string:

getContentType()


Devuelve string:

getHeight()


Devuelve number:

getWidth()


Devuelve number:

Clase google.ima.dai.api.CuePoint

Campos

Es una clase para especificar las propiedades de un punto de inserción, que representa una pausa publicitaria en las transmisiones de VOD de DAI.

Propiedades

Nombre Tipo Descripción
end

Es la hora de finalización de este punto de inserción.
played

Indica si se reprodujo este punto de inserción.
start

Es la hora de inicio de este punto de inserción.

Clase google.ima.dai.api.LiveStreamRequest

Campos

Es una 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 asignadas propiedades de solicitud de transmisión.

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

Propiedades

Nombre Tipo Descripción
adProgressData

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

Son los puntos de inserción de anuncios para la transmisión on demand. Estos pueden cambiar a medida que avanza la transmisión. Esto solo se propagará en el objeto de escucha de eventos para el AdEvent CUEPOINTS_CHANGED.
errorMessage

streamId

subtitles

url

Clase google.ima.dai.api.StreamEvent

Métodos

El administrador de flujos genera este tipo de evento como una notificación cuando cambia el estado del flujo.

getAd()


Devuelve google.ima.dai.api.Ad: Devuelve un objeto con información del anuncio.

getStreamData()


Devuelve google.ima.dai.api.StreamData: Devuelve un objeto con información de la transmisión.

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

Campos

Es la lista de 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 hay una actualización del 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ían para transmisiones on demand cuando cambian los puntos de inserción.
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 se inicia un anuncio.
STREAM_INITIALIZED

Se activa cuando se inicializa la transmisión.
THIRD_QUARTILE

Se activa cuando un anuncio alcanza su tercer cuarto.

Clase google.ima.dai.api.StreamManager

Métodos

Controla las transmisiones de inserción de anuncios dinámicos. Administra las interacciones con el backend de la DAI y controla los pings de seguimiento, así como la transmisión y el reenvío de eventos de anuncios al publicador. Este administrador no hereda de BaseAdsManager, ya que no es un administrador de un anuncio específico, sino de todo el flujo.

Constructor:
Parámetro Tipo Descripción
videoElement HTMLVideoElement

Es el elemento del reproductor de video real.

contentTimeForStreamTime(streamTime)

Muestra la duración del contenido sin anuncios para una hora de transmisión determinada. Muestra el tiempo de transmisión determinado para las transmisiones en vivo.

Devuelve number: el tiempo de contenido que corresponde con la hora de transmisión determinada una vez que se quitan los anuncios.

Parámetro Tipo Descripción
streamTime number

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

El diccionario de metadatos.

previousCuePointForStreamTime(streamTime)

Devuelve el punto de inserción anterior para la hora de transmisión determinada. Muestra un valor nulo si no existe un punto de inserción de ese tipo. Se usa para implementar funciones como el retroceso y se llama cuando el publicador detecta que el usuario realizó un salto para regresar a una pausa publicitaria.

Devuelve google.ima.dai.api.CuePoint: el punto de inserción anterior para la hora de transmisión determinada.

Parámetro Tipo Descripción
streamTime number

la hora de la transmisión a la que se avanzó

processMetadata(type, data, timestamp)

Procesa metadatos sincronizados para las 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

Datos de etiquetas sin procesar. Para ID3, debe ser la etiqueta completa.
timestamp number

Es la hora en la que se deben procesar los datos.

requestStream(streamRequest)

Solicita que se cargue una transmisión con los parámetros de transmisión 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 clics de los anuncios. Este elemento se usa como receptor de clics o toques mientras se reproduce un anuncio y puede provocar que se salga de la página actual.

Parámetro Tipo Descripción
clickElement Element

el elemento que se usa como clic en el anuncio

streamTimeForContentTime(contentTime)

Muestra la duración de la transmisión con anuncios para un tiempo de contenido determinado. Devuelve la duración del contenido determinada 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 la etiqueta de anuncio en tu solicitud de transmisión. En Cómo proporcionar parámetros de segmentación a tus novedades, encontrarás más información. Puedes usar los parámetros dai-ot y dai-ov para la preferencia de variante de transmisión. Consulta Anula los parámetros de variantes de transmisión para obtener más información.
apiKey

La clave de API de la solicitud de transmisión. Se configura a través de la IU de administrador de DFP y se le proporciona al publicador para desbloquear 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 actividad de transmisión.

Clase google.ima.dai.api.VODStreamRequest

Campos

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

Constructor:
Parámetro Tipo Descripción
opt_VODStreamRequest Object

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

Propiedades

Nombre Tipo Descripción
contentSourceId

Es el identificador único del contenido del publicador, de un CMS. Obligatorio para las transmisiones on demand.
videoId

Es el identificador de la fuente del contenido de video. Obligatorio para las transmisiones on demand.

Constante google.ima.VERSION

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