upgrade id5IdSystem to use v2 of our fetch endpoint (#5406)

- allow publishers to pass deterministic signals - add a counter to provide analytics on the number of auctions using the id5Id
prebid · Jun 30, 2020 · 76d5c51 · 76d5c51
1 parent bcfc972
commit 76d5c51
Show file tree

Hide file tree

Showing 4 changed files with 477 additions and 64 deletions.
diff --git a/modules/id5IdSystem.js b/modules/id5IdSystem.js
@@ -1,13 +1,22 @@
 /**
  * This module adds ID5 to the User ID module
  * The {@link module:modules/userId} module is required
- * @module modules/unifiedIdSystem
+ * @module modules/id5IdSystem
  * @requires module:modules/userId
  */
 
 import * as utils from '../src/utils.js'
-import {ajax} from '../src/ajax.js';
-import {submodule} from '../src/hook.js';
+import { ajax } from '../src/ajax.js';
+import { submodule } from '../src/hook.js';
+import { getRefererInfo } from '../src/refererDetection.js';
+import { getStorageManager } from '../src/storageManager.js';
+
+const MODULE_NAME = 'id5Id';
+const GVLID = 131;
+const BASE_NB_COOKIE_NAME = 'pbjs-id5id';
+const NB_COOKIE_EXP_DAYS = (30 * 24 * 60 * 60 * 1000); // 30 days
+
+const storage = getStorageManager(GVLID, MODULE_NAME);
 
 /** @type {Submodule} */
 export const id5IdSubmodule = {
@@ -16,37 +25,60 @@ export const id5IdSubmodule = {
    * @type {string}
    */
   name: 'id5Id',
+
   /**
    * Vendor id of ID5
    * @type {Number}
    */
-  gvlid: 131,
+  gvlid: GVLID,
+
   /**
    * decode the stored id value for passing to bid requests
    * @function decode
    * @param {(Object|string)} value
    * @returns {(Object|undefined)}
    */
   decode(value) {
-    return (value && typeof value['ID5ID'] === 'string') ? { 'id5id': value['ID5ID'] } : undefined;
+    if (value && typeof value.ID5ID === 'string') {
+      // don't lose our legacy value from cache
+      return { 'id5id': value.ID5ID };
+    } else if (value && typeof value.universal_uid === 'string') {
+      return { 'id5id': value.universal_uid };
+    } else {
+      return undefined;
+    }
   },
+
   /**
    * performs action to obtain id and return a value in the callback's response argument
-   * @function
+   * @function getId
    * @param {SubmoduleParams} [configParams]
    * @param {ConsentData} [consentData]
    * @param {(Object|undefined)} cacheIdObj
    * @returns {IdResponse|undefined}
    */
   getId(configParams, consentData, cacheIdObj) {
-    if (!configParams || typeof configParams.partner !== 'number') {
-      utils.logError(`User ID - ID5 submodule requires partner to be defined as a number`);
+    if (!hasRequiredParams(configParams)) {
       return undefined;
     }
     const hasGdpr = (consentData && typeof consentData.gdprApplies === 'boolean' && consentData.gdprApplies) ? 1 : 0;
     const gdprConsentString = hasGdpr ? consentData.consentString : '';
-    const storedUserId = this.decode(cacheIdObj);
-    const url = `https://id5-sync.com/g/v1/${configParams.partner}.json?1puid=${storedUserId ? storedUserId.id5id : ''}&gdpr=${hasGdpr}&gdpr_consent=${gdprConsentString}`;
+    const url = `https://id5-sync.com/g/v2/${configParams.partner}.json?gdpr_consent=${gdprConsentString}&gdpr=${hasGdpr}`;
+    const referer = getRefererInfo();
+    const signature = (cacheIdObj && cacheIdObj.signature) ? cacheIdObj.signature : '';
+    const pubId = (cacheIdObj && cacheIdObj.ID5ID) ? cacheIdObj.ID5ID : ''; // TODO: remove when 1puid isn't needed
+    const data = {
+      'partner': configParams.partner,
+      '1puid': pubId, // TODO: remove when 1puid isn't needed
+      'nbPage': incrementNb(configParams),
+      'o': 'pbjs',
+      'pd': configParams.pd || '',
+      'rf': referer.referer,
+      's': signature,
+      'top': referer.reachedTop ? 1 : 0,
+      'u': referer.stack[0] || window.location.href,
+      'v': '$prebid.version$'
+    };
 
     const resp = function (callback) {
       const callbacks = {
@@ -55,6 +87,7 @@ export const id5IdSubmodule = {
           if (response) {
             try {
               responseObj = JSON.parse(response);
+              resetNb(configParams);
             } catch (error) {
               utils.logError(error);
             }
@@ -66,10 +99,54 @@ export const id5IdSubmodule = {
           callback();
         }
       };
-      ajax(url, callbacks, undefined, { method: 'GET', withCredentials: true });
+      ajax(url, callbacks, JSON.stringify(data), { method: 'POST', withCredentials: true });
     };
     return {callback: resp};
+  },
+
+  /**
+   * Similar to Submodule#getId, this optional method returns response to for id that exists already.
+   *  If IdResponse#id is defined, then it will be written to the current active storage even if it exists already.
+   *  If IdResponse#callback is defined, then it'll called at the end of auction.
+   *  It's permissible to return neither, one, or both fields.
+   * @function extendId
+   * @param {SubmoduleParams} configParams
+   * @param {Object} cacheIdObj - existing id, if any
+   * @return {(IdResponse|function(callback:function))} A response object that contains id and/or callback.
+   */
+  extendId(configParams, cacheIdObj) {
+    incrementNb(configParams);
+    return cacheIdObj;
   }
 };
 
+function hasRequiredParams(configParams) {
+  if (!configParams || typeof configParams.partner !== 'number') {
+    utils.logError(`User ID - ID5 submodule requires partner to be defined as a number`);
+    return false;
+  }
+  return true;
+}
+function nbCookieName(configParams) {
+  return hasRequiredParams(configParams) ? `${BASE_NB_COOKIE_NAME}-${configParams.partner}-nb` : undefined;
+}
+function nbCookieExpStr(expDays) {
+  return (new Date(Date.now() + expDays)).toUTCString();
+}
+function storeNbInCookie(configParams, nb) {
+  storage.setCookie(nbCookieName(configParams), nb, nbCookieExpStr(NB_COOKIE_EXP_DAYS), 'Lax');
+}
+function getNbFromCookie(configParams) {
+  const cacheNb = storage.getCookie(nbCookieName(configParams));
+  return (cacheNb) ? parseInt(cacheNb) : 0;
+}
+function incrementNb(configParams) {
+  const nb = (getNbFromCookie(configParams) + 1);
+  storeNbInCookie(configParams, nb);
+  return nb;
+}
+function resetNb(configParams) {
+  storeNbInCookie(configParams, 0);
+}
+
 submodule('userId', id5IdSubmodule);
diff --git a/modules/userId/userId.md b/modules/userId/userId.md
@@ -25,12 +25,13 @@ pbjs.setConfig({
         }, {
             name: "id5Id",
             params: {
-                partner: 173 //Set your real ID5 partner ID here for production, please ask for one at http://id5.io/prebid
+                partner: 173, //Set your real ID5 partner ID here for production, please ask for one at https://id5.io/universal-id
+                pd: "some-pd-string" // See https://console.id5.io/docs/public/prebid for details
             },
             storage: {
                 type: "cookie",
                 name: "id5id",
-                expires: 5, // Expiration of cookies in days
+                expires: 90, // Expiration of cookies in days
                 refreshInSeconds: 8*3600 // User Id cache lifetime in seconds, defaulting to 'expires'
             },
         }, {