Classe: StreamRequest

ima.StreamRequest

class   static

Constructeur

StreamRequest

new StreamRequest()

Permet de spécifier les propriétés de la demande de flux.

Propriétés

adTagParameters

static

Chaîne

Facultatif. Vous pouvez modifier un ensemble limité de paramètres de balise publicitaire dans votre requête de flux. Fournissez 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. Voir Remplacer les paramètres de variante de flux pour plus d'informations.

adUiNode

static

roSGNode

Nœud du graphique de scène où l'UI de l'annonce s'affiche. 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

static

Chaîne

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

static

Chaîne

Requis pour les diffusions en direct. Elle permet de déterminer le flux à lire. La requête de flux en direct clé d'actif est un identifiant que l'on peut trouver dans l'interface utilisateur DFP.

authToken

static

Chaîne

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

static

Chaîne

Obligatoire pour les flux à la demande. Le cmsid provient de la source de contenu vidéo DFP dans l'interface utilisateur DFP.

customAssetKey

static

Chaîne

La clé de ressource personnalisée est utilisée pour déterminer quel flux doit être lu. Des clés d'actifs personnalisées sont requises pour les requêtes de flux de diffusion des pods.

format

static

ima.StreamFormat

Format du flux. La valeur par défaut est ima.StreamFormat.HLS.

networkCode

static

Chaîne

Code de réseau de l'éditeur qui envoie la demande de flux. Les codes réseau sont requis pour les requêtes de flux de diffusion de podcasts 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 limitées programmatiques. Pour la diffusion de pods et l'assemblage de clouds, l'ajout du code réseau permet de localiser et de lire le flux. Pour trouver le code de réseau, consultez cet article.

joueur

static

(ima.Player ou "Invalid")

Une implémentation de l'interface du joueur.

ppid

static

Chaîne

Obsolète. Utilisez adTagParameters. Facultatif. Identifiant fourni par l'éditeur d'une audience DFP.

streamActivityMonitorId

static

Chaîne

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

static

Chaîne

Obligatoire pour les flux à la demande. Identifiant de la source de contenu vidéo.

videoObject

static

(roVideo ou non valide)

Objet vidéo (tel que le 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

static

Tableau de V

Les options de session permettent de définir des paramètres spécifiques au VideoStitcher pour les VideoStitcher streamRequests.

Méthodes

createLiveStreamRequest

static

createLiveStreamRequest(assetKey, apiKey, networkCode) renvoie ima.StreamRequest

Initialise les propriétés requises 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 des paramètres obligatoires sont des chaînes vides, une journalisation des erreurs se produit et l'API renvoie un StreamRequest générique, sans aucune propriété ignorée.

Paramètre
assetKey	string
apiKey	string Paramètre attribué à la propriété ima.StreamRequest.apiKey des ima.StreamRequest renvoyés. 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.

Renvoie

ima.StreamRequest ima.StreamRequestobjet contenant les propriétés Live requises.

createPodLiveStreamRequest

static

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey) returns StreamRequest

Initialise les propriétés requises d'un Pod Live ima.StreamRequest. L'utilisation de cette API entraîne l'ignorance de toute autre propriété spécifique à ima.StreamType. Si des paramètres obligatoires sont des chaînes vides, une journalisation des erreurs se produit et l'API renvoie un StreamRequest générique, sans aucune propriété ignorée.

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

Renvoie

Objet StreamRequest ima.StreamRequest avec les propriétés PodLive requises.

createPodVodStreamRequest

static

createPodVodStreamRequest(networkCode) returns StreamRequest

Initialise les propriétés requises d'un ima.StreamRequest pour enregistrer un flux VOD lors de l'utilisation de 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 validations ayant échoué enregistrent une erreur dans la console de débogage.

Paramètre
networkCode	string le code de réseau Google Ad Manager.

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.

createStreamRequest

static

createStreamRequest() renvoie ima.StreamRequest

Renvoie

ima.StreamRequest Un objet ima.StreamRequest vide.

createVideoStitcherLiveStreamRequest

static

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken) returns ima.StreamRequest

Initialise les propriétés requises d'un StreamRequest Video Stitcher Live. L'utilisation de cette API entraîne l'ignorance de toute autre propriété spécifique à StreamType. Si l'un des paramètres obligatoires est une chaîne vide, une erreur est consignée et l'API renvoie un StreamRequest générique, sans ignorer aucune propriété.

Paramètre
customAssetKey	string
networkCode	string
liveConfigId	string
région	string
projectNumber	string
oAuthToken	string

Renvoie

Objet ima.StreamRequest ima.StreamRequest avec les propriétés VideoStitcherLive requises.

createVideoStitcherVodStreamRequest

static

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken) renvoie ima.StreamRequest

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

Paramètre
adTagUrl	string
networkCode	string
contentSourceUrl	string
région	string
projectNumber	string
oAuthToken	string

Renvoie

Objet ima.StreamRequest ima.StreamRequest avec les propriétés VideoStitcherVod requises.

createVideoStitcherVodStreamRequestWithVodConfig

static

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken) renvoie ima.StreamRequest

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

Paramètre
vodConfigId	string
networkCode	string
région	string
projectNumber	string
oAuthToken	string

Renvoie

Objet ima.StreamRequest ima.StreamRequest avec les propriétés VideoStitcherVod requises.

createVodStreamRequest

static

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode) returns ima.StreamRequest

Initialise les propriétés requises d'une VOD ima.StreamRequest. L'utilisation de cette API entraîne l'ignorance de toute autre propriété spécifique à ima.StreamType. Si des paramètres obligatoires sont des chaînes vides, une journalisation des erreurs se produit et l'API renvoie un StreamRequest générique, sans aucune propriété ignorée.

Paramètre
contentSourceId	string
videoId	string
apiKey	string Paramètre attribué à la propriété ima.StreamRequest.apiKey des ima.StreamRequest renvoyés. 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.

Renvoie

Objet ima.StreamRequest ima.StreamRequest avec les propriétés VOD requises.