prebid.js 7.14.0 → 7.16.0

package/modules/stroeerCoreBidAdapter.js

@@ -1,6 +1,6 @@
-import { getWindowSelf, getWindowTop, buildUrl, logError, isStr, isEmpty, deepAccess } from '../src/utils.js';
+import {buildUrl, deepAccess, getWindowSelf, getWindowTop, isEmpty, 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 GVL_ID = 136;
 const BIDDER_CODE = 'stroeerCore';
@@ -10,98 +10,33 @@ const DEFAULT_PORT = '';
 const FIVE_MINUTES_IN_SECONDS = 300;
 const USER_SYNC_IFRAME_URL = 'https://js.adscale.de/pbsync.html';
 
-const isSecureWindow = () => getWindowSelf().location.protocol === 'https:';
-const isMainPageAccessible = () => getMostAccessibleTopWindow() === getWindowTop();
-
-function getMostAccessibleTopWindow() {
-  let res = getWindowSelf();
-
-  try {
-    while (getWindowTop().top !== res && res.parent.location.href.length) {
-      res = res.parent;
-    }
-  } catch (ignore) {
-  }
-
-  return res;
-}
-
-function elementInView(elementId) {
-  const resolveElement = (elId) => {
-    const win = getWindowSelf();
-
-    return win.document.getElementById(elId);
-  };
-
-  const visibleInWindow = (el, win) => {
-    const rect = el.getBoundingClientRect();
-    const inView = (rect.top + rect.height >= 0) && (rect.top <= win.innerHeight);
-
-    if (win !== win.parent) {
-      return inView && visibleInWindow(win.frameElement, win.parent);
-    }
-
-    return inView;
-  };
-
-  try {
-    return visibleInWindow(resolveElement(elementId), getWindowSelf());
-  } catch (e) {
-    // old browser, element not found, cross-origin etc.
-  }
-  return undefined;
-}
-
-function _buildUrl({host: hostname = DEFAULT_HOST, port = DEFAULT_PORT, securePort, path: pathname = DEFAULT_PATH}) {
-  if (securePort) {
-    port = securePort;
-  }
-
-  return buildUrl({protocol: 'https', hostname, port, pathname});
-}
-
-function getGdprParams(gdprConsent) {
-  if (gdprConsent) {
-    const consentString = encodeURIComponent(gdprConsent.consentString || '')
-    const isGdpr = gdprConsent.gdprApplies ? 1 : 0;
-
-    return `?gdpr=${isGdpr}&gdpr_consent=${consentString}`
-  } else {
-    return '';
-  }
-}
-
 export const spec = {
   code: BIDDER_CODE,
   gvlid: GVL_ID,
-  supportedMediaTypes: [BANNER],
+  supportedMediaTypes: [BANNER, VIDEO],
 
   isBidRequestValid: (function () {
     const validators = [];
 
-    const createValidator = (checkFn, errorMsgFn) => {
+    const createValidator = (checkFn, msg) => {
       return (bidRequest) => {
         if (checkFn(bidRequest)) {
           return true;
         } else {
-          logError(`invalid bid: ${errorMsgFn(bidRequest)}`, 'ERROR');
+          logWarn(`${BIDDER_CODE}: Bid setup for ${bidRequest.adUnitCode} is invalid: ${msg}`);
           return false;
         }
       }
     };
 
-    function isBanner(bidReq) {
-      return (!bidReq.mediaTypes && !bidReq.mediaType) ||
-        (bidReq.mediaTypes && bidReq.mediaTypes.banner) ||
-        bidReq.mediaType === BANNER;
-    }
+    const hasValidMediaType = bidReq => hasBanner(bidReq) || hasVideo(bidReq);
 
-    validators.push(createValidator((bidReq) => isBanner(bidReq),
-      bidReq => `bid request ${bidReq.bidId} is not a banner`));
+    validators.push(createValidator((bidReq) => hasValidMediaType(bidReq),
+      'the media type is invalid'));
     validators.push(createValidator((bidReq) => typeof bidReq.params === 'object',
-      bidReq => `bid request ${bidReq.bidId} does not have custom params`));
+      'the custom params does not exist'));
     validators.push(createValidator((bidReq) => isStr(bidReq.params.sid),
-      bidReq => `bid request ${bidReq.bidId} does not have a sid string field`));
+      'the sid field must be a string'));
 
     return function (bidRequest) {
       return validators.every(f => f(bidRequest));
@@ -113,9 +48,8 @@ export const spec = {
 
     const refererInfo = bidderRequest.refererInfo;
 
-    const payload = {
+    const basePayload = {
       id: bidderRequest.auctionId,
-      bids: [],
       ref: refererInfo.ref,
       ssl: isSecureWindow(),
       mpa: isMainPageAccessible(),
@@ -127,7 +61,7 @@ export const spec = {
     const userIds = anyBid.userId;
 
     if (!isEmpty(userIds)) {
-      payload.user = {
+      basePayload.user = {
         euids: userIds
       };
     }
@@ -135,24 +69,24 @@ export const spec = {
     const gdprConsent = bidderRequest.gdprConsent;
 
     if (gdprConsent && gdprConsent.consentString != null && gdprConsent.gdprApplies != null) {
-      payload.gdpr = {
+      basePayload.gdpr = {
         consent: bidderRequest.gdprConsent.consentString, applies: bidderRequest.gdprConsent.gdprApplies
       };
     }
 
-    function bidSizes(bid) {
-      return deepAccess(bid, 'mediaTypes.banner.sizes') || bid.sizes /* for prebid < 3 */ || [];
-    }
+    const bannerBids = validBidRequests
+      .filter(hasBanner)
+      .map(mapToPayloadBannerBid);
 
-    validBidRequests.forEach(bid => {
-      payload.bids.push({
-        bid: bid.bidId, sid: bid.params.sid, siz: bidSizes(bid), viz: elementInView(bid.adUnitCode)
-      });
-    });
+    const videoBids = validBidRequests
+      .filter(hasVideo)
+      .map(mapToPayloadVideoBid);
 
     return {
-      method: 'POST', url: _buildUrl(anyBid.params), data: payload
-    }
+      method: 'POST',
+      url: buildEndpointUrl(anyBid.params),
+      data: {...basePayload, bids: [...bannerBids, ...videoBids]}
+    };
   },
 
   interpretResponse: function (serverResponse) {
@@ -160,12 +94,13 @@ export const spec = {
 
     if (serverResponse.body && typeof serverResponse.body === 'object') {
       serverResponse.body.bids.forEach(bidResponse => {
-        bids.push({
+        const mediaType = bidResponse.vastXml != null ? VIDEO : BANNER;
+
+        const bid = {
           requestId: bidResponse.bidId,
           cpm: bidResponse.cpm || 0,
           width: bidResponse.width || 0,
           height: bidResponse.height || 0,
-          ad: bidResponse.ad,
           ttl: FIVE_MINUTES_IN_SECONDS,
           currency: 'EUR',
           netRevenue: true,
@@ -173,7 +108,16 @@ export const spec = {
           meta: {
             advertiserDomains: bidResponse.adomain
           },
-        });
+          mediaType,
+        };
+
+        if (mediaType === VIDEO) {
+          bid.vastXml = bidResponse.vastXml;
+        } else {
+          bid.ad = bidResponse.ad;
+        }
+
+        bids.push(bid);
       });
     }
 
@@ -192,4 +136,97 @@ export const spec = {
   }
 };
 
+const isSecureWindow = () => getWindowSelf().location.protocol === 'https:';
+
+const isMainPageAccessible = () => {
+  try {
+    return !!getWindowTop().location.href;
+  } catch (ignore) {
+    return false;
+  }
+}
+
+const elementInView = (elementId) => {
+  const resolveElement = (elId) => {
+    const win = getWindowSelf();
+
+    return win.document.getElementById(elId);
+  };
+
+  const visibleInWindow = (el, win) => {
+    const rect = el.getBoundingClientRect();
+    const inView = (rect.top + rect.height >= 0) && (rect.top <= win.innerHeight);
+
+    if (win !== win.parent) {
+      return inView && visibleInWindow(win.frameElement, win.parent);
+    }
+
+    return inView;
+  };
+
+  try {
+    return visibleInWindow(resolveElement(elementId), getWindowSelf());
+  } catch (e) {
+    // old browser, element not found, cross-origin etc.
+  }
+  return undefined;
+}
+
+const buildEndpointUrl = ({host: hostname = DEFAULT_HOST, port = DEFAULT_PORT, securePort, path: pathname = DEFAULT_PATH}) => {
+  if (securePort) {
+    port = securePort;
+  }
+
+  return buildUrl({protocol: 'https', hostname, port, pathname});
+}
+
+const getGdprParams = gdprConsent => {
+  if (gdprConsent) {
+    const consentString = encodeURIComponent(gdprConsent.consentString || '')
+    const isGdpr = gdprConsent.gdprApplies ? 1 : 0;
+
+    return `?gdpr=${isGdpr}&gdpr_consent=${consentString}`
+  } else {
+    return '';
+  }
+}
+
+const hasBanner = bidReq => {
+  return (!bidReq.mediaTypes && !bidReq.mediaType) ||
+    (bidReq.mediaTypes && bidReq.mediaTypes.banner) ||
+    bidReq.mediaType === BANNER;
+}
+
+const hasVideo = bidReq => {
+  const mediaTypes = bidReq.mediaTypes;
+  return mediaTypes &&
+    mediaTypes.video &&
+    ['instream', 'outstream'].indexOf(mediaTypes.video.context) > -1;
+};
+
+const mapToPayloadBaseBid = (bidRequest) => ({
+  bid: bidRequest.bidId,
+  sid: bidRequest.params.sid,
+  viz: elementInView(bidRequest.adUnitCode),
+});
+
+const mapToPayloadBannerBid = (bidRequest) => ({
+  ban: {
+    siz: deepAccess(bidRequest, 'mediaTypes.banner.sizes') || [],
+  },
+  ...mapToPayloadBaseBid(bidRequest)
+});
+
+const mapToPayloadVideoBid = (bidRequest) => {
+  const video = deepAccess(bidRequest, 'mediaTypes.video') || {};
+  return {
+    vid: {
+      ctx: video.context,
+      siz: video.playerSize,
+      mim: video.mimes,
+    },
+    ...mapToPayloadBaseBid(bidRequest)
+  };
+};
+
 registerBidder(spec);

package/modules/stroeerCoreBidAdapter.md

@@ -6,26 +6,64 @@ Module Type: Bidder Adapter
 Maintainer: help@cz.stroeer-labs.com
 ```
 
+### Bid Params
 
-## Ad unit configuration for publishers
+| Name          | Scope    | Description        | Example                                 | Type     |
+|---------------|----------|--------------------|-----------------------------------------|----------|
+| `sid`         | required | Slot ID            | `'06b782cc-091b-4f53-9cd2-0291679aa1ac'`| `string` |
+
+### Ad Unit Configuration
+
+#### Banner
+
+* The server will ignore sizes that are not supported by the slot or by the platform (such as 987x123).
+
+##### Example
 
 ```javascript
-const adUnits = [{ 
-    code: 'div-gpt-ad-1460505748561-0',
+var adUnits = [
+  { 
+    code: 'your-banner-adunit-code',
     mediaTypes: {
-        banner: {
-            sizes: [[300, 250]],
-        }
+      banner: {
+        sizes: [[300, 250]],
+      }
     },
     bids: [{
-        bidder: 'stroeerCore',
-        params: {
-          sid: "06b782cc-091b-4f53-9cd2-0291679aa1ac"
-        }    
+      bidder: 'stroeerCore',
+      params: {
+        sid: '06b782cc-091b-4f53-9cd2-0291679aa1ac'
+      }    
     }]
-}];
+  }
+];
 ```
-### Config Notes
 
-* Slot id (`sid`) is required. The adapter will ignore bid requests from prebid if `sid` is not provided. This must be in the decoded form. For example, "1234" as opposed to "MTM0ODA=". 
-* The server ignores dimensions that are not supported by the slot or by the platform (such as 987x123).
+#### Video
+
+* Both instream and outstream contexts are supported.
+* We do not provide an outstream renderer. You will need to set up your own. See [Show Outstream Video Ads](https://docs.prebid.org/dev-docs/show-outstream-video-ads.html) for more information.
+* On `mediaTypes.video`, the fields `context` and `mediaTypes` are required.
+
+##### Example
+
+```javascript
+var adUnits = [
+  {
+    code: 'your-video-adunit-code',
+    mediaTypes: {
+      video: {
+        context: 'instream',
+        playerSize: [640, 480],
+        mimes: ['video/mp4', 'video/quicktime', 'video/x-ms-wmv']
+      }
+    },
+    bids: [{
+      bidder: 'stroeerCore',
+      params: {
+        sid: '35d4225e-f8e3-4f45-b1ea-77913afd00d1'
+      }
+    }]
+  }
+];
+```

package/modules/teadsBidAdapter.js

@@ -54,7 +54,7 @@ export const spec = {
       data: bids,
       deviceWidth: screen.width,
       hb_version: '$prebid.version$',
-      ...getUnifiedId2Parameter(deepAccess(validBidRequests, '0.userId.uid2')),
+      ...getSharedViewerIdParameters(validBidRequests),
       ...getFirstPartyTeadsIdParameter()
     };
 
@@ -124,6 +124,37 @@ export const spec = {
   }
 };
 
+/**
+ *
+ * @param validBidRequests an array of bids
+ * @returns {{sharedViewerIdKey : 'sharedViewerIdValue'}} object with all sharedviewerids
+ */
+function getSharedViewerIdParameters(validBidRequests) {
+  const sharedViewerIdMapping = {
+    unifiedId2: 'uid2.id', // uid2IdSystem
+    liveRampId: 'idl_env', // identityLinkIdSystem
+    lotamePanoramaId: 'lotamePanoramaId', // lotamePanoramaIdSystem
+    id5Id: 'id5id.uid', // id5IdSystem
+    criteoId: 'criteoId', // criteoIdSystem
+    yahooConnectId: 'connectId', // connectIdSystem
+    quantcastId: 'quantcastId', // quantcastIdSystem
+    epsilonPublisherLinkId: 'publinkId', // publinkIdSystem
+    publisherFirstPartyViewerId: 'pubcid', // sharedIdSystem
+    merkleId: 'merkleId.id', // merkleIdSystem
+    kinessoId: 'kpuid' // kinessoIdSystem
+  }
+
+  let sharedViewerIdObject = {};
+  for (const sharedViewerId in sharedViewerIdMapping) {
+    const key = sharedViewerIdMapping[sharedViewerId];
+    const value = deepAccess(validBidRequests, `0.userId.${key}`);
+    if (value) {
+      sharedViewerIdObject[sharedViewerId] = value;
+    }
+  }
+  return sharedViewerIdObject;
+}
+
 function getReferrerInfo(bidderRequest) {
   let ref = '';
   if (bidderRequest && bidderRequest.refererInfo && bidderRequest.refererInfo.page) {
@@ -228,15 +259,6 @@ function _validateId(id) {
   return (parseInt(id) > 0);
 }
 
-/**
- * Get unified ID v2 parameter to be sent in bid request.
- * @param `{id: string} | undefined` optionalUid2 uid2 user ID object available if "uid2IdSystem" module is enabled.
- * @returns `{} | {unifiedId2: string}`
- */
-function getUnifiedId2Parameter(optionalUid2) {
-  return optionalUid2 ? { unifiedId2: optionalUid2.id } : {};
-}
-
 /**
  * Get the first-party cookie Teads ID parameter to be sent in bid request.
  * @returns `{} | {firstPartyCookieTeadsId: string}`

package/modules/ucfunnelBidAdapter.js

@@ -1,4 +1,4 @@
-import { generateUUID, _each } from '../src/utils.js';
+import { generateUUID, _each, deepAccess } from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER, VIDEO, NATIVE} from '../src/mediaTypes.js';
 import { getStorageManager } from '../src/storageManager.js';
@@ -251,6 +251,7 @@ function getRequestData(bid, bidderRequest) {
   const userIdTdid = (bid.userId && bid.userId.tdid) ? bid.userId.tdid : '';
   const supplyChain = getSupplyChain(bid.schain);
   const bidFloor = getFloor(bid, size, bid.mediaTypes);
+  const gpid = deepAccess(bid, 'ortb2Imp.ext.gpid');
   // general bid data
   let bidData = {
     ver: VER,
@@ -267,17 +268,15 @@ function getRequestData(bid, bidderRequest) {
     bidData.fp = bidFloor;
   }
 
-  addUserId(bidData, bid.userId);
-  // TODO: is 'page' the right value here? does the fallback make sense?
-  bidData.u = bidderRequest?.refererInfo?.page || bidderRequest?.refererInfo?.topmostLocation;
-  try {
-    bidData.host = window.top.location.hostname;
-    bidData.xr = 0;
-  } catch (e) {
-    bidData.host = window.location.hostname;
-    bidData.xr = 1;
+  if (gpid) {
+    bidData.gpid = gpid;
   }
 
+  addUserId(bidData, bid.userId);
+
+  bidData.u = bidderRequest.refererInfo.page || bidderRequest.refererInfo.topmostLocation;
+  bidData.host = bidderRequest.refererInfo.domain;
+
   if (window.location.ancestorOrigins && window.location.ancestorOrigins.length > 0) {
     bidData.ao = window.location.ancestorOrigins[window.location.ancestorOrigins.length - 1];
   }