Pour discuter de nos produits et nous faire part de vos commentaires, rejoignez le canal Discord officiel Ad Manager sur le serveur de la communauté Google Advertising and Measurement.

Cette page a été traduite par l'API Cloud Translation.

SDK IMA DAI pour Roku

Class 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, la valeur "Invalid" (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ètre	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 : une erreur ou une valeur non valide en l'absence d'erreur

Paramètre	Type	Description
`streamRequest`	`object`

Nom	Type	Description
`adPosition`		Index de l'annonce dans la coupure publicitaire. L'index est `1` pour les annonces autonomes.
`duration`		Durée maximale de la pause en secondes, ou `-1` si elle est inconnue.
`podIndex`		Pour les diffusions en direct, renvoie l'ID de coupure en tant qu'index de pod ou `0` pour un préroll. Il n'y a pas de post-rolls dans les diffusions en direct. La valeur par défaut est `-2`. 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 un bloc d'annonces post-roll, renvoie n+1...n+x. La valeur par défaut est `0` si l'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 pré-rolls renvoient `0`, les post-rolls renvoient `-1` et les mid-rolls renvoient l'heure programmée du pod.
`totalAds`		Nombre total d'annonces contenues dans cette coupure publicitaire. La valeur est `1` pour les annonces autonomes.

Nom	Type	Description
`AD_PERIOD_ENDED`		Déclenché chaque fois que le flux passe de la publicité ou d'un écran à du contenu. Cet événement est déclenché même lorsqu'une annonce est lue une deuxième fois ou lorsqu'un utilisateur avance rapidement dans une annonce.
`AD_PERIOD_STARTED`		Déclenché chaque fois que le flux passe du contenu à la publicité ou à l'écran. Cet événement est déclenché même lorsqu'une annonce est lue une deuxième fois ou lorsqu'un utilisateur avance rapidement dans une 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 quartile.
`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'image de remplacement de l'icône est affichée.
`MIDPOINT`		Déclenché lorsque la tête de lecture de l'annonce dépasse le point médian.
`PROGRESS`		Déclenché lorsqu'il y a une mise à jour de la progression d'une annonce.
`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 dépasse le troisième quartile.

Nom	Type	Description
`adBreakInfo`		Informations liées à l'ensemble de la coupure publicitaire dans laquelle cette annonce est diffusée.
`adDescription`		Description de l'annonce.
`adId`		ID de l'annonce ou chaîne vide si l'ID est inconnu.
`adSystem`		Système publicitaire fournissant la création.
`adTitle`		Titre de l'annonce.
`advertiserName`		Nom de l'annonceur tel que défini par la partie diffusant l'annonce.
`companions`		Annonces associées spécifiées dans la réponse VAST.
`creativeAdId`		Code ISCI (Industry Standard Commercial Identifier) d'une annonce. Il s'agit de l'Ad-ID de la création sélectionnée dans la réponse VAST.
`creativeId`		ID de la création sélectionnée pour l'annonce.
`currentTime`		Heure actuelle dans une annonce, en secondes, ou -1 si elle est inconnue.
`dealId`		Renvoie le premier ID d'accord présent dans la chaîne d'encapsulation de l'annonce actuelle, en commençant par le haut.
`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 ce temps est inconnu.
`universalAdIDRegistry`		Chaîne utilisée pour identifier l'URL du site Web du registre où l'ID universel de l'annonce de la création sélectionnée est catalogué.
`universalAdIDValue`		Identifiant d'annonce universel de la création sélectionnée pour l'annonce.
`wrappers`		Tableau d'ima.WrapperInfo contenant des informations sur l'encapsuleur pour cette annonce. L'ordre sera de l'enveloppe extérieure à celle intérieure.

Nom	Type	Description
`adSlotId`		ID de l'emplacement publicitaire de l'annonce associée. Vide si non disponible.
`apiFramework`		API requise pour exécuter cette annonce, ou "Invalid" (Non valide) si elle n'est pas disponible.
`companionClickThrough`		URL de destination de la vidéo associée.
`creativeType`		Représente le type de création, généralement un type MIME.
`height`		Hauteur du companion en pixels. 0 si elle n'est pas disponible.
`trackingEvents`		Carte des événements de suivi où la clé est l'événement et la valeur est une liste d'URL à pinguer lors de cet événement.
`url`		URL de la ressource statique de ce complément.
`width`		Largeur du companion en pixels. 0 si elle n'est pas disponible.

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

Nom	Type	Description
`id`		ID de l'erreur. Pour obtenir la liste des codes d'erreur, consultez la constante ErrorEvent.
`info`		Informations supplémentaires sur l'erreur.
`type`		Toujours défini sur "error" pour indiquer le type de cet objet.

Nom	Type	Description
`BAD_STREAM_REQUEST`		La requête de flux n'a pas été renseignée correctement.
`COULD_NOT_LOAD_STREAM`		Impossible de charger le flux.
`ERROR`		Une 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.

Nom	Type	Description
`format`		Format de la vidéo : HLS ou DASH. Défini dans 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`		les sous-titres, s'ils sont disponibles. Non valide dans le cas contraire.

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

Paramètre	Type	Description
`streamManifest`	`string`	URL du fichier manifeste du flux avec les annonces insérées.
`streamSubtitle`	`ifArray>\|Invalid`	Sous-titres associés au flux, ou `Invalid` si aucun.

Nom	Type	Description
`adTagParameters`		Facultatif. Vous pouvez remplacer un ensemble limité de paramètres de tag d'annonce dans votre demande de flux. Pour en savoir plus, consultez Indiquer des paramètres de ciblage dans votre flux. Vous pouvez également utiliser les paramètres dai-ot et dai-ov pour définir la variante de flux préférée. 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'UI de l'annonce. IMA place des éléments tels que les boutons Pourquoi cette annonce ? et Ignorer sur cet élément pendant les annonces. L'élément doit recouvrir l'intégralité de l'élément vidéo.
`apiKey`		Facultatif. Ces clés peuvent être utilisées pour authentifier les demandes de flux. Les clés d'authentification pour l'insertion dynamique d'annonce doivent être configurées dans l'UI DFP.
`assetKey`		Obligatoire pour les diffusions en direct. Elle permet de déterminer le flux à lire. La clé de l'élément de la demande de diffusion en direct est un identifiant que vous trouverez dans l'UI DFP.
`authToken`		Jeton d'autorisation de la demande de flux. Utilisé à la place de la clé API pour une autorisation de contenu plus stricte. L'éditeur peut contrôler les autorisations des flux de contenu individuels en fonction de ce jeton.
`contentSourceId`		Obligatoire pour les flux à la demande. Le paramètre cmsid provient de la source de contenu vidéo DFP dans l'UI DFP.
`customAssetKey`		La clé d'élément personnalisé permet de déterminer le flux à lire. Des clés d'éléments personnalisées 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 envoie la demande de flux. Les codes réseau sont obligatoires pour les requêtes de flux de diffusion de séries d'annonces effectuées avec createPodLiveStreamRequest ou createPodVodStreamRequest. Ces codes sont également requis pour les requêtes de flux d'assemblage cloud effectuées avec createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest ou createVideoStitcherVodStreamRequestWithVodConfig. Ces codes sont facultatifs et recommandés pour les demandes de flux de service complet effectuées avec createLiveStreamRequest ou createVodStreamRequest. L'ajout du code réseau applique les paramètres sélectionnés dans l'UI Ad Manager, comme l'activation des annonces programmatiques limitées. Pour la diffusion de pods et l'assemblage cloud, l'ajout du code réseau permet de localiser et de lire le flux. Pour trouver le code de réseau, consultez cet article.
`player`		Implémentation de l'interface du lecteur.
`ppid`		Obsolète. Utilisez adTagParameters. Facultatif. Identifiant fourni par l'éditeur pour une audience DFP.
`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 flux à la demande. Identifiant de la source de contenu vidéo.
`videoObject`		Objet vidéo (tel que Video roSGNode) responsable de la lecture vidéo dans l'application cliente. Cet objet sera interrogé pour obtenir diverses données à utiliser pour synchroniser correctement les événements ID3 HLS en direct.
`videoStitcherSessionOptions`		Les options de session permettent de définir des paramètres spécifiques au VideoStitcher pour les streamRequests VideoStitcher.

Paramètre	Type	Description
`assetKey`	`string`
`apiKey`	`string`	Paramètre attribué à la propriété `ima.StreamRequest.apiKey` du `ima.StreamRequest` renvoyé. Si aucune clé API n'existe, transmettez une chaîne vide.
`networkCode`	`string`	Code de réseau de l'éditeur qui envoie la demande de flux. L'inclusion du code réseau est facultative, mais recommandée.

Paramètre	Type	Description
`contentSourceId`	`string`
`videoId`	`string`
`apiKey`	`string`	Paramètre attribué à la propriété `ima.StreamRequest.apiKey` du `ima.StreamRequest` renvoyé. Si aucune clé API n'existe, transmettez une chaîne vide.
`networkCode`	`string`	Code de réseau de l'éditeur qui envoie la demande de flux. L'inclusion du code réseau est facultative, mais recommandée.

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

Paramètre	Type	Description
`vodConfigId`	`string`
`networkCode`	`string`
`region`	`string`
`projectNumber`	`string`
`oAuthToken`	`string`

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

SDK IMA DAI pour Roku Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Class ima

disableLogging()

getStreamManager()

initSdk(settings)

requestStream(streamRequest)

Class ima.AdBreakInfo

Propriétés

createAdBreakInfo()

Classe ima.AdEvent

Propriétés

Class ima.AdInfo

Propriétés

createAdInfo()

Class ima.Companion

Propriétés

createCompanion()

Class ima.CuePoint

Propriétés

createCuePoint()

Class ima.Error

Propriétés

createError()

Classe ima.ErrorEvent

Propriétés

Class ima.Player

adBreakEnded(adBreakInfo)

adBreakStarted(adBreakInfo)

allVideoComplete()

createPlayer()

loadUrl(streamInfo)

streamInitialized(streamInfo)

Class ima.StreamFormat

Propriétés

Class ima.StreamInfo

Propriétés

createStreamInfo()

Class ima.StreamManager

addEventListener(event, callback)

createStreamManager(streamRequest, streamInitResponse)

enableInteractiveAds()

getContentTime(streamTime)

getCuePoints()

getPreviousCuePoint(time)

getStreamTime(contentTime)

loadThirdPartyStream(streamManifest, streamSubtitle)

onMessage(msg)

replaceAdTagParameters(adTagParameters)

start()

Class ima.StreamRequest

Propriétés

createLiveStreamRequest(assetKey, apiKey, networkCode)

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

createPodVodStreamRequest(networkCode)

createStreamRequest()

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

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

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

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

Class ima.StreamType

Propriétés

Class ima.WrapperInfo

Propriétés

createWrapperInfo()

SDK IMA DAI pour Roku

`disableLogging()`

`getStreamManager()`

`initSdk(settings)`

`requestStream(streamRequest)`

`createAdBreakInfo()`

`createAdInfo()`

`createCompanion()`

`createCuePoint()`

`createError()`

`adBreakEnded(adBreakInfo)`

`adBreakStarted(adBreakInfo)`

`allVideoComplete()`

`createPlayer()`

`loadUrl(streamInfo)`

`streamInitialized(streamInfo)`

`createStreamInfo()`

`addEventListener(event, callback)`

`createStreamManager(streamRequest, streamInitResponse)`

`enableInteractiveAds()`

`getContentTime(streamTime)`

`getCuePoints()`

`getPreviousCuePoint(time)`

`getStreamTime(contentTime)`

`loadThirdPartyStream(streamManifest, streamSubtitle)`

`onMessage(msg)`

`replaceAdTagParameters(adTagParameters)`

`start()`

`createLiveStreamRequest(assetKey, apiKey, networkCode)`

`createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)`

`createPodVodStreamRequest(networkCode)`

`createStreamRequest()`

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

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

`createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)`

`createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)`

`createWrapperInfo()`