PubMatic adapter to support image sync

modules/pubmaticBidAdapter.js

@@ -6,7 +6,8 @@ import {config} from '../src/config.js';
 const BIDDER_CODE = 'pubmatic';
 const LOG_WARN_PREFIX = 'PubMatic: ';
 const ENDPOINT = 'https://hbopenbid.pubmatic.com/translator?source=prebid-client';
-const USYNCURL = 'https://ads.pubmatic.com/AdServer/js/showad.js#PIX&kdntuid=1&p=';
+const USER_SYNC_URL_IFRAME = 'https://ads.pubmatic.com/AdServer/js/showad.js#PIX&kdntuid=1&p=';
+const USER_SYNC_URL_IMAGE = 'https://image8.pubmatic.com/AdServer/ImgSync?p=';
 const DEFAULT_CURRENCY = 'USD';
 const AUCTION_TYPE = 1;
 const PUBMATIC_DIGITRUST_KEY = 'nFIn8aLzbd';
@@ -1057,7 +1058,7 @@ export const spec = {
    * Register User Sync.
    */
   getUserSyncs: (syncOptions, responses, gdprConsent, uspConsent) => {
-    let syncurl = USYNCURL + publisherId;
+    let syncurl = '' + publisherId;
 
     // Attaching GDPR Consent Params in UserSync url
     if (gdprConsent) {
@@ -1078,10 +1079,13 @@ export const spec = {
     if (syncOptions.iframeEnabled) {
       return [{
         type: 'iframe',
-        url: syncurl
+        url: USER_SYNC_URL_IFRAME + syncurl
       }];
     } else {
-      utils.logWarn(LOG_WARN_PREFIX + 'Please enable iframe based user sync.');
+      return [{
+        type: 'image',
+        url: USER_SYNC_URL_IMAGE + syncurl
+      }];
     }
   },
 

test/spec/modules/pubmaticBidAdapter_spec.js

@@ -2711,37 +2711,53 @@ describe('PubMatic adapter', function () {
     });
 
     describe('getUserSyncs', function() {
-      const syncurl = 'https://ads.pubmatic.com/AdServer/js/showad.js#PIX&kdntuid=1&p=5670';
+      const syncurl_iframe = 'https://ads.pubmatic.com/AdServer/js/showad.js#PIX&kdntuid=1&p=5670';
+      const syncurl_image = 'https://image8.pubmatic.com/AdServer/ImgSync?p=5670';
       let sandbox;
       beforeEach(function () {
         sandbox = sinon.sandbox.create();
       });
       afterEach(function() {
         sandbox.restore();
-      })
+      });
 
-      it('execute only if iframeEnabled', function() {
+      it('execute as per config', function() {
         expect(spec.getUserSyncs({ iframeEnabled: true }, {}, undefined, undefined)).to.deep.equal([{
-          type: 'iframe', url: syncurl
+          type: 'iframe', url: syncurl_iframe
+        }]);
+        expect(spec.getUserSyncs({ iframeEnabled: false }, {}, undefined, undefined)).to.deep.equal([{
+          type: 'image', url: syncurl_image
         }]);
-        expect(spec.getUserSyncs({ iframeEnabled: false }, {}, undefined, undefined)).to.equal(undefined);
       });
 
       it('CCPA/USP', function() {
         expect(spec.getUserSyncs({ iframeEnabled: true }, {}, undefined, '1NYN')).to.deep.equal([{
-          type: 'iframe', url: `${syncurl}&us_privacy=1NYN`
+          type: 'iframe', url: `${syncurl_iframe}&us_privacy=1NYN`
+        }]);
+        expect(spec.getUserSyncs({ iframeEnabled: false }, {}, undefined, '1NYN')).to.deep.equal([{
+          type: 'image', url: `${syncurl_image}&us_privacy=1NYN`
         }]);
       });
 
       it('GDPR', function() {
         expect(spec.getUserSyncs({ iframeEnabled: true }, {}, {gdprApplies: true, consentString: 'foo'}, undefined)).to.deep.equal([{
-          type: 'iframe', url: `${syncurl}&gdpr=1&gdpr_consent=foo`
+          type: 'iframe', url: `${syncurl_iframe}&gdpr=1&gdpr_consent=foo`
         }]);
         expect(spec.getUserSyncs({ iframeEnabled: true }, {}, {gdprApplies: false, consentString: 'foo'}, undefined)).to.deep.equal([{
-          type: 'iframe', url: `${syncurl}&gdpr=0&gdpr_consent=foo`
+          type: 'iframe', url: `${syncurl_iframe}&gdpr=0&gdpr_consent=foo`
         }]);
         expect(spec.getUserSyncs({ iframeEnabled: true }, {}, {gdprApplies: true, consentString: undefined}, undefined)).to.deep.equal([{
-          type: 'iframe', url: `${syncurl}&gdpr=1&gdpr_consent=`
+          type: 'iframe', url: `${syncurl_iframe}&gdpr=1&gdpr_consent=`
+        }]);
+
+        expect(spec.getUserSyncs({ iframeEnabled: false }, {}, {gdprApplies: true, consentString: 'foo'}, undefined)).to.deep.equal([{
+          type: 'image', url: `${syncurl_image}&gdpr=1&gdpr_consent=foo`
+        }]);
+        expect(spec.getUserSyncs({ iframeEnabled: false }, {}, {gdprApplies: false, consentString: 'foo'}, undefined)).to.deep.equal([{
+          type: 'image', url: `${syncurl_image}&gdpr=0&gdpr_consent=foo`
+        }]);
+        expect(spec.getUserSyncs({ iframeEnabled: false }, {}, {gdprApplies: true, consentString: undefined}, undefined)).to.deep.equal([{
+          type: 'image', url: `${syncurl_image}&gdpr=1&gdpr_consent=`
         }]);
       });
 
@@ -2753,7 +2769,10 @@ describe('PubMatic adapter', function () {
           return config[key];
         });
         expect(spec.getUserSyncs({ iframeEnabled: true }, {}, undefined, undefined)).to.deep.equal([{
-          type: 'iframe', url: `${syncurl}&coppa=1`
+          type: 'iframe', url: `${syncurl_iframe}&coppa=1`
+        }]);
+        expect(spec.getUserSyncs({ iframeEnabled: false }, {}, undefined, undefined)).to.deep.equal([{
+          type: 'image', url: `${syncurl_image}&coppa=1`
         }]);
       });
 
@@ -2765,7 +2784,10 @@ describe('PubMatic adapter', function () {
           return config[key];
         });
         expect(spec.getUserSyncs({ iframeEnabled: true }, {}, undefined, undefined)).to.deep.equal([{
-          type: 'iframe', url: `${syncurl}`
+          type: 'iframe', url: `${syncurl_iframe}`
+        }]);
+        expect(spec.getUserSyncs({ iframeEnabled: false }, {}, undefined, undefined)).to.deep.equal([{
+          type: 'image', url: `${syncurl_image}`
         }]);
       });
 
@@ -2777,7 +2799,10 @@ describe('PubMatic adapter', function () {
           return config[key];
         });
         expect(spec.getUserSyncs({ iframeEnabled: true }, {}, {gdprApplies: true, consentString: 'foo'}, '1NYN')).to.deep.equal([{
-          type: 'iframe', url: `${syncurl}&gdpr=1&gdpr_consent=foo&us_privacy=1NYN&coppa=1`
+          type: 'iframe', url: `${syncurl_iframe}&gdpr=1&gdpr_consent=foo&us_privacy=1NYN&coppa=1`
+        }]);
+        expect(spec.getUserSyncs({ iframeEnabled: false }, {}, {gdprApplies: true, consentString: 'foo'}, '1NYN')).to.deep.equal([{
+          type: 'image', url: `${syncurl_image}&gdpr=1&gdpr_consent=foo&us_privacy=1NYN&coppa=1`
         }]);
       });
     });