Copper6 adapter: change utility suite

libraries/vidazooUtils/bidderUtils.js

@@ -124,7 +124,7 @@
     setStorageItem(storage, key, nextValue, timestamp);
     return nextValue;
   } catch (e) {
     return 0;
   }
 }
 
@@ -338,7 +338,6 @@
     url: encodeURIComponent(topWindowUrl),
     uqs: getTopWindowQueryParams(),
     cb: Date.now(),
-    bidFloor: bidFloor,
     bidId: bidId,
     referrer: bidderRequest.refererInfo.ref,
     adUnitCode: adUnitCode,
@@ -368,6 +367,9 @@
     ...uniqueRequestData
   };
 
+  if (bidFloor) {
+    data.bidFloor = bidFloor;
+  }
   // backward compatible userId generators
   if (bid.userIdAsEids?.length > 0) {
     appendUserIdsAsEidsToRequestPayload(data, bid.userIdAsEids);

libraries/vidazooUtils/vidazooTypes.ts

@@ -12,12 +12,14 @@ export interface VidazooBaseBidderParams {
   /**
    * The minimum bid value desired. Adapter will not respond with bids lower than this value
    */
-  bidFloor: number;
+  bidFloor?: number;
   /**
    * Placement id on platform.
    */
-
   placementId?: number;
+  /**
+   * Custom parameters for the request
+   */
   ext?: Ext;
   /**
    * Subdomain define subdomain in the bid request URL

modules/copper6sspBidAdapter.d.ts

@@ -0,0 +1,33 @@
+import { Ext } from '../libraries/vidazooUtils/vidazooTypes.ts';
+
+interface Copper6SSPCommonParams {
+  bidFloor?: number;
+  ext?: Ext;
+  subDomain?: string;
+}
+
+/** Current documented params */
+interface Copper6SSPModernParams extends Copper6SSPCommonParams {
+  cId: string;
+  pId: string;
+  placementId?: never;
+  endpointId?: never;
+}
+
+/** Previously documented legacy params */
+interface Copper6SSPLegacyParams extends Copper6SSPCommonParams {
+  placementId: string;
+  endpointId: string;
+  cId?: never;
+  pId?: never;
+}
+
+export type Copper6SSPBidRequestParams =
+  | Copper6SSPModernParams
+  | Copper6SSPLegacyParams;
+
+declare module '../src/adUnits' {
+  interface BidderParams {
+    copper6ssp: Copper6SSPBidRequestParams;
+  }
+}

modules/copper6sspBidAdapter.js

@@ -1,21 +1,88 @@
 import { registerBidder } from '../src/adapters/bidderFactory.js';
-import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
-import { isBidRequestValid, buildRequests, interpretResponse, getUserSyncs } from '../libraries/teqblazeUtils/bidderUtils.js';
+import { BANNER, VIDEO } from '../src/mediaTypes.js';
+import { getStorageManager } from '../src/storageManager.js';
+import {
+  extractCID,
+  extractPID,
+  onBidWon,
+  createUserSyncGetter,
+  createBuildRequestsFn,
+  createInterpretResponseFn
+} from '../libraries/vidazooUtils/bidderUtils.js';
 
+/**
+ * @typedef {import('./copper6sspBidAdapter.d.ts').Copper6SSPBidRequestParams} Copper6SSPBidRequestParams
+ */
+
+const DEFAULT_SUB_DOMAIN = 'exchange';
 const BIDDER_CODE = 'copper6ssp';
-const AD_URL = 'https://endpoint.copper6.com/pbjs';
-const SYNC_URL = 'https://сsync.copper6.com';
+const BIDDER_VERSION = '1.0.0';
 const GVLID = 1356;
+const DEFAULT_CID = "600000000000000000000cc6";
+const DEFAULT_PID = "600000000000000000000dc6";
+export const storage = getStorageManager({ bidderCode: BIDDER_CODE });
+
+export function createDomain(subDomain = DEFAULT_SUB_DOMAIN) {
+  return `https://${subDomain}.copper6.com`;
+}
+
+function createUniqueRequestData(hashUrl, bid) {
+  const { auctionId, transactionId } = bid;
+  return {
+    auctionId,
+    transactionId
+  };
+}
+
+function legacySupport(createDomain, createUniqueRequestData, storage, BIDDER_CODE, BIDDER_VERSION, allowSingleRequest = false) {
+  const buildFunction = createBuildRequestsFn(createDomain, createUniqueRequestData, storage, BIDDER_CODE, BIDDER_VERSION, allowSingleRequest);
+  return function legacyHandler(validBidRequests, bidderRequest) {
+    const modifiedRequests = validBidRequests.map(request => {
+      if (!request.params?.cId) {
+        if (request.params?.placementId) {
+          request.params.cId = request.params.placementId;
+        } else {
+          request.params.cId = DEFAULT_CID;
+        }
+        delete request.params.placementId;
+      }
+      if (!request.params?.pId) {
+        if (request.params?.endpointId) {
+          request.params.pId = request.params.endpointId;
+        } else {
+          request.params.pId = DEFAULT_PID;
+        }
+      }
+      return request;
+    });
+    return buildFunction(modifiedRequests, bidderRequest);
+  };
+}
+
+const buildRequests = legacySupport(createDomain, createUniqueRequestData, storage, BIDDER_CODE, BIDDER_VERSION, false);
+const interpretResponse = createInterpretResponseFn(BIDDER_CODE, false);
+const getUserSyncs = createUserSyncGetter({
+  iframeSyncUrl: 'https://sync.copper6.com/api/sync/iframe',
+  imageSyncUrl: 'https://sync.copper6.com/api/sync/image'
+});
+
+function isBidRequestValid(bid) {
+  const p = bid.params || {};
+  const hasNew = extractCID(p) && extractPID(p);
+  const hasLegacy = p.placementId && p.endpointId;
+  return !!(hasNew || hasLegacy);
+}
 
 export const spec = {
   code: BIDDER_CODE,
+  version: BIDDER_VERSION,
+  supportedMediaTypes: [BANNER, VIDEO],
   gvlid: GVLID,
-  supportedMediaTypes: [BANNER, VIDEO, NATIVE],
-
-  isBidRequestValid: isBidRequestValid(),
-  buildRequests: buildRequests(AD_URL),
+  isBidRequestValid,
+  buildRequests,
   interpretResponse,
-  getUserSyncs: getUserSyncs(SYNC_URL)
+  getUserSyncs,
+  onBidWon,
 };
 
 registerBidder(spec);

modules/copper6sspBidAdapter.md

@@ -1,79 +1,35 @@
 # Overview
 
-```
-Module Name: Copper6SSP Bidder Adapter
-Module Type: Copper6SSP Bidder Adapter
-Maintainer: info@copper6.com
-```
+**Module Name:** Copper6 Bidder Adapter
+
+**Module Type:** Bidder Adapter
+
+**Maintainer:** operations@copper6.com
 
 # Description
 
-Connects to Copper6SSP exchange for bids.
-Copper6SSP bid adapter supports Banner, Video (instream and outstream) and Native.
+Module that connects to Copper6's demand sources.
 
 # Test Parameters
-```
-    var adUnits = [
-                // Will return static test banner
-                {
-                    code: 'adunit1',
-                    mediaTypes: {
-                        banner: {
-                            sizes: [ [300, 250], [320, 50] ],
-                        }
-                    },
-                    bids: [
-                        {
-                            bidder: 'copper6ssp',
-                            params: {
-                                placementId: 'testBanner',
-                            }
-                        }
-                    ]
-                },
-                {
-                    code: 'addunit2',
-                    mediaTypes: {
-                        video: {
-                            playerSize: [ [640, 480] ],
-                            context: 'instream',
-                            minduration: 5,
-                            maxduration: 60,
-                        }
-                    },
-                    bids: [
-                        {
-                            bidder: 'copper6ssp',
-                            params: {
-                                placementId: 'testVideo',
-                            }
-                        }
-                    ]
-                },
-                {
-                    code: 'addunit3',
-                    mediaTypes: {
-                        native: {
-                            title: {
-                                required: true
-                            },
-                            body: {
-                                required: true
-                            },
-                            icon: {
-                                required: true,
-                                size: [64, 64]
-                            }
-                        }
-                    },
-                    bids: [
-                        {
-                            bidder: 'copper6ssp',
-                            params: {
-                                placementId: 'testNative',
-                            }
-                        }
-                    ]
+
+```js
+var adUnits = [
+    {
+        code: 'test-ad',
+        sizes: [[300, 250]],
+        bids: [
+            {
+                bidder: 'copper6ssp',
+                params: {
+                    cId: '562524b21b1c1f08117667f9',
+                    pId: '59ac17c192832d0016683fe3',
+                    bidFloor: 0.0001,
+                    ext: {
+                        // custom params that were recomended to add by a partner
+                    }
                 }
-            ];
-```
+            }
+        ]
+    }
+];
+```