dailymotion / vast-client-js

VAST Client JS 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. For the full API documentation go here. For the full Class reference go here To explore a practical example of how the VAST client can be implemented in web applications please visit this link. Additionally, use this link to learn how to use the VAST client in a basic Node application. Complies with the VAST 4.3 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: Then import the components you need. VASTClient If you need to fetch and parse VAST documents, you can use the method from the **VASTClient**: 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**. If you need to directly parse a VAST XML and also follow any wrappers chain, you can use the method from the **VASTClient** : VASTParser To directly parse a VAST XML you can use the **VASTParser**: The **VASTParser** will make no fetching, the final response will only contain the first VAST encountered. VASTTracker To track the execution of an ad, create a **VASTTracker** instance and use the dedicated methods to calls VAST tracking elements. API Documentation The API documentation is organized by components: • VASTClient • VASTParser • VASTTracker Changelog and migration guides can be found in the release notes. Pre-bundled versions We provide several pre-bundled versions of the client (see directory) Bundlers A version for js bundlers (like webpack or rollup) is available by default when adding the lib using a package manager (like npm or yarn): or [minified]. Browser script A pre-bundled version of VAST Client JS is available: [minified]. To use it, either host it on your CDN or locally in your project. If you're using a script tag make sure to set the type property to module like below. _your index.html_ _main.js_ Node A pre-bundled version for node is available too: or [minified]. Build / Contribute See CONTRIBUTING