JW Demand: Implemented buildRequests.

modules/jwplayerBidAdapter.js

@@ -2,11 +2,33 @@
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 // import { config } from 'src/config';
 import { VIDEO } from '../src/mediaTypes.js';
+import { deepSetValue, isFn } from '../src/utils.js';
 
 const BIDDER_CODE = 'jwplayer';
+const URL = 'https://ib.adnxs.com/openrtb2/prebid';
+
 const GVLID = 1046;
 const SUPPORTED_AD_TYPES = [VIDEO];
 
+// Video Parameters 
+// https://docs.prebid.org/dev-docs/bidder-adaptor.html#step-2-accept-video-parameters-and-pass-them-to-your-server
+const VIDEO_ORTB_PARAMS = [
+ 'mimes',
+ 'minduration',
+ 'maxduration',
+ 'protocols',
+ 'startdelay',
+ 'placement',
+ 'skip',
+ 'skipafter',
+ 'minbitrate',
+ 'maxbitrate',
+ 'delivery',
+ 'playbackmethod',
+ 'api',
+ 'linearity'
+];
+
 export const spec = {
  code: BIDDER_CODE,
  gvlid: GVLID,
@@ -29,10 +51,25 @@ export const spec = {
  /**
  * 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.
+ * @param {BidRequest[]} bidRequests A non-empty list of bid requests, or ad units, which should be sent to the server.
+ * @param bidderRequest
  * @return ServerRequest Info describing the request to the server.
  */
- buildRequests: function(validBidRequests, bidderRequest) {},
+ buildRequests: function(bidRequests, bidderRequest) {
+ if (!bidRequests) {
+ return;
+ }
+
+ return bidRequests.map(bidRequest => {
+ const payload = buildRequest(bidRequest, bidderRequest);
+
+ return {
+ method: 'POST',
+ url: URL,
+ data: payload
+ }
+ });
+ },
 
  /**
  * Unpack the response from the server into a list of bids.
@@ -50,4 +87,129 @@ export const spec = {
  // onBidderError: function({ error, bidderRequest }) {}
 };
 
+function buildRequest(bidRequest, bidderRequest) {
+ // Open RTB Request Object
+ const openrtbRequest = {
+ id: bidRequest.params.bidId,
+ imp: buildRequestImpression(bidRequest, bidderRequest),
+ site: buildRequestSite(bidRequest),
+ device: buildRequestDevice()
+ };
+
+ // Attaching GDPR Consent Params
+ if (bidderRequest.gdprConsent) {
+ deepSetValue(openrtbRequest, 'user.ext.consent', bidderRequest.gdprConsent.consentString);
+ deepSetValue(openrtbRequest, 'regs.ext.gdpr', (bidderRequest.gdprConsent.gdprApplies ? 1 : 0));
+ }
+
+ // CCPA
+ if (bidderRequest.uspConsent) {
+ deepSetValue(openrtbRequest, 'regs.ext.us_privacy', bidderRequest.uspConsent);
+ }
+
+ return JSON.stringify(openrtbRequest);;
+}
+
+function buildRequestImpression(bidRequest) {
+ const impressions = [];
+
+ const impressionObject = {
+ id: bidRequest.adUnitCode,
+ secure: isSecure() ? 1 : 0
+ };
+
+ impressionObject.video = buildImpressionVideo(bidRequest);
+
+ const bidFloorData = buildBidFloorData(bidRequest);
+ impressionObject.bidfloor = bidFloorData.floor;
+ impressionObject.bidfloorcur = bidFloorData.currency;
+
+ impressionObject.ext = buildImpressionExtension(bidRequest);
+
+ impressions.push(impressionObject);
+
+ return impressions;
+}
+
+function buildImpressionVideo(bidRequest) {
+ const videoParams = deepAccess(bidRequest, 'mediaTypes.video', {});
+
+ const video = {};
+
+ // Obtain all ORTB params related video from Ad Unit
+ VIDEO_ORTB_PARAMS.forEach((param) => {
+ if (videoParams.hasOwnProperty(param)) {
+ video[param] = videoParams[param];
+ }
+ });
+
+ return video;
+}
+
+function buildImpressionExtension(bidRequest) {
+ return {
+ appnexus: {
+ placement_id: bidRequest.params.placementId
+ }
+ };
+}
+
+function buildBidFloorData(bidRequest) {
+ const {params} = bidRequest;
+ // Bid Floor
+ const bidFloorRequest = {
+ currency: params.currency || 'USD',
+ mediaType: 'video',
+ size: '*'
+ };
+
+ let floorData;
+ if (isFn(bidRequest.getFloor)) {
+ floorData = bidRequest.getFloor(bidFloorRequest);
+ } else if (params.bidfloor) {
+ floorData = {floor: params.bidfloor, currency: params.currency || 'USD'};
+ }
+
+ return floorData;
+}
+
+function buildRequestSite(bidRequest) {
+ const site = {
+ domain: window.location.hostname,
+ page: window.location.href,
+ ref: bidRequest.refererInfo ? bidRequest.refererInfo.referer || null : null
+ };
+
+ const videoParams = deepAccess(bidRequest, 'mediaTypes.video', {});
+
+ // Site Content
+ if (videoParams.content && isPlainObject(videoParams.content)) {
+ openrtbRequest.site.content = {};
+ const contentStringKeys = ['id', 'title', 'series', 'season', 'genre', 'contentrating', 'language', 'url'];
+ const contentNumberkeys = ['episode', 'prodq', 'context', 'livestream', 'len'];
+ const contentArrayKeys = ['cat'];
+ const contentObjectKeys = ['ext'];
+ for (const contentKey in videoBidderParams.content) {
+ if (
+ (contentStringKeys.indexOf(contentKey) > -1 && isStr(videoParams.content[contentKey])) ||
+ (contentNumberkeys.indexOf(contentKey) > -1 && isNumber(videoParams.content[contentKey])) ||
+ (contentObjectKeys.indexOf(contentKey) > -1 && isPlainObject(videoParams.content[contentKey])) ||
+ (contentArrayKeys.indexOf(contentKey) > -1 && isArray(videoParams.content[contentKey]) &&
+ videoParams.content[contentKey].every(catStr => isStr(catStr)))) {
+ site.content[contentKey] = videoParams.content[contentKey];
+ } else {
+ logMessage('JWPlayer bid adapter validation error: ', contentKey, ' is either not supported is OpenRTB V2.5 or value is undefined');
+ }
+ }
+ }
+ return site;
+}
+
+function buildRequestDevice() {
+ return {
+ ua: navigator.userAgent,
+ ip: ''
+ };
+}
+
 registerBidder(spec);