Parse a VMAP XML dokumentumból Javascript objektum. Megfelel a VMAP 1.0.1 specifikációnak.

Telepítés

Telepítés az npm segítségével

npm install vmap

Használat

Adjunk meg a VMAP konstruktornak egy XML-t, hogy egy elemzett változatot kapjunk.

A VMAP tulajdonságaihoz az alább dokumentált API-k segítségével férhet hozzá.

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

Tulajdonságok

• version: A VMAP verziója (legyen 1.0).
• adBreaks: VMAPAdBreak objektumok tömbje.
• extensions:
  • children: Object, amely tartalmazza az összes ilyen kiterjesztés gyermekét és a nevüket kulcsként
  • attribute: Object amely tartalmazza az összes ilyen kiterjesztés attribútumot és azok nevét kulcsként
  • value: Object CDATA-ból elemezve, vagy tartalékként a bővítmény összes szöveges csomópontját összekapcsolva

VMAPAdBreak

Megadja a hirdetési szünetre vonatkozó információkat.

Tulajdonságok

• timeOffset: Reprezentálja a reklámszünet időzítését.
• breakType: Azonosítja, hogy a reklámszünet “lineáris”, “nem lineáris” vagy “display” hirdetéseket engedélyez-e.
• breakId: A hirdetési szünet opcionális karakterlánc-azonosítója.
• repeatAfter: A lineáris idővonal mentén egymástól egyenlő távolságra lévő hirdetési szünetek elosztására szolgáló opció.
• adSource: VMAPAdSource objektum.
• trackingEvents: Egy Object tömb a követési URL-ekkel
  • event: Az elemhez tartozó követendő esemény neve. Lehet a breakStart, breakEnd vagy error valamelyike.
  • uri: A nyomkövető URI-je.
• extensions: Object tömbje
  • children: Object, amely tartalmazza az összes ilyen kiterjesztés gyermekét és a nevüket kulcsként
  • attribute: Object amely tartalmazza az összes ilyen kiterjesztés attribútumot és azok nevét kulcsként
  • value: Object a CDATA-ból elemezve, vagy tartalékként a bővítmény összes szöveges csomópontját összekapcsolva

Módszerek

• track(event, errorCode): Az adott esemény nyomkövetőinek meghívása egy opcionális hibakód paraméterrel error események esetén.

VMAPAdSource

A lejátszó számára vagy egy inline hirdetési választ, vagy egy hirdetési válaszra való hivatkozást biztosít.

Tulajdonságok

• id: A hirdetésforrás hirdetésazonosítója.
• allowMultipleAds: Megjelöli, hogy egy hirdetési szünetben egy VAST hirdetési pod vagy több hirdetési büfé szolgálható-e ki.
• followRedirects: Megjelöli, hogy a videólejátszónak tiszteletben kell-e tartania a hirdetési válaszon belüli átirányításokat.
• vastAdData: Beágyazott VAST választ tartalmaz.
• adTagURI: Tartalmaz egy URI-t a VAST-hoz.
• customData: Egyedi hirdetési adatokat tartalmaz.

Támogatás és kompatibilitás

A könyvtár 100%-ban JavaScriptben íródott, és a forráskód olyan modern funkciókat használ, mint modules, classes, ecc… . Győződjön meg róla, hogy a környezete támogatja ezeket a funkciókat, vagy fordítsa át a könyvtárat a projekt csomagolásakor.

Előre csomagolt verziók

A könyvtár több előre csomagolt verzióját biztosítjuk (lásd dist könyvtár)

Browser

A VMAP-jsis elérhető előre csomagolt verziója: vmap-js.js.

A szkriptet közvetlenül hozzáadhatja az oldalához, és a könyvtárat a VMAP konstruktoron keresztül érheti el.

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

var vmap = new VMAP(vmapXML);

Node

A node-hoz is elérhető egy előre csomagolt verzió: vmap-js-node.js.

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

Build and tests

A függőségek telepítése:

npm install

A projektet a Rollup segítségével csomagoljuk. Build with:

npm run-script build

Run tests with:

npm test