add sublimeBundleBidAdapter duplicated from sublimeBidAdapter

modules/sublimeBidAdapter.js

@@ -3,7 +3,6 @@ import { config } from '../src/config.js';
 import * as utils from '../src/utils.js';
 
 const BIDDER_CODE = 'sublime';
-const BIDDER_GVLID = 114;
 const DEFAULT_BID_HOST = 'pbjs.sskzlabs.com';
 const DEFAULT_CALLBACK_NAME = 'sublime_prebid_callback';
 const DEFAULT_CURRENCY = 'EUR';
@@ -270,13 +269,14 @@ function onTimeout(timeoutData) {
 }
 
 export const spec = {
- code: BIDDER_CODE,
  aliases: [],
- isBidRequestValid: isBidRequestValid,
  buildRequests: buildRequests,
+ code: BIDDER_CODE,
  interpretResponse: interpretResponse,
+ isBidRequestValid: isBidRequestValid,
  onBidWon: onBidWon,
  onTimeout: onTimeout,
+ sendEvent: sendEvent,
 };
 
 registerBidder(spec);

modules/sublimeBundleBidAdapter.js

@@ -0,0 +1,282 @@
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { config } from '../src/config.js';
+import * as utils from '../src/utils.js';
+
+const BIDDER_CODE = 'sublime';
+const DEFAULT_BID_HOST = 'pbjs.sskzlabs.com';
+const DEFAULT_CALLBACK_NAME = 'sublime_prebid_callback';
+const DEFAULT_CURRENCY = 'EUR';
+const DEFAULT_PROTOCOL = 'https';
+const DEFAULT_SAC_HOST = 'sac.ayads.co'
+const DEFAULT_TTL = 600;
+const SUBLIME_ANTENNA = 'antenna.ayads.co';
+const SUBLIME_VERSION = '0.5.2-bundle';
+
+/**
+ * Debug log message
+ * @param {String} msg
+ * @param {Object} obj
+ */
+function log(msg, obj) {
+ utils.logInfo('SublimeBidAdapter - ' + msg, obj);
+}
+
+// Default state
+const state = {
+ zoneId: '',
+ transactionId: ''
+};
+
+/**
+ * Set a new state
+ * @param {Object} value
+ */
+function setState(value) {
+ Object.assign(state, value);
+ log('State has been updated :', state);
+}
+
+/**
+ * Send pixel to our debug endpoint
+ * @param {string} eventName - Event name that will be send in the e= query string
+ * @param {Boolean} isMandatoryPixel - If set to true, will always send the pixel
+ */
+function sendEvent(eventName, isMandatoryPixel = false) {
+ let shoudSendPixel = (isMandatoryPixel || state.debug);
+ let ts = Date.now();
+ let eventObject = {
+ t: ts,
+ tse: ts,
+ z: state.zoneId,
+ e: eventName,
+ src: 'pa',
+ puid: state.transactionId,
+ trId: state.transactionId,
+ ver: SUBLIME_VERSION,
+ };
+
+ if (shoudSendPixel) {
+ log('Sending pixel for event: ' + eventName, eventObject);
+
+ let queryString = utils.formatQS(eventObject);
+ utils.triggerPixel('https://' + SUBLIME_ANTENNA + '/?' + queryString);
+ } else {
+ log('Not sending pixel for event (use debug: true to send it): ' + eventName, eventObject);
+ }
+}
+
+/**
+ * Determines whether or not the given bid request is valid.
+ *
+ * @param {BidRequest} bid The bid params to validate.
+ * @return {Boolean} True if this is a valid bid, and false otherwise.
+ */
+function isBidRequestValid(bid) {
+ return !!Number(bid.params.zoneId);
+}
+
+/**
+ * Make a server request from the list of BidRequests.
+ *
+ * @param {BidRequest[]} validBidRequests - An array of bids
+ * @param {Object} bidderRequest - Info describing the request to the server.
+ * @return {ServerRequest|ServerRequest[]} - Info describing the request to the server.
+ */
+function buildRequests(validBidRequests, bidderRequest) {
+ window.sublime = window.sublime || {};
+
+ let commonPayload = {
+ pbav: SUBLIME_VERSION,
+ // Current Prebid params
+ prebidVersion: '$prebid.version$',
+ currencyCode: config.getConfig('currency.adServerCurrency') || DEFAULT_CURRENCY,
+ timeout: (typeof bidderRequest === 'object' && !!bidderRequest) ? bidderRequest.timeout : config.getConfig('bidderTimeout'),
+ };
+
+ // RefererInfo
+ if (bidderRequest && bidderRequest.refererInfo) {
+ commonPayload.referer = bidderRequest.refererInfo.referer;
+ commonPayload.numIframes = bidderRequest.refererInfo.numIframes;
+ }
+ // GDPR handling
+ if (bidderRequest && bidderRequest.gdprConsent) {
+ commonPayload.gdprConsent = bidderRequest.gdprConsent.consentString;
+ commonPayload.gdpr = bidderRequest.gdprConsent.gdprApplies; // we're handling the undefined case server side
+
+ // Injecting gdpr consent into sublime tag
+ window.sublime.gdpr = window.sublime.gdpr || {};
+ window.sublime.gdpr.injected = {
+ consentString: bidderRequest.gdprConsent.consentString,
+ gdprApplies: bidderRequest.gdprConsent.gdprApplies
+ };
+ }
+
+ return validBidRequests.filter((bid, index) => {
+ // Any bidRequest after the first is skipped
+ if (index) {
+ let leftoverZonesIds = validBidRequests.slice(1).map(bid => { return bid.params.zoneId }).join(',');
+ utils.logWarn(`SublimeBidAdapter - ZoneIds ${leftoverZonesIds} are ignored. Only one ZoneId per page can be instanciated.`);
+ return false;
+ }
+
+ return bid;
+ }).map(bid => {
+ let bidHost = bid.params.bidHost || DEFAULT_BID_HOST;
+ let callbackName = (bid.params.callbackName || DEFAULT_CALLBACK_NAME) + '_' + bid.params.zoneId;
+ let protocol = bid.params.protocol || DEFAULT_PROTOCOL;
+ let sacHost = bid.params.sacHost || DEFAULT_SAC_HOST;
+
+ setState({
+ transactionId: bid.transactionId,
+ zoneId: bid.params.zoneId,
+ debug: bid.params.debug || false,
+ });
+
+ // Adding Sublime tag
+ let script = document.createElement('script');
+ script.type = 'application/javascript';
+ script.src = 'https://' + sacHost + '/sublime/' + bid.params.zoneId + '/prebid?callback=' + callbackName;
+ document.body.appendChild(script);
+
+ // Register a callback to send notify
+ window[callbackName] = (response) => {
+ let xhr = new XMLHttpRequest();
+ let hasAd = response.ad ? '1' : '0';
+ let url = protocol + '://' + bidHost + '/notify';
+
+ let params = {
+ a: hasAd,
+ ad: response.ad || '',
+ cpm: response.cpm || 0,
+ currency: response.currency || DEFAULT_CURRENCY,
+ notify: 1,
+ requestId: bid.bidId ? encodeURIComponent(bid.bidId) : null,
+ transactionId: bid.transactionId,
+ zoneId: bid.params.zoneId
+ };
+
+ let queryString = Object.keys(params).map(key => {
+ return key + '=' + encodeURIComponent(params[key])
+ }).join('&');
+
+ xhr.open('POST', url, true);
+ xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
+ xhr.send(queryString);
+ return xhr;
+ };
+
+ let bidPayload = {
+ adUnitCode: bid.adUnitCode,
+ auctionId: bid.auctionId,
+ bidder: bid.bidder,
+ bidderRequestId: bid.bidderRequestId,
+ bidRequestsCount: bid.bidRequestsCount,
+ requestId: bid.bidId,
+ sizes: bid.sizes.map(size => ({
+ w: size[0],
+ h: size[1],
+ })),
+ transactionId: bid.transactionId,
+ zoneId: bid.params.zoneId,
+ };
+
+ let payload = Object.assign({}, commonPayload, bidPayload);
+
+ return {
+ method: 'POST',
+ url: protocol + '://' + bidHost + '/bid',
+ data: payload,
+ options: {
+ contentType: 'application/json',
+ withCredentials: true
+ },
+ }
+ });
+}
+
+/**
+ * Unpack the response from the server into a list of bids.
+ *
+ * @param {*} serverResponse A successful response from the server.
+ * @param {*} bidRequest An object with bid request informations
+ * @return {Bid[]} An array of bids which were nested inside the server.
+ */
+function interpretResponse(serverResponse, bidRequest) {
+ const bidResponses = [];
+ const response = serverResponse.body;
+
+ sendEvent('dintres');
+
+ if (response) {
+ if (response.timeout || !response.ad || /<!--\s+No\s+ad\s+-->/gmi.test(response.ad)) {
+ return bidResponses;
+ }
+
+ // Setting our returned sizes object to default values
+ let returnedSizes = {
+ width: 1800,
+ height: 1000
+ };
+
+ // Verifying Banner sizes
+ if (bidRequest && bidRequest.data && bidRequest.data.w === 1 && bidRequest.data.h === 1) {
+ // If banner sizes are 1x1 we set our default size object to 1x1
+ returnedSizes = {
+ width: 1,
+ height: 1
+ };
+ }
+
+ const bidResponse = {
+ requestId: response.requestId || '',
+ cpm: response.cpm || 0,
+ width: response.width || returnedSizes.width,
+ height: response.height || returnedSizes.height,
+ creativeId: response.creativeId || 1,
+ dealId: response.dealId || 1,
+ currency: response.currency || DEFAULT_CURRENCY,
+ netRevenue: response.netRevenue || true,
+ ttl: response.ttl || DEFAULT_TTL,
+ ad: response.ad,
+ pbav: SUBLIME_VERSION
+ };
+
+ sendEvent('bida', true);
+ bidResponses.push(bidResponse);
+ } else {
+ sendEvent('dnobid');
+ }
+
+ return bidResponses;
+}
+
+/**
+ * Send pixel when bidWon event is triggered
+ * @param {Object} timeoutData
+ */
+function onBidWon(bid) {
+ log('Bid won', bid);
+ sendEvent('bidwon', true);
+}
+
+/**
+ * Send debug when we timeout
+ * @param {Object} timeoutData
+ */
+function onTimeout(timeoutData) {
+ log('Timeout from adapter', timeoutData);
+ sendEvent('dbidtimeout', true);
+}
+
+export const spec = {
+ aliases: [],
+ buildRequests: buildRequests,
+ code: BIDDER_CODE,
+ interpretResponse: interpretResponse,
+ isBidRequestValid: isBidRequestValid,
+ onBidWon: onBidWon,
+ onTimeout: onTimeout,
+ sendEvent: sendEvent,
+};
+
+registerBidder(spec);

modules/sublimeBundleBidAdapter.md

@@ -0,0 +1,62 @@
+# Overview
+
+```
+Module Name: Sublime Bundle Bid Adapter
+Module Type: Bidder Adapter
+Maintainer: pbjs@sublimeskinz.com
+```
+
+# Description
+
+Connects to Sublime for bids.
+Sublime bid adapter supports Skinz.
+
+# Nota Bene
+
+Our prebid adapter is unusable with SafeFrame.
+
+# Build
+
+You can build your version of prebid.js, execute:
+
+```shell
+gulp build --modules=sublimeBundleBidAdapter
+```
+
+Or to build with multiple adapters
+
+```shell
+gulp build --modules=sublimeBundleBidAdapter,secondAdapter,thirdAdapter
+```
+
+More details in the root [README](../README.md#Build)
+
+## To build from you own repository
+
+- copy `/modules/sublimeBundleBidAdapter.js` to your `/modules/` directory
+- copy `/modules/sublimeBundleBidAdapter.md` to your `/modules/` directory
+- copy `/test/spec/modules/sublimeBundleBidAdapter_spec.js` to your `/test/spec/modules/` directory
+
+Then build
+
+
+# Invocation Parameters
+
+```js
+var adUnits = [{
+ code: 'sublime',
+ mediaTypes: {
+ banner: {
+ sizes: [1800, 1000]
+ }
+ },
+ bids: [{
+ bidder: 'sublime',
+ params: {
+ zoneId: <zoneId>
+ }
+ }]
+}];
+```
+
+Where you replace `<zoneId>` by your Sublime Zone id