API SDK IMA de Roku pour Google

1. 1. Image
   2. ima.AdBreakInfo.
   3. Événement publicitaire
   4. ima.AdInfo
   5. ima.companion
   6. ima.CuePoint.
   7. Erreur
   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, "Non valide" est renvoyé. Si une erreur se produit 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)

Lance une requête de flux asynchronus. Elle est renvoyée immédiatement au joueur après avoir appelé 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 (VOD), renvoie l'index de la série d'annonces. Pour une série d'annonces vidéo pré-roll, renvoie 0. Pour les annonces mid-roll, cette fonction renvoie : 1, 2, ..., n. Pour une série d'annonces post-roll, cette 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 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 renvoient -1 et les annonces mid-roll renvoient l'heure programmée pour la série d'annonces.
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, TERMINÉE, ERREUR, FIRST_QUARTILE, MIDPOINT, PROGRESS, SKIPPABLE_STATE_CHANGED, SKIPPED, {START11}2

Événements déclenchés par le gestionnaire des annonces

Propriétés

Nom	Type	Description
AD_PERIOD_ENDED		Déclenché chaque fois que la diffusion passe d'une annonce ou d'un écran à un contenu Ceci se déclenche même lorsqu'une annonce est lue une deuxième fois ou lors d'une recherche d'annonce.
AD_PERIOD_STARTED		Déclenché chaque fois que le flux passe du contenu à la publicité ou à l'écran Ceci se déclenche même lorsqu'une annonce est lue une deuxième fois ou lors d'une recherche d'annonce.
COMPLETE		Déclenché à la fin de l'annonce
ERROR		Déclenché lorsqu'une erreur se produit
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
SKIPPABLE_STATE_CHANGED		Déclenché lorsqu'une annonce désactivable change de champ.
SKIPPED		Déclenché lorsqu'une annonce est ignorée
START		Déclenché lorsqu'une annonce commence à être diffusée
THIRD_QUARTILE		Déclenché lorsque la tête de lecture passe au troisième quart

Haut de page

Classe ima.AdInfo

Fields

adBreakInfo, adDescription, adId, adSystem, adTitle, merchantName, companion, currentTime, duration, universalAdID,

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		Infos sur la coupure complète de cette annonce.
adDescription		Description de l'annonce.
adId		Identifiant de l'annonce ou chaîne vide si inconnu.
adSystem		Système publicitaire qui fournit la création.
adTitle		Titre de l'annonce.
advertiserName		Nom de l'annonceur, tel que défini par le tiers actif.
companions		Annonces associées spécifiées dans la réponse VAST.
currentTime		Heure actuelle dans une annonce, en secondes, ou -1 si inconnue.
duration		Durée de cette annonce unique en secondes ou -1 si elle est inconnue.
universalAdIDRegistry		Chaîne permettant d'identifier l'URL du site Web du registre sur lequel l'ID d'annonce universel de la création sélectionnée est listé.
universalAdIDValue		Identifiant universel de l'annonce sélectionnée pour l'annonce.
wrappers		Tableau de ima.WrapperInfo avec informations sur le wrapper pour cette annonce. L'ordre sera du wrapper externe vers 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		API requise pour diffuser cette annonce, ou non valide si indisponible.
creativeType		Représente le type de création, généralement un type MIME.
height		Hauteur en pixels de l'élément associé. 0 si non disponible.
trackingEvents		Un mappage des événements de suivi, où la clé est l'événement et la valeur est une liste d'URL pour pinguer cet événement.
url		URL de la ressource statique de l'élément associé.
width		Largeur de l'élément associé 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		Booléen 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éfini sur toujours 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 requête de flux n'a pas été correctement renseignée.
COULD_NOT_LOAD_STREAM		Impossible de charger le flux.
ERROR		Erreur inconnue.
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ée 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. D'autres fonctions sont facultatives.

Renvoie ima.Player:

loadUrl(streamInfo)

Appelée 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, manifest, 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 dans ima.StreamFormat.
manifest		URL du flux.
streamId		Identifiant unique pour le flux.
streamType		Type de vidéo: en direct ou à la demande. Définie dans ima.StreamType.
subtitles		Sous-titres, s'ils sont disponibles Sinon, elle n'est pas valide.

createStreamInfo()

Renvoie ima.StreamInfo:

Haut de page

Classe ima.StreamManager

Méthodes

/#!, 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 connaître 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 associée directement à la RAF. Il s'agit maintenant d'une opération no-op.

getContentTime(streamTime)

Récupère un temps en millisecondes pour un flux de vidéo à la demande, ce qui représente le temps passé dans le contenu sans annonces. Consultez la page https://developers.google.com/interactive-media-ads/docs/sdks/roku/dai/faq. Pour connaître l'heure du contenu concernant la durée actuelle du flux, transmettez -1.

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

Paramètre	Type	Description
streamTime	Integer	Heure de la diffusion.

getCuePoints()

Renvoie tous les points de repère correspondant à toutes les coupures publicitaires. Cette option n'est valide que pour les contenus de vidéo à la demande où toutes les coupures publicitaires sont connues à l'avance. Toutes les heures représentent l'heure de diffusion en secondes.

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

getPreviousCuePoint(time)

Renvoie le point de repère précédant cette fois. Le point de repère indique une coupure publicitaire. Toutes les heures représentent l'heure de diffusion en secondes.

Renvoie ima.CuePoint:un objet avec "start", "end" et "hasPlay". Renvoie Non valide si aucun point de repère n'est disponible.

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

getStreamTime(contentTime)

Récupère le temps de diffusion du contenu d'une vidéo à la demande en millisecondes. Voir https://developers.google.com/interactive-media-ads/docs/sdks/roku/dai/faq

Renvoie Integer : heure de diffusion correspondant à l'heure du contenu.

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 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. Sachez que cet appel est no-op pour les flux de vidéo à la demande.

Paramètre	Type	Description
adTagParameters	string	Paramètres du nouveau 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, createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest ou createVodStreamRequest

Permet de spécifier les propriétés de la demande 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. Fournissez des paramètres de ciblage à votre flux pour en savoir plus. 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 la section Remplacer les paramètres de variantes de flux.
adUiNode		Nœud du graphique de scène dans lequel l'interface utilisateur de l'annonce s'affiche. IMA place des éléments tels que Pourquoi cette annonce ? et Passer sur cet élément pendant les annonces. L'élément doit se superposer à l'intégralité de l'élément vidéo.
apiKey		Facultatif. Ces clés permettent d'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 figure 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és sont obligatoires pour les demandes de flux de diffusion de séries d'annonces.
format		Format du flux. La valeur par défaut est ima.StreamFormat.HLS.
networkCode		Code réseau de l'éditeur qui envoie 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. Identifiant fourni par l'éditeur.
streamActivityMonitorId		ID à utiliser pour déboguer le flux avec le moniteur d'activité du flux. Cela permet aux éditeurs de trouver facilement un journal de flux dans l'outil de contrôle d'activité des flux.
videoId		Obligatoire pour les flux à la demande. Identifiant de la source du contenu vidéo.
videoObject		Objet vidéo (tel que roSGNode vidéo) responsable de la lecture vidéo dans l'application cliente. Cet objet sera interrogé pour déterminer si certaines données doivent être utilisées pour planifier 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 des paramètres obligatoires sont des chaînes vides, 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 Live requises.

Paramètre	Type	Description
assetKey	string
apiKey	string	Paramètre facultatif attribué à la propriété apiKey du StreamRequest renvoyé. Valeur par défaut : chaîne vide.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Initialise les propriétés requises 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 des paramètres obligatoires sont des chaînes vides, 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 avec les propriétés PodLive requises.

Paramètre	Type	Description
customAssetKey	string
networkCode	string
apiKey	string	Paramètre facultatif attribué à la propriété ima.StreamRequest.apiKey du ima.StreamRequest renvoyé. Valeur par défaut : chaîne vide.

createStreamRequest()

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

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

Initialise les propriétés requises d'un composant StreamRequest d'assemblage vidéo en direct. Si vous utilisez cette API, toutes les autres propriétés spécifiques à StreamType seront ignorées. Si des paramètres obligatoires sont des chaînes vides, 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 VideoStitcherLive requises.

Paramètre	Type	Description
customAssetKey	string
networkCode	string
liveConfigId	string
region	string
projectNumber	string
oAuthToken	string

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)

Initialise les propriétés requises d'une vidéo à la demande Stitcher de vidéo à la demande StreamRequest. Si vous utilisez cette API, toutes les autres propriétés spécifiques à StreamType seront ignorées. Si des paramètres obligatoires sont des chaînes vides, 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 VideoStitcherVod requises.

Paramètre	Type	Description
adTagUrl	string
networkCode	string
contentSourceUrl	string
region	string
projectNumber	string
oAuthToken	string

createVodStreamRequest(contentSourceId, videoId, apiKey)

Initialise les propriétés requises 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 des paramètres obligatoires sont des chaînes vides, 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: ima.StreamRequest avec les propriétés VOD requises.

Paramètre	Type	Description
contentSourceId	string
videoId	string
apiKey	string	Paramètre facultatif attribué à la propriété ima.StreamRequest.apiKey du ima.StreamRequest renvoyé. Valeur par défaut : chaîne vide.

Haut de page

Classe ima.StreamType

Fields

EN DIRECT, VOD

Définit le type de flux que le lecteur est invité à lire. Les annonces pré-roll et les VOD doivent être lues dès le début de la diffusion.

Propriétés

Nom	Type	Description
LIVE		La vidéo est en ligne.
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		Identifiant de l'annonce ou chaîne vide si inconnu.
adSystem		Nom déclaré du système d'annonces ou chaîne vide si inconnue.
creativeAdId		ID de l'annonce dans 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