Clase: StreamRequest

ima.StreamRequest

class   static

Constructor

StreamRequest

new StreamRequest()

Se usa para especificar propiedades de la solicitud de transmisión.

Propiedades

adTagParameters

static

String

Opcional. Puedes anular un conjunto limitado de parámetros de etiquetas de anuncios en tu solicitud de transmisión. En Cómo agregar parámetros de segmentación a tu transmisión, encontrarás más información. También puedes usar los parámetros dai-ot y dai-ov para establecer la preferencia de variantes de transmisión. Consulta Cómo anular los parámetros de variantes de transmisión para obtener más información.

adUiNode

static

roSGNode

Es un nodo de gráfico de escena en el que se muestra la IU del anuncio. Durante los anuncios, IMA coloca elementos como los botones Por qué este anuncio y Omitir en este elemento. El elemento debe superponerse a todo el elemento de video.

apiKey

static

String

Opcional. Estas claves se pueden usar para autenticar solicitudes de transmisión. Las claves de autenticación de DAI se deben configurar en la IU de DFP.

assetKey

static

String

Se requiere para las transmisiones en vivo. Se usa para determinar qué transmisión se debe reproducir. La clave del activo de la solicitud de transmisión en vivo es un identificador que se puede encontrar en la IU de DFP.

authToken

static

String

El token de autorización de la solicitud de transmisión. Se usa en lugar de la clave de API para una autorización de contenido más estricta. El editor puede controlar las autorizaciones de transmisiones de contenido individuales en función de este token.

contentSourceId

static

String

Es obligatorio para las transmisiones a pedido. El parámetro cmsid proviene de la fuente de contenido de video de DFP en la IU de DFP.

customAssetKey

static

String

La clave del activo personalizada se usa para determinar qué transmisión se debe reproducir. Se requieren claves de activos personalizadas para las solicitudes de transmisión de entrega de pods.

formato

static

ima.StreamFormat

Es el formato de la transmisión. La configuración predeterminada es ima.StreamFormat.HLS.

networkCode

static

String

Es el código de red del publicador que realiza la solicitud de transmisión. Se requieren códigos de red para las solicitudes de transmisión de servicio de Pod realizadas con createPodLiveStreamRequest o createPodVodStreamRequest. Estos códigos también son necesarios para las solicitudes de transmisión de Cloud Stitching realizadas con createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest o createVideoStitcherVodStreamRequestWithVodConfig. Estos códigos son opcionales y se recomiendan para las solicitudes de transmisión de servicio completo realizadas con createLiveStreamRequest o createVodStreamRequest. Agregar el código de red aplica la configuración seleccionada en la IU de Ad Manager, como la habilitación de anuncios programáticos limitados. Para la publicación de Pods y la unión de Cloud, agregar el código de red permite ubicar y reproducir la transmisión. Para encontrar el código de red, consulta este artículo.

jugador

static

(ima.Player o no válido)

Es una implementación de la interfaz del reproductor.

ppid

static

String

Obsoleta. Usa adTagParameters. Opcional. Es un identificador proporcionado por el publicador de un público de DFP.

streamActivityMonitorId

static

String

Es el ID que se usará para depurar la transmisión con el monitor de actividad de transmisión. Se usa para proporcionar una forma conveniente de permitir que los publicadores encuentren un registro de transmisión en la herramienta de supervisión de la actividad de transmisión.

videoId

static

String

Es obligatorio para las transmisiones a pedido. Es el identificador de la fuente de contenido de video.

videoObject

static

(roVideo o no válido)

Objeto de video (como el nodo roSGNode de Video) responsable de la reproducción de video en la app del cliente. Se sondeará este objeto para obtener varios datos que se usarán para sincronizar correctamente los eventos ID3 de HLS en vivo.

videoStitcherSessionOptions

static

Es un array de V.

Las opciones de sesión se usan para configurar parámetros específicos del VideoStitcher para las solicitudes de transmisión de VideoStitcher.

Métodos

createLiveStreamRequest

static

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

Inicializa las propiedades obligatorias de un StreamRequest en vivo. El uso de esta API hace que se ignore cualquier otra propiedad específica de StreamType. Si alguno de los parámetros obligatorios son cadenas vacías, se registrará un error y la API devolverá un StreamRequest genérico, sin que se ignore ninguna propiedad.

Parámetro
assetKey	string
apiKey	string Parámetro asignado a la propiedad ima.StreamRequest.apiKey del objeto ima.StreamRequest que se devolvió. Si no existe una clave de API, pasa una cadena vacía.
networkCode	string Es el código de red del publicador que realiza la solicitud de transmisión. Incluir el código de red es opcional, pero se recomienda.

Muestra

Objeto ima.StreamRequest ima.StreamRequest con propiedades de Live obligatorias.

createPodLiveStreamRequest

static

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey) devuelve StreamRequest

Inicializa las propiedades obligatorias de un Pod Live ima.StreamRequest. El uso de esta API hace que se ignore cualquier otra propiedad específica de ima.StreamType. Si alguno de los parámetros obligatorios son cadenas vacías, se registrará un error y la API devolverá un StreamRequest genérico, sin que se ignore ninguna propiedad.

Parámetro
customAssetKey	string
networkCode	string
apiKey	string Parámetro opcional asignado a la propiedad ima.StreamRequest.apiKey de los objetos ima.StreamRequest devueltos. El valor predeterminado es una cadena vacía.

Muestra

Objeto StreamRequest ima.StreamRequest con las propiedades de PodLive obligatorias.

createPodVodStreamRequest

static

createPodVodStreamRequest(networkCode) devuelve StreamRequest

Inicializa las propiedades requeridas de un ima.StreamRequest para registrar una transmisión VOD cuando se utiliza el servicio DAI Pod con un cosidor de video de terceros. Esta función establece el tipo de solicitud en ima.StreamType.POD_VOD y valida todas las propiedades requeridas para detectar datos faltantes. Las validaciones fallidas registrarán un error en la consola de depuración.

Parámetro
networkCode	string El código de red de Google Ad Manager

Muestra

StreamRequest un objeto ima.StreamRequest Si se especifican todas las propiedades requeridas, el tipo de solicitud se establece en ima.StreamType.POD_VOD.

createStreamRequest

static

createStreamRequest() devuelve ima.StreamRequest

Muestra

ima.StreamRequest Un objeto ima.StreamRequest vacío.

createVideoStitcherLiveStreamRequest

static

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

Inicializa las propiedades obligatorias de un objeto StreamRequest de Video Stitcher Live. El uso de esta API hace que se ignore cualquier otra propiedad específica de StreamType. Si alguno de los parámetros obligatorios son cadenas vacías, se registrará un error y la API devolverá un StreamRequest genérico, sin que se ignore ninguna propiedad.

Parámetro
customAssetKey	string
networkCode	string
liveConfigId	string
región	string
projectNumber	string
oAuthToken	string

Muestra

Objeto ima.StreamRequest ima.StreamRequest con las propiedades de VideoStitcherLive requeridas.

createVideoStitcherVodStreamRequest

static

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

Inicializa las propiedades obligatorias de un StreamRequest de Video Stitcher VOD. El uso de esta API hace que se ignore cualquier otra propiedad específica de StreamType. Si alguno de los parámetros obligatorios son cadenas vacías, se registrará un error y la API devolverá un StreamRequest genérico, sin que se ignore ninguna propiedad.

Parámetro
adTagUrl	string
networkCode	string
contentSourceUrl	string
región	string
projectNumber	string
oAuthToken	string

Muestra

Objeto ima.StreamRequest ima.StreamRequest con las propiedades de VideoStitcherVod requeridas.

createVideoStitcherVodStreamRequestWithVodConfig

static

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

Inicializa las propiedades requeridas de un StreamRequest de Video Stitcher VOD usando el vodConfigId creado a partir de Video Stitcher de Cloud. El uso de esta API hace que se ignore cualquier otra propiedad específica de StreamType. Si alguno de los parámetros obligatorios son cadenas vacías, se registrará un error y la API devolverá un StreamRequest genérico, sin que se ignore ninguna propiedad.

Parámetro
vodConfigId	string
networkCode	string
región	string
projectNumber	string
oAuthToken	string

Muestra

Objeto ima.StreamRequest ima.StreamRequest con las propiedades de VideoStitcherVod requeridas.

createVodStreamRequest

static

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

Inicializa las propiedades obligatorias de un objeto ima.StreamRequest de VOD. El uso de esta API hace que se ignore cualquier otra propiedad específica de ima.StreamType. Si alguno de los parámetros obligatorios son cadenas vacías, se registrará un error y la API devolverá un StreamRequest genérico, sin que se ignore ninguna propiedad.

Parámetro
contentSourceId	string
videoId	string
apiKey	string Parámetro asignado a la propiedad ima.StreamRequest.apiKey del objeto ima.StreamRequest que se devolvió. Si no existe una clave de API, pasa una cadena vacía.
networkCode	string Es el código de red del publicador que realiza la solicitud de transmisión. Incluir el código de red es opcional, pero se recomienda.

Muestra

Objeto ima.StreamRequest ima.StreamRequest con propiedades de VOD obligatorias.