openrtb/lib/openrtb2_3/bidRequest.js

A Javascript library which builds and validates OpenRTB objects

const RtbObject = require('../rtbObject');
const validator = require('../validator');
const AppBuilder = require('./app').builder;
const UserBuilder = require('./user').builder;
const DeviceBuilder = require('./device').builder;
const ImpressionBuilder = require('./imp').builder;
const SiteBuilder = require('./site').builder;
const RegsBuilder = require('./regs').builder;
const removeEmptyValues = require('../utils').removeEmptyValues;
const bidRequestSchema = require('./schemas/bidRequest');
const ValidationError = require('../errors/ValidationError');

var BidRequest = function(timestamp, id, at, imp, app, device, user, bcat, badv, test, tmax, site, regs, ext){
  this.timestamp = timestamp;
  this.id = id;
  this.at = at;
  this.imp = imp;
  this.app = app;
  this.device = device;
  this.user = user;
  this.bcat = bcat;
  this.badv = badv;
  this.test = test;
  this.tmax = tmax;
  this.site = site;
  this.regs = regs;
  this.ext = ext;
};

BidRequest.prototype = Object.create(RtbObject.prototype);

var BidRequestBuilder = function(){};

BidRequestBuilder.prototype.timestamp = function(timestamp){
  this._timestamp = timestamp;
  return this;
};

BidRequestBuilder.prototype.id = function(id){
  this._id = id;
  return this;
};

BidRequestBuilder.prototype.at = function(at){
  this._at = at;
  return this;
};

BidRequestBuilder.prototype.imp = function(imp){
  const builder = new ImpressionBuilder();
  this._imp = imp.map((imp) => {
    builder
    .id(imp.id)
    .bidfloor(imp.bidfloor)
    .tagid(imp.tagid)
    .secure(imp.secure);

    if (imp.pmp) {
      builder.pmp(imp.pmp);
    }

    if (imp.banner){
      builder.banner(imp.banner);
    } else if (imp.native){
      builder.native(imp.native);
    } else if (imp.video){
      builder.video(imp.video);
    }

    return builder.build();
  });
  return this;
};

BidRequestBuilder.prototype.app = function(app){
  const builder = new AppBuilder();
  this._app = builder
              .storeurl(app.storeurl)
              .cat(app.cat)
              .id(app.id)
              .name(app.name)
              .publisher(app.publisher)
              .bundle(app.bundle)
              .domain(app.domain)
              .build();
  return this;
};

BidRequestBuilder.prototype.device = function(device){
  const builder = new DeviceBuilder();
  this._device = builder
              .connectiontype(device.connectiontype)
              .carrier(device.carrier)
              .ip(device.ip)
              .geo(device.geo)
              .language(device.language)
              .make(device.make)
              .model(device.model)
              .devicetype(device.devicetype)
              .dnt(device.dnt)
              .os(device.os)
              .osv(device.osv)
              .didsha1(device.didsha1)
              .ua(device.ua)
              .ifa(device.ifa)
              .build();
  return this;
};

BidRequestBuilder.prototype.user = function(user){
  const builder = new UserBuilder();
  this._user = builder
              .gender(user.gender)
              .id(user.id)
              .yob(user.yob)
              .buyeruid(user.buyeruid)
              .build();
  return this;
};

BidRequestBuilder.prototype.bcat = function(bcat){
  this._bcat = bcat;
  return this;
};

BidRequestBuilder.prototype.badv = function(badv){
  this._badv = badv;
  return this;
};

BidRequestBuilder.prototype.test = function(test){
  this._test = test;
  return this;
};

BidRequestBuilder.prototype.tmax = function(tmax){
  this._tmax = tmax;
  return this;
};

BidRequestBuilder.prototype.site = function(site){
  const builder = new SiteBuilder();
  this._site = builder
            .id(site.id)
            .name(site.name)
            .domain(site.domain)
            .cat(site.cat)
            .sectioncat(site.sectioncat)
            .pagecat(site.pagecat)
            .page(site.page)
            .ref(site.ref)
            .search(site.search)
            .mobile(site.mobile)
            .privacypolicy(site.privacypolicy)
            .publisher(site.publisher || {})
            .content(site.content || {})
            .keywords(site.keywords)
            .ext(site.ext)
            .build();
  return this;
};

BidRequestBuilder.prototype.regs = function(regs){
  const builder = new RegsBuilder();
  this._regs = builder
            .coppa(regs.coppa)
            .ext(regs.ext)
            .build();
  return this;
};

BidRequestBuilder.prototype.ext = function(ext){
  this._ext = ext;
  return this;
};

BidRequestBuilder.prototype.build = function() {
  
  var bidRequest = new BidRequest(
    this._timestamp || new Date().toISOString(),
    this._id,
    this._at,
    this._imp,
    this._app,
    this._device,
    this._user,
    this._bcat,
    this._badv,
    this._test,
    this._tmax,
    this._site,
    this._regs,
    this._ext
  );

  bidRequest = removeEmptyValues(bidRequest);

  var validationErrors = validator.validate(bidRequestSchema, bidRequest);

  if(validationErrors.length > 0){
    throw new ValidationError({
      message: "Validation failed",
      errors: validationErrors
    });
  }
  return bidRequest;
};

module.exports = {
  object: BidRequest,
  builder: BidRequestBuilder
};