Partilhar um documento VMAP XML para objeto Javascript. Cumpre com VMAP 1.0.1 spec.

Instalação

Instalar com npm

npm install vmap

Uso

Fornecer ao construtor um XML a fim de ter uma versão parsed dele.

Acesso propriedades usando os APIs documentados abaixo.

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

Propriedades

• version: A versão VMAP (deve ser 1.0).
• adBreaks: Um array de VMAPAdBreak objetos.
• extensions: Um array de Object com
  • children: Object contendo toda esta extensão crianças e seu nome como a chave
  • attribute: Object contendo todos os atributos desta extensão e seu nome como chave
  • value: Object parsed from CDATA or as a fallback all of the text nodes of this extension concatenated

VMAPAdBreak

Provê informação sobre uma quebra de anúncio.

Propriedades

• timeOffset: Representa o tempo da quebra do anúncio.
• breakType: Identifica se a quebra do anúncio permite anúncios “lineares”, “não lineares” ou “mostrar”.
• breakId: Um identificador de string opcional para a quebra do anúncio.
• repeatAfter: Uma opção usada para distribuir quebras de anúncio igualmente espaçadas uma da outra ao longo de uma linha temporal linear.
• adSource: A VMAPAdSource objeto.
• trackingEvents: Uma matriz de Object com URLs de rastreamento
  • event: O nome do evento a rastrear para o elemento. Pode ser um de breakStart, breakEnd ou erro.
  • uri: O URI do rastreador.
• extensions: Uma matriz de Object com
  • children: Object contendo toda esta extensão crianças e seu nome como a chave
  • attribute: Object contendo todos os atributos desta extensão e seu nome como chave
  • value: Object parsed from CDATA or as a fallback all of the text nodes of this extension concatenated

Métodos

• track(event, errorCode): Chama os rastreadores para o evento dado com um parâmetro de código de erro de opção para error eventos.

VMAPAdSource

Fornece ao leitor uma resposta de anúncio em linha ou uma referência a uma resposta de anúncio.

Propriedades

• id: Identificador do anúncio para a fonte do anúncio.
• allowMultipleAds: Indica se um pod de anúncio VAST ou buffet múltiplo de anúncios pode ser servido em uma quebra de anúncio.
• followRedirects: Indica se o reprodutor de vídeo deve honrar os redirecionamentos dentro de uma resposta de anúncio.
• vastAdData: Contém uma resposta VAST incorporada.
• adTagURI: Contém um URI para o VAST.
• customData: Contém dados de anúncios personalizados.

: Suporte e compatibilidade

: A biblioteca é 100% escrita em JavaScript e o código fonte usa recursos modernos como modules, classes, ecc… . Certifique-se de que o seu ambiente suporta estes recursos, ou transponha a biblioteca ao empacotar o seu projeto.

Versões pré-agrupadas

Fornecemos várias versões pré-agrupadas da biblioteca (ver dist diretório)

Navegador

Uma versão pré-agrupada do VMAP-jsis disponível: vmap-js.js.

Você pode adicionar o script diretamente à sua página e acessar a biblioteca através do construtor VMAP

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

var vmap = new VMAP(vmapXML);

Nó

Uma versão pré-agrupada para nó também está disponível: vmap-js-node.js.

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

Construir e testar

Instalar dependências com:

npm install

O projeto é empacotado usando Rollup. Construir com:

npm run-script build

Executar testes com:

npm test