API SDK IMA de Roku pour Google

1. 1. ima
   2. ima.AdBreakInfo.
   3. ima.AdEvent
   4. ima.AdInfo.
   5. ima.compagnon
   6. ima.CuePoint,
   7. ima.error.
   8. ima.ErrorEvent
   9. ima.player
   10. ima.StreamFormat
   11. ima.streaminfo
   12. ima.StreamManager
   13. ima.StreamRequest.
   14. ima.StreamType
   15. ima.WrapperInfo

Classe ima

Méthodes

disableLogging, getStreamManager, initSdk, requestStream

Fonctions globales qui contrôlent le SDK IMA

disableLogging()

Désactive la journalisation du SDK. La journalisation sera activée par défaut.

getStreamManager()

Renvoie un gestionnaire de flux s'il est disponible. Si le gestionnaire de flux n'est pas encore disponible, "Invalid" est affiché. Si une erreur s'est produite lors de la création du gestionnaire de flux, un objet d'erreur est renvoyé.

Renvoie object:gestionnaire de flux ou objet d'erreur.

initSdk()

Initialise le SDK.

requestStream(streamRequest)

Démarre une requête de flux "asynchronus" Le contrôle est immédiatement renvoyé au lecteur après l'appel de cette méthode.

Renvoie object : erreur ou non valide si aucune erreur

Paramètre	Type	Description
streamRequest	object

Haut de page

Classe ima.AdBreakInfo

Fields

adPosition, duration, podIndex, timeOffset, totalAds

Méthodes

createAdBreakInfo.

Contient des informations sur une coupure publicitaire. Transmis aux rappels d'événement par le SDK.

Propriétés

Nom	Type	Description
adPosition		Index de l'annonce dans la coupure publicitaire. 1 pour les annonces autonomes.
duration		Durée maximale de la coupure en secondes ou -1 si elle est inconnue.
podIndex		Pour les diffusions en direct, la valeur renvoyée est toujours "-1". Pour la vidéo à la demande, l'index de la série d'annonces Pour une série d'annonces vidéo pré-roll, renvoie 0. Pour les annonces vidéo mid-roll, renvoie 1, 2, ..., n. Pour une série d'annonces vidéo post-roll, la fonction renvoie n+1...n+x. La valeur par défaut est 0 si cette annonce ne fait pas partie d'une série d'annonces ou si cette série d'annonces ne fait pas partie d'une playlist.
timeOffset		Position de la série d'annonces dans le contenu en secondes. Les annonces vidéo pré-roll renvoient 0, les annonces post-roll renvoyées -1 et les annonces vidéo mid-roll renvoient l'heure planifiée du pod.
totalAds		Nombre total d'annonces contenues dans cette coupure publicitaire. 1 pour les annonces autonomes.

createAdBreakInfo()

Renvoie ima.AdBreakInfo :

Haut de page

Classe ima.AdEvent

Fields

AD_PERIOD_ENDED, AD_PERIOD_STARTED, COMPLETE, ERROR, FIRST_QUARTILE, MIDPOINT, PROGRESS, START, THIRD_QUARTILE

Événements déclenchés par le gestionnaire d'annonces.

Propriétés

Nom	Type	Description
AD_PERIOD_ENDED		Déclenché à chaque fois que le flux passe de la publicité ou de l'écran à un contenu. Elle se déclenche même lorsqu'une annonce est lue une deuxième fois ou lorsque vous recherchez une annonce.
AD_PERIOD_STARTED		Déclenché chaque fois que le flux passe du contenu à la publicité ou à l'écran. Elle se déclenche même lorsqu'une annonce est lue une deuxième fois ou lorsque vous recherchez une annonce.
COMPLETE		Déclenché lorsque la lecture de l'annonce est terminée
ERROR		Déclenché en cas d'erreur
FIRST_QUARTILE		Déclenché lorsque la tête de lecture de l'annonce dépasse le premier quart
MIDPOINT		Déclenché lorsque la tête de lecture de l'annonce atteint le point médian
PROGRESS		Déclenché en cas de mise à jour de la progression d'une annonce.
START		Déclenché lorsqu'une annonce commence à être diffusée
THIRD_QUARTILE		Déclenché lorsque la tête de lecture de l'annonce franchit le troisième quart

Haut de page

Classe ima.AdInfo

Fields

adBreakInfo, adDescription, adId, adSystem, adTitle, advertiserName, companions, currentTime, duration, UniversalalAdIDRegistry, {Value0wrap}

Méthodes

createAdInfo

Contient des informations sur une annonce. Transmis aux rappels d'événement par le SDK.

Propriétés

Nom	Type	Description
adBreakInfo		Informations concernant la coupure complète de cette annonce.
adDescription		Description de l'annonce.
adId		ID de l'annonce ou chaîne vide si inconnu.
adSystem		Système publicitaire fournissant la création.
adTitle		Titre de l'annonce.
advertiserName		Nom de l'annonceur tel que défini par le tiers diffusant des annonces.
companions		Annonces associées spécifiées dans la réponse VAST.
currentTime		Heure actuelle d'une annonce en secondes ou -1 si inconnue.
duration		Durée de cette annonce unique en secondes ou -1 si inconnue.
universalAdIDRegistry		Chaîne permettant d'identifier l'URL du site Web du registre où l'ID d'annonce universelle de la création sélectionnée est catalogué.
universalAdIDValue		Identifiant universel de l'annonce sélectionnée pour l'annonce.
wrappers		Tableau d' ima.WrapperInfo avec des informations de wrapper pour cette annonce. L'ordre sera de l'enveloppe externe à l'intérieur.

createAdInfo()

Renvoie ima.AdInfo :

Haut de page

Classe ima.Companion

Fields

apiFramework, creativeType, height, trackingEvents, url, width

Méthodes

createCompanion

Contient des informations sur les compagnons d'une annonce.

Propriétés

Nom	Type	Description
apiFramework		L'API a dû exécuter cette annonce, ou n'est pas valide si elle n'est pas disponible.
creativeType		Représente le type de création, généralement un type MIME.
height		Hauteur de l'élément associé en pixels. 0 si non disponible.
trackingEvents		Mappage d'événements de suivi dont la clé correspond à l'événement et la valeur à une liste d'URL qui pinguent cet événement.
url		URL de la ressource statique de cette annonce associée.
width		Largeur de l'annonce associée, en pixels. 0 si non disponible.

createCompanion()

Renvoie ima.Companion:

Haut de page

Classe ima.CuePoint

Fields

end, hasPlayed, start

Méthodes

createCuePoint

Contient des informations sur un point de repère.

Propriétés

Nom	Type	Description
end		Heure de fin d'un point de repère en secondes. Cela correspond à une coupure publicitaire.
hasPlayed		Valeur booléenne indiquant que le point de repère a déjà été lu.
start		Heure de début d'un point de repère en secondes. Cela correspond à une coupure publicitaire.

createCuePoint()

Renvoie ima.CuePoint:

Haut de page

Classe ima.Error

Fields

id, info, type

Méthodes

createError

Objet transmis au gestionnaire d'erreurs en cas d'erreur.

Propriétés

Nom	Type	Description
id		ID de l'erreur. Consultez la constante ErrorEvent pour obtenir la liste des codes d'erreur.
info		Informations supplémentaires sur l'erreur.
type		Définissez toujours sur "error" pour indiquer le type de cet objet.

createError()

Renvoie ima.Error:

Haut de page

Classe ima.ErrorEvent

Fields

BAD_STREAM_REQUEST, COULD_NOT_LOAD_STREAM, ERROR, INVALID_RESPONSE, STREAM_API_KEY_NOT_VALID

Toutes les erreurs que le SDK peut renvoyer.

Propriétés

Nom	Type	Description
BAD_STREAM_REQUEST		La demande de flux n'a pas été correctement renseignée.
COULD_NOT_LOAD_STREAM		Impossible de charger le flux.
ERROR		Une erreur inconnue s'est produite.
INVALID_RESPONSE		La réponse du serveur n'était pas valide.
STREAM_API_KEY_NOT_VALID		La clé API fournie n'a pas été acceptée par le serveur.

Haut de page

Classe ima.Player

Méthodes

adBreakEnded, adBreakStarted, allVideoComplete, createPlayer, loadUrl

adBreakEnded(adBreakInfo)

Facultatif. Appelée à la fin d'une coupure publicitaire.

Paramètre	Type	Description
adBreakInfo	ima.AdBreakInfo	Contient des informations sur la coupure publicitaire.

adBreakStarted(adBreakInfo)

Facultatif. Appelé lorsqu'une coupure publicitaire a commencé.

Paramètre	Type	Description
adBreakInfo	ima.AdBreakInfo	Contient des informations sur la coupure publicitaire.

allVideoComplete()

Facultatif. Appelée lorsque toutes les vidéos sont terminées.

createPlayer()

Crée un objet IMA Player vide. Vous devez implémenter la fonction loadUrl pour diffuser des annonces. Les autres fonctions sont facultatives.

Renvoie ima.Player:

loadUrl(streamInfo)

Appelé lorsque le lecteur doit commencer à lire une URL. Vous devez implémenter cette méthode pour charger le flux.

Paramètre	Type	Description
streamInfo	ima.StreamInfo	Contient les informations nécessaires pour lire du contenu.

Haut de page

Classe ima.StreamFormat

Fields

DASH, HLS

Définit le format du flux.

Propriétés

Nom	Type	Description
DASH
HLS

Haut de page

Classe ima.StreamInfo

Fields

format, manifeste, streamId, streamType, sous-titres

Méthodes

createStreamInfo

Informations transmises par le SDK au lecteur concernant le flux.

Propriétés

Nom	Type	Description
format		Format de la vidéo: hls ou tiret. Défini au format ima.StreamFormat.
manifest		URL du flux.
streamId		ID unique du flux.
streamType		Type de vidéo: en direct ou à la demande. Défini dans ima.StreamType.
subtitles		Sous-titres, si disponibles. Non valide.

createStreamInfo()

Renvoie ima.StreamInfo:

Haut de page

Classe ima.StreamManager

Méthodes

addEventListener, createStreamManager, enableInteractiveAds, getContentTime, getCuePoints, getPreviousCuePoint, getStreamTime, onMessage, replaceAdTagParameters, start

Objet permettant de gérer la lecture de flux.

addEventListener(event, callback)

Ajoute un écouteur pour l'événement spécifié. Consultez la constante AdEvents pour les événements compatibles.

Paramètre	Type	Description
event	string
callback	function

createStreamManager(streamRequest, streamInitResponse)

Renvoie ima.StreamManager :

Paramètre	Type	Description
streamRequest	ima.StreamRequest
streamInitResponse	ima.StreamInitResponse

enableInteractiveAds()

Non compatible. Transmettez plutôt les données de l'annonce compagnon directement à la RAF. Il ne s'agit plus d'une opération.

getContentTime(streamTime)

Récupère une durée en millisecondes pour un flux de vidéo à la demande, qui représente l'heure sans contenu dans le contenu. Consultez la page https://developers.google.com/interactive-media-ads/docs/sdks/roku/faq. Pour obtenir l'heure d'exécution du contenu de la diffusion en direct actuelle, indiquez "-1".

Renvoie Integer:heure de contenu correspondant à l'heure de diffusion indiquée.

Paramètre	Type	Description
streamTime	Integer	Heure du flux.

getCuePoints()

Renvoie tous les points de repère correspondant à toutes les coupures publicitaires. Cela n'est valable que pour les contenus de vidéo à la demande dans lesquels toutes les coupures publicitaires sont connues à l'avance. Les heures représentent le temps de diffusion en secondes.

Renvoie Object : un tableau avec tous les points de repère.

getPreviousCuePoint(time)

Renvoie le point de repère précédant cette heure. Le point de repère indique une coupure publicitaire. Les heures représentent le temps de diffusion en secondes.

Renvoie ima.CuePoint: objet avec début, fin et hasPlay. Renvoie Non valide si aucun point de repère n'est disponible.

Paramètre	Type	Description
time	Float	L'heure à laquelle chercher, "-1" indique l'heure actuelle.

getStreamTime(contentTime)

Récupère le temps de diffusion du contenu à partir d'un contenu en VOD. Consultez la page https://developers.google.com/interactive-media-ads/docs/sdks/roku/faq.

Renvoie Integer : heure du flux correspondant à l'heure du contenu donné.

Paramètre	Type	Description
contentTime	Integer	Heure du contenu.

onMessage(msg)

Gère tous les messages provenant de l'objet vidéo. Doit être appelé pour chaque message reçu sur roMessagePort.

Paramètre	Type	Description
msg	object	Message provenant du port roVideo.

replaceAdTagParameters(adTagParameters)

Remplace tous les paramètres de tag d'emplacement publicitaire à utiliser pour les demandes d'annonces à venir pour un flux en direct. Notez que cet appel ne fonctionne pas pour les flux de vidéo à la demande.

Paramètre	Type	Description
adTagParameters	string	Nouveaux paramètres de tag d'emplacement publicitaire.

start()

Lance la lecture du flux.

Haut de page

Classe ima.StreamRequest

Fields

adTagParameters, adUiNode, apiKey, assetKey, authToken, contentSourceId, networkCode, player, }

Méthodes

createLiveStreamRequest, createPodLiveStreamRequest, createStreamRequest, createVodStreamRequest

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

Propriétés

Nom	Type	Description
adTagParameters		Facultatif. Vous pouvez remplacer un ensemble limité de paramètres de tag d'emplacement publicitaire dans votre demande de flux. Fournir des paramètres de ciblage à votre flux fournit plus d'informations. Vous pouvez également utiliser les paramètres dai-ot et dai-ov pour la préférence de variante de flux. Pour en savoir plus, consultez Remplacer les paramètres de variantes de flux.
adUiNode		Nœud d'un graphique de scène dans lequel l'UI de l'annonce s'affiche. IMA place des éléments tels que Why This Ad et Skip sur cet élément, au cours des annonces. L'élément doit se superposer à l'élément vidéo dans son intégralité.
apiKey		Facultatif. Ces clés peuvent être utilisées pour authentifier les requêtes de flux. Les clés d'authentification pour l'insertion dynamique d'annonce doivent être configurées dans l'interface utilisateur de DFP.
assetKey		Obligatoire pour les diffusions en direct. Cela permet de déterminer le flux à lire. La clé de l'élément de la demande de diffusion en direct est un identifiant qui se trouve dans l'interface utilisateur de DFP.
authToken		Jeton d'autorisation de la demande de flux. Utilisée à la place de la clé API pour une autorisation de contenu plus stricte. L'éditeur peut contrôler les autorisations de flux de contenu individuels en fonction de ce jeton.
contentSourceId		Obligatoire pour les flux à la demande. Le cmsid provient de la source de contenu vidéo DFP dans l'interface utilisateur de DFP.
customAssetKey		La clé de l'élément personnalisé permet de déterminer le flux à lire. Les clés d'éléments personnalisées sont obligatoires pour les requêtes de flux de diffusion de séries d'annonces.
format		Format du flux. La valeur par défaut est ima.StreamFormat.HLS.
networkCode		Code de réseau de l'éditeur qui effectue la demande de flux. Les codes de réseau sont requis pour les requêtes de flux de diffusion de pods.
player		Implémentation de l'interface du lecteur.
ppid		Obsolète. Utilisez adTagParameters. Facultatif. Un identifiant fourni par l'éditeur DFP Audience.
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 surveillance de l'activité des flux.
videoId		Obligatoire pour les flux à la demande. Identifiant de la source de contenu vidéo.
videoObject		Objet vidéo (par exemple, le composant roSGNode vidéo) responsable de la lecture de la vidéo dans l'application cliente. Cet objet sera interrogé pour déterminer si certaines données doivent être utilisées pour synchroniser correctement les événements HLS ID3 en direct.

createLiveStreamRequest(assetKey, apiKey)

Initialise les propriétés obligatoires d'un StreamRequest en direct. Si vous utilisez cette API, toutes les autres propriétés spécifiques à StreamType seront ignorées. Si l'un des paramètres requis est une chaîne vide, la journalisation des erreurs se produit et l'API renvoie une valeur StreamRequest générique, sans aucune propriété ignorée.

Renvoie ima.StreamRequest:objet ima.StreamRequest avec les propriétés actives requises.

Paramètre	Type	Description
assetKey	string
apiKey	string	Paramètre facultatif qui sera attribué à la propriété apiKey renvoyée par StreamRequest. La valeur par défaut est une chaîne vide.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Initialise les propriétés obligatoires d'un pod ima.StreamRequest actif. Si vous utilisez cette API, toutes les autres propriétés spécifiques à ima.StreamType seront ignorées. Si l'un des paramètres requis est une chaîne vide, la journalisation des erreurs se produit et l'API renvoie une valeur StreamRequest générique, sans aucune propriété ignorée.

Renvoie StreamRequest:objet ima.StreamRequest contenant les propriétés PodLive requises.

Paramètre	Type	Description
customAssetKey	string
networkCode	string
apiKey	string	Paramètre facultatif qui sera attribué à la propriété ima.StreamRequest.apiKey renvoyée par ima.StreamRequest. La valeur par défaut est une chaîne vide.

createStreamRequest()

Renvoie ima.StreamRequest : un objet ima.StreamRequest vide.

createVodStreamRequest(contentSourceId, videoId, apiKey)

Initialise les propriétés obligatoires d'un ima.StreamRequest de vidéo à la demande. Si vous utilisez cette API, toutes les autres propriétés spécifiques à ima.StreamType seront ignorées. Si l'un des paramètres requis est une chaîne vide, la journalisation des erreurs se produit et l'API renvoie une valeur StreamRequest générique, sans aucune propriété ignorée.

Renvoie ima.StreamRequest : objet ima.StreamRequest avec les propriétés de vidéo à la demande requises.

Paramètre	Type	Description
contentSourceId	string
videoId	string
apiKey	string	Paramètre facultatif qui sera attribué à la propriété ima.StreamRequest.apiKey renvoyée par ima.StreamRequest. La valeur par défaut est une chaîne vide.

Haut de page

Classe ima.StreamType

Fields

EN DIRECT, VOD

Définit le type de flux que le lecteur doit lire. Les annonces vidéo pré-roll et VOD doivent être diffusées dès le début du flux.

Propriétés

Nom	Type	Description
LIVE		La vidéo est en direct.
VOD		La vidéo est disponible à la demande.

Haut de page

Classe ima.WrapperInfo

Fields

adId, adSystem, creativeAdId, creativeId, dealId

Méthodes

createWrapperInfo

Contient des informations sur un wrapper.

Propriétés

Nom	Type	Description
adId		ID de l'annonce ou chaîne vide si inconnu.
adSystem		Nom déclaré du système d'annonces ou chaîne vide si inconnu.
creativeAdId		Identifiant de la création ou chaîne vide si inconnu.
creativeId		ID de la création ou chaîne vide si inconnu.
dealId		ID de l'accord ou chaîne vide si inconnu.

createWrapperInfo()

Renvoie ima.WrapperInfo :

Haut de page