Parse a VMAP XML document to Javascript object. Complies with VMAP 1.0.1 spec.

Installation

Install with npm

npm install vmap

Usage

Provide the VMAP constructor an XML in order to have a parsed version of it.

Dostęp do VMAP właściwości za pomocą interfejsów API udokumentowanych poniżej.

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

Właściwości

• version: Wersja VMAP (powinna być 1.0).
• adBreaks: Tablica VMAPAdBreak obiektów.
• extensions: Tablica Object z
  • children: Object zawierającą wszystkie dzieci tego rozszerzenia i ich nazwę jako klucz
  • attribute: Object zawierający wszystkie atrybuty tego rozszerzenia i ich nazwę jako klucz
  • value: Object parsowany z CDATA lub jako fallback wszystkie węzły tekstowe tego rozszerzenia zwarte

VMAPAdBreak

Dostarcza informacji o przerwie reklamowej.

Właściwości

• timeOffset: Reprezentuje czas trwania przerwy reklamowej.
• breakType: Określa, czy przerwa reklamowa dopuszcza reklamy „liniowe”, „nieliniowe” lub „wyświetlane”.
• breakId: Opcjonalny identyfikator łańcuchowy dla przerwy reklamowej.
• repeatAfter: Opcja używana do dystrybucji przerw reklamowych w równych odstępach od siebie wzdłuż liniowej osi czasu.
• adSource: Obiekt VMAPAdSource.
• trackingEvents: Tablica Object z adresami URL do śledzenia
  • event: Nazwa zdarzenia do śledzenia dla elementu. Może być jedną z breakStart, breakEnd lub error.
  • uri: URI elementu śledzącego.
• extensions: Tablica Object z
  • children: Object zawierająca wszystkie dzieci tego rozszerzenia i ich nazwę jako klucz
  • attribute: Object zawierający wszystkie atrybuty tego rozszerzenia i ich nazwę jako klucz
  • value: Object parsowane z CDATA lub jako fallback wszystkie węzły tekstowe tego rozszerzenia konkatenowane

Metody

• track(event, errorCode): Wywołaj trackery dla danego zdarzenia z parametrem kodu błędu opcji dla zdarzeń error.

VMAPAdSource

Przekazuje odtwarzaczowi odpowiedź na reklamę inline lub odniesienie do odpowiedzi na reklamę.

Właściwości

• id: Identyfikator źródła reklam.
• allowMultipleAds: Wskazuje, czy w przerwie reklamowej może być wyświetlana reklama VAST lub wiele bufetów reklam.
• followRedirects: Wskazuje, czy odtwarzacz wideo powinien honorować przekierowania w ramach odpowiedzi reklamowej.
• vastAdData: Zawiera osadzoną odpowiedź VAST.
• adTagURI: Zawiera URI do VAST.
• customData: Contains custom ad data.

Wsparcie i kompatybilność

Biblioteka jest w 100% napisana w JavaScript, a kod źródłowy wykorzystuje nowoczesne funkcje, takie jak modules, classes, ecc… . Upewnij się, że twoje środowisko obsługuje te funkcje, lub transpiluj bibliotekę podczas bundlowania projektu.

Wersje pre-bundlowane

Dostarczamy kilka pre-bundlowanych wersji biblioteki (zobacz katalog dist)

Przeglądarka

Dostępna jest pre-bundlowana wersja VMAP-jsis: vmap-js.js.

Możesz dodać skrypt bezpośrednio do swojej strony i uzyskać dostęp do biblioteki poprzez konstruktor VMAP.

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

var vmap = new VMAP(vmapXML);

Node

Dostępna jest również pre-bundlowana wersja dla node: vmap-js-node.js.

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

Build and tests

Install dependencies with:

npm install

Projekt jest bundlowany przy użyciu Rollup. Build with:

npm run-script build

Run tests with:

npm test

.