SDK IMA DAI pour Roku

1. 1. ima
   2. ima.AdBreakInfo
   3. ima.AdEvent
   4. ima.AdInfo
   5. ima.Companion
   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()

Affiche un gestionnaire de flux, s'il est disponible. Si le gestionnaire de flux n'est pas encore disponible, la valeur "Non valide" est renvoyée. 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(settings)

Initialise le SDK.

Paramètres	Type	Description
settings	object	Objet de paramètres IMA facultatif.

requestStream(streamRequest)

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

Renvoie object:erreur ou non valide en l'absence d'erreur.

Paramètres	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. Valeur 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, renvoie toujours -1. Pour la vidéo à la demande (VOD), renvoie l'index de la série d'annonces. Pour une série d'annonces pré-roll, renvoie 0. Pour les mid-rolls, renvoie 1, 2, ..., n. Pour une série d'annonces post-roll, 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 elle ne fait pas partie d'une playlist.
timeOffset		Position de la série d'annonces dans le contenu, en secondes. Une annonce vidéo pré-roll renvoie 0, une annonce vidéo post-roll renvoie -1 et une annonce vidéo mid-roll renvoie l'heure prévue pour le pod.
totalAds		Nombre total d'annonces contenues dans cette coupure publicitaire. Valeur 1 pour les annonces autonomes.

createAdBreakInfo()

Renvoie ima.AdBreakInfo:

Haut de page

Classe ima.AdEvent

Fields

AD_PERIOD_ENDED, AD_PERIOD_STARTED, COMPLETE, ERREUR, FIRST_QUARTILE, ICON_FALLBACK_IMAGE_CLOSED, ICON_FALLBACK_IMAGE_SHOWN, MIDPOINT, KIPP2KIABLE_16}SKIPPABLE_STATE_CHANGEDTHIRD_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 au contenu. Il 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 au contenu publicitaire ou à l'écran. Il se déclenche même lorsqu'une annonce est lue une deuxième fois ou lorsque vous recherchez une annonce.
COMPLETE		Déclenché à la fin de la lecture de l'annonce.
ERROR		Déclenché lorsqu'une erreur se produit.
FIRST_QUARTILE		Déclenché lorsque la tête de lecture de l'annonce traverse le premier quart.
ICON_FALLBACK_IMAGE_CLOSED		Déclenché lorsque l'utilisateur ferme la boîte de dialogue de l'image de remplacement de l'icône.
ICON_FALLBACK_IMAGE_SHOWN		Déclenché lorsque l'icône de remplacement est affichée.
MIDPOINT		Déclenché lorsque la tête de lecture de l'annonce franchit le point médian.
PROGRESS		Déclenché lors d'une mise à jour de la progression d'une annonce.
SKIPPABLE_STATE_CHANGED		Déclenché lorsque l'état d'une annonce (désactivable) est modifié.
SKIPPED		Déclenché lorsqu'une annonce est ignorée.
START		Déclenché au début de la lecture d'une annonce.
THIRD_QUARTILE		Déclenché lorsque la tête de lecture de l'annonce traverse le troisième quart.

Haut de page

Classe ima.AdInfo

Fields

adBreakInfo, adDescription, adId, adSystem, adTitle, advertiserName, companions, currentTime, duration, skipOffset, universalAdIDRegistryuniversalAdIDValue

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 sur l'intégralité de la coupure publicitaire dans laquelle se trouve cette annonce.
adDescription		Description de l'annonce.
adId		Identifiant de l'annonce ou chaîne vide si elle est inconnue.
adSystem		Système publicitaire fournissant la création.
adTitle		Titre de l'annonce.
advertiserName		Nom de l'annonceur, tel qu'il est défini par la partie diffusant des annonces.
companions		Annonces associées spécifiées dans la réponse VAST.
currentTime		Heure actuelle dans une annonce en secondes ou -1 si elle est inconnue.
duration		Durée de cette annonce unique en secondes ou "-1" si elle est inconnue.
skipOffset		Temps nécessaire pour que l'annonce devienne désactivable, ou -1 si inconnu.
universalAdIDRegistry		Chaîne permettant d'identifier l'URL du site Web de registre sur lequel l'identifiant de l'annonce universelle de la création sélectionnée est catalogué.
universalAdIDValue		Identifiant de l'annonce universelle de la création sélectionnée pour l'annonce.
wrappers		Tableau d'ima.WrapperInfo avec les informations de wrapper pour cette annonce. L'ordre passera du wrapper externe au wrapper interne.

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 créations associées d'une annonce.

Propriétés

Nom	Type	Description
apiFramework		L'API nécessaire pour exécuter cette annonce, ou "Non 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'annonce associée, en pixels. 0 si indisponible.
trackingEvents		Carte des événements de suivi où la clé correspond à l'événement et sa valeur à une liste d'URL à pinguer en réponse à cet événement.
url		URL de la ressource statique de cette création associée.
width		Largeur de l'annonce associée, en pixels. 0 si indisponible.

createCompanion()

Renvoie ima.Companion:

Haut de page

Classe ima.CuePoint

Fields

end, hasPlayed et 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		Identifiant de l'erreur. Consultez la constante ErrorEvent pour obtenir la liste des codes d'erreur.
info		Informations supplémentaires sur l'erreur.
type		Toujours défini 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 est susceptible de 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		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é à la fin d'une coupure publicitaire.

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

adBreakStarted(adBreakInfo)

Facultatif. Appelé au début d'une coupure publicitaire.

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

allVideoComplete()

Facultatif. Appelée lorsque toute la vidéo est terminée.

createPlayer()

Crée un objet IMA Player vide. Vous devez implémenter la fonction loadUrl pour lire les annonces. D'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ètres	Type	Description
streamInfo	ima.StreamInfo	Contient les informations nécessaires à la lecture 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, subtitles

Méthodes

createStreamInfo

Informations sur le flux transmises au lecteur par le SDK.

Propriétés

Nom	Type	Description
format		Format de la vidéo: hls ou tiret. Définie dans ima.StreamFormat.
manifest		URL du flux.
streamId		Identifiant unique du flux.
streamType		Type de vidéo: en direct ou à la demande. Défini dans ima.StreamType.
subtitles		Sous-titres, le cas échéant. Non valide dans le cas contraire.

createStreamInfo()

Renvoie ima.StreamInfo:

Haut de page

Classe ima.StreamManager

Méthodes

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

Objet permettant de gérer la lecture en flux continu.

addEventListener(event, callback)

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

Paramètres	Type	Description
event	string
callback	function

createStreamManager(streamRequest, streamInitResponse)

Renvoie ima.StreamManager:

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

enableInteractiveAds()

Non compatible. À la place, les données de l'annonce compagnon sont transmises directement à RAF. Ceci est maintenant une opération no.

getContentTime(streamTime)

Obtient une durée en millisecondes pour un flux de vidéo à la demande. Elle correspond au temps passé dans le contenu sans annonce. Consultez la page https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq. Pour obtenir l'heure du contenu pour le passage temporel actuel de la diffusion dans -1.

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

Paramètres	Type	Description
streamTime	Integer	Heure du flux.

getCuePoints()

Affiche tous les points de repère correspondant à toutes les coupures publicitaires. Cela n'est valable que pour les vidéos à la demande dont toutes les coupures publicitaires sont connues à l'avance. Toutes les heures représentent la durée de la 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 heure. Le point de repère indique une coupure publicitaire. Toutes les heures représentent la durée de la diffusion en secondes.

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

Paramètres	Type	Description
time	Float	Il s'agit de l'heure à laquelle la recherche doit être effectuée. "-1" indique l'heure actuelle.

getStreamTime(contentTime)

Obtient la durée du flux à partir d'un horaire de contenu pour la VOD, en millisecondes. Pour en savoir plus, consultez la page https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq.

Renvoie Integer : durée de diffusion correspondant à la durée indiquée pour le contenu.

Paramètres	Type	Description
contentTime	Integer	Heure du contenu.

loadThirdPartyStream(streamManifest, streamSubtitle)

Charge les métadonnées de l'annonce et appelle la fonction loadUrl avec les données streamManifestUrl et streamSubtitle fournies. Cette fonction ne fonctionne que lorsque le type de requête de flux est ima.StreamType.POD_VOD.

Paramètres	Type	Description
streamManifest	string	URL du fichier manifeste du flux avec les annonces assemblées.
streamSubtitle	ifArray>|Invalid	Les sous-titres sont associés au flux, ou Invalid s'il n'y en a pas.

onMessage(msg)

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

Paramètres	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. Notez que cet appel est une opération no-op pour les flux de vidéo à la demande.

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

start()

Lance la lecture du flux.

Haut de page

Classe ima.StreamRequest

Fields

adTagParameters, adUiNode, apiKey, assetKey, authToken, contentSourceId, customAssetKey, format, networkCode, MonitorId}, ppidstreamActivityMonitorIdvideoIdvideoObjectvideoStitcherSessionOptions

Méthodes

createLiveStreamRequest, createPodLiveStreamRequest, createPodVodStreamRequest, createStreamRequest, createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest, CreateVideoStitcherVodStreamRequestWithVodConfig, 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 définir la préférence des variantes de flux. Pour en savoir plus, consultez Remplacer les paramètres de variantes de flux.
adUiNode		Nœud du graphique de scène où s'affiche l'interface utilisateur de l'annonce. Le système IMA place des éléments tels que les boutons Pourquoi cette annonce et Ignorer sur cet élément pendant la diffusion des annonces. L'élément doit se superposer à l'intégralité de l'élément vidéo.
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 DoubleClick for Publishers.
assetKey		Obligatoire pour les diffusions en direct. Cela permet de déterminer quel flux diffuser. La clé d'élément de la demande de diffusion en direct est un identifiant qui se trouve dans l'interface utilisateur de Ad Manager.
authToken		Jeton d'autorisation de la requête de flux. Elle est 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 individuelles en fonction de ce jeton.
contentSourceId		Obligatoire pour les diffusions à la demande. Le paramètre cmsid provient de la source de contenu vidéo de Ad Manager dans l'interface utilisateur de DoubleClick for Publishers.
customAssetKey		La clé d'élément personnalisée permet de déterminer le flux à lire. Les clés d'éléments personnalisés sont requises 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 de réseau de l'éditeur à l'origine de la demande de flux. Les codes de réseau sont requis pour les demandes 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 de l'audience DoubleClick for Publishers.
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.
videoId		Obligatoire pour les diffusions à la demande. Identifiant de la source de contenu vidéo.
videoObject		Objet vidéo (tel que le composant Video roSGNode) responsable de la lecture de la vidéo dans l'application cliente. Cet objet sera interrogé afin de déterminer différentes données à utiliser pour synchroniser correctement les événements HLS ID3 en direct.
videoStitcherSessionOptions		Les options de session permettent de définir des paramètres spécifiques à l'éditeur vidéo pour les streamRequests VideoStitcher.

createLiveStreamRequest(assetKey, apiKey)

Initialise les propriétés obligatoires d'un StreamRequest en direct. L'utilisation de cette API entraîne l'ignorance de toutes les autres propriétés spécifiques à StreamType. Si les paramètres obligatoires sont des chaînes vides, la journalisation des erreurs se produit et l'API renvoie un StreamRequest générique, sans aucune propriété ignorée.

Renvoie ima.StreamRequest:objet ima.StreamRequest avec les propriétés "En direct" requises.

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

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

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

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

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

createPodVodStreamRequest(networkCode)

Initialise les propriétés requises d'un ima.StreamRequest pour enregistrer un flux de vidéo à la demande lorsque vous utilisez la diffusion de séries d'annonces pour l'insertion dynamique de séries d'annonces avec un assembleur vidéo tiers. Cette fonction définit le type de requête sur ima.StreamType.POD_VOD et valide toutes les propriétés requises pour les données manquantes. Les échecs de validation généreront une erreur dans la console de débogage.

Renvoie StreamRequest:un objet ima.StreamRequest. Si toutes les propriétés obligatoires sont spécifiées, le type de requête est défini sur ima.StreamType.POD_VOD.

Paramètres	Type	Description
networkCode	string	le code de réseau Google Ad Manager

createStreamRequest()

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

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

Initialise les propriétés requises d'un StreamRequest Video Stitcher Live. Si vous utilisez cette API, toutes les autres propriétés spécifiques à StreamType seront ignorées. Si les paramètres obligatoires sont des chaînes vides, la journalisation des erreurs se produit et l'API renvoie un StreamRequest générique, sans aucune propriété ignorée.

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

Paramètres	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'un StreamRequest de vidéo à la demande d'assembleur vidéo. Si vous utilisez cette API, toutes les autres propriétés spécifiques à StreamType seront ignorées. Si les paramètres obligatoires sont des chaînes vides, la journalisation des erreurs se produit et l'API renvoie un StreamRequest générique, sans aucune propriété ignorée.

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

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

CreateVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)

Initialise les propriétés requises d'un StreamRequest de vidéo à la demande d'assembleur vidéo à l'aide de vodConfigId créé à partir de l'assembleur vidéo cloud. L'utilisation de cette API entraîne l'omission de toutes les autres propriétés spécifiques à StreamType. Si les paramètres obligatoires sont des chaînes vides, la journalisation des erreurs se produit et l'API renvoie un StreamRequest générique, sans aucune propriété ignorée.

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

Paramètres	Type	Description
vodConfigId	string
networkCode	string
region	string
projectNumber	string
oAuthToken	string

createVodStreamRequest(contentSourceId, videoId, apiKey)

Initialise les propriétés obligatoires d'un ima.StreamRequest de VOD. Si vous utilisez cette API, toutes les autres propriétés spécifiques à ima.StreamType seront ignorées. Si les paramètres obligatoires sont des chaînes vides, la journalisation des erreurs se produit et l'API renvoie un StreamRequest générique, sans aucune propriété ignorée.

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

Paramètres	Type	Description
contentSourceId	string
videoId	string
apiKey	string	Paramètre facultatif qui sera attribué à la propriété ima.StreamRequest.apiKey de l'élément ima.StreamRequest renvoyé. 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 est invité à lire. Les annonces vidéo pré-roll et les vidéos à la demande 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 elle est inconnue.
adSystem		Nom déclaré du système publicitaire ou chaîne vide si elle est inconnue.
creativeAdId		Identifiant de l'annonce au niveau de la création ou chaîne vide si elle est inconnue.
creativeId		Identifiant de la création ou chaîne vide si elle est inconnue.
dealId		ID de l'accord ou chaîne vide si cette information est inconnue.

createWrapperInfo()

Renvoie ima.WrapperInfo:

Haut de page