yieldbot.js

/**
 * @overview Yieldbot sponsored Prebid.js adapter.
 * @author elljoh
 */
var adloader = require('../adloader');
var bidfactory = require('../bidfactory');
var bidmanager = require('../bidmanager');
var utils = require('../utils');

/**
 * Adapter for requesting bids from Yieldbot.
 *
 * @returns {Object} Object containing implementation for invocation in {@link module:adaptermanger.callBids}
 * @class
 */
var YieldbotAdapter = function YieldbotAdapter() {

  window.ybotq = window.ybotq || [];

  var ybotlib = {
    BID_STATUS: {
      PENDING: 0,
      AVAILABLE: 1,
      EMPTY: 2
    },
    definedSlots: [],
    pageLevelOption: false,
    /**
     * Builds the Yieldbot creative tag.
     *
     * @param {String} slot - The slot name to bid for
     * @param {String} size - The dimenstions of the slot
     * @private
     */
    buildCreative: function (slot, size) {
      return '<script type="text/javascript" src="//cdn.yldbt.com/js/yieldbot.intent.js"></script>' +
        '<script type="text/javascript">var ybotq = ybotq || [];' +
        'ybotq.push(function () {yieldbot.renderAd(\'' + slot + ':' + size + '\');});</script>';
    },
    /**
     * Bid response builder.
     *
     * @param {Object} slotCriteria  - Yieldbot bid criteria
     * @private
     */
    buildBid: function (slotCriteria) {
      var bid = {};

      if (slotCriteria && slotCriteria.ybot_ad && slotCriteria.ybot_ad !== 'n') {

        bid = bidfactory.createBid(ybotlib.BID_STATUS.AVAILABLE);

        bid.cpm = parseInt(slotCriteria.ybot_cpm) / 100.0 || 0; // Yieldbot CPM bids are in cents

        var szArr = slotCriteria.ybot_size ? slotCriteria.ybot_size.split('x') : [0, 0];
        var slot = slotCriteria.ybot_slot || '';
        var sizeStr = slotCriteria.ybot_size || ''; // Creative template needs the dimensions string

        bid.width = szArr[0] || 0;
        bid.height = szArr[1] || 0;

        bid.ad = ybotlib.buildCreative(slot, sizeStr);

        // Add Yieldbot parameters to allow publisher bidderSettings.yieldbot specific targeting
        for (var k in slotCriteria) {
          bid[k] = slotCriteria[k];
        }

      } else {
        bid = bidfactory.createBid(ybotlib.BID_STATUS.EMPTY);
      }

      bid.bidderCode = 'yieldbot';
      return bid;
    },
    /**
     * Yieldbot implementation of {@link module:adaptermanger.callBids}
     * @param {Object} params - Adapter bid configuration object
     * @private
     */
    callBids: function (params) {

      var bids = params.bids || [];
      var ybotq = window.ybotq || [];

      ybotlib.pageLevelOption = false;

      ybotq.push(function () {
        var yieldbot = window.yieldbot;

        utils._each(bids, function (v) {
          var bid = v;
          var psn = bid.params && bid.params.psn || 'ERROR_DEFINE_YB_PSN';
          var slot = bid.params && bid.params.slot || 'ERROR_DEFINE_YB_SLOT';

          yieldbot.pub(psn);
          yieldbot.defineSlot(slot, { sizes: bid.sizes || [] });

          ybotlib.definedSlots.push(bid.bidId);
        });

        yieldbot.enableAsync();
        yieldbot.go();
      });

      ybotq.push(function () {
        ybotlib.handleUpdateState();
      });

      adloader.loadScript('//cdn.yldbt.com/js/yieldbot.intent.js', null, true);
    },
    /**
     * Yieldbot bid request callback handler.
     *
     * @see {@link YieldbotAdapter~_callBids}
     * @private
     */
    handleUpdateState: function () {
      var yieldbot = window.yieldbot;

      utils._each(ybotlib.definedSlots, function (v) {
        var slot;
        var criteria;
        var placementCode;
        var adapterConfig;

        adapterConfig = $$PREBID_GLOBAL$$._bidsRequested
            .find(bidderRequest => bidderRequest.bidderCode === 'yieldbot').bids
              .find(bid => bid.bidId === v) || {};
        slot = adapterConfig.params.slot || '';
        criteria = yieldbot.getSlotCriteria(slot);

        placementCode = adapterConfig.placementCode || 'ERROR_YB_NO_PLACEMENT';
        var bid = ybotlib.buildBid(criteria);

        bidmanager.addBidResponse(placementCode, bid);

      });
    }
  };
  return {
    callBids: ybotlib.callBids
  };
};

module.exports = YieldbotAdapter;