Appnexus adaptor - Added App parameters for hybrid apps. (#2973)

* Added hybrid app parameters and debug url parameters

* Fix test for app parameters. removed debugging

* added defensive code per review from @jaiminpanchal27

* simplified if/then statements

* fix JS lint issue

Author: aneuway2

modules/appnexusBidAdapter.js

@@ -10,6 +10,7 @@ const URL = '//ib.adnxs.com/ut/v3/prebid';
 const VIDEO_TARGETING = ['id', 'mimes', 'minduration', 'maxduration',
   'startdelay', 'skippable', 'playback_method', 'frameworks'];
 const USER_PARAMS = ['age', 'external_uid', 'segments', 'gender', 'dnt', 'language'];
+const APP_DEVICE_PARAMS = ['geo', 'device_id']; // appid is collected separately
 const NATIVE_MAPPING = {
   body: 'description',
   cta: 'ctatext',
@@ -59,6 +60,23 @@ export const spec = {
         .forEach(param => userObj[param] = userObjBid.params.user[param]);
     }
 
+    const appDeviceObjBid = find(bidRequests, hasAppDeviceInfo);
+    let appDeviceObj;
+    if (appDeviceObjBid && appDeviceObjBid.params && appDeviceObjBid.params.app) {
+      appDeviceObj = {};
+      Object.keys(appDeviceObjBid.params.app)
+        .filter(param => includes(APP_DEVICE_PARAMS, param))
+        .forEach(param => appDeviceObj[param] = appDeviceObjBid.params.app[param]);
+    }
+
+    const appIdObjBid = find(bidRequests, hasAppId);
+    let appIdObj;
+    if (appIdObjBid && appIdObjBid.params && appDeviceObjBid.params.app && appDeviceObjBid.params.app.id) {
+      appIdObj = {
+        appid: appIdObjBid.params.app.id
+      };
+    }
+
     const memberIdBid = find(bidRequests, hasMemberId);
     const member = memberIdBid ? parseInt(memberIdBid.params.member, 10) : 0;
 
@@ -74,6 +92,13 @@ export const spec = {
       payload.member_id = member;
     }
 
+    if (appDeviceObjBid) {
+      payload.device = appDeviceObj
+    }
+    if (appIdObjBid) {
+      payload.app = appIdObj;
+    }
+
     if (bidderRequest && bidderRequest.gdprConsent) {
       // note - objects for impbus use underscore instead of camelCase
       payload.gdpr_consent = {
@@ -381,6 +406,19 @@ function hasMemberId(bid) {
   return !!parseInt(bid.params.member, 10);
 }
 
+function hasAppDeviceInfo(bid) {
+  if (bid.params) {
+    return !!bid.params.app
+  }
+}
+
+function hasAppId(bid) {
+  if (bid.params && bid.params.app) {
+    return !!bid.params.app.id
+  }
+  return !!bid.params.app
+}
+
 function getRtbBid(tag) {
   return tag && tag.ads && tag.ads.length && find(tag.ads, ad => ad.rtb);
 }

modules/appnexusBidAdapter.md

@@ -17,9 +17,13 @@ Appnexus bid adapter supports Banner, Video (instream and outstream) and Native.
 var adUnits = [
    // Banner adUnit
    {
-       code: 'banner-div',
-       sizes: [[300, 250], [300,600]],
-       bids: [{
+      code: 'banner-div',
+      mediaTypes: {
+        banner: {
+          sizes: [[300, 250], [300,600]]
+        }
+      }
+      bids: [{
          bidder: 'appnexus',
          params: {
            placementId: '10433394'
@@ -98,6 +102,37 @@ var adUnits = [
          }
        }
      ]
+   },
+   // Banner adUnit in a App Webview
+   // Only use this for situations where prebid.js is in a webview of an App
+   // See Prebid Mobile for displaying ads via an SDK
+   {
+     code: 'banner-div',
+     mediaTypes: {
+       banner: {
+         sizes: [[300, 250], [300,600]]
+       }
+     }
+     bids: [{
+       bidder: 'appnexus',
+       params: {
+         placementId: '10433394',
+         app: {
+           id: "B1O2W3M4AN.com.prebid.webview",
+           geo: {
+             lat: 40.0964439,
+             lng: -75.3009142
+           },
+           device_id: {
+             idfa: "4D12078D-3246-4DA4-AD5E-7610481E7AE", // Apple advertising identifier
+             aaid: "38400000-8cf0-11bd-b23e-10b96e40000d", // Android advertising identifier
+             md5udid: "5756ae9022b2ea1e47d84fead75220c8", // MD5 hash of the ANDROID_ID
+             sha1udid: "4DFAA92388699AC6539885AEF1719293879985BF", // SHA1 hash of the ANDROID_ID
+             windowsadid: "750c6be243f1c4b5c9912b95a5742fc5" // Windows advertising identifier
+           }
+         }
+       }
+     }]
    }
 ];
 ```

test/spec/modules/appnexusBidAdapter_spec.js

@@ -326,6 +326,50 @@ describe('AppNexusAdapter', () => {
       expect(payload.gdpr_consent.consent_string).to.exist.and.to.equal(consentString);
       expect(payload.gdpr_consent.consent_required).to.exist.and.to.be.true;
     });
+
+    it('supports sending hybrid mobile app parameters', () => {
+      let appRequest = Object.assign({},
+        bidRequests[0],
+        {
+          params: {
+            placementId: '10433394',
+            app: {
+              id: 'B1O2W3M4AN.com.prebid.webview',
+              geo: {
+                lat: 40.0964439,
+                lng: -75.3009142
+              },
+              device_id: {
+                idfa: '4D12078D-3246-4DA4-AD5E-7610481E7AE', // Apple advertising identifier
+                aaid: '38400000-8cf0-11bd-b23e-10b96e40000d', // Android advertising identifier
+                md5udid: '5756ae9022b2ea1e47d84fead75220c8', // MD5 hash of the ANDROID_ID
+                sha1udid: '4DFAA92388699AC6539885AEF1719293879985BF', // SHA1 hash of the ANDROID_ID
+                windowsadid: '750c6be243f1c4b5c9912b95a5742fc5' // Windows advertising identifier
+              }
+            }
+          }
+        }
+      );
+      const request = spec.buildRequests([appRequest]);
+      const payload = JSON.parse(request.data);
+      expect(payload.app).to.exist;
+      expect(payload.app).to.deep.equal({
+        appid: 'B1O2W3M4AN.com.prebid.webview'
+      });
+      expect(payload.device.device_id).to.exist;
+      expect(payload.device.device_id).to.deep.equal({
+        aaid: '38400000-8cf0-11bd-b23e-10b96e40000d',
+        idfa: '4D12078D-3246-4DA4-AD5E-7610481E7AE',
+        md5udid: '5756ae9022b2ea1e47d84fead75220c8',
+        sha1udid: '4DFAA92388699AC6539885AEF1719293879985BF',
+        windowsadid: '750c6be243f1c4b5c9912b95a5742fc5'
+      });
+      expect(payload.device.geo).to.exist;
+      expect(payload.device.geo).to.deep.equal({
+        lat: 40.0964439,
+        lng: -75.3009142
+      });
+    });
   })
 
   describe('interpretResponse', () => {