Michao Bid Adapter: Initial release

modules/michaoBidAdapter.js

@@ -0,0 +1,260 @@
+import { ortbConverter } from '../libraries/ortbConverter/converter.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
+import { Renderer } from '../src/Renderer.js';
+import {
+  deepSetValue,
+  isBoolean,
+  isNumber,
+  isStr,
+  logError,
+  replaceAuctionPrice,
+  triggerPixel,
+} from '../src/utils.js';
+
+const ENV = {
+  BIDDER_CODE: 'michao',
+  SUPPORTED_MEDIA_TYPES: [BANNER, VIDEO, NATIVE],
+  ENDPOINT: 'https://rtb.michao-ssp.com/openrtb/prebid',
+  NET_REVENUE: true,
+  DEFAULT_CURRENCY: 'USD',
+  OUTSTREAM_RENDERER_URL:
+    'https://cdn.jsdelivr.net/npm/[email protected]/dist/in-video-renderer.umd.min.js',
+};
+
+export const spec = {
+  code: ENV.BIDDER_CODE,
+  supportedMediaTypes: ENV.SUPPORTED_MEDIA_TYPES,
+
+  isBidRequestValid: function (bid) {
+    const params = bid.params;
+
+    if (!isNumber(params?.site)) {
+      domainLogger.invalidSiteError(params?.site);
+      return false;
+    }
+
+    if (!isStr(params?.placement)) {
+      domainLogger.invalidPlacementError(params?.placement);
+      return false;
+    }
+
+    if (params?.partner) {
+      if (!isNumber(params?.partner)) {
+        domainLogger.invalidPartnerError(params?.partner);
+        return false;
+      }
+    }
+
+    if (params?.test) {
+      if (!isBoolean(params?.test)) {
+        domainLogger.invalidTestParamError(params?.test);
+        return false;
+      }
+    }
+
+    return true;
+  },
+
+  buildRequests: function (validBidRequests, bidderRequest) {
+    const bidRequests = [];
+
+    validBidRequests.forEach((validBidRequest) => {
+      let bidRequestEachFormat = [];
+
+      if (validBidRequest.mediaTypes?.banner) {
+        bidRequestEachFormat.push({
+          ...validBidRequest,
+          mediaTypes: {
+            banner: validBidRequest.mediaTypes.banner,
+          },
+        });
+      }
+
+      if (validBidRequest.mediaTypes?.native) {
+        bidRequestEachFormat.push({
+          ...validBidRequest,
+          mediaTypes: {
+            native: validBidRequest.mediaTypes.native,
+          },
+        });
+      }
+
+      if (validBidRequest.mediaTypes?.video) {
+        bidRequestEachFormat.push({
+          ...validBidRequest,
+          mediaTypes: {
+            video: validBidRequest.mediaTypes.video,
+          },
+        });
+      }
+
+      bidRequests.push(buildRequest(bidRequestEachFormat, bidderRequest));
+    });
+
+    return bidRequests;
+  },
+
+  interpretResponse: function (serverResponse, request) {
+    return converter.fromORTB({
+      response: serverResponse.body,
+      request: request.data,
+    }).bids;
+  },
+
+  getUserSyncs: function (
+    syncOptions,
+    serverResponses,
+    gdprConsent,
+    uspConsent
+  ) {
+    if (syncOptions.iframeEnabled) {
+      return [
+        {
+          type: 'iframe',
+          url:
+            'https://sync.michao-ssp.com/cookie-syncs?' +
+            generateGdprParams(gdprConsent),
+        },
+      ];
+    }
+
+    return [];
+  },
+
+  onBidBillable: function (bid) {
+    if (bid.burl && isStr(bid.burl)) {
+      triggerPixel(generateBillableUrl(bid));
+    }
+  },
+};
+
+export const domainLogger = {
+  invalidSiteError(value) {
+    logError(
+      `Michao Bid Adapter: Invalid site ID. Expected number, got ${typeof value}. Value: ${value}`
+    );
+  },
+
+  invalidPlacementError(value) {
+    logError(
+      `Michao Bid Adapter: Invalid placement. Expected string, got ${typeof value}. Value: ${value}`
+    );
+  },
+
+  invalidPartnerError(value) {
+    logError(
+      `Michao Bid Adapter: Invalid partner ID. Expected number, got ${typeof value}. Value: ${value}`
+    );
+  },
+
+  invalidTestParamError(value) {
+    logError(
+      `Michao Bid Adapter: Invalid test parameter. Expected boolean, got ${typeof value}. Value: ${value}`
+    );
+  },
+};
+
+function buildRequest(bidRequests, bidderRequest) {
+  const openRTBBidRequest = converter.toORTB({
+    bidRequests: bidRequests,
+    bidderRequest,
+  });
+
+  return {
+    method: 'POST',
+    url: ENV.ENDPOINT,
+    data: openRTBBidRequest,
+    options: { contentType: 'application/json', withCredentials: true },
+  };
+}
+
+function generateGdprParams(gdprConsent) {
+  let gdprParams = '';
+
+  if (typeof gdprConsent === 'object') {
+    if (gdprConsent?.gdprApplies) {
+      gdprParams = `gdpr=${Number(gdprConsent.gdprApplies)}&gdpr_consent=${
+        gdprConsent.consentString || ''
+      }`;
+    }
+  }
+
+  return gdprParams;
+}
+
+function generateBillableUrl(bid) {
+  return replaceAuctionPrice(bid.burl, bid.originalCpm || bid.cpm);
+}
+
+const converter = ortbConverter({
+  request(buildRequest, imps, bidderRequest, context) {
+    const bidRequest = context.bidRequests[0];
+    const openRTBBidRequest = buildRequest(imps, bidderRequest, context);
+    openRTBBidRequest.cur = [ENV.DEFAULT_CURRENCY];
+    openRTBBidRequest.test = bidRequest.params?.test ? 1 : 0;
+
+    deepSetValue(
+      openRTBBidRequest,
+      'site.id',
+      bidRequest.params.site.toString()
+    );
+    if (bidRequest?.schain) {
+      deepSetValue(openRTBBidRequest, 'source.schain', bidRequest.schain);
+    }
+
+    if (bidRequest.params?.partner) {
+      deepSetValue(
+        openRTBBidRequest,
+        'site.publisher.ext.partner',
+        bidRequest.params.partner.toString()
+      );
+    }
+
+    return openRTBBidRequest;
+  },
+
+  imp(buildImp, bidRequest, context) {
+    const imp = buildImp(bidRequest, context);
+    deepSetValue(imp, 'ext.placement', bidRequest.params.placement.toString());
+
+    if (!bidRequest.mediaTypes?.native) {
+      delete imp.native;
+    }
+
+    return imp;
+  },
+
+  bidResponse(buildBidResponse, bid, context) {
+    const bidResponse = buildBidResponse(bid, context);
+    const { bidRequest } = context;
+    if (
+      bidResponse.mediaType === VIDEO &&
+      bidRequest.mediaTypes.video.context === 'outstream'
+    ) {
+      bidResponse.vastXml = bid.adm;
+      const renderer = Renderer.install({
+        url: ENV.OUTSTREAM_RENDERER_URL,
+        id: bidRequest.bidId,
+        adUnitCode: bidRequest.adUnitCode,
+      });
+      renderer.render(() => {
+        bid.renderer.push(() => {
+          const inRenderer = new window.InVideoRenderer();
+          inRenderer.render(bid.adUnitCode, bid);
+        });
+      });
+      bidResponse.renderer = renderer;
+    }
+
+    return bidResponse;
+  },
+
+  context: {
+    netRevenue: ENV.NET_REVENUE,
+    currency: ENV.DEFAULT_CURRENCY,
+    ttl: 360,
+  },
+});
+
+registerBidder(spec);

modules/michaoBidAdapter.md

@@ -0,0 +1,87 @@
+# Overview
+
+```markdown
+Module Name: Michao Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: [email protected]
+```
+
+# Description
+
+Module that connects to Michao’s demand sources
+
+Supported Ad format:
+* Banner
+* Video (instream and outstream)
+* Native
+
+# Test Parameters
+```
+var adUnits = [
+    // Banner adUnit
+    {
+        code: 'banner-div',
+        mediaTypes: {
+            banner: {
+                sizes: [[300, 250]],
+            }
+        },
+        bids: [{
+            bidder: 'michao',
+            params: {
+                site: 1,
+                placement: '1',
+            }
+        }]
+    },
+    // Video adUnit
+    {
+        code: 'video-div',
+        mediaTypes: {
+            video: {
+                context: 'outstream',
+                playerSize: [640, 480],
+                minduration: 0,
+                maxduration: 120,
+                mimes: ['video/mp4'],
+                protocols: [7]
+            }
+        },
+        bids: [{
+            bidder: 'michao',
+            params: {
+                site: 1,
+                placement: '1',
+            }
+        }]
+    },
+    // Native AdUnit
+    {
+        code: 'native-div',
+        mediaTypes: {
+            native: {
+                ortb: {
+                    assets: [
+                        {
+                            id: 1,
+                            required: 1,
+                            img: {
+                                type: 3,
+                                w: 989,
+                                h: 742,
+                            },
+                        },
+                    ]
+                }
+            }
+        },
+        bids: [{
+            bidder: 'michao',
+            params: {
+                site: 1,
+                placement: '1',
+            }
+        }]
+    }
+];
+```