API du SDK IMA 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

Classe google.ima.dai.api.Ad

Méthodes

Classe représentant un objet d'annonce lors de l'insertion d'annonces dynamiques. Cette classe expose un sous-ensemble des propriétés ima.Ad.

getAdId()


Renvoie string:

getAdPodInfo()


Renvoie google.ima.dai.api.AdPodInfo:

getAdSystem()


Renvoie string:

getAdvertiserName()


Renvoie string:

getApiFramework()


Renvoie string:

getCompanionAds()


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

getCreativeAdId()


Renvoie string:

getCreativeId()


Renvoie string:

getDealId()


Renvoie string:

getDescription()


Renvoie string:

getDuration()


Renvoie number:

getTitle()


Renvoie string:

getVastMediaHeight()


Renvoie number:

getVastMediaWidth()


Renvoie number:

getWrapperAdIds()


Renvoie Array.<string>:

getWrapperAdSystems()


Renvoie Array.<string>:

getWrapperCreativeIds()


Renvoie Array.<string>:

Classe google.ima.dai.api.AdPodInfo

Méthodes

Classe représentant un objet d'informations sur le bloc d'annonces lors de l'insertion d'annonces dynamiques. Cette classe expose un sous-ensemble des propriétés ima.AdPodInfo.

getAdPosition()


Renvoie number:

getMaxDuration()


Renvoie number:

getPodIndex()


Renvoie number:

getTimeOffset()


Renvoie number:

getTotalAds()


Renvoie number:

Classe google.ima.dai.api.AdProgressData

Fields

Classe permettant de spécifier les données de progression des annonces.

Propriétés

Nom Type Description
adBreakDuration

adPosition

currentTime

duration

totalAds

Classe google.ima.dai.api.CompanionAd

Méthodes

Classe représentant un objet d'annonce associée lors de l'insertion d'annonces dynamiques. Cette classe expose un sous-ensemble des propriétés ima.CompanionAd.

getAdSlotId()


Renvoie string:

getContent()


Renvoie string:

getContentType()


Renvoie string:

getHeight()


Renvoie number:

getWidth()


Renvoie number:

Classe google.ima.dai.api.CuePoint

Fields

Classe permettant de spécifier les propriétés d'un repère, qui représente une coupure publicitaire dans les flux VOD DAI.

Propriétés

Nom Type Description
end

Heure de fin de ce point de repère.
played

Indique si ce point de repère a été lu.
start

Heure de début de ce repère.

Classe google.ima.dai.api.LiveStreamRequest

Fields

Classe permettant de spécifier les propriétés de la requête de diffusion en direct.

Constructeur:
Paramètre Type Description
opt_liveStreamRequest Object

objet auquel des propriétés de requête de flux sont déjà attribuées.

Propriétés

Nom Type Description
assetKey

Il permet de déterminer le flux à lire. La clé d'élément de la requête de diffusion en direct est un identifiant que vous pouvez trouver dans l'interface utilisateur de DFP.

Classe google.ima.dai.api.StreamData

Fields

Classe permettant de spécifier des données de flux.

Propriétés

Nom Type Description
adProgressData

Informations sur le timing de l'annonce en cours de lecture.
cuepoints

Cuepoints d'annonce pour le flux à la demande. Ceux-ci peuvent changer au fur et à mesure que le flux avance. Cette valeur ne sera renseignée que dans l'écouteur d'événements pour AdEventCUEPOINTS_CHANGED.
errorMessage

streamId

subtitles

url

Classe google.ima.dai.api.StreamEvent

Méthodes

Ce type d'événement est généré par le gestionnaire de flux en tant que notification lorsque l'état du flux change.

getAd()


Renvoie google.ima.dai.api.Ad:objet de retour avec des informations sur l'annonce.

getStreamData()


Renvoie google.ima.dai.api.StreamData:objet de retour avec des informations sur le flux.

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

Fields

Liste des types d'événements compatibles avec le SDK IMA.

Valeurs

Valeur Description
AD_BREAK_ENDED

Déclenché à la fin d'une coupure publicitaire
AD_BREAK_STARTED

Déclenché au début d'une coupure publicitaire
AD_PROGRESS

Déclenché lorsqu'une annonce est mise à jour
CLICK

Distribué lorsque l'utilisateur clique ou appuie sur l'élément de clic pendant la lecture d'une annonce.
COMPLETE

Déclenché à la fin d'une annonce.
CUEPOINTS_CHANGED

Distribué pour les flux à la demande lorsque les repères changent.
ERROR

Déclenché lorsqu'une erreur se produit.
FIRST_QUARTILE

Déclenché lorsqu'une annonce atteint son premier quartile.
LOADED

Déclenché lorsque le fichier manifeste du flux est disponible.
MIDPOINT

Déclenché lorsqu'une annonce atteint son point médian
STARTED

Déclenché au début d'une annonce
STREAM_INITIALIZED

Déclenché lorsque le flux est initialisé.
THIRD_QUARTILE

Déclenché lorsqu'une annonce atteint son troisième quartile.

Classe google.ima.dai.api.StreamManager

Méthodes

Gère les flux d'insertion dynamique d'annonces. Il gère les interactions avec le backend DAI et les pings de suivi, ainsi que la transmission des flux et des événements d'annonces à l'éditeur. Ce gestionnaire n'hérite pas de BaseAdsManager, car il ne s'agit pas d'un gestionnaire pour une annonce spécifique, mais pour l'ensemble du flux.

Constructeur:
Paramètre Type Description
videoElement HTMLVideoElement

Élément du lecteur vidéo

contentTimeForStreamTime(streamTime)

Indique la durée du contenu sans annonces pour un temps de diffusion donné. Renvoie l'heure de diffusion donnée pour les diffusions en direct.

Renvoie number:durée du contenu correspondant à l'heure de diffusion donnée une fois les annonces supprimées.

Paramètre Type Description
streamTime number

la durée de la diffusion avec les annonces insérées (en secondes).

onTimedMetadata(metadata)

Transmet un dictionnaire de métadonnées traitées. Le dictionnaire attend la clé "TXXX" avec la chaîne de métadonnées définie par l'utilisateur comme valeur. Si votre lecteur fournit des métadonnées brutes, appelez plutôt ima.dai.api.StreamManager.processMetadata.

Paramètre Type Description
metadata Object

Dictionnaire de métadonnées.

previousCuePointForStreamTime(streamTime)

Renvoie le point de repère précédent pour l'heure de flux donnée. Renvoie la valeur "null" si aucun point de repère de ce type n'existe. Cette méthode permet d'implémenter des fonctionnalités telles que le retour en arrière et est appelée lorsque l'éditeur détecte que l'utilisateur a effectué une recherche afin de le renvoyer à une coupure publicitaire.

Renvoie google.ima.dai.api.CuePoint:le point de repère précédent pour le temps de diffusion donné.

Paramètre Type Description
streamTime number

L'heure du flux à laquelle la recherche a été effectuée.

processMetadata(type, data, timestamp)

Traite les métadonnées temporelles pour les diffusions en direct. À utiliser si votre lecteur vidéo fournit des métadonnées non analysées avec des codes temporels. Sinon, appelez ima.dai.api.StreamManager.onTimedMetadata.

Paramètre Type Description
type string

Type de métadonnées. Doit être "ID3".
data Uint8Array

Données de balise brutes. Pour ID3, il doit s'agir de la balise entière.
timestamp number

Heure à laquelle les données doivent être traitées.

requestStream(streamRequest)

Demande le chargement d'un flux à l'aide des paramètres de flux fournis.

Paramètre Type Description
streamRequest google.ima.dai.api.StreamRequest

contient des paramètres pour charger les métadonnées de flux.

setClickElement(clickElement)

Définit l'élément de clic sur les annonces. Cet élément est utilisé comme récepteur de clic ou de pression pendant la lecture d'une annonce et peut entraîner la navigation vers une autre page.

Paramètre Type Description
clickElement Element

l'élément utilisé comme clic sur l'annonce.

streamTimeForContentTime(contentTime)

Indique l'heure de diffusion avec les annonces pour un temps de contenu donné. Renvoie l'heure du contenu donné pour les diffusions en direct.

Renvoie number:heure de diffusion correspondant à l'heure du contenu donné une fois les annonces insérées.

Paramètre Type Description
contentTime number

la durée du contenu sans aucune annonce (en secondes).

Classe google.ima.dai.api.StreamRequest

Fields

Classe permettant de spécifier les propriétés de la requête de flux.

Propriétés

Nom Type Description
adTagParameters

Vous pouvez remplacer un ensemble limité de paramètres de balise publicitaire dans votre demande de flux. Pour en savoir plus, consultez Indiquer des paramètres de ciblage dans votre flux. Vous pouvez utiliser les paramètres dai-ot et dai-ov pour définir la préférence de variante de flux. Pour en savoir plus, consultez la section Remplacer les paramètres de variantes de flux.
apiKey

Clé API de la requête de flux. Il est configuré via l' interface utilisateur d'administration DFP et fourni à l'éditeur pour déverrouiller son contenu. Il vérifie les applications qui tentent d'accéder au contenu.
streamActivityMonitorId

ID à utiliser pour déboguer le flux avec le contrôleur de l'activité des flux. Il s'agit d'un moyen pratique de permettre aux éditeurs de trouver un journal de flux dans l'outil de surveillance de l'activité des flux.

Classe google.ima.dai.api.VODStreamRequest

Fields

Classe permettant de spécifier les propriétés de la requête de flux de vidéo à la demande.

Constructeur:
Paramètre Type Description
opt_VODStreamRequest Object

objet auquel des propriétés de requête de flux sont déjà attribuées.

Propriétés

Nom Type Description
contentSourceId

Identifiant unique du contenu de l'éditeur, à partir d'un CMS. Obligatoire pour les diffusions à la demande.
videoId

Identifiant de la source de contenu vidéo. Obligatoire pour les diffusions à la demande.

Constante google.ima.VERSION

Chaîne contenant la version complète du SDK.