Parse un document VMAP XML în obiect Javascript. Este în conformitate cu specificația VMAP 1.0.1.

Instalare

Instalați cu npm

npm install vmap

Utilizare

Furnizați constructorului VMAP un XML pentru a avea o versiune analizată a acestuia.

Accesați proprietățile VMAP folosind API-urile documentate mai jos.

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

Proprietăți

• version: Versiunea VMAP (ar trebui să fie 1.0).
• adBreaks: O matrice de obiecte VMAPAdBreak.
• extensions: O matrice de Object cu
  • children: Object care conține toți copiii acestei extensii și numele lor ca cheie
  • attribute: Object conținând toate atributele acestei extensii și numele lor ca și cheie
  • value: Object analizat din CDATA sau, ca o soluție de rezervă, toate nodurile de text ale acestei extensii concatenate

VMAPAdBreak

Furnizează informații despre o pauză publicitară.

Proprietăți

• timeOffset: Reprezintă sincronizarea pauzei publicitare.
• breakType: Identifică dacă pauza publicitară permite reclame „liniare”, „neliniare” sau „de afișare”.
• breakId: Un identificator de șir opțional pentru pauza publicitară.
• repeatAfter: O opțiune utilizată pentru a distribui pauzele publicitare la distanțe egale între ele de-a lungul unei cronologii liniare.
• adSource: Un obiect VMAPAdSource.
• trackingEvents: O matrice de Object cu URL-uri de urmărire
  • event: Numele evenimentului de urmărit pentru element. Poate fi unul dintre breakStart, breakEnd sau error.
  • uri: URI-ul urmăritorului.
• extensions: O matrice de Object cu
  • children: Object care conține toți copiii acestei extensii și numele lor ca cheie
  • attribute: Object conținând toate atributele acestei extensii și numele lor ca și cheie
  • value: Object analizat din CDATA sau, ca o soluție de rezervă, toate nodurile de text ale acestei extensii concatenate

Metode

• track(event, errorCode): Apelarea urmăritorilor pentru evenimentul dat cu un parametru de cod de eroare opțional pentru evenimentele error.

VMAPAdSource

Furnizează playerului fie un răspuns publicitar în linie, fie o referință la un răspuns publicitar.

Proprietăți

• id: Identificatorul anunțului pentru sursa anunțului.
• allowMultipleAds: Indică dacă un pod de anunțuri VAST sau mai multe bufete de anunțuri pot fi servite într-o pauză publicitară.
• followRedirects: Indică dacă playerul video trebuie să onoreze redirecționările din cadrul unui răspuns publicitar.
• vastAdData: Conține un răspuns VAST încorporat.
• adTagURI: Conține un URI către VAST.
• customData: Conține date publicitare personalizate.

Suport și compatibilitate

Librăria este scrisă 100% în JavaScript, iar codul sursă utilizează caracteristici moderne precum modules, classes, ecc… . Asigurați-vă că mediul dvs. suportă aceste caracteristici, sau transpuneți biblioteca atunci când vă împachetați proiectul.

Versiuni pre-pachetate

Furnizăm mai multe versiuni pre-pachetate ale bibliotecii (vezi directorul dist)

Browser

Este disponibilă o versiune pre-pachetată a VMAP-jsis: vmap-js.js.

Puteți adăuga scriptul direct în pagina dvs. și accesa biblioteca prin constructorul VMAP.

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

var vmap = new VMAP(vmapXML);

Node

Este disponibilă și o versiune pre-bundled pentru node: vmap-js-node.js.

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

Construiți și testați

Instalați dependențele cu:

npm install

Proiectul este grupat folosind Rollup. Construiți cu:

npm run-script build

Executați testele cu:

npm test

.