Added new Converge Bid Adapter (#5053)

* Added new Converge Bid Adapter

* Fix JSDoc in Converge Bid Adapter

modules/convergeBidAdapter.js

@@ -0,0 +1,313 @@
+import * as utils from '../src/utils.js';
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import { Renderer } from '../src/Renderer.js';
+import { VIDEO, BANNER } from '../src/mediaTypes.js';
+
+const BIDDER_CODE = 'converge';
+const ENDPOINT_URL = 'https://tech.convergd.com/hb';
+const TIME_TO_LIVE = 360;
+const SYNC_URL = 'https://tech.convergd.com/push_sync';
+const RENDERER_URL = 'https://acdn.adnxs.com/video/outstream/ANOutstreamVideo.js';
+
+let hasSynced = false;
+
+const LOG_ERROR_MESS = {
+  noAuid: 'Bid from response has no auid parameter - ',
+  noAdm: 'Bid from response has no adm parameter - ',
+  noBid: 'Array of bid objects is empty',
+  noPlacementCode: "Can't find in requested bids the bid with auid - ",
+  emptyUids: 'Uids should be not empty',
+  emptySeatbid: 'Seatbid array from response has empty item',
+  emptyResponse: 'Response is empty',
+  hasEmptySeatbidArray: 'Response has empty seatbid array',
+  hasNoArrayOfBids: 'Seatbid from response has no array of bid objects - '
+};
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [ BANNER, VIDEO ],
+  /**
+   * Determines whether or not the given bid request is valid.
+   *
+   * @param {BidRequest} bid The bid params to validate.
+   * @return boolean True if this is a valid bid, and false otherwise.
+   */
+  isBidRequestValid: function(bid) {
+    return !!bid.params.uid;
+  },
+  /**
+   * Make a server request from the list of BidRequests.
+   *
+   * @param {BidRequest[]} validBidRequests - an array of bids
+   * @param {bidderRequest} bidderRequest - bidder request object
+   * @return ServerRequest Info describing the request to the server.
+   */
+  buildRequests: function(validBidRequests, bidderRequest) {
+    const auids = [];
+    const bidsMap = {};
+    const slotsMapByUid = {};
+    const sizeMap = {};
+    const bids = validBidRequests || [];
+    let priceType = 'net';
+    let pageKeywords;
+    let reqId;
+
+    bids.forEach(bid => {
+      if (bid.params.priceType === 'gross') {
+        priceType = 'gross';
+      }
+      reqId = bid.bidderRequestId;
+      const {params: {uid}, adUnitCode} = bid;
+      auids.push(uid);
+      const sizesId = utils.parseSizesInput(bid.sizes);
+
+      if (!pageKeywords && !utils.isEmpty(bid.params.keywords)) {
+        const keywords = utils.transformBidderParamKeywords(bid.params.keywords);
+
+        if (keywords.length > 0) {
+          keywords.forEach(deleteValues);
+        }
+        pageKeywords = keywords;
+      }
+
+      if (!slotsMapByUid[uid]) {
+        slotsMapByUid[uid] = {};
+      }
+      const slotsMap = slotsMapByUid[uid];
+      if (!slotsMap[adUnitCode]) {
+        slotsMap[adUnitCode] = {adUnitCode, bids: [bid], parents: []};
+      } else {
+        slotsMap[adUnitCode].bids.push(bid);
+      }
+      const slot = slotsMap[adUnitCode];
+
+      sizesId.forEach((sizeId) => {
+        sizeMap[sizeId] = true;
+        if (!bidsMap[uid]) {
+          bidsMap[uid] = {};
+        }
+
+        if (!bidsMap[uid][sizeId]) {
+          bidsMap[uid][sizeId] = [slot];
+        } else {
+          bidsMap[uid][sizeId].push(slot);
+        }
+        slot.parents.push({parent: bidsMap[uid], key: sizeId, uid});
+      });
+    });
+
+    const payload = {
+      pt: priceType,
+      auids: auids.join(','),
+      sizes: utils.getKeys(sizeMap).join(','),
+      r: reqId,
+      wrapperType: 'Prebid_js',
+      wrapperVersion: '$prebid.version$'
+    };
+
+    if (pageKeywords) {
+      payload.keywords = JSON.stringify(pageKeywords);
+    }
+
+    if (bidderRequest) {
+      if (bidderRequest.refererInfo && bidderRequest.refererInfo.referer) {
+        payload.u = bidderRequest.refererInfo.referer;
+      }
+      if (bidderRequest.timeout) {
+        payload.wtimeout = bidderRequest.timeout;
+      }
+      if (bidderRequest.gdprConsent) {
+        if (bidderRequest.gdprConsent.consentString) {
+          payload.gdpr_consent = bidderRequest.gdprConsent.consentString;
+        }
+        payload.gdpr_applies =
+          (typeof bidderRequest.gdprConsent.gdprApplies === 'boolean')
+            ? Number(bidderRequest.gdprConsent.gdprApplies) : 1;
+      }
+      if (bidderRequest.uspConsent) {
+        payload.us_privacy = bidderRequest.uspConsent;
+      }
+    }
+
+    return {
+      method: 'GET',
+      url: ENDPOINT_URL,
+      data: utils.parseQueryStringParameters(payload).replace(/\&$/, ''),
+      bidsMap: bidsMap,
+    };
+  },
+  /**
+   * Unpack the response from the server into a list of bids.
+   *
+   * @param {*} serverResponse A successful response from the server.
+   * @param {*} bidRequest
+   * @param {Renderer} RendererConst
+   * @return {Bid[]} An array of bids which were nested inside the server.
+   */
+  interpretResponse: function(serverResponse, bidRequest, RendererConst = Renderer) {
+    serverResponse = serverResponse && serverResponse.body;
+    const bidResponses = [];
+    const bidsMap = bidRequest.bidsMap;
+    const priceType = bidRequest.data.pt;
+
+    let errorMessage;
+
+    if (!serverResponse) errorMessage = LOG_ERROR_MESS.emptyResponse;
+    else if (serverResponse.seatbid && !serverResponse.seatbid.length) {
+      errorMessage = LOG_ERROR_MESS.hasEmptySeatbidArray;
+    }
+
+    if (!errorMessage && serverResponse.seatbid) {
+      serverResponse.seatbid.forEach(respItem => {
+        _addBidResponse(_getBidFromResponse(respItem), bidsMap, priceType, bidResponses, RendererConst);
+      });
+    }
+    if (errorMessage) utils.logError(errorMessage);
+    return bidResponses;
+  },
+  getUserSyncs: function (syncOptions, responses, gdprConsent, uspConsent) {
+    if (!hasSynced && syncOptions.pixelEnabled) {
+      let params = '';
+
+      if (gdprConsent && typeof gdprConsent.consentString === 'string') {
+        if (typeof gdprConsent.gdprApplies === 'boolean') {
+          params += `&gdpr=${Number(gdprConsent.gdprApplies)}&gdpr_consent=${gdprConsent.consentString}`;
+        } else {
+          params += `&gdpr_consent=${gdprConsent.consentString}`;
+        }
+      }
+      if (uspConsent) {
+        params += `&us_privacy=${uspConsent}`;
+      }
+
+      hasSynced = true;
+      return {
+        type: 'image',
+        url: SYNC_URL + params
+      };
+    }
+  }
+};
+
+function isPopulatedArray(arr) {
+  return !!(utils.isArray(arr) && arr.length > 0);
+}
+
+function deleteValues(keyPairObj) {
+  if (isPopulatedArray(keyPairObj.value) && keyPairObj.value[0] === '') {
+    delete keyPairObj.value;
+  }
+}
+
+function _getBidFromResponse(respItem) {
+  if (!respItem) {
+    utils.logError(LOG_ERROR_MESS.emptySeatbid);
+  } else if (!respItem.bid) {
+    utils.logError(LOG_ERROR_MESS.hasNoArrayOfBids + JSON.stringify(respItem));
+  } else if (!respItem.bid[0]) {
+    utils.logError(LOG_ERROR_MESS.noBid);
+  }
+  return respItem && respItem.bid && respItem.bid[0];
+}
+
+function _addBidResponse(serverBid, bidsMap, priceType, bidResponses, RendererConst) {
+  if (!serverBid) return;
+  let errorMessage;
+  if (!serverBid.auid) errorMessage = LOG_ERROR_MESS.noAuid + JSON.stringify(serverBid);
+  if (!serverBid.adm) errorMessage = LOG_ERROR_MESS.noAdm + JSON.stringify(serverBid);
+  else {
+    const awaitingBids = bidsMap[serverBid.auid];
+    if (awaitingBids) {
+      const sizeId = `${serverBid.w}x${serverBid.h}`;
+      if (awaitingBids[sizeId]) {
+        const slot = awaitingBids[sizeId][0];
+
+        const bid = slot.bids.shift();
+        const bidResponse = {
+          requestId: bid.bidId, // bid.bidderRequestId,
+          bidderCode: spec.code,
+          cpm: serverBid.price,
+          width: serverBid.w,
+          height: serverBid.h,
+          creativeId: serverBid.auid, // bid.bidId,
+          currency: 'EUR',
+          netRevenue: priceType !== 'gross',
+          ttl: TIME_TO_LIVE,
+          dealId: serverBid.dealid
+        };
+        if (serverBid.content_type === 'video' || (!serverBid.content_type && bid.mediaTypes && bid.mediaTypes.video)) {
+          bidResponse.vastXml = serverBid.adm;
+          bidResponse.mediaType = VIDEO;
+          bidResponse.adResponse = {
+            content: bidResponse.vastXml
+          };
+          if (!bid.renderer && (!bid.mediaTypes || !bid.mediaTypes.video || bid.mediaTypes.video.context === 'outstream')) {
+            bidResponse.renderer = createRenderer(bidResponse, {
+              id: bid.bidId,
+              url: RENDERER_URL
+            }, RendererConst);
+          }
+        } else {
+          bidResponse.ad = serverBid.adm;
+          bidResponse.mediaType = BANNER;
+        }
+
+        bidResponses.push(bidResponse);
+
+        if (!slot.bids.length) {
+          slot.parents.forEach(({parent, key, uid}) => {
+            const index = parent[key].indexOf(slot);
+            if (index > -1) {
+              parent[key].splice(index, 1);
+            }
+            if (!parent[key].length) {
+              delete parent[key];
+              if (!utils.getKeys(parent).length) {
+                delete bidsMap[uid];
+              }
+            }
+          });
+        }
+      }
+    } else {
+      errorMessage = LOG_ERROR_MESS.noPlacementCode + serverBid.auid;
+    }
+  }
+  if (errorMessage) {
+    utils.logError(errorMessage);
+  }
+}
+
+function outstreamRender (bid) {
+  bid.renderer.push(() => {
+    window.ANOutstreamVideo.renderAd({
+      targetId: bid.adUnitCode,
+      adResponse: bid.adResponse
+    });
+  });
+}
+
+function createRenderer (bid, rendererParams, RendererConst) {
+  const rendererInst = RendererConst.install({
+    id: rendererParams.id,
+    url: rendererParams.url,
+    loaded: false
+  });
+
+  try {
+    rendererInst.setRender(outstreamRender);
+  } catch (err) {
+    utils.logWarn('Prebid Error calling setRender on renderer', err);
+  }
+
+  return rendererInst;
+}
+
+export function resetUserSync() {
+  hasSynced = false;
+}
+
+export function getSyncUrl() {
+  return SYNC_URL;
+}
+
+registerBidder(spec);

modules/convergeBidAdapter.md

@@ -0,0 +1,57 @@
+# Overview
+
+Module Name: Converge Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: support@converge-digital.com
+
+# Description
+
+Module that connects to Converge demand source to fetch bids.
+Converge Bid Adapter supports Banner and Video (instream and outstream).
+
+# Test Parameters
+```
+    var adUnits = [
+           {
+               code: 'test-div',
+               sizes: [[300, 250]],
+               bids: [
+                   {
+                       bidder: "converge",
+                       params: {
+                           uid: '59',
+                           priceType: 'gross' // by default is 'net'
+                       }
+                   }
+               ]
+           },{
+               code: 'test-div',
+               sizes: [[728, 90]],
+               bids: [
+                   {
+                       bidder: "converge",
+                       params: {
+                           uid: 1,
+                           priceType: 'gross',
+                           keywords: {
+                               brandsafety: ['disaster'],
+                               topic: ['stress', 'fear']
+                           }
+                       }
+                   }
+               ]
+           },{
+               code: 'test-div',
+               sizes: [[640, 360]],
+               mediaTypes: { video: {} },
+               bids: [
+                   {
+                       bidder: "converge",
+                       params: {
+                           uid: 60
+                       }
+                   }
+               ]
+           }
+       ];
+```