prebid.js 7.2.0 → 7.5.0

package/modules/openxOrtbBidAdapter.js

@@ -0,0 +1,349 @@
+import {config} from '../src/config.js';
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import * as utils from '../src/utils.js';
+import {BANNER, VIDEO} from '../src/mediaTypes.js';
+import {includes} from '../src/polyfill.js';
+
+const bidderConfig = 'hb_pb_ortb';
+const bidderVersion = '1.0';
+const VIDEO_TARGETING = ['startdelay', 'mimes', 'minduration', 'maxduration', 'delivery',
+  'startdelay', 'skip', 'playbackmethod', 'api', 'protocol', 'boxingallowed', 'maxextended',
+  'linearity', 'delivery', 'protocols', 'placement', 'minbitrate', 'maxbitrate', 'battr', 'ext'];
+export const REQUEST_URL = 'https://rtb.openx.net/openrtbb/prebidjs';
+export const SYNC_URL = 'https://u.openx.net/w/1.0/pd';
+export const DEFAULT_PH = '2d1251ae-7f3a-47cf-bd2a-2f288854a0ba';
+export const spec = {
+  code: 'openx',
+  supportedMediaTypes: [BANNER, VIDEO],
+  isBidRequestValid,
+  buildRequests,
+  interpretResponse,
+  getUserSyncs,
+  transformBidParams
+};
+
+registerBidder(spec);
+
+function transformBidParams(params, isOpenRtb) {
+  return utils.convertTypes({
+    'unit': 'string',
+    'customFloor': 'number'
+  }, params);
+}
+
+function isBidRequestValid(bidRequest) {
+  const hasDelDomainOrPlatform = bidRequest.params.delDomain ||
+    bidRequest.params.platform;
+
+  if (utils.deepAccess(bidRequest, 'mediaTypes.banner') &&
+    hasDelDomainOrPlatform) {
+    return !!bidRequest.params.unit ||
+      utils.deepAccess(bidRequest, 'mediaTypes.banner.sizes.length') > 0;
+  }
+
+  return !!(bidRequest.params.unit && hasDelDomainOrPlatform);
+}
+
+function buildRequests(bids, bidderRequest) {
+  let videoBids = bids.filter(bid => isVideoBid(bid));
+  let bannerBids = bids.filter(bid => isBannerBid(bid));
+  let requests = bannerBids.length ? [createBannerRequest(bannerBids, bidderRequest)] : [];
+  videoBids.forEach(bid => {
+    requests.push(createVideoRequest(bid, bidderRequest));
+  });
+  return requests;
+}
+
+function createBannerRequest(bids, bidderRequest) {
+  let data = getBaseRequest(bids[0], bidderRequest);
+  data.imp = bids.map(bid => {
+    const floor = getFloor(bid, BANNER);
+    let imp = {
+      id: bid.bidId,
+      tagid: bid.params.unit,
+      banner: {
+        format: toFormat(bid.mediaTypes.banner.sizes),
+        topframe: utils.inIframe() ? 0 : 1
+      },
+      ext: {divid: bid.adUnitCode}
+    };
+    enrichImp(imp, bid, floor);
+    return imp;
+  });
+  return {
+    method: 'POST',
+    url: REQUEST_URL,
+    data: data
+  }
+}
+
+function toFormat(sizes) {
+  return sizes.map((s) => {
+    return { w: s[0], h: s[1] };
+  });
+}
+
+function enrichImp(imp, bid, floor) {
+  if (bid.params.customParams) {
+    utils.deepSetValue(imp, 'ext.customParams', bid.params.customParams);
+  }
+  if (floor > 0) {
+    imp.bidfloor = floor;
+    imp.bidfloorcur = 'USD';
+  } else if (bid.params.customFloor) {
+    imp.bidfloor = bid.params.customFloor;
+  }
+  if (bid.ortb2Imp && bid.ortb2Imp.ext && bid.ortb2Imp.ext.data) {
+    imp.ext.data = bid.ortb2Imp.ext.data;
+  }
+}
+
+function createVideoRequest(bid, bidderRequest) {
+  let width;
+  let height;
+  const videoMediaType = utils.deepAccess(bid, `mediaTypes.video`);
+  const playerSize = utils.deepAccess(bid, 'mediaTypes.video.playerSize');
+  const context = utils.deepAccess(bid, 'mediaTypes.video.context');
+  const floor = getFloor(bid, VIDEO);
+
+  // normalize config for video size
+  if (utils.isArray(bid.sizes) && bid.sizes.length === 2 && !utils.isArray(bid.sizes[0])) {
+    width = parseInt(bid.sizes[0], 10);
+    height = parseInt(bid.sizes[1], 10);
+  } else if (utils.isArray(bid.sizes) && utils.isArray(bid.sizes[0]) && bid.sizes[0].length === 2) {
+    width = parseInt(bid.sizes[0][0], 10);
+    height = parseInt(bid.sizes[0][1], 10);
+  } else if (utils.isArray(playerSize) && playerSize.length === 2) {
+    width = parseInt(playerSize[0], 10);
+    height = parseInt(playerSize[1], 10);
+  }
+
+  let data = getBaseRequest(bid, bidderRequest);
+  data.imp = [{
+    id: bid.bidId,
+    tagid: bid.params.unit,
+    video: {
+      w: width,
+      h: height,
+      topframe: utils.inIframe() ? 0 : 1
+    },
+    ext: {divid: bid.adUnitCode}
+  }];
+
+  enrichImp(data.imp[0], bid, floor);
+
+  if (context) {
+    if (context === 'instream') {
+      data.imp[0].video.placement = 1;
+    } else if (context === 'outstream') {
+      data.imp[0].video.placement = 4;
+    }
+  }
+
+  // backward compatability for video params
+  let videoParams = bid.params.video || bid.params.openrtb || {};
+  if (utils.isArray(videoParams.imp)) {
+    videoParams = videoParams[0].video;
+  }
+
+  Object.keys(videoParams)
+    .filter(param => includes(VIDEO_TARGETING, param))
+    .forEach(param => data.imp[0].video[param] = videoParams[param]);
+  Object.keys(videoMediaType)
+    .filter(param => includes(VIDEO_TARGETING, param))
+    .forEach(param => data.imp[0].video[param] = videoMediaType[param]);
+
+  return {
+    method: 'POST',
+    url: REQUEST_URL,
+    data: data
+  }
+}
+
+function getBaseRequest(bid, bidderRequest) {
+  let req = {
+    id: bidderRequest.auctionId,
+    cur: [config.getConfig('currency.adServerCurrency') || 'USD'],
+    at: 1,
+    tmax: config.getConfig('bidderTimeout'),
+    site: {
+      page: config.getConfig('pageUrl') || bidderRequest.refererInfo.referer
+    },
+    regs: {
+      coppa: (config.getConfig('coppa') === true || bid.params.coppa) ? 1 : 0,
+    },
+    device: {
+      dnt: (utils.getDNT() || bid.params.doNotTrack) ? 1 : 0,
+      h: screen.height,
+      w: screen.width,
+      ua: window.navigator.userAgent,
+      language: window.navigator.language.split('-').shift()
+    },
+    ext: {
+      bc: `${bidderConfig}_${bidderVersion}`
+    }
+  };
+
+  if (bid.params.platform) {
+    utils.deepSetValue(req, 'ext.platform', bid.params.platform);
+  }
+  if (bid.params.delDomain) {
+    utils.deepSetValue(req, 'ext.delDomain', bid.params.delDomain);
+  }
+  if (bid.params.test) {
+    req.test = 1
+  }
+  if (bidderRequest.gdprConsent) {
+    if (bidderRequest.gdprConsent.gdprApplies !== undefined) {
+      utils.deepSetValue(req, 'regs.ext.gdpr', bidderRequest.gdprConsent.gdprApplies === true ? 1 : 0);
+    }
+    if (bidderRequest.gdprConsent.consentString !== undefined) {
+      utils.deepSetValue(req, 'user.ext.consent', bidderRequest.gdprConsent.consentString);
+    }
+    if (bidderRequest.gdprConsent.addtlConsent !== undefined) {
+      utils.deepSetValue(req, 'user.ext.ConsentedProvidersSettings.consented_providers', bidderRequest.gdprConsent.addtlConsent);
+    }
+  }
+  if (bidderRequest.uspConsent) {
+    utils.deepSetValue(req, 'regs.ext.us_privacy', bidderRequest.uspConsent);
+  }
+  if (bid.schain) {
+    utils.deepSetValue(req, 'source.ext.schain', bid.schain);
+  }
+  if (bid.userIdAsEids) {
+    utils.deepSetValue(req, 'user.ext.eids', bid.userIdAsEids);
+  }
+  const commonFpd = bidderRequest.ortb2 || {};
+  if (commonFpd.site) {
+    utils.mergeDeep(req, {site: commonFpd.site});
+  }
+  if (commonFpd.user) {
+    utils.mergeDeep(req, {user: commonFpd.user});
+  }
+  return req;
+}
+
+function isVideoBid(bid) {
+  return utils.deepAccess(bid, 'mediaTypes.video');
+}
+
+function isBannerBid(bid) {
+  return utils.deepAccess(bid, 'mediaTypes.banner') || !isVideoBid(bid);
+}
+
+function getFloor(bid, mediaType) {
+  let floor = 0;
+
+  if (typeof bid.getFloor === 'function') {
+    const floorInfo = bid.getFloor({
+      currency: 'USD',
+      mediaType: mediaType,
+      size: '*'
+    });
+
+    if (typeof floorInfo === 'object' &&
+      floorInfo.currency === 'USD' &&
+      !isNaN(parseFloat(floorInfo.floor))) {
+      floor = Math.max(floor, parseFloat(floorInfo.floor));
+    }
+  }
+
+  return floor;
+}
+
+function interpretResponse(resp, req) {
+  // pass these from request to the responses for use in userSync
+  if (req.data.ext) {
+    if (req.data.ext.delDomain) {
+      utils.deepSetValue(resp, 'body.ext.delDomain', req.data.ext.delDomain);
+    }
+    if (req.data.ext.platform) {
+      utils.deepSetValue(resp, 'body.ext.platform', req.data.ext.platform);
+    }
+  }
+
+  const respBody = resp.body;
+  if ('nbr' in respBody) {
+    return [];
+  }
+
+  let bids = [];
+  respBody.seatbid.forEach(seatbid => {
+    bids = [...bids, ...seatbid.bid.map(bid => {
+      let response = {
+        requestId: bid.impid,
+        cpm: bid.price,
+        width: bid.w,
+        height: bid.h,
+        creativeId: bid.crid,
+        dealId: bid.dealid,
+        currency: respBody.cur || 'USD',
+        netRevenue: true,
+        ttl: 300,
+        mediaType: 'banner' in req.data.imp[0] ? BANNER : VIDEO,
+        meta: { advertiserDomains: bid.adomain }
+      };
+
+      if (response.mediaType === VIDEO) {
+        if (bid.nurl) {
+          response.vastUrl = bid.nurl;
+        } else {
+          response.vastXml = bid.adm;
+        }
+      } else {
+        response.ad = bid.adm;
+      }
+
+      if (bid.ext) {
+        response.meta.networkId = bid.ext.dsp_id;
+        response.meta.advertiserId = bid.ext.buyer_id;
+        response.meta.brandId = bid.ext.brand_id;
+      }
+
+      if (respBody.ext && respBody.ext.paf) {
+        response.meta.paf = respBody.ext.paf;
+        response.meta.paf.content_id = utils.deepAccess(bid, 'ext.paf.content_id');
+      }
+
+      return response
+    })];
+  });
+
+  return bids;
+}
+
+/**
+ * @param syncOptions
+ * @param responses
+ * @param gdprConsent
+ * @param uspConsent
+ * @return {{type: (string), url: (*|string)}[]}
+ */
+function getUserSyncs(syncOptions, responses, gdprConsent, uspConsent) {
+  if (syncOptions.iframeEnabled || syncOptions.pixelEnabled) {
+    let pixelType = syncOptions.iframeEnabled ? 'iframe' : 'image';
+    let queryParamStrings = [];
+    let syncUrl = SYNC_URL;
+    if (gdprConsent) {
+      queryParamStrings.push('gdpr=' + (gdprConsent.gdprApplies ? 1 : 0));
+      queryParamStrings.push('gdpr_consent=' + encodeURIComponent(gdprConsent.consentString || ''));
+    }
+    if (uspConsent) {
+      queryParamStrings.push('us_privacy=' + encodeURIComponent(uspConsent));
+    }
+    if (responses.length > 0 && responses[0].body && responses[0].body.ext) {
+      const ext = responses[0].body.ext;
+      if (ext.delDomain) {
+        syncUrl = `https://${ext.delDomain}/w/1.0/pd`
+      } else if (ext.platform) {
+        queryParamStrings.push('ph=' + ext.platform)
+      }
+    } else {
+      queryParamStrings.push('ph=' + DEFAULT_PH)
+    }
+    return [{
+      type: pixelType,
+      url: `${syncUrl}${queryParamStrings.length > 0 ? '?' + queryParamStrings.join('&') : ''}`
+    }];
+  }
+}

package/modules/openxOrtbBidAdapter.md

@@ -0,0 +1,105 @@
+# Overview
+
+```
+Module Name: OpenX OpenRTB Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: team-openx@openx.com
+```
+
+# Description
+
+This is an updated version of the OpenX bid adapter which calls our new serving architecture.
+Publishers are welcome to test this adapter and give feedback. Please note you should only include either openxBidAdapter or openxOrtbBidAdapter in your build.
+
+# Bid Parameters
+## Banner
+
+| Name | Scope | Type | Description | Example
+| ---- | ----- | ---- | ----------- | -------
+| `delDomain` or `platform` | required | String | OpenX delivery domain or platform id provided by your OpenX representative.  | "PUBLISHER-d.openx.net" or "555not5a-real-plat-form-id0123456789"
+| `unit` | required | String | OpenX ad unit ID provided by your OpenX representative. | "1611023122"
+| `customParams` | optional | Object | User-defined targeting key-value pairs. customParams applies to a specific unit. | `{key1: "v1", key2: ["v2","v3"]}`
+| `customFloor` | optional | Number | Minimum price in USD. customFloor applies to a specific unit. For example, use the following value to set a $1.50 floor: 1.50 <br/><br/> **WARNING:**<br/> Misuse of this parameter can impact revenue | 1.50
+| `doNotTrack` | optional | Boolean | Prevents advertiser from using data for this user. <br/><br/> **WARNING:**<br/> Request-level setting.  May impact revenue. | true
+| `coppa` | optional | Boolean | Enables Child's Online Privacy Protection Act (COPPA) regulations. | true
+
+## Video
+
+| Name | Scope | Type | Description | Example
+| ---- | ----- | ---- | ----------- | -------
+| `unit` | required | String | OpenX ad unit ID provided by your OpenX representative. | "1611023122"
+| `delDomain` | required | String |  OpenX delivery domain provided by your OpenX representative.  | "PUBLISHER-d.openx.net"
+| `video` | optional | OpenRTB video subtypes | Alternatively can be added under adUnit.mediaTypes.video | `{ video: {mimes: ['video/mp4']}`
+
+
+# Example
+```javascript
+var adUnits = [
+  {
+    code: 'test-div',
+    sizes: [[728, 90]],  // a display size
+    mediaTypes: {'banner': {}},
+    bids: [
+      {
+        bidder: 'openx',
+        params: {
+          unit: '539439964',
+          delDomain: 'se-demo-d.openx.net',
+          customParams: {
+            key1: 'v1',
+            key2: ['v2', 'v3']
+          },
+        }
+      }, {
+         bidder: 'openx',
+         params: {
+           unit: '539439964',
+           platform: 'a3aece0c-9e80-4316-8deb-faf804779bd1',
+           customParams: {
+             key1: 'v1',
+             key2: ['v2', 'v3']
+           },
+         }
+       }
+    ]
+  },
+  {
+    code: 'video1',
+    mediaTypes: {
+      video: {
+        playerSize: [640, 480],
+        context: 'instream'
+      }
+    },
+    bids: [{
+      bidder: 'openx',
+      params: {
+        unit: '1611023124',
+        delDomain: 'PUBLISHER-d.openx.net',
+        video: {
+          mimes: ['video/x-ms-wmv, video/mp4']
+        }
+      }
+    }]
+  }
+];
+```
+
+# Configuration
+Add the following code to enable user syncing. By default, Prebid.js version 0.34.0+ turns off user syncing through iframes.
+OpenX strongly recommends enabling user syncing through iframes. This functionality improves DSP user match rates and increases the
+OpenX bid rate and bid price. Be sure to call `pbjs.setConfig()` only once.
+
+```javascript
+pbjs.setConfig({
+   userSync: {
+      iframeEnabled: true
+   }
+});
+```
+
+# Additional Details
+[Banner Ads](https://docs.openx.com/publishers/prebid-adapter-web/)
+
+[Video Ads](https://docs.openx.com/publishers/prebid-adapter-video/)
+

package/modules/pubCommonId.js

@@ -9,8 +9,7 @@ import * as events from '../src/events.js';
 import CONSTANTS from '../src/constants.json';
 import { getStorageManager } from '../src/storageManager.js';
 
-const MODULE_TYPE = 'fpid-module';
-const storage = getStorageManager({moduleType: MODULE_TYPE});
+const storage = getStorageManager();
 
 const ID_NAME = '_pubcid';
 const OPTOUT_NAME = '_pubcid_optout';

package/modules/readpeakBidAdapter.js

@@ -1,7 +1,7 @@
-import {logError, replaceAuctionPrice} from '../src/utils.js';
-import {registerBidder} from '../src/adapters/bidderFactory.js';
-import {config} from '../src/config.js';
-import {BANNER, NATIVE} from '../src/mediaTypes.js';
+import { logError, replaceAuctionPrice, triggerPixel, isStr } from '../src/utils.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { config } from '../src/config.js';
+import { NATIVE, BANNER } from '../src/mediaTypes.js';
 
 export const ENDPOINT = 'https://app.readpeak.com/header/prebid';
 
@@ -64,8 +64,16 @@ export const spec = {
     };
   },
 
-  interpretResponse: (response, request) =>
-    bidResponseAvailable(request, response)
+  interpretResponse: (response, request) => {
+    return bidResponseAvailable(request, response)
+  },
+
+  onBidWon: (bid) => {
+    if (bid.burl && isStr(bid.burl)) {
+      bid.burl = replaceAuctionPrice(bid.burl, bid.cpm);
+      triggerPixel(bid.burl);
+    }
+  },
 };
 
 function bidResponseAvailable(bidRequest, bidResponse) {
@@ -103,6 +111,7 @@ function bidResponseAvailable(bidRequest, bidResponse) {
         bid.ad = idToBidMap[id].adm
         bid.width = idToBidMap[id].w
         bid.height = idToBidMap[id].h
+        bid.burl = idToBidMap[id].burl
       }
       if (idToBidMap[id].adomain) {
         bid.meta = {

package/modules/relaidoBidAdapter.js

@@ -1,4 +1,4 @@
-import { deepAccess, logWarn, getBidIdParameter, parseQueryStringParameters, triggerPixel, generateUUID, isArray } from '../src/utils.js';
+import { deepAccess, logWarn, getBidIdParameter, parseQueryStringParameters, triggerPixel, generateUUID, isArray, isNumber } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER, VIDEO } from '../src/mediaTypes.js';
 import { Renderer } from '../src/Renderer.js';
@@ -6,7 +6,7 @@ import { getStorageManager } from '../src/storageManager.js';
 
 const BIDDER_CODE = 'relaido';
 const BIDDER_DOMAIN = 'api.relaido.jp';
-const ADAPTER_VERSION = '1.0.7';
+const ADAPTER_VERSION = '1.0.8';
 const DEFAULT_TTL = 300;
 const UUID_KEY = 'relaido_uuid';
 
@@ -44,7 +44,10 @@ function buildRequests(validBidRequests, bidderRequest) {
     let height = 0;
 
     if (hasVideoMediaType(bidRequest) && isVideoValid(bidRequest)) {
-      const playerSize = getValidSizes(deepAccess(bidRequest, 'mediaTypes.video.playerSize'));
+      let playerSize = getValidSizes(deepAccess(bidRequest, 'mediaTypes.video.playerSize'));
+      if (playerSize.length === 0) {
+        playerSize = getValidSizes(deepAccess(bidRequest, 'params.video.playerSize'));
+      }
       width = playerSize[0][0];
       height = playerSize[0][1];
       mediaType = VIDEO;
@@ -253,7 +256,10 @@ function isBannerValid(bid) {
 }
 
 function isVideoValid(bid) {
-  const playerSize = getValidSizes(deepAccess(bid, 'mediaTypes.video.playerSize'));
+  let playerSize = getValidSizes(deepAccess(bid, 'mediaTypes.video.playerSize'));
+  if (playerSize.length === 0) {
+    playerSize = getValidSizes(deepAccess(bid, 'params.video.playerSize'));
+  }
   if (playerSize.length > 0) {
     const context = deepAccess(bid, 'mediaTypes.video.context');
     if (context && context === 'outstream') {
@@ -300,6 +306,15 @@ function getValidSizes(sizes) {
         if ((width >= 300 && height >= 250)) {
           result.push([width, height]);
         }
+      } else if (isNumber(sizes[i])) {
+        const width = sizes[0];
+        const height = sizes[1];
+        if (width == 1 && height == 1) {
+          return [[1, 1]];
+        }
+        if ((width >= 300 && height >= 250)) {
+          return [[width, height]];
+        }
       }
     }
   }

package/modules/riseBidAdapter.js

@@ -287,6 +287,7 @@ function generateBidParameters(bid, bidderRequest) {
     floorPrice: Math.max(getFloor(bid, mediaType), params.floorPrice),
     bidId: getBidIdParameter('bidId', bid),
     bidderRequestId: getBidIdParameter('bidderRequestId', bid),
+    loop: getBidIdParameter('bidderRequestsCount', bid),
     transactionId: getBidIdParameter('transactionId', bid),
   };
 

package/modules/seedtagBidAdapter.js

@@ -147,6 +147,36 @@ function buildBidResponse(seedtagBid) {
   return bid;
 }
 
+/**
+ *
+ * @returns Measure time to first byte implementation
+ * @see https://web.dev/ttfb/
+ *      https://developer.mozilla.org/en-US/docs/Web/API/Navigation_timing_API
+ */
+function ttfb() {
+  const ttfb = (() => {
+    // Timing API V2
+    try {
+      const entry = performance.getEntriesByType('navigation')[0];
+      return Math.round(entry.responseStart - entry.startTime);
+    } catch (e) {
+      // Timing API V1
+      try {
+        const entry = performance.timing;
+        return Math.round(entry.responseStart - entry.fetchStart);
+      } catch (e) {
+        // Timing API not available
+        return 0;
+      }
+    }
+  })();
+
+  // prevent negative or excessive value
+  // @see https://github.com/googleChrome/web-vitals/issues/162
+  //      https://github.com/googleChrome/web-vitals/issues/137
+  return ttfb >= 0 && ttfb <= performance.now() ? ttfb : 0;
+}
+
 export function getTimeoutUrl (data) {
   let queryParams = '';
   if (
@@ -195,7 +225,9 @@ export const spec = {
       timeout: bidderRequest.timeout,
       version: '$prebid.version$',
       connectionType: getConnectionType(),
-      bidRequests: _map(validBidRequests, buildBidRequest)
+      auctionStart: bidderRequest.auctionStart || Date.now(),
+      ttfb: ttfb(),
+      bidRequests: _map(validBidRequests, buildBidRequest),
     };
 
     if (payload.cmp) {

package/modules/sharedIdSystem.js

@@ -5,13 +5,13 @@
  * @requires module:modules/userId
  */
 
-import {buildUrl, generateUUID, hasDeviceAccess, logInfo, parseUrl, triggerPixel} from '../src/utils.js';
+import { parseUrl, buildUrl, triggerPixel, logInfo, hasDeviceAccess, generateUUID } from '../src/utils.js';
 import {submodule} from '../src/hook.js';
-import {coppaDataHandler} from '../src/adapterManager.js';
+import { coppaDataHandler } from '../src/adapterManager.js';
 import {getStorageManager} from '../src/storageManager.js';
 
-const MODULE_TYPE = 'fpid-module';
-export const storage = getStorageManager({moduleName: 'pubCommonId', moduleType: MODULE_TYPE});
+const GVLID = 887;
+export const storage = getStorageManager({gvlid: GVLID, moduleName: 'pubCommonId'});
 const COOKIE = 'cookie';
 const LOCAL_STORAGE = 'html5';
 const OPTOUT_NAME = '_pubcid_optout';
@@ -74,6 +74,11 @@ export const sharedIdSystemSubmodule = {
    */
   name: 'sharedId',
   aliasName: 'pubCommonId',
+  /**
+   * Vendor id of prebid
+   * @type {Number}
+   */
+  gvlid: GVLID,
 
   /**
    * decode the stored id value for passing to bid requests
@@ -88,7 +93,8 @@ export const sharedIdSystemSubmodule = {
       return undefined;
     }
     logInfo(' Decoded value PubCommonId ' + value);
-    return {'pubcid': value};
+    const idObj = {'pubcid': value};
+    return idObj;
   },
   /**
    * performs action to obtain id