prebid.js 6.1.0 → 6.5.0

package/modules/targetVideoBidAdapter.js

@@ -0,0 +1,187 @@
+import find from 'core-js-pure/features/array/find.js';
+import { getBidRequest } from '../src/utils.js';
+import { BANNER, VIDEO } from '../src/mediaTypes.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+
+const SOURCE = 'pbjs';
+const BIDDER_CODE = 'targetVideo';
+const ENDPOINT_URL = 'https://ib.adnxs.com/ut/v3/prebid';
+const MARGIN = 1.35;
+
+export const spec = {
+
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER],
+
+  /**
+   * Determines whether or not the given bid request is valid.
+   *
+   * @param {object} bid The bid to validate.
+   * @return boolean True if this is a valid bid, and false otherwise.
+   */
+  isBidRequestValid: function(bid) {
+    return !!(bid && bid.params && bid.params.placementId);
+  },
+
+  /**
+   * Make a server request from the list of BidRequests.
+   *
+   * @param {BidRequest[]} bidRequests A non-empty list of bid requests which should be sent to the Server.
+   * @return ServerRequest Info describing the request to the server.
+   */
+  buildRequests: function(bidRequests, bidderRequest) {
+    const tags = bidRequests.map(createVideoTag);
+    const schain = bidRequests[0].schain;
+    const payload = {
+      tags: tags,
+      sdk: {
+        source: SOURCE,
+        version: '$prebid.version$'
+      },
+      schain: schain
+    };
+    return formatRequest(payload, bidderRequest);
+  },
+
+  /**
+   * Unpack the response from the server into a list of bids.
+   *
+   * @param {*} serverResponse A successful response from the server.
+   * @return {Bid[]} An array of bids which were nested inside the server.
+   */
+  interpretResponse: function(serverResponse, { bidderRequest }) {
+    serverResponse = serverResponse.body;
+    const bids = [];
+
+    if (serverResponse.tags) {
+      serverResponse.tags.forEach(serverBid => {
+        const rtbBid = getRtbBid(serverBid);
+        if (rtbBid && rtbBid.cpm !== 0 && rtbBid.ad_type == VIDEO) {
+          bids.push(newBid(serverBid, rtbBid, bidderRequest));
+        }
+      });
+    }
+
+    return bids;
+  }
+
+}
+
+function getSizes(request) {
+  let sizes = request.sizes;
+  if (!sizes && request.mediaTypes && request.mediaTypes.banner && request.mediaTypes.banner.sizes) {
+    sizes = request.mediaTypes.banner.sizes;
+  }
+  if (Array.isArray(sizes) && !Array.isArray(sizes[0])) {
+    sizes = [sizes[0], sizes[1]];
+  }
+  if (!Array.isArray(sizes) || !Array.isArray(sizes[0])) {
+    sizes = [[0, 0]];
+  }
+
+  return sizes;
+}
+
+function formatRequest(payload, bidderRequest) {
+  const options = {
+    withCredentials: true
+  };
+  const request = {
+    method: 'POST',
+    url: ENDPOINT_URL,
+    data: JSON.stringify(payload),
+    bidderRequest,
+    options
+  };
+
+  return request;
+}
+
+/**
+ * Create video auction.
+ *
+ * @param {*} serverResponse A successful response from the server.
+ * @return {Bid[]} An array of bids which were nested inside the server.
+ */
+function createVideoTag(bid) {
+  const tag = {};
+  tag.id = parseInt(bid.params.placementId, 10);
+  tag.gpid = 'targetVideo';
+  tag.sizes = getSizes(bid);
+  tag.primary_size = tag.sizes[0];
+  tag.ad_types = [VIDEO];
+  tag.uuid = bid.bidId;
+  tag.allow_smaller_sizes = false;
+  tag.use_pmt_rule = false
+  tag.prebid = true;
+  tag.disable_psa = true;
+  tag.hb_source = 1;
+  tag.require_asset_url = true;
+  tag.video = {
+    playback_method: 2,
+    skippable: true
+  };
+
+  return tag;
+}
+
+/**
+ * Unpack the Server's Bid into a Prebid-compatible one.
+ * @param serverBid
+ * @param rtbBid
+ * @param bidderRequest
+ * @return Bid
+ */
+function newBid(serverBid, rtbBid, bidderRequest) {
+  const bidRequest = getBidRequest(serverBid.uuid, [bidderRequest]);
+  const sizes = getSizes(bidRequest);
+  const bid = {
+    requestId: serverBid.uuid,
+    cpm: rtbBid.cpm * MARGIN,
+    creativeId: rtbBid.creative_id,
+    dealId: rtbBid.deal_id,
+    currency: 'USD',
+    netRevenue: true,
+    width: sizes[0][0],
+    height: sizes[0][1],
+    ttl: 300,
+    adUnitCode: bidRequest.adUnitCode,
+    appnexus: {
+      buyerMemberId: rtbBid.buyer_member_id,
+      dealPriority: rtbBid.deal_priority,
+      dealCode: rtbBid.deal_code
+    }
+  };
+
+  if (rtbBid.rtb.video) {
+    Object.assign(bid, {
+      vastImpUrl: rtbBid.notify_url,
+      ad: getBannerHtml(rtbBid.notify_url + '&redir=' + encodeURIComponent(rtbBid.rtb.video.asset_url)),
+      ttl: 3600
+    });
+  }
+
+  return bid;
+}
+
+function getRtbBid(tag) {
+  return tag && tag.ads && tag.ads.length && find(tag.ads, ad => ad.rtb);
+}
+
+function getBannerHtml(vastUrl) {
+  return `<!DOCTYPE html>
+    <html lang="en">
+    <head>
+      <meta charset="UTF-8">
+      <title></title>
+      <style>html, body {width: 100%; height: 100%; margin: 0;}</style>
+    </head>
+    <body>
+      <div id="targetVideoPlayer"></div>
+      <script src="https://player.target-video.com/custom/targetvideo-banner.js"></script>
+      <script>initPlayer("${vastUrl}");</script>
+    </body>
+  </html>`;
+}
+
+registerBidder(spec);

package/modules/targetVideoBidAdapter.md

@@ -0,0 +1,34 @@
+# Overview
+
+```
+Module Name:  Target Video Bid Adapter
+Module Type:  Bidder Adapter
+Maintainer:   grajzer@gmail.com
+```
+
+# Description
+
+Connects to Appnexus exchange for bids.
+
+TargetVideo bid adapter supports Banner.
+
+# Test Parameters
+```
+var adUnits = [
+  // Banner adUnit
+  {
+      code: 'banner-div',
+      mediaTypes: {
+          banner: {
+              sizes: [[640, 480], [300, 250]],
+          }
+      },
+      bids: [{
+          bidder: 'targetVideo',
+          params: {
+              placementId: 13232361
+          }
+      }]
+  }
+];
+```

package/modules/telariaBidAdapter.js

@@ -2,7 +2,7 @@ import { logError, isEmpty, deepAccess, triggerPixel, logWarn, isArray } from '.
 import {createBid as createBidFactory} from '../src/bidfactory.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {VIDEO} from '../src/mediaTypes.js';
-import {STATUS} from '../src/constants.json';
+import CONSTANTS from '../src/constants.json';
 
 const BIDDER_CODE = 'telaria';
 const DOMAIN = 'tremorhub.com';
@@ -86,7 +86,7 @@ export const spec = {
       logError(errorMessage);
     } else if (!isEmpty(bidResult.seatbid)) {
       bidResult.seatbid[0].bid.forEach(tag => {
-        bids.push(createBid(STATUS.GOOD, bidderRequest, tag, width, height, BIDDER_CODE));
+        bids.push(createBid(CONSTANTS.STATUS.GOOD, bidderRequest, tag, width, height, BIDDER_CODE));
       });
     }
 

package/modules/trustxBidAdapter.js

@@ -6,9 +6,8 @@ import { config } from '../src/config.js';
 
 const BIDDER_CODE = 'trustx';
 const ENDPOINT_URL = 'https://grid.bidswitch.net/hbjson?sp=trustx';
-const ADDITIONAL_SYNC_URL = 'https://x.bidswitch.net/sync?ssp=themediagrid';
 const TIME_TO_LIVE = 360;
-const ADAPTER_SYNC_URL = 'https://sofia.trustx.org/push_sync';
+const ADAPTER_SYNC_URL = 'https://x.bidswitch.net/sync?ssp=themediagrid';
 const RENDERER_URL = 'https://acdn.adnxs.com/video/outstream/ANOutstreamVideo.js';
 
 const LOG_ERROR_MESS = {
@@ -281,12 +280,12 @@ export const spec = {
   },
   getUserSyncs: function(syncOptions, responses, gdprConsent, uspConsent) {
     if (syncOptions.pixelEnabled) {
-      const syncsPerBidder = config.getConfig('userSync.syncsPerBidder');
       let params = [];
-      if (gdprConsent && typeof gdprConsent.consentString === 'string') {
+      if (gdprConsent) {
         if (typeof gdprConsent.gdprApplies === 'boolean') {
-          params.push(`gdpr=${Number(gdprConsent.gdprApplies)}&gdpr_consent=${gdprConsent.consentString}`);
-        } else {
+          params.push(`gdpr=${Number(gdprConsent.gdprApplies)}`);
+        }
+        if (typeof gdprConsent.consentString === 'string') {
           params.push(`gdpr_consent=${gdprConsent.consentString}`);
         }
       }
@@ -294,17 +293,10 @@ export const spec = {
         params.push(`us_privacy=${uspConsent}`);
       }
       const stringParams = params.join('&');
-      const syncs = [{
+      return {
         type: 'image',
-        url: ADAPTER_SYNC_URL + (stringParams ? `?${stringParams}` : '')
-      }];
-      if (syncsPerBidder > 1) {
-        syncs.push({
-          type: 'image',
-          url: ADDITIONAL_SYNC_URL + (stringParams ? `&${stringParams}` : '')
-        });
-      }
-      return syncs;
+        url: ADAPTER_SYNC_URL + stringParams
+      };
     }
   }
 }

package/modules/undertoneBidAdapter.js

@@ -98,9 +98,16 @@ export const spec = {
       'commons': commons
     };
     const referer = bidderRequest.refererInfo.referer;
+    const canonicalUrl = getCanonicalUrl();
+    if (referer) {
+      commons.referrer = referer;
+    }
+    if (canonicalUrl) {
+      commons.canonicalUrl = canonicalUrl;
+    }
     const hostname = parseUrl(referer).hostname;
     let domain = extractDomainFromHost(hostname);
-    const pageUrl = getCanonicalUrl() || referer;
+    const pageUrl = canonicalUrl || referer;
 
     const pubid = validBidRequests[0].params.publisherId;
     let reqUrl = `${URL}?pid=${pubid}&domain=${domain}`;

package/modules/userId/index.js

@@ -141,7 +141,7 @@ import { createEidsArray, buildEidPermissions } from './eids.js';
 import { getCoreStorageManager } from '../../src/storageManager.js';
 import {
   getPrebidInternal, isPlainObject, logError, isArray, cyrb53Hash, deepAccess, timestamp, delayExecution, logInfo, isFn,
-  logWarn, isEmptyStr, isNumber
+  logWarn, isEmptyStr, isNumber, isGptPubadsDefined
 } from '../../src/utils.js';
 import includes from 'core-js-pure/features/array/includes.js';
 
@@ -184,6 +184,9 @@ export let syncDelay;
 /** @type {(number|undefined)} */
 export let auctionDelay;
 
+/** @type {(string|undefined)} */
+let ppidSource;
+
 /** @param {Submodule[]} submodules */
 export function setSubmoduleRegistry(submodules) {
   submoduleRegistry = submodules;
@@ -557,6 +560,26 @@ export function requestBidsHook(fn, reqBidsConfigObj) {
   initializeSubmodulesAndExecuteCallbacks(function () {
     // pass available user id data to bid adapters
     addIdDataToAdUnitBids(reqBidsConfigObj.adUnits || getGlobal().adUnits, initializedSubmodules);
+
+    // userSync.ppid should be one of the 'source' values in getUserIdsAsEids() eg pubcid.org or id5-sync.com
+    const matchingUserId = ppidSource && (getUserIdsAsEids() || []).find(userID => userID.source === ppidSource);
+    if (matchingUserId && typeof deepAccess(matchingUserId, 'uids.0.id') === 'string') {
+      const ppidValue = matchingUserId.uids[0].id.replace(/[\W_]/g, '');
+      if (ppidValue.length >= 32 && ppidValue.length <= 150) {
+        if (isGptPubadsDefined()) {
+          window.googletag.pubads().setPublisherProvidedId(ppidValue);
+        } else {
+          window.googletag = window.googletag || {};
+          window.googletag.cmd = window.googletag.cmd || [];
+          window.googletag.cmd.push(function() {
+            window.googletag.pubads().setPublisherProvidedId(ppidValue);
+          });
+        }
+      } else {
+        logWarn(`User ID - Googletag Publisher Provided ID for ${ppidSource} is not between 32 and 150 characters - ${ppidValue}`);
+      }
+    }
+
     // calling fn allows prebid to continue processing
     fn.call(this, reqBidsConfigObj);
   });
@@ -817,6 +840,7 @@ export function attachIdSystem(submodule) {
  * @param {{getConfig:function}} config
  */
 export function init(config) {
+  ppidSource = undefined;
   submodules = [];
   configRegistry = [];
   addedUserIdHook = false;
@@ -839,9 +863,10 @@ export function init(config) {
   }
 
   // listen for config userSyncs to be set
-  config.getConfig(conf => {
+  config.getConfig('userSync', conf => {
     // Note: support for 'usersync' was dropped as part of Prebid.js 4.0
     const userSync = conf.userSync;
+    ppidSource = userSync.ppid;
     if (userSync && userSync.userIds) {
       configRegistry = userSync.userIds;
       syncDelay = isNumber(userSync.syncDelay) ? userSync.syncDelay : DEFAULT_SYNC_DELAY;

package/modules/ventes.md

@@ -0,0 +1,71 @@
+---
+layout: bidder
+title: ventes
+description: Prebid ventes Bidder Adapter
+pbjs: false
+biddercode: ventes
+gdpr_supported: false
+usp_supported: false
+media_types: banner
+coppa_supported: false
+schain_supported: false
+dchain_supported: false
+prebid_member: false
+---
+
+### BidParams
+{: .table .table-bordered .table-striped }
+| Name            | Scope    | Description                                		 | Example                      		| Type          |
+|-----------------|----------|-----------------------------------------------------------|----------------------------------------------|---------------|
+| `placementId`   | required | Placement ID from Ventes Avenues 			 | `'VA-062-0013-0183'` 			| `string`	|
+| `publisherId`   | required | Publisher ID from Ventes Avenues 			 | `'VA-062'` 					| `string`	|
+| `user`          | optional | Object that specifies information about an external user. | `user: { age: 25, gender: 0, dnt: true}` 	| `object`	|
+| `app`           | optional | Object containing mobile app parameters.  		 | `app : { id: 'app-id'}`			| `object`	|
+
+#### User Object
+
+{: .table .table-bordered .table-striped }
+| Name              | Description 										| Example		| Type             	|
+|-------------------|-------------------------------------------------------------------------------------------|-----------------------|-----------------------|
+| `age`             | The age of the user.									| `35`			| `integer`		|
+| `externalUid`     | Specifies a string that corresponds to an external user ID for this user. 		| `'1234567890abcdefg'`	| `string` 		|
+| `segments`        | Specifies the segments to which the user belongs.						| `[1, 2]` 		| `Array<integer>`	|
+| `gender`          | Specifies the gender of the user.  Allowed values: Unknown: `0`; Male: `1`; Female: `2`	| `1` 			| `integer`		|
+| `dnt`             | Do not track flag.  Indicates if tracking cookies should be disabled for this auction	| `true`  	 	| `boolean`		|
+| `language`        | Two-letter ANSI code for this user's language.						| `EN`			| `string`		|
+
+
+### Ad Unit Setup for Banner
+```javascript
+var adUnits = [
+{
+  code: 'test-hb-ad-11111-1',
+  mediaTypes: {
+    banner: {  
+      sizes: [
+          [300, 250]
+      ]
+    }   
+  }, 
+  bids: [{
+    bidder: 'ventes',
+    params: {
+        placementId: 'VA-062-0013-0183',
+        publisherId: '5cebea3c9eea646c7b623d5e',
+        IABCategories: "['IAB1', 'IAB5']",
+        device:{
+          ip: '123.145.167.189',
+          ifa:"AEBE52E7-03EE-455A-B3C4-E57283966239",
+        },
+        app: {
+          id: "agltb3B1Yi1pbmNyDAsSA0FwcBiJkfIUDA",
+          name: "Yahoo Weather",
+          bundle: 'com.kiloo.subwaysurf',
+          storeurl: 'https://play.google.com/store/apps/details?id=com.kiloo.subwaysurf&hl=en',
+          domain: 'somoaudience.com',
+        } 
+    }
+  }]
+ }
+]
+```