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

Class google.ima.dai.api.Ad

Méthodes

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

getAdId()


Retours string :

getAdPodInfo()


Retours google.ima.dai.api.AdPodInfo :

getAdSystem()


Retours string :

getAdvertiserName()


Retours string :

getApiFramework()


Retours string :

getCompanionAds()


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

getCreativeAdId()


Retours string :

getCreativeId()


Retours string :

getDealId()


Retours string :

getDescription()


Retours string :

getDuration()


Retours number :

getTitle()


Retours string :

getVastMediaHeight()


Retours number :

getVastMediaWidth()


Retours number :

getWrapperAdIds()


Retours Array.<string> :

getWrapperAdSystems()


Retours Array.<string> :

getWrapperCreativeIds()


Retours Array.<string> :

Class google.ima.dai.api.AdPodInfo

Méthodes

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

getAdPosition()


Retours number :

getMaxDuration()


Retours number :

getPodIndex()


Retours number :

getTimeOffset()


Retours number :

getTotalAds()


Retours number :

Class 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

Class google.ima.dai.api.CompanionAd

Méthodes

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

getAdSlotId()


Retours string :

getContent()


Retours string :

getContentType()


Retours string :

getHeight()


Retours number :

getWidth()


Retours number :

Class google.ima.dai.api.CuePoint

Fields

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

Propriétés

Nom Type Description
end

Heure de fin de ce 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 demande de flux sont déjà attribuées.

Propriétés

Nom Type Description
assetKey

Elle permet de déterminer le flux à lire. La clé de l'asset de la demande de diffusion en direct est un identifiant que vous pouvez trouver dans l'UI DFP.

Class google.ima.dai.api.StreamData

Fields

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

Propriétés

Nom Type Description
adProgressData

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

Points de repère publicitaires pour le flux à la demande. Ces valeurs peuvent changer au fur et à mesure de la diffusion. Cette valeur ne sera renseignée dans l'écouteur d'événements que pour CUEPOINTS_CHANGED AdEvent.
errorMessage

streamId

subtitles

url

Class google.ima.dai.api.StreamEvent

Méthodes

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

getAd()


Retours google.ima.dai.api.Ad : renvoie l'objet avec les informations sur l'annonce.

getStreamData()


Returns google.ima.dai.api.StreamData : renvoie l'objet avec les informations du flux.

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

Fields

Liste des types d'événements acceptés par le SDK IMA.

Valeurs

Valeur Description
AD_BREAK_ENDED

Déclenché lorsqu'une coupure publicitaire se termine.
AD_BREAK_STARTED

Déclenché lorsqu'une série d'annonces commence
AD_PROGRESS

Déclenché lorsqu'une mise à jour est effectuée sur la progression d'une annonce.
CLICK

Déclenché lorsque l'utilisateur clique ou appuie sur l'élément cliquable pendant la lecture d'une annonce.
COMPLETE

Déclenché lorsqu'une annonce est terminée.
CUEPOINTS_CHANGED

Déclenchée pour les flux à la demande lorsque les points de repère 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é lorsqu'une annonce commence.
STREAM_INITIALIZED

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

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

Class 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, et transfère les événements de flux et 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 proprement dit.

contentTimeForStreamTime(streamTime)

Renvoie la durée du contenu sans annonces pour une durée de flux donnée. Renvoie le temps de diffusion donné pour les diffusions en direct.

Renvoie number : le code temporel du contenu qui correspond au code temporel du flux donné une fois les annonces supprimées.

Paramètre Type Description
streamTime number

Durée du flux 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 le code temporel du flux donné. Renvoie la valeur "null" si aucun point de repère de ce type n'existe. Cette méthode est utilisée pour implémenter des fonctionnalités telles que le retour rapide. Elle est appelée lorsque l'éditeur détecte que l'utilisateur a effectué une recherche afin de le rediriger vers un emplacement publicitaire.

Renvoie google.ima.dai.api.CuePoint : le point de repère précédent pour le code temporel du flux donné.

Paramètre Type Description
streamTime number

Heure de diffusion à laquelle l'utilisateur a accédé.

processMetadata(type, data, timestamp)

Traite les métadonnées temporelles pour les diffusions en direct. Utilisez cette méthode 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 brutes du tag. Pour ID3, il doit s'agir de l'intégralité du tag.
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 les paramètres permettant de charger les métadonnées du 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 une navigation hors de la page actuelle.

Paramètre Type Description
clickElement Element

Élément utilisé comme lien de redirection de l'annonce.

streamTimeForContentTime(contentTime)

Renvoie le temps de diffusion avec les annonces pour une heure de contenu donnée. Renvoie le temps de contenu donné pour les diffusions en direct.

Renvoie number : le temps de flux qui correspond au temps de contenu donné une fois les annonces insérées.

Paramètre Type Description
contentTime number

Durée du contenu sans publicité (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 tag d'annonce 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 vos préférences concernant les variantes de flux. Pour en savoir plus, consultez Remplacer les paramètres de variantes de flux.
apiKey

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

ID à utiliser pour déboguer le flux avec l'outil de contrôle de l'activité des flux. Cela permet aux éditeurs de trouver facilement un journal de flux dans l'outil de contrôle de l'activité des flux.

Class google.ima.dai.api.VODStreamRequest

Fields

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

Constructeur :
Paramètre Type Description
opt_VODStreamRequest Object

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

Propriétés

Nom Type Description
contentSourceId

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

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

Constante google.ima.VERSION

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