add 51degrees property thirdpartycookiesenabled (prebid#14262)

* 51Degrees RTD submodule: map new `ortb2.device.ext` param - `thirdpartycookiesenabled`

* 51Degrees RTD submodule: update tests

* 51Degrees RTD submodule: update tests

* doc update

* doc update

* 51Degrees RTD submodule: rename custom key, add tests

* doc update

* doc update

---------

Co-authored-by: Bohdan V <25197509+BohdanVV@users.noreply.github.com>

Author: justadreamer

modules/51DegreesRtdProvider.js

@@ -227,6 +227,7 @@ export const convert51DegreesDataToOrtb2 = (data51) => {
  * @param {number} [device.screenpixelsphysicalwidth] Screen physical width in pixels
  * @param {number} [device.pixelratio] Pixel ratio
  * @param {number} [device.screeninchesheight] Screen height in inches
+ * @param {string} [device.thirdpartycookiesenabled] Third-party cookies enabled
  *
  * @returns {Object} Enriched ORTB2 object
  */
@@ -261,7 +262,12 @@ export const convert51DegreesDeviceToOrtb2 = (device) => {
   deepSetNotEmptyValue(ortb2Device, 'w', device.screenpixelsphysicalwidth || device.screenpixelswidth);
   deepSetNotEmptyValue(ortb2Device, 'pxratio', device.pixelratio);
   deepSetNotEmptyValue(ortb2Device, 'ppi', devicePhysicalPPI || devicePPI);
+  // kept for backward compatibility
   deepSetNotEmptyValue(ortb2Device, 'ext.fiftyonedegrees_deviceId', device.deviceid);
+  deepSetNotEmptyValue(ortb2Device, 'ext.fod.deviceId', device.deviceid);
+  if (['True', 'False'].includes(device.thirdpartycookiesenabled)) {
+    deepSetValue(ortb2Device, 'ext.fod.tpc', device.thirdpartycookiesenabled === 'True' ? 1 : 0);
+  }
 
   return {device: ortb2Device};
 }

modules/51DegreesRtdProvider.md

@@ -8,13 +8,17 @@
 
 ## Description
 
-The 51Degrees module enriches an OpenRTB request with [51Degrees Device Data](https://51degrees.com/documentation/index.html).
+51Degrees module enriches an OpenRTB request with [51Degrees Device Data](https://51degrees.com/documentation/index.html).
 
-The 51Degrees module sets the following fields of the device object: `devicetype`, `make`, `model`, `os`, `osv`, `h`, `w`, `ppi`, `pxratio`. Interested bidder adapters may use these fields as needed. In addition, the module sets `device.ext.fiftyonedegrees_deviceId` to a permanent device ID, which can be rapidly looked up in on-premise data, exposing over 250 properties, including device age, chipset, codec support, price, operating system and app/browser versions, age, and embedded features.
+51Degrees module sets the following fields of the device object: `devicetype`, `make`, `model`, `os`, `osv`, `h`, `w`, `ppi`, `pxratio`. Interested bidder adapters may use these fields as needed. 
+
+The module also adds a `device.ext.fod` extension object (fod == fifty one degrees) and sets `device.ext.fod.deviceId` to a permanent device ID, which can be rapidly looked up in on-premise data, exposing over 250 properties, including device age, chipset, codec support, price, operating system and app/browser versions, age, and embedded features. 
+
+It also sets `device.ext.fod.tpc` key to a binary value to indicate whether third-party cookies are enabled in the browser (1 if enabled, 0 if disabled).
 
 The module supports on-premise and cloud device detection services, with free options for both.
 
-A free resource key for use with 51Degrees cloud service can be obtained from [51Degrees cloud configuration](https://configure.51degrees.com/HNZ75HT1). This is the simplest approach to trial the module.
+A free resource key for use with 51Degrees cloud service can be obtained from [51Degrees cloud configuration](https://configure.51degrees.com/7bL8jDGz). This is the simplest approach to trial the module.
 
 An interface-compatible self-hosted service can be used with .NET, Java, Node, PHP, and Python. See [51Degrees examples](https://51degrees.com/documentation/_examples__device_detection__getting_started__web__on_premise.html).
 
@@ -36,7 +40,7 @@ gulp build --modules=rtdModule,51DegreesRtdProvider,appnexusBidAdapter,...
 
 #### Resource Key
 
-In order to use the module, please first obtain a Resource Key using the [Configurator tool](https://configure.51degrees.com/HNZ75HT1) - choose the following properties:
+In order to use the module, please first obtain a Resource Key using the [Configurator tool](https://configure.51degrees.com/7bL8jDGz) - choose the following properties:
 
 * DeviceId
 * DeviceType
@@ -52,6 +56,7 @@ In order to use the module, please first obtain a Resource Key using the [Config
 * ScreenInchesHeight
 * ScreenInchesWidth
 * PixelRatio
+* ThirdPartyCookiesEnabled
 
 The Cloud API is **free** to integrate and use. To increase limits, please check [51Degrees pricing](https://51degrees.com/pricing).
 
@@ -106,7 +111,7 @@ pbjs.setConfig({
                 waitForIt: true, // should be true, otherwise the auctionDelay will be ignored
                 params: {
                     resourceKey: '<YOUR_RESOURCE_KEY>',
-                    // Get your resource key from https://configure.51degrees.com/HNZ75HT1
+                    // Get your resource key from https://configure.51degrees.com/7bL8jDGz
                     // alternatively, you can use the on-premise version of the 51Degrees service and connect to your chosen endpoint
                     // onPremiseJSUrl: 'https://localhost/51Degrees.core.js'
                 },

test/spec/modules/51DegreesRtdProvider_spec.js

@@ -33,6 +33,7 @@ describe('51DegreesRtdProvider', function() {
     devicetype: 'Desktop',
     pixelratio: 1,
     deviceid: '17595-131215-132535-18092',
+    thirdpartycookiesenabled: 'True',
   };
 
   const fiftyOneDegreesDeviceX2scaling = {
@@ -61,6 +62,10 @@ describe('51DegreesRtdProvider', function() {
       pxratio: 1,
       ext: {
         fiftyonedegrees_deviceId: '17595-131215-132535-18092',
+        fod: {
+          deviceId: '17595-131215-132535-18092',
+          tpc: 1,
+        },
       },
     },
   };
@@ -362,7 +367,8 @@ describe('51DegreesRtdProvider', function() {
     it('does not set the deviceid if it is not provided', function() {
       const device = {...fiftyOneDegreesDevice};
       delete device.deviceid;
-      expect(convert51DegreesDeviceToOrtb2(device).device).to.not.have.any.keys('ext');
+      expect(convert51DegreesDeviceToOrtb2(device).device.ext).to.not.have.any.keys('fiftyonedegrees_deviceId');
+      expect(convert51DegreesDeviceToOrtb2(device).device.ext.fod).to.not.have.any.keys('deviceId');
     });
 
     it('sets the model to hardwarename if hardwaremodel is not provided', function() {
@@ -400,6 +406,19 @@ describe('51DegreesRtdProvider', function() {
         w: expectedORTB2DeviceResult.device.w,
       });
     });
+
+    it('does not set the tpc if thirdpartycookiesenabled is "Unknown"', function () {
+      const device = { ...fiftyOneDegreesDevice };
+      device.thirdpartycookiesenabled = 'Unknown';
+      expect(convert51DegreesDeviceToOrtb2(device).device.ext.fod).to.not.have.any.keys('tpc');
+    });
+
+    it('sets the tpc if thirdpartycookiesenabled is "True" or "False"', function () {
+      const deviceTrue = { ...fiftyOneDegreesDevice, thirdpartycookiesenabled: 'True' };
+      const deviceFalse = { ...fiftyOneDegreesDevice, thirdpartycookiesenabled: 'False' };
+      expect(convert51DegreesDeviceToOrtb2(deviceTrue).device.ext.fod).to.deep.include({ tpc: 1 });
+      expect(convert51DegreesDeviceToOrtb2(deviceFalse).device.ext.fod).to.deep.include({ tpc: 0 });
+    });
   });
 
   describe('getBidRequestData', function() {