User ID Module

[idettman]

User ID Module

Type of change

• Feature

Description of change

This module adds a User ID module, which currently includes submodules for Unified ID and Pub Common ID.

Submodule Configuration

Each submodule can configure how it stores user id data to the the browser.

type: sets the browser storage API used to store the user data. The supported types are html5, or cookie

1. html5 uses window.localStorage
2. cookie uses document.cookies

expires: days to expire to locally stored values

name: the name of the key used to store user data

Example

// Activate unifiedId and pubCommonId user data values to be passed to bid adapters
pbjs.setConfig({
  usersync: {
    userIds: [{
      name: "unifiedId",
      params: {
        partner: "PARTNER_ID",
        url: "http://match.adsrvr.org/track/rid?ttd_pid=prebid&fmt=json"
      },
      storage: {
        type: "html5",
        name: "unifiedid",
        expires: 60
      }
    }, {
      name: "pubCommonId",
      storage: {
        type: "cookie",
        name: "pubcid",
        expires: 30
      }
    }],
    syncDelay: 5000
  }
});

[bretg]

@pycnvr , @jsnellbaker , @snapwich - hoping to release this next week with 2.10. I believe Isaac's updated it with the inspection requests except for some features that I propose we hash out in a separate thread.

[pycnvr]

Looks good.

[snapwich]

LGTM

[ETNOL]

@idettman Should this be using userSync and not usersync?