MediaBrama Bid Adapter : initial release

modules/mediabramaBidAdapter.js

@@ -0,0 +1,155 @@
+import {
+  isFn,
+  isStr,
+  deepAccess,
+  getWindowTop,
+  triggerPixel
+} from '../src/utils.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER } from '../src/mediaTypes.js';
+import { config } from '../src/config.js';
+
+const BIDDER_CODE = 'mediabrama';
+const AD_URL = 'https://prebid.mediabrama.com/pbjs';
+const SYNC_URL = 'https://prebid.mediabrama.com/sync';
+
+function isBidResponseValid(bid) {
+  if (!bid.requestId || !bid.cpm || !bid.creativeId ||
+    !bid.ttl || !bid.currency || !bid.meta) {
+    return false;
+  }
+
+  switch (bid.mediaType) {
+    case BANNER:
+      return Boolean(bid.width && bid.height && bid.ad);
+    default:
+      return false;
+  }
+}
+
+function getBidFloor(bid) {
+  if (!isFn(bid.getFloor)) {
+    return deepAccess(bid, 'params.bidFloor', 0);
+  }
+
+  try {
+    const bidFloor = bid.getFloor({
+      currency: 'USD',
+      mediaType: '*',
+      size: '*',
+    });
+    return bidFloor.floor;
+  } catch (_) {
+    return 0
+  }
+}
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER],
+
+  isBidRequestValid: (bid) => {
+    return Boolean(bid.bidId && bid.params && bid.params.placementId);
+  },
+
+  buildRequests: (validBidRequests = [], bidderRequest) => {
+    const winTop = getWindowTop();
+    const location = winTop.location;
+    const placements = [];
+
+    const request = {
+      deviceWidth: winTop.screen.width,
+      deviceHeight: winTop.screen.height,
+      language: (navigator && navigator.language) ? navigator.language.split('-')[0] : '',
+      host: location.host,
+      page: location.pathname,
+      placements: placements
+    };
+
+    if (bidderRequest) {
+      if (bidderRequest.uspConsent) {
+        request.ccpa = bidderRequest.uspConsent;
+      }
+      if (bidderRequest.gdprConsent) {
+        request.gdpr = bidderRequest.gdprConsent;
+      }
+    }
+
+    const len = validBidRequests.length;
+    for (let i = 0; i < len; i++) {
+      const bid = validBidRequests[i];
+      const placement = {
+        placementId: bid.params.placementId,
+        bidId: bid.bidId,
+        schain: bid.schain || {},
+        bidfloor: getBidFloor(bid)
+      };
+
+      if (typeof bid.userId !== 'undefined') {
+        placement.userId = bid.userId;
+      }
+
+      const mediaType = bid.mediaTypes;
+
+      if (mediaType && mediaType[BANNER] && mediaType[BANNER].sizes) {
+        placement.sizes = mediaType[BANNER].sizes;
+        placement.adFormat = BANNER;
+      }
+
+      placements.push(placement);
+    }
+
+    return {
+      method: 'POST',
+      url: AD_URL,
+      data: request
+    };
+  },
+
+  interpretResponse: (serverResponse) => {
+    let response = [];
+    for (let i = 0; i < serverResponse.body.length; i++) {
+      let resItem = serverResponse.body[i];
+      if (isBidResponseValid(resItem)) {
+        const advertiserDomains = resItem.adomain && resItem.adomain.length ? resItem.adomain : [];
+        resItem.meta = { ...resItem.meta, advertiserDomains };
+
+        response.push(resItem);
+      }
+    }
+    return response;
+  },
+
+  getUserSyncs: (syncOptions, serverResponses, gdprConsent, uspConsent) => {
+    let syncType = syncOptions.iframeEnabled ? 'iframe' : 'image';
+    let syncUrl = SYNC_URL + `/${syncType}?pbjs=1`;
+    if (gdprConsent && gdprConsent.consentString) {
+      if (typeof gdprConsent.gdprApplies === 'boolean') {
+        syncUrl += `&gdpr=${Number(gdprConsent.gdprApplies)}&gdpr_consent=${gdprConsent.consentString}`;
+      } else {
+        syncUrl += `&gdpr=0&gdpr_consent=${gdprConsent.consentString}`;
+      }
+    }
+    if (uspConsent && uspConsent.consentString) {
+      syncUrl += `&ccpa_consent=${uspConsent.consentString}`;
+    }
+
+    const coppa = config.getConfig('coppa') ? 1 : 0;
+    syncUrl += `&coppa=${coppa}`;
+
+    return [{
+      type: syncType,
+      url: syncUrl
+    }];
+  },
+
+  onBidWon: (bid) => {
+    const cpm = deepAccess(bid, 'adserverTargeting.hb_pb') || '';
+    if (isStr(bid.nurl) && bid.nurl !== '') {
+      bid.nurl = bid.nurl.replace(/\${AUCTION_PRICE}/, cpm);
+      triggerPixel(bid.nurl);
+    }
+  }
+};
+
+registerBidder(spec);

modules/mediabramaBidAdapter.md

@@ -0,0 +1,33 @@
+# Overview
+
+```
+Module Name: MediaBrama Bidder Adapter
+Module Type: MediaBrama Bidder Adapter
+Maintainer: support@mediabrama.com
+```
+
+# Description
+
+Module that connects to mediabrama demand sources
+
+# Test Parameters
+```
+    var adUnits = [
+        {
+            code: 'div-prebid',
+            mediaTypes:{
+                banner: {
+                    sizes: [[300, 250]],
+                }
+            },
+            bids:[
+                {
+                    bidder: 'mediabrama',
+                    params: {
+                        placementId: '24428' //test, please replace after test 
+                    }
+                }
+            ]
+        },
+    ];
+```