Parar un documento VMAP XML a objeto Javascript. Cumple con la especificación VMAP 1.0.1.

Instalación

Instalar con npm

npm install vmap

Uso

Proporcionar al constructor VMAPun XML para tener una versión analizada del mismo.

Accede a las propiedades de VMAP utilizando las APIs documentadas a continuación.

import VMAP from 'vmap';// Fetch VMAP as XMLconst xhr = new XMLHttpRequest();xhr.open('GET', vmapURL);xhr.send();xhr.onreadystatechange = function() { if (xhr.readyState === xhr.DONE) { if (xhr.status === 200) { // Get a parsed VMAP object const vmap = new VMAP(xhr.responseXML); } }};

API

VMAP

Propiedades

• version: La versión de VMAP (debe ser 1.0).
• adBreaks: Una matriz de VMAPAdBreak objetos.
• extensions: Un array de Object con
  • children: Object que contiene todos los hijos de esta extensión y su nombre como clave
  • attribute: Object que contiene todos los atributos de esta extensión y su nombre como clave
  • value: Object analizado a partir de CDATA o como alternativa todos los nodos de texto de esta extensión concatenados

VMAPAdBreak

Proporciona información sobre una pausa publicitaria.

Propiedades

• timeOffset: Representa el tiempo de la pausa publicitaria.
• breakType: Identifica si la pausa publicitaria permite anuncios «lineales», «no lineales» o «de pantalla».
• breakId: Un identificador de cadena opcional para la pausa publicitaria.
• repeatAfter: Una opción utilizada para distribuir las pausas de anuncios igualmente espaciadas entre sí a lo largo de una línea de tiempo lineal.
• adSource: Un objeto VMAPAdSource.
• trackingEvents: Un array de Object con URLs de seguimiento
  • event: El nombre del evento a rastrear para el elemento. Puede ser uno de breakStart, breakEnd o error.
  • uri: El URI del rastreador.
• extensions: Un array de Object con
  • children: Object que contiene todos los hijos de esta extensión y su nombre como clave
  • attribute: Object que contiene todos los atributos de esta extensión y su nombre como clave
  • value: Object analizado desde CDATA o como alternativa todos los nodos de texto de esta extensión concatenados

Métodos

• track(event, errorCode): Llama a los rastreadores para el evento dado con un parámetro de código de error de opción para eventos error.

VMAPAdSource

Proporciona al reproductor una respuesta de anuncio en línea o una referencia a una respuesta de anuncio.

Propiedades

• id: Identificador de anuncios para la fuente de anuncios.
• allowMultipleAds: Indica si se puede servir un pod de anuncios VAST o un buffet múltiple de anuncios en una pausa publicitaria.
• followRedirects: Indica si el reproductor de vídeo debe respetar las redirecciones dentro de una respuesta de anuncios.
• vastAdData: Contiene una respuesta VAST incrustada.
• adTagURI: Contiene un URI al VAST.
• customData: Contiene datos de anuncios personalizados.

Soporte y compatibilidad

La librería está 100% escrita en JavaScript y el código fuente utiliza características modernas como modules, classes, ecc… . Asegúrese de que su entorno es compatible con estas características, o transpile la biblioteca al empaquetar su proyecto.

Versiones pre-empaquetadas

Proporcionamos varias versiones pre-empaquetadas de la biblioteca (ver directorio dist)

Navegador

Una versión pre-empaquetada de VMAP-jsis disponible: vmap-js.js.

Puedes añadir el script directamente a tu página y acceder a la librería a través del constructor VMAP.

<script src="dist/vmap-js.js"></script>

var vmap = new VMAP(vmapXML);

Node

También está disponible una versión precompuesta para node: vmap-js-node.js.

const VMAP = require('vmap')const vmap = new VMAP(vmapXML);

Construye y prueba

Instala las dependencias con:

npm install

El proyecto está empaquetado usando Rollup. Construir con:

npm run-script build

Ejecutar pruebas con:

npm test