Parse ett VMAP XML-dokument till ett Javascript-objekt. Överensstämmer med VMAP 1.0.1 spec.

Installation

Installera med npm

npm install vmap

Användning

Förse VMAPkonstruktören med ett XML-dokument för att få en analyserad version av det.

Access VMAPegenskaper med hjälp av de API:er som dokumenteras nedan.

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

Egenskaper

• version: VMAP-versionen (bör vara 1.0).
• adBreaks: En matris med VMAPAdBreak objekt.
• extensions: En matris med VMAPAdBreak objekt: En array av Object med
  • children: En array av Object med
    • children: Object som innehåller alla dessa tilläggsbarn och deras namn som nyckel
    • attribute: Object som innehåller alla dessa tilläggsattribut och deras namn som nyckel
    • value: Object parsed from CDATA or as a fallback all of the text nodes of this extension concatenated

  VMAPAdBreak

  Gör information om ett annonsavbrott.

  Properties

  • timeOffset:
  • breakType: Anger om annonsavbrottet tillåter ”linjära”, ”icke-linjära” eller ”display”-annonser.
  • breakId: Anger om annonsavbrottet tillåter ”linjära”, ”icke-linjära” eller ”display”-annonser:
  • repeatAfter: En valfri strängidentifierare för annonsavbrottet: Ett alternativ som används för att fördela annonsavbrott med lika stort avstånd från varandra längs en linjär tidslinje.
  • adSource: Ett alternativ som används för att fördela annonsavbrott med lika stort avstånd från varandra längs en linjär tidslinje: VMAPAdSource: Ett VMAPAdSource objekt.
  • trackingEvents: Ett VMAPAdSource objekt: En array av Object med spårnings-URL:er
    • event: Namnet på den händelse som ska spåras för elementet. Kan vara ett av breakStart, breakEnd eller error.
    • uri: URI för spåraren.
  • extensions: En array av Object med
    • children: En array av Object med
      • children: Object som innehåller alla barn till det här tillägget och deras namn som nyckel
      • attribute: Object som innehåller alla dessa tilläggsattribut och deras namn som nyckel
      • value: Object parsed from CDATA or as a fallback all of the text nodes of this extension concatenated

    Methods

    • track(event, errorCode): error händelser.

    VMAPAdSource

    Gör att spelaren får antingen ett inline-annonsvar eller en referens till ett annonsvar.

    Egenskaper

    • id: Annonsidentifierare för annonskällan.
    • allowMultipleAds: Anger om en VAST-annonskapsel eller flera annonsbufféer kan serveras i ett annonsavbrott.
    • followRedirects: Anger om videospelaren ska respektera omdirigeringar i ett annonssvar.
    • vastAdData:
    • adTagURI: Innehåller ett inbäddat VAST-svar: Innehåller en URI till VAST.
    • customData: Innehåller ett VAST-svar: Innehåller anpassade annonsdata.

    Stöd och kompatibilitet

    Biblioteket är skrivet till 100 % i JavaScript och källkoden använder moderna funktioner som modules, classes, ecc… . Se till att din miljö har stöd för dessa funktioner, eller transpila biblioteket när du paketerar ditt projekt.

    Förbuntade versioner

    Vi tillhandahåller flera förbuntade versioner av biblioteket (se katalogen dist)

    Browser

    En förbuntad version av VMAP-jsis tillgänglig: vmap-js.js.

    Du kan lägga till skriptet direkt på din sida och få tillgång till biblioteket via VMAPkonstruktören.

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

    var vmap = new VMAP(vmapXML);

    Node

    En förpaketerad version för node finns också: vmap-js-node.js.

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

    Bygg och tester

    Installera beroenden med:

    npm install

    Projektet är paketerat med Rollup. Bygg med:

    npm run-script build

    Kör tester med:

    npm test