vast-xml/lib/creative.js

VAST XML responses for online video advertisers.

var CompanionAd = require('./companion-ad')
  , Icon = require('./icon')
  , TrackingEvent = require('./tracking-event')

function Creative(type, settings) {
  settings = settings || {};
  this.type = type;
  this.AdParameters = settings.AdParameters;

  if (settings.Duration) {
    this.Duration = settings.Duration;    
  } else if (type === 'Linear') {
    throw new Error('A Duration is required for all creatives. Consider defaulting to "00:00:00"');
  }
  this.attributes = {};
  if (settings.id) this.attributes.id = settings.id;
  if (settings.width) this.attributes.width = settings.width;
  if (settings.height) this.attributes.height = settings.height;
  if (settings.expandedWidth) this.attributes.expandedWidth = settings.expandedWidth;
  if (settings.expandedHeight) this.attributes.expandedHeight = settings.expandedHeight;
  if (settings.scalable !== undefined) this.attributes.scalable = settings.scalable;
  if (settings.maintainAspectRatio !== undefined) this.attributes.maintainAspectRatio = settings.maintainAspectRatio;
  if (settings.minSuggestedDuration) this.attributes.minSuggestedDuration = settings.minSuggestedDuration;
  if (settings.apiFramework) this.attributes.apiFramework = settings.apiFramework;
  if (type == 'Linear' && settings.skipoffset) this.skipoffset = settings.skipoffset;

  this.mediaFiles = [];
  this.attachMediaFile = function(url, settings) {
    settings = settings || {};
    var mediaFile = { attributes : {} };
    mediaFile.url = url;
    mediaFile.attributes.type = settings.type || 'video/mp4';
    mediaFile.attributes.width = settings.width || '640';
    mediaFile.attributes.height = settings.height || '360';
    mediaFile.attributes.delivery = settings.delivery || 'progressive';
    if (!settings.id)
      throw new Error('an `id` is required for all media files');
    mediaFile.attributes.id = settings.id
    if (settings.bitrate) mediaFile.attributes.bitrate = settings.bitrate
    if (settings.minBitrate) mediaFile.attributes.minBitrate = settings.minBitrate
    if (settings.maxBitrate) mediaFile.attributes.maxBitrate = settings.maxBitrate
    if (settings.scalable !== undefined) mediaFile.attributes.scalable = settings.scalable
    if (settings.maintainAspectRatio) mediaFile.attributes.maintainAspectRatio = settings.maintainAspectRatio
    if (settings.codec) mediaFile.attributes.codec = settings.codec
    if (settings.apiFramework) mediaFile.attributes.apiFramework = settings.apiFramework
    this.mediaFiles.push(mediaFile);
    return this;
  };
  this.trackingEvents = [];
  this.attachTrackingEvent = function(type, url, offset) {
    this.trackingEvents.push(new TrackingEvent(type, url, offset));
    return this;
  };
  this.videoClicks = [];
  this.attachVideoClick = function(type, url, id) {
    var VALID_VIDEO_CLICKS = ['ClickThrough', 'ClickTracking', 'CustomClick']
    if (VALID_VIDEO_CLICKS.indexOf(type) < 0) { 
      throw new Error('The supplied VideoClick `type` is not a valid VAST VideoClick type.');
    }
    this.videoClicks.push({ type : type, url : url, id : id || '' });
    return this;
  };
  this.clickThroughs = [];
  this.attachClickThrough = function(url) {  
    this.clickThroughs.push(url);
    return this;
  }
  this.clicks = [];
  this.attachClick = function(uri, type) {
    if (typeof uri === 'string') type = 'NonLinearClickThrough'
    this.clicks = [{ type : type, uri : uri }];
    return this;
  }
  this.adParameters = function(data, xmlEncoded) {  
    this.adParameters = { data : data, xmlEncoded : xmlEncoded }
    return this;
  }
  this.resources = [];
  this.attachResource = function(type, uri, creativeType) {
    var resource = { type : type, uri : uri }
    if (type === 'HTMLResource') resource.html = uri;
    if (creativeType) resource.creativeType = creativeType;
    this.resources.push(resource);
    return this;
  };
  this.icons = [];
  this.attachIcon = function(settings) {
    var icon = new Icon(settings);
    this.icons.push(icon);
    return icon;
  }
}

module.exports = Creative;