Prisma Bid Adapter: initial bid adapter release

modules/prismaBidAdapter.js

@@ -0,0 +1,205 @@
+import {ajax} from '../src/ajax.js';
+import {config} from '../src/config.js';
+import { transformBidderParamKeywords } from '../src/utils.js';
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import {BANNER, VIDEO} from '../src/mediaTypes.js';
+
+const BIDDER_CODE = 'prisma';
+const BIDDER_URL = 'https://prisma.nexx360.io/prebid';
+const CACHE_URL = 'https://prisma.nexx360.io/cache';
+const METRICS_TRACKER_URL = 'https://prisma.nexx360.io/track-imp';
+
+const GVLID = 965;
+
+function getConnectionType() {
+  const connection = navigator.connection || navigator.webkitConnection;
+  if (!connection) {
+    return 0;
+  }
+  switch (connection.type) {
+    case 'ethernet':
+      return 1;
+    case 'wifi':
+      return 2;
+    case 'cellular':
+      switch (connection.effectiveType) {
+        case 'slow-2g':
+        case '2g':
+          return 4;
+        case '3g':
+          return 5;
+        case '4g':
+          return 6;
+        default:
+          return 3;
+      }
+    default:
+      return 0;
+  }
+}
+
+export const spec = {
+  code: BIDDER_CODE,
+  gvlid: GVLID,
+  aliases: ['prismadirect'], // short 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) {
+    if (!!bid.params.bidfloorCurrency && !['EUR', 'USD'].includes(bid.params.bidfloorCurrency)) return false;
+    if (!!bid.params.bidfloor && typeof bid.params.bidfloor !== 'number') return false;
+    if (!!bid.params.keywords && typeof bid.params.keywords !== 'object') return false;
+    return !!(bid.params.account && bid.params.tagId);
+  },
+  /**
+         * Make a server request from the list of BidRequests.
+         *
+         * @param {validBidRequests[]} - an array of bids
+         * @return ServerRequest Info describing the request to the server.
+         */
+  buildRequests: function(validBidRequests, bidderRequest) {
+    const adUnits = [];
+    const test = config.getConfig('debug') ? 1 : 0;
+    let adunitValue = null;
+    let userEids = null;
+    Object.keys(validBidRequests).forEach(key => {
+      adunitValue = validBidRequests[key];
+      const foo = {
+        account: adunitValue.params.account,
+        tagId: adunitValue.params.tagId,
+        videoExt: adunitValue.params.videoExt,
+        label: adunitValue.adUnitCode,
+        bidId: adunitValue.bidId,
+        auctionId: adunitValue.auctionId,
+        transactionId: adunitValue.transactionId,
+        mediatypes: adunitValue.mediaTypes,
+        bidfloor: adunitValue.params.bidfloor || 0,
+        bidfloorCurrency: adunitValue.params.bidfloorCurrency || 'USD',
+        keywords: adunitValue.params.keywords ? transformBidderParamKeywords(adunitValue.params.keywords) : [],
+      }
+      adUnits.push(foo);
+      if (adunitValue.userIdAsEids) userEids = adunitValue.userIdAsEids;
+    });
+    const payload = {
+      adUnits,
+      // TODO: does the fallback make sense here?
+      href: encodeURIComponent(bidderRequest.refererInfo.page || bidderRequest.refererInfo.topmostLocation)
+    };
+    if (bidderRequest) { // modules informations (gdpr, ccpa, schain, userId)
+      if (bidderRequest.gdprConsent) {
+        payload.gdpr = bidderRequest.gdprConsent.gdprApplies ? 1 : 0;
+        payload.gdprConsent = bidderRequest.gdprConsent.consentString;
+      } else {
+        payload.gdpr = 0;
+        payload.gdprConsent = '';
+      }
+      if (bidderRequest.uspConsent) { payload.uspConsent = bidderRequest.uspConsent; }
+      if (bidderRequest.schain) { payload.schain = bidderRequest.schain; }
+      if (userEids !== null) payload.userEids = userEids;
+    };
+    payload.connectionType = getConnectionType();
+
+    if (test) payload.test = 1;
+    const payloadString = JSON.stringify(payload);
+    return {
+      method: 'POST',
+      url: BIDDER_URL,
+      data: payloadString,
+    };
+  },
+  /**
+         * Unpack the response from the server into a list of bids.
+         *
+         * @param {ServerResponse} serverResponse A successful response from the server.
+         * @return {Bid[]} An array of bids which were nested inside the server.
+         */
+  interpretResponse: function(serverResponse, bidRequest) {
+    const serverBody = serverResponse.body;
+    const bidResponses = [];
+    let bidResponse = null;
+    let value = null;
+    if (serverBody.hasOwnProperty('responses')) {
+      Object.keys(serverBody['responses']).forEach(key => {
+        value = serverBody['responses'][key];
+        const url = `${CACHE_URL}?uuid=${value['uuid']}`;
+        bidResponse = {
+          requestId: value['bidId'],
+          cpm: value['cpm'],
+          currency: value['currency'],
+          width: value['width'],
+          height: value['height'],
+          ttl: value['ttl'],
+          creativeId: value['creativeId'],
+          netRevenue: true,
+          prisma: {
+            'ssp': value['bidder'],
+            'consent': value['consent'],
+            'tagId': value['tagId']
+          },
+          /*
+          meta: {
+            'advertiserDomains': value['adomain']
+          }
+          */
+        };
+        if (value.type === 'banner') bidResponse.adUrl = url;
+        if (value.type === 'video') {
+          const params = {
+            type: 'prebid',
+            mediatype: 'video',
+            ssp: value.bidder,
+            tag_id: value.tagId,
+            consent: value.consent,
+            price: value.cpm,
+          };
+          bidResponse.cpm = value.cpm;
+          bidResponse.mediaType = 'video';
+          bidResponse.vastUrl = url;
+          bidResponse.vastImpUrl = `${METRICS_TRACKER_URL}?${new URLSearchParams(params).toString()}`;
+        }
+        bidResponses.push(bidResponse);
+      });
+    }
+    return bidResponses;
+  },
+
+  /**
+     * Register the user sync pixels which should be dropped after the auction.
+     *
+     * @param {SyncOptions} syncOptions Which user syncs are allowed?
+     * @param {ServerResponse[]} serverResponses List of server's responses.
+     * @return {UserSync[]} The user syncs which should be dropped.
+     */
+  getUserSyncs: function(syncOptions, serverResponses, gdprConsent, uspConsent) {
+    if (typeof serverResponses === 'object' && serverResponses != null && serverResponses.length > 0 && serverResponses[0].hasOwnProperty('body') &&
+        serverResponses[0].body.hasOwnProperty('cookies') && typeof serverResponses[0].body.cookies === 'object') {
+      return serverResponses[0].body.cookies.slice(0, 5);
+    } else {
+      return [];
+    }
+  },
+
+  /**
+     * Register bidder specific code, which will execute if a bid from this bidder won the auction
+     * @param {Bid} The bid that won the auction
+     */
+  onBidWon: function(bid) {
+    // fires a pixel to confirm a winning bid
+    const params = { type: 'prebid', mediatype: 'banner' };
+    if (bid.hasOwnProperty('prisma')) {
+      if (bid.prisma.hasOwnProperty('ssp')) params.ssp = bid.prisma.ssp;
+      if (bid.prisma.hasOwnProperty('tagId')) params.tag_id = bid.prisma.tagId;
+      if (bid.prisma.hasOwnProperty('consent')) params.consent = bid.prisma.consent;
+    };
+    params.price = bid.cpm;
+    const url = `${METRICS_TRACKER_URL}?${new URLSearchParams(params).toString()}`;
+    ajax(url, null, undefined, {method: 'GET', withCredentials: true});
+    return true;
+  }
+
+}
+registerBidder(spec);

modules/prismaBidAdapter.md

@@ -0,0 +1,59 @@
+# Overview
+
+```
+Module Name:  Prisma Bid Adapter
+Module Type:  Bidder Adapter
+Maintainer: gabriel@nexx360.io
+```
+
+# Description
+
+Connects to Prisma network for bids.
+
+To use us as a bidder you must have an account and an active "tagId" on our platform.
+
+# Test Parameters
+
+## Web
+
+### Display
+```
+var adUnits = [
+   // Banner adUnit
+   {
+      code: 'banner-div',
+      mediaTypes: {
+        banner: {
+          sizes: [[300, 250], [300,600]]
+        }
+      },
+      bids: [{
+         bidder: 'prisma',
+         params: {
+            account: '1067',
+            tagId: 'luvxjvgn'
+         }
+       }]
+   },
+];
+```
+
+### Video Instream
+```
+    var videoAdUnit = {
+        code: 'video1',
+        mediaTypes: {
+            video: {
+                playerSize: [640, 480],
+                context: 'instream'
+            }
+        },
+        bids: [{
+            bidder: 'prisma',
+            params: {
+               account: '1067',
+               tagId: 'luvxjvgn'
+            }
+        }]
+    };
+```