Equativ Bid Adapter: initial release, Smartadserver Bid Adapter: take lowest floor to send to endpoint

libraries/equativUtils/equativUtils.js

@@ -0,0 +1,30 @@
+import { VIDEO } from '../../src/mediaTypes.js';
+import { deepAccess, isFn } from '../../src/utils.js';
+
+const DEFAULT_FLOOR = 0.0;
+
+/**
+ * Get floors from Prebid Price Floors module
+ *
+ * @param {object} bid Bid request object
+ * @param {string} currency Ad server currency
+ * @param {string} mediaType Bid media type
+ * @return {number} Floor price
+ */
+export function getBidFloor (bid, currency, mediaType) {
+  const floors = [];
+
+  if (isFn(bid.getFloor)) {
+    (deepAccess(bid, `mediaTypes.${mediaType}.${mediaType === VIDEO ? 'playerSize' : 'sizes'}`) || []).forEach(size => {
+      const floor = bid.getFloor({
+        currency: currency || 'USD',
+        mediaType,
+        size
+      }).floor;
+
+      floors.push(!isNaN(floor) ? floor : DEFAULT_FLOOR);
+    });
+  }
+
+  return floors.length ? Math.min(...floors) : DEFAULT_FLOOR;
+}

modules/equativBidAdapter.js

@@ -0,0 +1,133 @@
+import { BANNER } from '../src/mediaTypes.js';
+import { getBidFloor } from '../libraries/equativUtils/equativUtils.js'
+import { ortbConverter } from '../libraries/ortbConverter/converter.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { deepAccess, deepSetValue, mergeDeep } from '../src/utils.js';
+
+/**
+ * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid
+ * @typedef {import('../src/adapters/bidderFactory.js').ServerRequest} ServerRequest
+ */
+
+export const spec = {
+  code: 'equativ',
+  gvlid: 45,
+  supportedMediaTypes: [BANNER],
+
+  /**
+   * @param bidRequests
+   * @param bidderRequest
+   * @returns {ServerRequest[]}
+   */
+  buildRequests: (bidRequests, bidderRequest) => {
+    return {
+      data: converter.toORTB({ bidderRequest, bidRequests }),
+      method: 'POST',
+      url: 'https://ssb-global.smartadserver.com/api/bid?callerId=169'
+    };
+  },
+
+  /**
+   * @param serverResponse
+   * @param bidRequest
+   * @returns {Bid[]}
+   */
+  interpretResponse: (serverResponse, bidRequest) =>
+    converter.fromORTB({
+      request: bidRequest.data,
+      response: serverResponse.body,
+    }),
+
+  /**
+   * @param bidRequest
+   * @returns {boolean}
+   */
+  isBidRequestValid: (bidRequest) => {
+    return !!(
+      deepAccess(bidRequest, 'params.networkId') ||
+      deepAccess(bidRequest, 'ortb2.site.publisher.id') ||
+      deepAccess(bidRequest, 'ortb2.app.publisher.id') ||
+      deepAccess(bidRequest, 'ortb2.dooh.publisher.id')
+    );
+  },
+
+  /**
+   * @param syncOptions
+   * @param serverResponse
+   * @returns {{type: string, url: string}[]}
+   */
+  // getUserSyncs: (syncOptions, serverResponse) => {
+  //   if (syncOptions.iframeEnabled && serverResponses[0]?.body.cSyncUrl) {
+  //     return [
+  //       {
+  //         type: 'iframe',
+  //         url: serverResponses[0].body.cSyncUrl,
+  //       },
+  //     ];
+  //   }
+  //   return (syncOptions.pixelEnabled && serverResponse.body?.dspPixels)
+  //     ? serverResponse.body.dspPixels.map((pixel) => ({
+  //       type: 'image',
+  //       url: pixel,
+  //     })) : [];
+  // },
+};
+
+export const converter = ortbConverter({
+  context: {
+    netRevenue: true,
+    ttl: 300,
+  },
+
+  imp(buildImp, bidRequest, context) {
+    const imp = buildImp(bidRequest, context);
+    const { siteId, pageId, formatId } = bidRequest.params;
+
+    delete imp.dt;
+
+    imp.bidfloor = imp.bidfloor || getBidFloor(bidRequest);
+    imp.secure = 1;
+    imp.tagid = bidRequest.adUnitCode;
+
+    if (siteId || pageId || formatId) {
+      const bidder = {};
+
+      if (siteId) {
+        bidder.siteId = siteId;
+      }
+
+      if (pageId) {
+        bidder.pageId = pageId;
+      }
+
+      if (formatId) {
+        bidder.formatId = formatId;
+      }
+
+      mergeDeep(imp, {
+        ext: { bidder },
+      });
+    }
+
+    return imp;
+  },
+
+  request(buildRequest, imps, bidderRequest, context) {
+    const bid = context.bidRequests[0];
+    const req = buildRequest(imps, bidderRequest, context);
+
+    if (deepAccess(bid, 'ortb2.site.publisher')) {
+      deepSetValue(req, 'site.publisher.id', bid.ortb2.site.publisher.id || bid.params.networkId);
+    } else if (deepAccess(bid, 'ortb2.app.publisher')) {
+      deepSetValue(req, 'app.publisher.id', bid.ortb2.app.publisher.id || bid.params.networkId);
+    } else if (deepAccess(bid, 'ortb2.dooh.publisher')) {
+      deepSetValue(req, 'dooh.publisher.id', bid.ortb2.dooh.publisher.id || bid.params.networkId);
+    } else {
+      deepSetValue(req, 'site.publisher.id', bid.params.networkId);
+    }
+
+    return req;
+  },
+});
+
+registerBidder(spec);

modules/equativBidAdapter.md

@@ -0,0 +1,40 @@
+# Overview
+
+```
+Module Name: Equativ Bidder Adapter (beta)
+Module Type: Bidder Adapter
+Maintainer: [email protected]
+```
+
+# Description
+
+Connect to Equativ for bids.
+
+The Equativ adapter requires setup and approval from the Equativ team. Please reach out to your technical account manager for more information.
+
+# Test Parameters
+
+## Web or In-app
+```javascript
+var adUnits = [
+    {
+        code: '/589236/banner_1',
+        mediaTypes: {
+            banner: {
+                sizes: [[300, 250]]
+            }
+        },
+        bids: [
+            {
+                bidder: 'equativ',
+                params: {
+                    networkId: 13,  // mandatory if no ortb2.(site or app).publisher.id set
+                    siteId: 20743,  // optional
+                    pageId: 89653,  // optional
+                    formatId: 291,  // optional
+                }
+            }
+        ]
+    }
+];
+```

modules/smartadserverBidAdapter.js

@@ -4,24 +4,23 @@ import {
   isArray,
   isArrayOfNums,
   isEmpty,
-  isFn,
   isInteger,
-  isPlainObject,
   logError
 } from '../src/utils.js';
 import { BANNER, VIDEO } from '../src/mediaTypes.js';
 import { config } from '../src/config.js';
+import { getBidFloor } from '../libraries/equativUtils/equativUtils.js'
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 
 /**
  * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest
  * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid
  * @typedef {import('../src/adapters/bidderFactory.js').ServerRequest} ServerRequest
+ * @typedef {import('../src/adapters/bidderFactory.js').UserSync} UserSync
  */
 
 const BIDDER_CODE = 'smartadserver';
 const GVL_ID = 45;
-const DEFAULT_FLOOR = 0.0;
 
 export const spec = {
   code: BIDDER_CODE,
@@ -176,7 +175,7 @@ export const spec = {
    * Makes server requests from the list of BidRequests.
    *
    * @param {BidRequest[]} validBidRequests an array of bids
-   * @param {BidderRequest} bidderRequest bidder request object
+   * @param {BidRequest} bidderRequest bidder request object
    * @return {ServerRequest[]} Info describing the request to the server.
    */
   buildRequests: function (validBidRequests, bidderRequest) {
@@ -257,15 +256,15 @@ export const spec = {
           if (isSupportedVideoContext) {
             let videoPayload = deepClone(payload);
             spec.fillPayloadForVideoBidRequest(videoPayload, videoMediaType, bid.params.video);
-            videoPayload.bidfloor = bid.params.bidfloor || spec.getBidFloor(bid, adServerCurrency, VIDEO);
+            videoPayload.bidfloor = bid.params.bidfloor || getBidFloor(bid, adServerCurrency, VIDEO);
             bidRequests.push(spec.createServerRequest(videoPayload, bid.params.domain));
           }
         } else {
           type = VIDEO;
           spec.fillPayloadForVideoBidRequest(payload, videoMediaType, bid.params.video);
         }
 
-        payload.bidfloor = bid.params.bidfloor || spec.getBidFloor(bid, adServerCurrency, type);
+        payload.bidfloor = bid.params.bidfloor || getBidFloor(bid, adServerCurrency, type);
         bidRequests.push(spec.createServerRequest(payload, bid.params.domain));
       } else {
         bidRequests.push({});
@@ -324,34 +323,12 @@ export const spec = {
     return bidResponses;
   },
 
-  /**
-   * Get floors from Prebid Price Floors module
-   *
-   * @param {object} bid Bid request object
-   * @param {string} currency Ad server currency
-   * @param {string} mediaType Bid media type
-   * @return {number} Floor price
-   */
-  getBidFloor: function (bid, currency, mediaType) {
-    if (!isFn(bid.getFloor)) {
-      return DEFAULT_FLOOR;
-    }
-
-    const floor = bid.getFloor({
-      currency: currency || 'USD',
-      mediaType,
-      size: '*'
-    });
-
-    return isPlainObject(floor) && !isNaN(floor.floor) ? floor.floor : DEFAULT_FLOOR;
-  },
-
   /**
    * User syncs.
    *
    * @param {*} syncOptions Publisher prebid configuration.
    * @param {*} serverResponses A successful response from the server.
-   * @return {syncs[]} An array of syncs that should be executed.
+   * @return {UserSync[]} An array of syncs that should be executed.
    */
   getUserSyncs: function (syncOptions, serverResponses) {
     const syncs = [];