Skip to content

Latest commit

 

History

History
165 lines (149 loc) · 4.57 KB

lockrAIMIdSystem.md

File metadata and controls

165 lines (149 loc) · 4.57 KB

lockr AIM

Alternative Identity Manager (AIM) is a unified container for identity and data management. With AIM’s self-service platform, publishers seamlessly integrate and activate alternative IDs like LiveRamp’s Authenticated Traffic Solution (ATS), Unified ID 2.0 (UID2), ID5 and more. The burden of due diligence and maintenance, coupled with the benefits of server-side calls result in the adoption of multiple alternative IDs, clean rooms like InfoSum and CDPs like Blueconic based on their specific needs.

Account Creation | AIM

Sign up for an Identity lockr account. Setup your app and activate the AIM library. Compile Prebid with the appropriate configurations, and deploy.

Configuration | AIM

First, make sure to add the lockr’s AIM submodule to your Prebid.js package with: The following configuration parameters are available: AIM supports all Single Sign On functions, newsletter registrations, UTM parameters, etc. For the sake of clarity, a few examples are shared below. **Google oAuth: ** If you are using Google oAuth (as an example), the onSignIn function will subsequently call window.lockr.setAdditionalData function and include a raw email.

function onSignIn(googleUser) {
   pbjs.setConfig({
      userSync: {
         userIds: [{
            name: 'lockrAIMId',
            params: {
               email: '[email protected]',
               appID: 'e84afc5f-4adf-4144-949f-1de5bd151fcc'
            }
         }]
      }
    });
}

Facebook oAuth: If you are using Facebook Login (as an example), the statusChangeCallback function will subsequently call window.lockr.setAdditionalData function and include a raw email.

function statusChangeCallback(response) {
   console.log('statusChangeCallback');
   console.log(response);
   if(response.status === 'connected'){
     pbjs.setConfig({
        userSync: {
           userIds: [{
              name: 'lockrAIMId',
              params: {
                 email: '[email protected]',
                 appID: 'e84afc5f-4adf-4144-949f-1de5bd151fcc'
              }
           }]
        }
      });
   }else{
     document.getElementById('status').innerHTML = 'Please login';
   }
}

Note: The above code can be triggered from anywhere on the domain (i.e. a subscription form).

Param Scope Type Description Example
name Required String The name of this module: "lockrAIMId" "lockrAIMId"
params Required Object Details for the configuration.
params.email Required String Email address for identity tokens. [email protected]
params.appID Required String Identity lockr appID [email protected]

lockr AIM Example

pbjs.setConfig({
    userSync: {
       userIds: [{
          name: 'lockrAIMId',
          params: {
             email: '[email protected]',
             appID: 'e84afc5f-4adf-4144-949f-1de5bd151fcc'
          }
       }]
    }
});

Note: lockr’s AIM self-service interface empowers publishers with the ability to pass the alternative IDs activated back to the client as local storage or as a first party cookie. Each Identity Provider can be individually set to restrict from client-side delivery and instead be retained as an authentication event within Identity lockr. In this case no data is lost, but instead maintained for automated or manual sharing to any Data Endpoint.

Troubleshooting and Error handling:

  1. Navigate to the domain where Prebid.js Library is integrated.
  2. Go to the 'Network' tab of your Developer Tools. Search for “prebid.js”
  3. In the application tab, you can confirm any activated Identity Provider (if client-side storage is turned on in AIM’s Identity Provider settings).
  4. Debugging: Enable the debug flag to true in the setConfig call:
pbjs.setConfig({
    debug: true,
    userSync: {
       userIds: [{
          name: 'lockrAIMId',
          params: {
             email: '[email protected]',
             appID: 'e84afc5f-4adf-4144-949f-1de5bd151fcc'
          }
       }]
    }
});