README.md

vpaid-ad

VPAID ad class for extending purposes.

This is a reference implementation of VPAID ad. Feel free to extend this to suit your needs. It implements the most basic set of VPAID methods.

Installing using npm

npm i --save vpaid-ad

Usage

You can extend it using this way:

const Linear = require('vpaid-ad/src/linear')
class VpaidAd extends Linear {
  initAd (width, height, viewMode, desiredBitrate, creativeData, environmentVars) {
  	// Do something
    super.initAd(
      width,
      height,
      viewMode,
      desiredBitrate,
      creativeData,
      environmentVars
    )
  }
}

window.getVPAIDAd = function () {
  return new VpaidAd()
}

Your player can then call:

vpaid = window.getVPAIDAd()
vpaid.subscribe(...)

clickThru

There's a special clickThru method that you can use:

vpaid.clickThru({
  url: 'https://example.com',
  id: 'my-id',
  playerHandles: true
})

The above function emits the parameters as both an object and as an array.

As an array:

["https://example.com", "my-id", true]

As an object:

{
  "url": "https://example.com",
  "id": "my-id",
  "playerHandles": true
}

Resources

• MailOnline's VPAIDHTML5Client