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()


Muestra string:

getAdPodInfo()


Muestra google.ima.dai.api.AdPodInfo:

getAdSystem()


Muestra string:

getAdvertiserName()


Muestra string:

getApiFramework()


Muestra string:

getCompanionAds()


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

getCreativeAdId()


Muestra string:

getCreativeId()


Muestra string:

getDealId()


Muestra string:

getDescription()


Muestra string:

getDuration()


Muestra number:

getTitle()


Muestra string:

getVastMediaHeight()


Muestra number:

getVastMediaWidth()


Muestra number:

getWrapperAdIds()


Muestra Array.<string>:

getWrapperAdSystems()


Muestra Array.<string>:

getWrapperCreativeIds()


Muestra 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()


Muestra number:

getMaxDuration()


Muestra number:

getPodIndex()


Muestra number:

getTimeOffset()


Muestra number:

getTotalAds()


Muestra 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()


Muestra string:

getContent()


Muestra string:

getContentType()


Muestra string:

getHeight()


Muestra number:

getWidth()


Muestra 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 transmisiones de DAI VOD.

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

Una clase para especificar las 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 de recurso 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 los datos de transmisión.

Propiedades

Nombre Tipo Descripción
adProgressData

Información relacionada con los tiempos para el anuncio que se está reproduciendo actualmente
cuepoints

Son los puntos de inserción de anuncios para la transmisión on demand. Es posible que cambien a medida que progrese la transmisión. Esto solo se propagará en el objeto de escucha de eventos de AdEvent CUEPOINTS_CHANGED.
errorMessage

streamId

subtitles

url

Clase google.ima.dai.api.StreamEvent

Métodos

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

getAd()


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

getStreamData()


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

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

Campos

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 o se presiona el elemento de clic mientras se reproduce un anuncio.
COMPLETE

Se activa cuando se completa un anuncio.
CUEPOINTS_CHANGED

Se despacha para las 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 alcanza 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 cuartil.

Clase google.ima.dai.api.StreamManager

Métodos

Controla 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 el reenvío de eventos de transmisión y de anuncios al publicador. Este administrador no hereda contenido de BaseAdsManager, ya que no es un administrador de un anuncio específico, sino de toda la transmisión.

Constructor:
Parámetro Tipo Descripción
videoElement HTMLVideoElement

Es el elemento del reproductor de video en sí.

contentTimeForStreamTime(streamTime)

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

Muestra number: La hora del contenido que corresponde al tiempo de transmisión determinado una vez que se quitan los anuncios.

Parámetro Tipo Descripción
streamTime number

el tiempo de transmisión con los 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 el reproductor proporciona metadatos sin procesar, llama a ima.dai.api.StreamManager.processMetadata en su lugar.

Parámetro Tipo Descripción
metadata Object

El diccionario de metadatos.

previousCuePointForStreamTime(streamTime)

Muestra el punto de inserción anterior para el tiempo de transmisión determinado. El resultado es nulo si no existe el punto de inserción. Se usa para implementar funciones, como el ajuste automático, y se llama cuando el publicador detecta que el usuario realizó una búsqueda para volver a una pausa publicitaria.

Muestra google.ima.dai.api.CuePoint: el punto de inserción anterior para el tiempo de transmisión determinado.

Parámetro Tipo Descripción
streamTime number

el tiempo de transmisión que se buscó.

processMetadata(type, data, timestamp)

Procesa metadatos temporizados para las transmisiones en vivo. Úsala si el 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

Tipo para los metadatos. Debe ser "ID3".
data Uint8Array

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

Tiempo durante el cual 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 en los anuncios. Este elemento se utiliza como receptor de clics o de presión mientras se reproduce un anuncio y puede hacer que salgas de la página actual.

Parámetro Tipo Descripción
clickElement Element

el elemento utilizado cuando se hace clic en el anuncio.

streamTimeForContentTime(contentTime)

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

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

Parámetro Tipo Descripción
contentTime number

el tiempo del contenido sin anuncios (en segundos).

Clase google.ima.dai.api.StreamRequest

Campos

Es una clase para especificar las 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. Proporciona parámetros de segmentación a tu transmisión para obtener más información. Puede usar los parámetros dai-ot y dai-ov para elegir la preferencia de las variantes de transmisión. Consulta Anula los parámetros de las 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 para administradores de DFP y se proporciona al editor para que desbloquee su contenido. Verifica las aplicaciones que intentan acceder al contenido.
streamActivityMonitorId

El ID que se usará 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.

Clase google.ima.dai.api.VODStreamRequest

Campos

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

Propiedades

Nombre Tipo Descripción
contentSourceId

Es el identificador único para el contenido del publicador, de un CMS. Obligatorio para las transmisiones a pedido.
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.