vst-nodejs

Minimal Nodejs VAST Client

Vast Client JS is a JavaScript library to fetch and parse Digital Video Ad Serving Template (VAST) documents.

This library provides three components:

• A VAST Client to fetch and parse VAST XML resources into JavaScript Objects.
• A VAST Parser to directly parse a VAST XML.
• A VAST Tracker to batch and call tracking URLs.

Complies with the VAST 3.0 specification provided by the Interactive Advertising Bureau (IAB).

Get Started

VAST Client JS is available as an NPM package and can be easily installed with:

yarn add vst-nodejs

Then import the components you need.

VASTClient

If you need to fetch and parse VAST documents, you can use the VASTClient:

import { VASTClient } from 'vst-nodejs'
 
const vastClient = new VASTClient();
 
vastClient.get('https://www.examplevast.com/vast.xml')
  .then(res => {
    // Do something with the parsed VAST response
  })
  .catch(err => {
    // Deal with the error
  });

In addition to fetching and parsing a VAST resource, VASTClient provides options to filter a sequence of calls based on count and time of execution, together with the possibility to track URLs using VASTTracker.

VASTParser

To directly parse a VAST XML you can use the VASTParser:

import { VASTParser } from 'vst-nodejs'
 
const vastParser = new VASTParser();
 
vastParser.parseVAST(vastXml)
  .then(res => {
    // Do something with the parsed VAST response
  })
  .catch(err => {
    // Deal with the error
  });

VASTTracker

To track the execution of an ad use the VASTTracker:

import { VASTTracker } from 'vst-nodejs'
 
const vastTracker = new VASTTracker(vastClient, ad, creative);
 
// Track an impression for the given ad
vastTracker.trackImpression();

API Documentation

The API documentation is organized by components:

• VASTClient
• VASTParser
• VASTTracker

Proxy

import { VASTClient } from 'vst-nodejs'
 
const vastClient = new VASTClient();
 
vastClient
  .get('https://www.examplevast.com/vast.xml', {
    proxy: {
      host: '****',
      port: 22225,
      auth: {
        username: '****',
        password: '*****'
      }
    }
  })
  .then(res => {
    // Do something with the parsed VAST response
  })
  .catch(err => {
    // Deal with the error
  });