UNIQUEST Bid Adapter: initial release

modules/uniquestAnalyticsAdapter.js

@@ -0,0 +1,108 @@
+import {logError} from '../src/utils.js';
+import {ajax} from '../src/ajax.js';
+import adapterManager from '../src/adapterManager.js';
+import {EVENTS} from '../src/constants.js';
+import {getRefererInfo} from '../src/refererDetection.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
+
+const ADAPTER_CODE = 'uniquest';
+const BASE_URL = 'https://rcvp.ust-ad.com/';
+const AUCTION_END_URI = 'pbaae';
+const AD_RENDERED_URI = 'pbaars';
+
+let sid;
+
+function sendEvent(event, uri) {
+  ajax(
+    BASE_URL + uri,
+    null,
+    JSON.stringify(event)
+  );
+}
+
+function adRenderSucceededHandler(eventType, args, pageUrl) {
+  const event = {
+    event_type: eventType,
+    url: pageUrl,
+    slot_id: sid,
+    bid: {
+      auction_id: args.bid?.auctionId,
+      creative_id: args.bid?.creativeId,
+      bidder: args.bid?.bidderCode,
+      media_type: args.bid?.mediaType,
+      size: args.bid?.size,
+      cpm: String(args.bid?.cpm),
+      currency: args.bid?.currency,
+      original_cpm: String(args.bid?.originalCpm),
+      original_currency: args.bid?.originalCurrency,
+      hb_pb: String(args.bid?.adserverTargeting.hb_pb),
+      bidding_time: args.bid?.timeToRespond,
+      ad_unit_code: args.bid?.adUnitCode
+    }
+  };
+  sendEvent(event, AD_RENDERED_URI);
+}
+
+function auctionEndHandler(eventType, args, pageUrl) {
+  if (args.bidsReceived.length > 0) {
+    const event = {
+      event_type: eventType,
+      url: pageUrl,
+      slot_id: sid,
+      bids: args.bidsReceived?.map(br => ({
+        auction_id: br?.auctionId,
+        creative_id: br?.creativeId,
+        bidder: br?.bidder,
+        media_type: br?.mediaType,
+        size: br?.size,
+        cpm: String(br?.cpm),
+        currency: br?.currency,
+        original_cpm: String(br?.originalCpm),
+        original_currency: br?.originalCurrency,
+        hb_pb: String(br?.adserverTargeting.hb_pb),
+        bidding_time: br?.timeToRespond,
+        ad_unit_code: br?.adUnitCode
+      }))
+    };
+    sendEvent(event, AUCTION_END_URI);
+  }
+}
+
+let baseAdapter = adapter({analyticsType: 'endpoint'});
+let uniquestAdapter = Object.assign({}, baseAdapter, {
+
+  enableAnalytics(config = {}) {
+    if (config.options && config.options.sid) {
+      sid = config.options.sid;
+      baseAdapter.enableAnalytics.call(this, config);
+    } else {
+      logError('Config not found. Analytics is disabled due.');
+    }
+  },
+
+  disableAnalytics() {
+    sid = undefined;
+    baseAdapter.disableAnalytics.apply(this, arguments);
+  },
+
+  track({eventType, args}) {
+    const refererInfo = getRefererInfo();
+    let pageUrl = refererInfo.page;
+
+    switch (eventType) {
+      case EVENTS.AD_RENDER_SUCCEEDED:
+        adRenderSucceededHandler(eventType, args, pageUrl);
+        break;
+      case EVENTS.AUCTION_END:
+        auctionEndHandler(eventType, args, pageUrl);
+        break;
+    }
+  }
+});
+
+adapterManager.registerAnalyticsAdapter({
+  adapter: uniquestAdapter,
+  code: ADAPTER_CODE
+});
+
+export default uniquestAdapter;

modules/uniquestAnalyticsAdapter.md

@@ -0,0 +1,22 @@
+# Overview
+
+```
+Module Name: UNIQUEST Analytics Adapter
+Module Type: Analytics Adapter
+Maintainer:  prebid_info@muneee.co.jp
+```
+
+# Description
+
+Analytics exchange for UNIQUEST
+
+# Test Parameters
+
+```
+{
+  provider: 'uniquest',
+  options: {
+    sid: 'ONhFoaQn',
+  }
+}
+```

modules/uniquestBidAdapter.js

@@ -0,0 +1,97 @@
+import {getBidIdParameter} from '../src/utils.js';
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import {BANNER} from '../src/mediaTypes.js';
+import {tryAppendQueryString} from '../libraries/urlUtils/urlUtils.js';
+
+/**
+ * @typedef {import('../src/adapters/bidderFactory').Bid} Bid
+ * @typedef {import('../src/adapters/bidderFactory').BidRequest} BidRequest
+ * @typedef {import('../src/auction').BidderRequest} BidderRequest
+ */
+
+const BIDDER_CODE = 'uniquest';
+const ENDPOINT = 'https://adpb.ust-ad.com/hb/prebid';
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER],
+
+  /**
+   * 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.
+   */
+  isBidRequestValid: function (bid) {
+    return !!(bid.params && bid.params.sid);
+  },
+
+  /**
+   * Make a server request from the list of BidRequests.
+   *
+   * @param {validBidRequests} validBidRequests an array of bids
+   * @param {BidderRequest} bidderRequest
+   * @return ServerRequest Info describing the request to the server.
+   */
+  buildRequests: function (validBidRequests, bidderRequest) {
+    const bidRequests = [];
+
+    for (let i = 0; i < validBidRequests.length; i++) {
+      let queryString = '';
+      const request = validBidRequests[i];
+
+      const bid = request.bidId;
+      const sid = getBidIdParameter('sid', request.params);
+      const widths = request.sizes.map(size => size[0]).join(',');
+      const heights = request.sizes.map(size => size[1]).join(',');
+      const timeout = bidderRequest.timeout
+
+      queryString = tryAppendQueryString(queryString, 'bid', bid);
+      queryString = tryAppendQueryString(queryString, 'sid', sid);
+      queryString = tryAppendQueryString(queryString, 'widths', widths);
+      queryString = tryAppendQueryString(queryString, 'heights', heights);
+      queryString = tryAppendQueryString(queryString, 'timeout', timeout);
+
+      bidRequests.push({
+        method: 'GET',
+        url: ENDPOINT,
+        data: queryString,
+      });
+    }
+    return bidRequests;
+  },
+
+  /**
+   * 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, requests) {
+    const response = serverResponse.body;
+
+    if (!response || Object.keys(response).length === 0) {
+      return []
+    }
+
+    const bid = {
+      requestId: response.request_id,
+      cpm: response.cpm,
+      currency: response.currency,
+      width: response.width,
+      height: response.height,
+      ad: response.ad,
+      creativeId: response.bid_id,
+      netRevenue: response.net_revenue,
+      mediaType: response.media_type,
+      ttl: response.ttl,
+      meta: {
+        advertiserDomains: response.meta && response.meta.advertiser_domains ? response.meta.advertiser_domains : [],
+      },
+    };
+
+    return [bid];
+  },
+};
+
+registerBidder(spec);

modules/uniquestBidAdapter.md

@@ -0,0 +1,35 @@
+# Overview
+
+```
+Module Name: UNIQUEST Bid Adapter
+Module Type: Bidder Adapter
+Maintainer:  prebid_info@muneee.co.jp
+```
+
+# Description
+Connects to UNIQUEST exchange for bids.
+
+# Test Parameters
+```js
+var adUnits = [
+  // Banner adUnit
+  {
+    code: 'test-div',
+    mediaTypes: {
+      banner: {
+        sizes: [
+          [300, 300],
+          [300, 250],
+          [320, 100]
+        ]
+      }
+    },
+    bids: [{
+      bidder: 'uniquest',
+      params: {
+        sid: 'ONhFoaQn', // device is smartphone only
+      }
+    }]
+  }
+];
+```