zmaticoo Bid Adapter : add support for video (#11016)

lxj15398019970 · web-flow · commit 3dc8deab0233 · 2024-02-05T08:59:02.000+01:00
* feat:zmaticoo adapter for video

Signed-off-by: adam &lt;L12354*。com&gt;

* feat:just test ci/circleci:build failed

Signed-off-by: adam &lt;L12354*。com&gt;

* feat:add unit test

Signed-off-by: adam &lt;L12354*。com&gt;

* feat:fix response.seatbid and advertiserDomains empty

Signed-off-by: adam &lt;L12354*。com&gt;

* feat:add unit test

Signed-off-by: adam &lt;L12354*。com&gt;

---------

Signed-off-by: adam &lt;L12354*。com&gt;
Co-authored-by: adam &lt;L12354*。com&gt;
diff --git a/modules/zmaticooBidAdapter.js b/modules/zmaticooBidAdapter.js
@@ -1,16 +1,38 @@
-import {deepAccess, logWarn} from '../src/utils.js';
+import {deepAccess, isArray, isBoolean, isNumber, isStr, logWarn} from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
-import {BANNER} from '../src/mediaTypes.js';
+import {BANNER, VIDEO} from '../src/mediaTypes.js';
 
 const BIDDER_CODE = 'zmaticoo';
 const ENDPOINT_URL = 'https://bid.zmaticoo.com/prebid/bid';
 const DEFAULT_CUR = 'USD';
 const TTL = 200;
 const NET_REV = true;
 
+const DATA_TYPES = {
+  'NUMBER': 'number', 'STRING': 'string', 'BOOLEAN': 'boolean', 'ARRAY': 'array', 'OBJECT': 'object'
+};
+const VIDEO_CUSTOM_PARAMS = {
+  'mimes': DATA_TYPES.ARRAY,
+  'minduration': DATA_TYPES.NUMBER,
+  'maxduration': DATA_TYPES.NUMBER,
+  'startdelay': DATA_TYPES.NUMBER,
+  'playbackmethod': DATA_TYPES.ARRAY,
+  'api': DATA_TYPES.ARRAY,
+  'protocols': DATA_TYPES.ARRAY,
+  'w': DATA_TYPES.NUMBER,
+  'h': DATA_TYPES.NUMBER,
+  'battr': DATA_TYPES.ARRAY,
+  'linearity': DATA_TYPES.NUMBER,
+  'placement': DATA_TYPES.NUMBER,
+  'plcmt': DATA_TYPES.NUMBER,
+  'minbitrate': DATA_TYPES.NUMBER,
+  'maxbitrate': DATA_TYPES.NUMBER,
+  'skip': DATA_TYPES.NUMBER
+}
+
 export const spec = {
   code: BIDDER_CODE,
-  supportedMediaTypes: [BANNER],
+  supportedMediaTypes: [BANNER, VIDEO],
 
   /**
    * Determines whether or not the given bid request is valid.
@@ -20,6 +42,10 @@ export const spec = {
    */
   isBidRequestValid: function (bid) {
     // check for all required bid fields
+    if (!(hasBannerMediaType(bid) || hasVideoMediaType(bid))) {
+      logWarn('Invalid bid request - missing required mediaTypes');
+      return false;
+    }
     if (!(bid && bid.bidId && bid.params)) {
       logWarn('Invalid bid request - missing required bid data');
       return false;
@@ -30,7 +56,7 @@ export const spec = {
       return false;
     }
 
-    if (!(bid.params.device && bid.params.device.ip)) {
+    if (!(bid.params.device)) {
       logWarn('Invalid bid request - missing required device data');
       return false;
     }
@@ -48,19 +74,49 @@ export const spec = {
     const secure = 1;
     const request = validBidRequests[0];
     const params = request.params;
-    let impData = {
-      id: request.bidId,
-      secure: secure,
-      banner: buildBanner(request),
-      ext: {
-        bidder: {
-          pubId: params.pubId
+    const imps = validBidRequests.map(request => {
+      const impData = {
+        id: request.bidId,
+        secure: secure,
+        ext: {
+          bidder: {
+            pubId: params.pubId
+          }
         }
+      };
+      if (params.tagid) {
+        impData.tagid = params.tagid;
       }
-    };
+      if (request.mediaTypes) {
+        for (const mediaType in request.mediaTypes) {
+          switch (mediaType) {
+            case BANNER:
+              impData.banner = buildBanner(request);
+              break;
+            case VIDEO:
+              impData.video = buildVideo(request);
+              break;
+          }
+        }
+      }
+      if (typeof bidderRequest.getFloor === 'function') {
+        const floorInfo = bidderRequest.getFloor({
+          currency: 'USD',
+          mediaType: impData.video ? 'video' : 'banner',
+          size: [impData.video ? impData.video.w : impData.banner.w, impData.video ? impData.video.h : impData.banner.h]
+        });
+        if (floorInfo && floorInfo.floor) {
+          impData.bidfloor = floorInfo.floor;
+        }
+      }
+      if (!impData.bidfloor && params.bidfloor) {
+        impData.bidfloor = params.bidfloor;
+      }
+      return impData;
+    });
     let payload = {
       id: bidderRequest.bidderRequestId,
-      imp: [impData],
+      imp: imps,
       site: params.site ? params.site : {},
       app: params.app ? params.app : {},
       device: params.device ? params.device : {},
@@ -79,19 +135,21 @@ export const spec = {
       regs: params.regs ? params.regs : {},
       ext: params.ext ? params.ext : {}
     };
-
+    payload.regs.ext = {}
+    payload.user.ext = {}
     payload.device.ua = navigator.userAgent;
     payload.device.ip = navigator.ip;
-    payload.site.page = bidderRequest.refererInfo.page;
+    payload.site.page = bidderRequest?.refererInfo?.page || window.location.href;
+    payload.site.domain = _getDomainFromURL(payload.site.page);
     payload.site.mobile = /(ios|ipod|ipad|iphone|android)/i.test(navigator.userAgent) ? 1 : 0;
     if (params.test) {
       payload.test = params.test;
     }
-    if (request.gdprConsent) {
-      payload.regs.ext = Object.assign(payload.regs.ext, {gdpr: request.gdprConsent.gdprApplies === true ? 1 : 0});
+    if (bidderRequest.gdprConsent) {
+      payload.regs.ext = Object.assign(payload.regs.ext, {gdpr: bidderRequest.gdprConsent.gdprApplies == true ? 1 : 0});
     }
-    if (request.gdprConsent && request.gdprConsent.gdprApplies) {
-      payload.user.ext = Object.assign(payload.user.ext, {consent: request.gdprConsent.consentString});
+    if (bidderRequest.gdprConsent && bidderRequest.gdprConsent.gdprApplies) {
+      payload.user.ext = Object.assign(payload.user.ext, {consent: bidderRequest.gdprConsent.consentString});
     }
     const postUrl = ENDPOINT_URL;
     return {
@@ -103,28 +161,37 @@ export const spec = {
    * Unpack the response from the server into a list of bids.
    *
    * @param {ServerResponse} serverResponse A successful response from the server.
-   * @param bidRequest The payload from the server's response.
+   * @param {BidRequest} bidRequest The payload from the server's response.
    * @return {Bid[]} An array of bids which were nested inside the server.
    */
   interpretResponse: function (serverResponse, bidRequest) {
-    let bidResponse = [];
-    if (Object.keys(serverResponse.body).length !== 0) {
-      let zresponse = serverResponse.body;
-      let zbid = zresponse.seatbid[0].bid[0];
-      let bid = {
-        requestId: zbid.impid,
-        cpm: zbid.price,
-        currency: zbid.cur,
-        width: zbid.w,
-        height: zbid.h,
-        ad: zbid.adm,
-        ttl: TTL,
-        creativeId: zbid.crid,
-        netRevenue: NET_REV
-      };
-      bidResponse.push(bid);
+    let bidResponses = [];
+    const response = (serverResponse || {}).body;
+    if (response && response.seatbid && response.seatbid.length && response.seatbid[0].bid && response.seatbid[0].bid.length) {
+      response.seatbid.forEach(zmSeatbid => {
+        zmSeatbid.bid.forEach(zmBid => {
+          let bid = {
+            requestId: zmBid.impid,
+            cpm: zmBid.price,
+            currency: response.cur,
+            width: zmBid.w,
+            height: zmBid.h,
+            ad: zmBid.adm,
+            ttl: TTL,
+            creativeId: zmBid.crid,
+            netRevenue: NET_REV,
+          };
+          bid.meta = {
+            advertiserDomains: (zmBid.adomain && zmBid.adomain.length) ? zmBid.adomain : []
+          };
+          if (zmBid.ext && zmBid.ext.vast_url) {
+            bid.vastXml = zmBid.ext.vast_url;
+          }
+          bidResponses.push(bid);
+        })
+      })
     }
-    return bidResponse;
+    return bidResponses;
   }
 }
 
@@ -138,4 +205,64 @@ function buildBanner(request) {
   };
 }
 
+function buildVideo(request) {
+  let video = {};
+  const videoParams = deepAccess(request, 'mediaTypes.video', {});
+  for (const key in VIDEO_CUSTOM_PARAMS) {
+    if (videoParams.hasOwnProperty(key)) {
+      video[key] = checkParamDataType(key, videoParams[key], VIDEO_CUSTOM_PARAMS[key]);
+    }
+  }
+  if (videoParams.playerSize) {
+    if (isArray(videoParams.playerSize[0])) {
+      video.w = parseInt(videoParams.playerSize[0][0], 10);
+      video.h = parseInt(videoParams.playerSize[0][1], 10);
+    } else if (isNumber(videoParams.playerSize[0])) {
+      video.w = parseInt(videoParams.playerSize[0], 10);
+      video.h = parseInt(videoParams.playerSize[1], 10);
+    }
+  }
+  return video;
+}
+
+export function checkParamDataType(key, value, datatype) {
+  let functionToExecute;
+  switch (datatype) {
+    case DATA_TYPES.BOOLEAN:
+      functionToExecute = isBoolean;
+      break;
+    case DATA_TYPES.NUMBER:
+      functionToExecute = isNumber;
+      break;
+    case DATA_TYPES.STRING:
+      functionToExecute = isStr;
+      break;
+    case DATA_TYPES.ARRAY:
+      functionToExecute = isArray;
+      break;
+  }
+  if (functionToExecute(value)) {
+    return value;
+  }
+  logWarn('Ignoring param key: ' + key + ', expects ' + datatype + ', found ' + typeof value);
+  return undefined;
+}
+
+function hasBannerMediaType(bidRequest) {
+  return !!deepAccess(bidRequest, 'mediaTypes.banner');
+}
+
+/**
+ * @param {BidRequest} bidRequest bid request
+ */
+function hasVideoMediaType(bidRequest) {
+  return !!deepAccess(bidRequest, 'mediaTypes.video');
+}
+
+export function _getDomainFromURL(url) {
+  let anchor = document.createElement('a');
+  anchor.href = url;
+  return anchor.hostname;
+}
+
 registerBidder(spec);
diff --git a/modules/zmaticooBidAdapter.md b/modules/zmaticooBidAdapter.md
@@ -12,6 +12,8 @@ zMaticoo Bidder Adapter for Prebid.js.
 
 # Test Parameters
 
+## banner
+
 ```
         var adUnits = [
             {
@@ -23,7 +25,7 @@ zMaticoo Bidder Adapter for Prebid.js.
                 bids: [
                     {
                         bidder: 'zmaticoo',
-                        bidId: '12345',
+                        bidId: '123456',
                         params: {
                             user: {
                                 uid: '12345',
@@ -43,3 +45,36 @@ zMaticoo Bidder Adapter for Prebid.js.
             }
         ];
 ```
+
+## video
+
+```
+     var adUnits = [{
+    code: 'test1',
+    mediaTypes: {
+        video: {
+            playerSize: [480, 320],
+            mimes: ['video/mp4'],
+            context: 'instream',
+            placement: 1,       // required, integer
+            maxduration: 30,    // required, integer
+            minduration: 15,    // optional, integer
+            pos: 1,             // optional, integer
+            startdelay: 10,     // required if placement == 1
+            protocols: [2, 3],  // required, array of integers
+            api: [2, 3],        // required, array of integers
+            playbackmethod: [2, 6], // required, array of integers
+            skippable: true,    // optional, boolean
+            skipafter: 10       // optional, integer
+        }
+    },
+    bids: [{
+        bidder: "zmaticoo",
+        bidId: '123456',
+        params: {
+            pubId: 'prebid-test',
+            site: {domain: "test.com"}
+        }
+    }]
+}];
+```
diff --git a/test/spec/modules/zmaticooBidAdapter_spec.js b/test/spec/modules/zmaticooBidAdapter_spec.js
