Qc/qc usersyncs (prebid#4923)

* QC adapter. support usersyncs * cache user sync
happypancake · Jun 22, 2020 · a104aec · a104aec
1 parent fe013bd
commit a104aec
Show file tree

Hide file tree

Showing 3 changed files with 93 additions and 2 deletions.
diff --git a/modules/quantcastBidAdapter.js b/modules/quantcastBidAdapter.js
@@ -2,6 +2,7 @@ import * as utils from '../src/utils.js';
 import { ajax } from '../src/ajax.js';
 import { config } from '../src/config.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
+import find from 'core-js/library/fn/array/find.js';
 
 const BIDDER_CODE = 'quantcast';
 const DEFAULT_BID_FLOOR = 0.0000000001;
@@ -80,6 +81,7 @@ export const spec = {
   code: BIDDER_CODE,
   GVLID: 11,
   supportedMediaTypes: ['banner', 'video'],
+  hasUserSynced: false,
 
   /**
    * Verify the `AdUnits.bids` response with `true` for valid request and `false`
@@ -223,6 +225,27 @@ export const spec = {
   onTimeout(timeoutData) {
     const url = `${QUANTCAST_PROTOCOL}://${QUANTCAST_DOMAIN}:${QUANTCAST_PORT}/qchb_notify?type=timeout`;
     ajax(url, null, null);
+  },
+  getUserSyncs(syncOptions, serverResponses) {
+    const syncs = []
+    if (!this.hasUserSynced && syncOptions.pixelEnabled) {
+      const responseWithUrl = find(serverResponses, serverResponse =>
+        utils.deepAccess(serverResponse.body, 'userSync.url')
+      );
+
+      if (responseWithUrl) {
+        const url = utils.deepAccess(responseWithUrl.body, 'userSync.url')
+        syncs.push({
+          type: 'image',
+          url: url
+        });
+      }
+      this.hasUserSynced = true;
+    }
+    return syncs;
+  },
+  resetUserSync() {
+    this.hasUserSynced = false;
   }
 };
 

diff --git a/modules/quantcastBidAdapter.md b/modules/quantcastBidAdapter.md
@@ -27,7 +27,10 @@ const adUnits = [{
         battr: [1, 2] // OPTIONAL - Array of blocked creative attributes as per OpenRTB Spec List 5.3
       }
     }
-  ]
+  ],
+  userSync: {
+    url: 'https://quantcast.com/pixelUrl'
+  }
 }];
 ```
 
@@ -63,6 +66,9 @@ var adUnits = [{
         }
       }
     }
-  ]
+  ],
+  userSync: {
+    url: 'https://quantcast.com/pixelUrl'
+  }
 }];
 ```
diff --git a/test/spec/modules/quantcastBidAdapter_spec.js b/test/spec/modules/quantcastBidAdapter_spec.js
@@ -542,5 +542,67 @@ describe('Quantcast adapter', function () {
 
       expect(interpretedResponse.length).to.equal(0);
     });
+
+    it('should return pixel url when available userSync available', function () {
+      const syncOptions = {
+        pixelEnabled: true
+      };
+      const serverResponses = [
+        {
+          body: {
+            userSync: {
+              url: 'http://quantcast.com/pixelUrl'
+            }
+          }
+        },
+        {
+          body: {
+
+          }
+        }
+      ];
+
+      const actualSyncs = qcSpec.getUserSyncs(syncOptions, serverResponses);
+      const expectedSync = {
+        type: 'image',
+        url: 'http://quantcast.com/pixelUrl'
+      };
+      expect(actualSyncs.length).to.equal(1);
+      expect(actualSyncs[0]).to.deep.equal(expectedSync);
+      qcSpec.resetUserSync();
+    });
+
+    it('should not return user syncs if done already', function () {
+      const syncOptions = {
+        pixelEnabled: true
+      };
+      const serverResponses = [
+        {
+          body: {
+            userSync: {
+              url: 'http://quantcast.com/pixelUrl'
+            }
+          }
+        },
+        {
+          body: {
+
+          }
+        }
+      ];
+
+      let actualSyncs = qcSpec.getUserSyncs(syncOptions, serverResponses);
+      const expectedSync = {
+        type: 'image',
+        url: 'http://quantcast.com/pixelUrl'
+      };
+      expect(actualSyncs.length).to.equal(1);
+      expect(actualSyncs[0]).to.deep.equal(expectedSync);
+
+      actualSyncs = qcSpec.getUserSyncs(syncOptions, serverResponses);
+      expect(actualSyncs.length).to.equal(0);
+
+      qcSpec.resetUserSync();
+    });
   });
 });