SDK IMA DAI pour Roku

    1. Image
    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

Image du cours

Méthodes

Fonctions globales qui contrôlent le SDK IMA.

disableLogging()

Désactive la journalisation du SDK. La journalisation est 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 "Invalid" s'affiche. 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)

Il 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. La commande est renvoyée immédiatement au joueur après avoir appelé 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

Méthodes

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

Propriétés

Nom Type Description
adPosition

Index de l'annonce dans la coupure publicitaire. Valeur égale à 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 la valeur -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 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 renvoient -1 et les annonces vidéo mid-roll renvoient l'heure prévue de la série d'annonces.

totalAds

Nombre total d'annonces contenues dans cette coupure publicitaire. Valeur égale à 1 pour les annonces autonomes.

createAdBreakInfo()


Renvoie ima.AdBreakInfo:

Haut de page

Classe ima.AdEvent

Fields

É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 à du contenu. Cette action se déclenche même lorsque l'annonce est diffusée une deuxième fois ou lorsque vous accédez à une annonce.

AD_PERIOD_STARTED

Déclenché chaque fois que le flux passe du contenu à la publicité ou à l'écran. Cette action se déclenche même lorsque l'annonce est diffusée une deuxième fois ou lorsque vous accédez à une annonce.

COMPLETE

Déclenché à la fin de la lecture de l'annonce

ERROR

Déclenché en cas d'erreur

FIRST_QUARTILE

Déclenché lorsque la tête de lecture de l'annonce traverse le premier quartile.

MIDPOINT

Déclenché lorsque la tête de lecture de l'annonce traverse le point médian

PROGRESS

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

SKIPPABLE_STATE_CHANGED

Déclenché lorsque l'état d'une annonce désactivable change.

SKIPPED

Déclenché lorsqu'une annonce est ignorée.

START

Déclenché lorsque la lecture d'une annonce commence.

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

Méthodes

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

Propriétés

Nom Type Description
adBreakInfo

Informations sur la coupure entière dans laquelle se trouve cette annonce.

adDescription

Description de l'annonce.

adId

Identifiant 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 qu'il est défini par la partie active.

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 d'une annonce spécifique en secondes ou "-1" si elle est inconnue.

universalAdIDRegistry

Chaîne permettant d'identifier l'URL du site Web du registre sur lequel l'identifiant d'annonce universel de la création sélectionnée est catalogué.

universalAdIDValue

Identifiant d'annonce universelle de la création sélectionnée pour l'annonce.

wrappers

Tableau d'éléments ima.WrapperInfo avec des informations sur le wrapper pour cette annonce. L'ordre va du wrapper externe vers l'intérieur.

createAdInfo()


Renvoie ima.AdInfo:

Haut de page

Classe ima.Companion

Fields

Méthodes

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 cette annonce 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

Un mappage des événements de suivi, où la clé est l'événement et la valeur est une liste d'URL à pinguer en cas d'é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

Méthodes

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 et type

Méthodes

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" (Erreur) pour indiquer le type de cet objet

createError()


Renvoie ima.Error:

Haut de page

Classe ima.ErrorEvent

Fields

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 remplie.

COULD_NOT_LOAD_STREAM

Impossible de charger le flux.

ERROR

Erreur inconnue.

INVALID_RESPONSE

La réponse du serveur n'est 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(adBreakInfo)

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

Paramètres Type Description
adBreakInfo ima.AdBreakInfo

Contient des informations sur la coupure publicitaire.

adBreakStarted(adBreakInfo)

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

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

Définit le format du flux.

Propriétés

Nom Type Description
DASH

HLS

Haut de page

Classe ima.StreamInfo

Fields

Méthodes

Informations transmises au joueur par le SDK à propos du flux.

Propriétés

Nom Type Description
format

Format de la vidéo: hls ou dash. 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éfinie dans ima.StreamType.

subtitles

Sous-titres, le cas échéant Si ce n'est pas le cas, cette valeur n'est pas valide.

createStreamInfo()


Renvoie ima.StreamInfo:

Haut de page

Classe ima.StreamManager

Méthodes

Objet permettant de gérer la lecture du flux.

addEventListener(event, callback)

Ajoute un écouteur pour l'événement spécifié. Consultez la constante AdEvents pour 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. Transmettez plutôt les données de l'annonce compagnon directement à la fonction RAF. Il s'agit désormais d'une opération no-op.

getContentTime(streamTime)

Récupère une durée en millisecondes pour un flux de vidéo à la demande. Elle correspond à la durée sans annonces du contenu. Voir: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq Pour obtenir la durée du contenu pour la durée de diffusion actuelle transmise à -1.

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

Paramètres Type Description
streamTime Integer

Heure du flux.

getCuePoints()

Renvoie tous les points de repère correspondant à l'ensemble des coupures publicitaires. Cela n'est valable que pour les contenus de vidéo à la demande, dont toutes les coupures publicitaires sont connues à l'avance. Toutes les durées sont exprimées en secondes.

Renvoie Object: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. Toutes les durées sont exprimées en secondes.

Renvoie ima.CuePoint:objet avec début, fin et hasPlayed. Renvoie la valeur "Invalid" si aucun point de repère n'est disponible.

Paramètres Type Description
time Float

Il s'agit de l'heure à rechercher. -1 indique l'heure actuelle.

getStreamTime(contentTime)

Récupère la durée du flux à partir d'une heure de contenu pour la VOD, en millisecondes. Voir: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq

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

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

Sous-titres associés à la diffusion, ou Invalid s'il n'y en a aucun.

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 provenant du port roVideo.

replaceAdTagParameters(adTagParameters)

Remplace tous les paramètres de tag d'emplacement publicitaire à utiliser pour les demandes d'annonces à venir d'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

Méthodes

Utilisé pour 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 obtenir plus d'informations. Vous pouvez également 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 de variantes de flux.

adUiNode

Nœud du graphique de scène dans lequel s'affiche l'UI de l'annonce. IMA place des éléments tels que Pourquoi cette annonce et Ignorer sur cet élément lors des annonces. L'élément doit se superposer à l'intégralité de l'élément vidéo.

apiKey

Facultatif. Ces clés peuvent servir à authentifier des requêtes de flux. Les clés d'authentification pour l'insertion dynamique d'annonce doivent être configurées dans l'interface utilisateur de Advantage.

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 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 basées sur 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 DFP.

customAssetKey

La clé d'élément personnalisé permet de déterminer le flux à lire. Des clés d'éléments personnalisés sont requises pour les demandes de flux de diffusion de pods.

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 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 dans Ad Manager Audience.

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.

videoId

Obligatoire pour les diffusions à la demande. Identifiant de la source du 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 d'identifier différentes données à utiliser pour synchroniser correctement les événements ID3 HLS en direct.

createLiveStreamRequest(assetKey, apiKey)

Initialise les propriétés requises d'un StreamRequest actif. Si vous utilisez cette API, toutes les autres propriétés spécifiques à StreamType sont ignorées. Si les paramètres requis sont des chaînes vides, la journalisation des erreurs est effectuée 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 actives requises.

Paramètres Type Description
assetKey string

apiKey string

Paramètre facultatif qui sera attribué à la propriété apiKey de StreamRequest renvoyée. Valeur par défaut : chaîne vide.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Initialise les propriétés requises pour l'activité ima.StreamRequest d'un pod. Si vous utilisez cette API, toutes les autres propriétés spécifiques à ima.StreamType sont ignorées. Si les paramètres requis sont des chaînes vides, la journalisation des erreurs est effectuée 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 ima.StreamRequest renvoyée. 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 VOD lorsque vous utilisez la diffusion de pods d'insertion dynamique d'annonce 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èrent une erreur dans la console de débogage.

Renvoie StreamRequest:un objet ima.StreamRequest. Si toutes les propriétés requises 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 d'assemblage vidéo en direct. Si vous utilisez cette API, toutes les autres propriétés spécifiques à StreamType sont ignorées. Si les paramètres requis sont des chaînes vides, la journalisation des erreurs est effectuée 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 VOD d'assemblage vidéo. Si vous utilisez cette API, toutes les autres propriétés spécifiques à StreamType sont ignorées. Si les paramètres requis sont des chaînes vides, la journalisation des erreurs est effectuée 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

createVodStreamRequest(contentSourceId, videoId, apiKey)

Initialise les propriétés requises d'un ima.StreamRequest de VOD. Si vous utilisez cette API, toutes les autres propriétés spécifiques à ima.StreamType sont ignorées. Si les paramètres requis sont des chaînes vides, la journalisation des erreurs est effectuée 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 ima.StreamRequest renvoyée. La valeur par défaut est une chaîne vide.

Haut de page

Classe ima.StreamType

Fields

Définit le type de flux que le joueur est invité à lire. Les annonces vidéo pré-roll et les vidéos à la demande doivent être lues depuis 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

Méthodes

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 publicitaire ou chaîne vide si inconnu.

creativeAdId

Identifiant de l'annonce sur la création ou chaîne vide si inconnu.

creativeId

Identifiant de la création ou chaîne vide si inconnu.

dealId

Identifiant de l'accord ou chaîne vide si inconnu.

createWrapperInfo()


Renvoie ima.WrapperInfo:

Haut de page