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 dynamique d'annonces. 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 dans une série d'annonces lors de l'insertion dynamique d'annonces. 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 de l'annonce.

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 dynamique d'annonces. 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 point de repère, qui représente une coupure publicitaire dans les flux de vidéo à la demande pour l'insertion dynamique d'annonce.

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 point de 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ètres Type Description
opt_liveStreamRequest Object

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

Propriétés

Nom Type Description
assetKey

Cela permet de déterminer quel flux lire. La clé d'élément de la demande de diffusion en direct est un identifiant disponible dans l'interface utilisateur de Ad Manager.

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

Points de repère d'annonces pour le flux à la demande Ceux-ci peuvent changer à mesure que le flux progresse. Il ne sera renseigné que dans l'écouteur d'événements de la AdEvent CUEPOINTS_CHANGED.
errorMessage

streamId

subtitles

url

Classe google.ima.dai.api.StreamEvent

Méthodes

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

getAd()


Renvoie google.ima.dai.api.Ad:objet renvoyé avec les informations sur l'annonce.

getStreamData()


Renvoie google.ima.dai.api.StreamData:objet renvoyé avec des informations de flux.

Énumération 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'il existe une mise à jour de l'avancement d'une annonce
CLICK

Envoyé 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

Envoyé 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 quart.
LOADED

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

Déclenché lorsque le point médian de l'annonce est atteint.
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 quart.

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 d'insertion dynamique d'annonce, les pings de suivi, ainsi que le transfert des événements de flux et d'annonce à l'éditeur. Ce gestionnaire n'hérite pas de BaseAdsManager, car il n'est pas administrateur pour une annonce spécifique, mais un pour l'ensemble du flux.

Constructeur:
Paramètres Type Description
videoElement HTMLVideoElement

Élément du lecteur vidéo réel.

contentTimeForStreamTime(streamTime)

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

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

Paramètres Type Description
streamTime number

Durée du flux avec les annonces insérées (en secondes).

onTimedMetadata(metadata)

Transmet des données dans 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ètres Type Description
metadata Object

Dictionnaire de métadonnées.

previousCuePointForStreamTime(streamTime)

Renvoie le point de repère précédent pour l'heure du flux donnée. Renvoie la valeur "null" si ce point de repère n'existe pas. Ce bouton permet d'implémenter des fonctionnalités telles que le retour arrière. Il est appelé lorsque l'éditeur détecte que l'utilisateur a recherché un élément afin de le renvoyer vers une coupure publicitaire.

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

Paramètres Type Description
streamTime number

la durée de diffusion recherchée.

processMetadata(type, data, timestamp)

Traitement des métadonnées planifiées 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ètres Type Description
type string

Saisissez du texte pour les métadonnées. Doit être "ID3".
data Uint8Array

Données brutes de la balise. Pour ID3, doit correspondre à l'intégralité de la balise.
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ètres Type Description
streamRequest google.ima.dai.api.StreamRequest

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

setClickElement(clickElement)

Définit l'élément cliquable dans les annonces. Cet élément est utilisé en tant que destinataire du clic ou de l'appui pendant la lecture d'une annonce et peut entraîner la navigation en dehors de la page actuelle.

Paramètres Type Description
clickElement Element

l'élément utilisé lors du clic sur l'annonce

streamTimeForContentTime(contentTime)

Renvoie la durée de diffusion avec les annonces correspondant à une durée de contenu donnée. Renvoie la durée de contenu donnée pour les diffusions en direct.

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

Paramètres Type Description
contentTime number

la 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'emplacement publicitaire dans votre demande de flux. Indiquez des paramètres de ciblage dans votre flux pour obtenir plus d'informations. Vous pouvez utiliser les paramètres "dai-ot" et "dai-ov" pour définir la préférence pour les variantes de flux. Pour en savoir plus, consultez Remplacer les paramètres des variantes de flux.
apiKey

Clé API de la requête de flux. Ce paramètre est configuré via l' interface utilisateur d'administration de Ad Manager et fourni à l'éditeur pour permettre le déverrouillage de son contenu. Elle vérifie les applications qui tentent d'accéder au contenu.
streamActivityMonitorId

ID à utiliser pour déboguer le flux à l'aide de 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 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ètres Type Description
opt_VODStreamRequest Object

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, issu d'un CMS. Obligatoire pour les flux à la demande.
videoId

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

Constante google.ima.VERSION

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