Smaato: Add iframe UserSyncs (prebid#12924)

Author: el-chuck

modules/smaatoBidAdapter.js

@@ -19,11 +19,12 @@ import {ortbConverter} from '../libraries/ortbConverter/converter.js';
 
 const BIDDER_CODE = 'smaato';
 const SMAATO_ENDPOINT = 'https://prebid.ad.smaato.net/oapi/prebid';
-const SMAATO_CLIENT = 'prebid_js_$prebid.version$_3.2'
+const SMAATO_CLIENT = 'prebid_js_$prebid.version$_3.3'
 const TTL = 300;
 const CURRENCY = 'USD';
 const SUPPORTED_MEDIA_TYPES = [BANNER, VIDEO, NATIVE];
-const SYNC_URL = 'https://s.ad.smaato.net/c/?adExInit=p'
+const IMAGE_SYNC_URL = 'https://s.ad.smaato.net/c/?adExInit=p'
+const IFRAME_SYNC_URL = 'https://s.ad.smaato.net/i/?adExInit=p'
 
 export const spec = {
   code: BIDDER_CODE,
@@ -197,7 +198,7 @@ export const spec = {
    * @return {UserSync[]} The user syncs which should be dropped.
    */
   getUserSyncs: (syncOptions, serverResponses, gdprConsent, uspConsent) => {
-    if (syncOptions && syncOptions.pixelEnabled) {
+    if (syncOptions) {
       let gdprParams = '';
       if (gdprConsent && gdprConsent.consentString) {
         if (typeof gdprConsent.gdprApplies === 'boolean') {
@@ -207,10 +208,22 @@ export const spec = {
         }
       }
 
-      return [{
-        type: 'image',
-        url: SYNC_URL + gdprParams
-      }];
+      if (syncOptions.iframeEnabled) {
+        let maxUrlsParam = '';
+        if (config.getConfig('userSync') && config.getConfig('userSync').syncsPerBidder) {
+          maxUrlsParam = `&maxUrls=${config.getConfig('userSync').syncsPerBidder}`;
+        }
+
+        return [{
+          type: 'iframe',
+          url: IFRAME_SYNC_URL + gdprParams + maxUrlsParam
+        }];
+      } else if (syncOptions.pixelEnabled) {
+        return [{
+          type: 'image',
+          url: IMAGE_SYNC_URL + gdprParams
+        }];
+      }
     }
 
     return [];

test/spec/modules/smaatoBidAdapter_spec.js

@@ -12,7 +12,8 @@ import 'modules/consentManagementTcf.js';
 import 'modules/consentManagementUsp.js';
 import 'modules/schain.js';
 
-const SYNC_URL = 'https://s.ad.smaato.net/c/?adExInit=p'
+const IMAGE_SYNC_URL = 'https://s.ad.smaato.net/c/?adExInit=p'
+const IFRAME_SYNC_URL = 'https://s.ad.smaato.net/i/?adExInit=p'
 
 const ADTYPE_IMG = 'Img';
 const ADTYPE_VIDEO = 'Video';
@@ -1670,41 +1671,101 @@ describe('smaatoBidAdapterTest', () => {
   });
 
   describe('getUserSyncs', () => {
-    it('when pixelEnabled false then returns no pixels', () => {
+    afterEach(() => {
+      config.resetConfig();
+    })
+
+    it('when pixelEnabled and iframeEnabled false then returns no syncs', () => {
       expect(spec.getUserSyncs()).to.be.empty
     })
 
-    it('when pixelEnabled true then returns pixel', () => {
+    it('when pixelEnabled true then returns image sync', () => {
       expect(spec.getUserSyncs({pixelEnabled: true}, null, null, null)).to.deep.equal(
         [
           {
             type: 'image',
-            url: SYNC_URL
+            url: IMAGE_SYNC_URL
           }
         ]
       )
     })
 
-    it('when pixelEnabled true and gdprConsent then returns pixel with gdpr params', () => {
+    it('when iframeEnabled true then returns iframe sync', () => {
+      expect(spec.getUserSyncs({iframeEnabled: true}, null, null, null)).to.deep.equal(
+          [
+            {
+              type: 'iframe',
+              url: IFRAME_SYNC_URL
+            }
+          ]
+      )
+    })
+
+    it('when iframeEnabled true and syncsPerBidder then returns iframe sync', () => {
+      config.setConfig({userSync: {syncsPerBidder: 5}});
+      expect(spec.getUserSyncs({iframeEnabled: true}, null, null, null)).to.deep.equal(
+          [
+            {
+              type: 'iframe',
+              url: `${IFRAME_SYNC_URL}&maxUrls=5`
+            }
+          ]
+      )
+    })
+
+    it('when iframeEnabled and pixelEnabled true then returns iframe sync', () => {
+      expect(spec.getUserSyncs({pixelEnabled: true, iframeEnabled: true}, null, null, null)).to.deep.equal(
+          [
+            {
+              type: 'iframe',
+              url: IFRAME_SYNC_URL
+            }
+          ]
+      )
+    })
+
+    it('when pixelEnabled true and gdprConsent then returns image sync with gdpr params', () => {
       expect(spec.getUserSyncs({pixelEnabled: true}, null, {gdprApplies: true, consentString: CONSENT_STRING}, null)).to.deep.equal(
         [
           {
             type: 'image',
-            url: `${SYNC_URL}&gdpr=1&gdpr_consent=${CONSENT_STRING}`
+            url: `${IMAGE_SYNC_URL}&gdpr=1&gdpr_consent=${CONSENT_STRING}`
           }
         ]
       )
     })
 
-    it('when pixelEnabled true and gdprConsent without gdpr then returns pixel with gdpr_consent', () => {
+    it('when iframeEnabled true and gdprConsent then returns iframe with gdpr params', () => {
+      expect(spec.getUserSyncs({iframeEnabled: true}, null, {gdprApplies: true, consentString: CONSENT_STRING}, null)).to.deep.equal(
+          [
+            {
+              type: 'iframe',
+              url: `${IFRAME_SYNC_URL}&gdpr=1&gdpr_consent=${CONSENT_STRING}`
+            }
+          ]
+      )
+    })
+
+    it('when pixelEnabled true and gdprConsent without gdpr then returns pixel sync with gdpr_consent', () => {
       expect(spec.getUserSyncs({pixelEnabled: true}, null, {consentString: CONSENT_STRING}, null), null).to.deep.equal(
         [
           {
             type: 'image',
-            url: `${SYNC_URL}&gdpr_consent=${CONSENT_STRING}`
+            url: `${IMAGE_SYNC_URL}&gdpr_consent=${CONSENT_STRING}`
           }
         ]
       )
     })
+
+    it('when iframeEnabled true and gdprConsent without gdpr then returns iframe sync with gdpr_consent', () => {
+      expect(spec.getUserSyncs({iframeEnabled: true}, null, {consentString: CONSENT_STRING}, null), null).to.deep.equal(
+          [
+            {
+              type: 'iframe',
+              url: `${IFRAME_SYNC_URL}&gdpr_consent=${CONSENT_STRING}`
+            }
+          ]
+      )
+    })
   })
 });