Parsování dokumentu VMAP XML na objekt Javascript. Vyhovuje specifikaci VMAP 1.0.1.

Instalace

Instalace pomocí npm

npm install vmap

Použití

Předejte konstruktoru VMAP XML, abyste měli jeho parsovanou verzi.

Přístup k vlastnostem VMAP pomocí níže zdokumentovaných API.

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

Vlastnosti

• version: Verze VMAP (měla by být 1.0).
• adBreaks:
• extensions: Pole Object s
  • children: Object obsahující všechny děti tohoto rozšíření a jejich jméno jako klíč
  • attribute: Object obsahující všechny atributy tohoto rozšíření a jejich název jako klíč
  • value: Object parsované z CDATA nebo jako nouzové řešení všechny textové uzly tohoto rozšíření zřetězené

VMAPAdBreak

Poskytuje informace o přerušení reklamy.

Vlastnosti

• timeOffset:
• breakType: Určuje, zda přerušení reklamy umožňuje „lineární“, „nelineární“ nebo „zobrazovací“ reklamu.
• breakId:
• repeatAfter:
• adSource:
• trackingEvents:
• event: Název události, která se má pro daný prvek sledovat. Může to být jedna z možností breakStart, breakEnd nebo error.
• uri: URI sledovací události.

Metody

• track(event, errorCode): Volání sledovačů pro danou událost s parametrem volitelného kódu chyby pro události error.

VMAPAdSource

Poskytuje přehrávači buď inline odpověď na reklamu, nebo odkaz na odpověď na reklamu.

Vlastnosti

• id: Identifikátor zdroje reklamy.
• allowMultipleAds: Určuje, zda lze do reklamního zlomu servírovat reklamní pod nebo více reklamních bufetů.
• followRedirects: Určuje, zda má videopřehrávač respektovat přesměrování v rámci reklamní odpovědi.
• vastAdData: Obsahuje vloženou odpověď VAST.
• adTagURI: Obsahuje URI na VAST.
• customData:

Podpora a kompatibilita

Knihovna je 100% napsána v jazyce JavaScript a zdrojový kód využívá moderní funkce jako modules, classes, ecc… . Ujistěte se, že vaše prostředí tyto funkce podporuje, nebo knihovnu při svazování projektu transpilujte.

Předpřipravené verze

Poskytujeme několik předpřipravených verzí knihovny (viz adresář dist)

Prohlížeč

K dispozici je předpřipravená verze VMAP-jsis: vmap-js.js.

Skript můžete přidat přímo do své stránky a ke knihovně přistupovat prostřednictvím konstruktoru VMAP.

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

var vmap = new VMAP(vmapXML);

Uzel

K dispozici je také předpřipravená verze pro uzel: vmap-js-node.js.

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

Sestavení a testy

Instalace závislostí pomocí:

npm install

Projekt je svázán pomocí Rollup. Sestavte pomocí:

npm run-script build

Spustit testy pomocí:

npm test

.