From 360c3eaf94baf6af0336abc59829baa3d66a3a5d Mon Sep 17 00:00:00 2001
From: Alexis BRENON <brenon.alexis@gmail.com>
Date: Fri, 30 Aug 2024 11:26:09 +0200
Subject: [PATCH] Greenbids Analytics : send cpm on any valid bid (#12174)

* fix(greenbids,analytics): send cpm on any valid bid (#5)

* fix(greenbids,analytics): cpm not passed

* bump version number

* fix unit tests
---
 modules/greenbidsAnalyticsAdapter.js          | 28 ++++++++++++++++++-
 .../modules/greenbidsAnalyticsAdapter_spec.js |  8 ++++--
 2 files changed, 33 insertions(+), 3 deletions(-)

diff --git a/modules/greenbidsAnalyticsAdapter.js b/modules/greenbidsAnalyticsAdapter.js
index 156ae0332a2..99ce89ee4d1 100644
--- a/modules/greenbidsAnalyticsAdapter.js
+++ b/modules/greenbidsAnalyticsAdapter.js
@@ -4,9 +4,17 @@ import { EVENTS } from '../src/constants.js';
 import adapterManager from '../src/adapterManager.js';
 import {deepClone, generateUUID, logError, logInfo, logWarn, getParameterByName} from '../src/utils.js';
 
+/**
+ * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid
+ */
+
+/**
+ * @typedef {object} Message Payload message sent to the Greenbids API
+ */
+
 const analyticsType = 'endpoint';
 
-export const ANALYTICS_VERSION = '2.3.1';
+export const ANALYTICS_VERSION = '2.3.2';
 
 const ANALYTICS_SERVER = 'https://a.greenbids.ai';
 
@@ -97,6 +105,11 @@ export const greenbidsAnalyticsAdapter = Object.assign(adapter({ANALYTICS_SERVER
       contentType: 'application/json'
     });
   },
+  /**
+   *
+   * @param {string} auctionId
+   * @returns {Message}
+   */
   createCommonMessage(auctionId) {
     const cachedAuction = this.getCachedAuction(auctionId);
     return {
@@ -111,14 +124,27 @@ export const greenbidsAnalyticsAdapter = Object.assign(adapter({ANALYTICS_SERVER
       adUnits: [],
     };
   },
+  /**
+   * @param {Bid} bid
+   * @param {BIDDER_STATUS} status
+   */
   serializeBidResponse(bid, status) {
     return {
       bidder: bid.bidder,
       isTimeout: (status === BIDDER_STATUS.TIMEOUT),
       hasBid: (status === BIDDER_STATUS.BID),
       params: (bid.params && Object.keys(bid.params).length > 0) ? bid.params : {},
+      ...(status === BIDDER_STATUS.BID ? {
+        cpm: bid.cpm,
+        currency: bid.currency
+      } : {}),
     };
   },
+  /**
+   * @param {*} message Greenbids API payload
+   * @param {Bid} bid Bid to add to the payload
+   * @param {BIDDER_STATUS} status Bidding status
+   */
   addBidResponseToMessage(message, bid, status) {
     const adUnitCode = bid.adUnitCode.toLowerCase();
     const adUnitIndex = message.adUnits.findIndex((adUnit) => {
diff --git a/test/spec/modules/greenbidsAnalyticsAdapter_spec.js b/test/spec/modules/greenbidsAnalyticsAdapter_spec.js
index d5362c9ed19..7eeaa7a6c67 100644
--- a/test/spec/modules/greenbidsAnalyticsAdapter_spec.js
+++ b/test/spec/modules/greenbidsAnalyticsAdapter_spec.js
@@ -280,13 +280,17 @@ describe('Greenbids Prebid AnalyticsAdapter Testing', function () {
                     bidder: 'greenbids',
                     isTimeout: false,
                     hasBid: true,
-                    params: {}
+                    params: {},
+                    cpm: 0.1,
+                    currency: 'USD',
                   },
                   {
                     bidder: 'greenbidsx',
                     isTimeout: false,
                     hasBid: true,
-                    params: {'placement ID': 12784}
+                    params: { 'placement ID': 12784 },
+                    cpm: 0.08,
+                    currency: 'USD',
                   }
                 ]
               },