Configure Prebid.js for ATS

Go to Prebid.org

Select the latest version of Prebid.js core.

Include the following ATS / RampID compatible modules:

After you download your properly-configured Prebid.js file, update your call to pbjs.setConfig to pass the required information to the RampID user ID module and Google PAIR ID module (if included).

Passing to RampID Module

The code examples below illustrate what your call should look like based on where the envelopes are being stored. See Configure Envelope Settings to learn where you can find this setting for ATS for Web.

Identity envelope stored in a cookie:

pbjs.setConfig({
    userSync: {
        userIds: [{
            name: "identityLink",
            params: {
                pid: '999',             // Set your ATS Placement ID here
                notUse3P: true/false    // If you want to generate and use a RampID based on a LiveRamp 3p cookie (from a previous authentication) until ATS can generate a new RampID, set this property to false.
            },
            storage: {
                type: "cookie",
                name: "idl_env",        // "idl_env" is the required storage name
                expires: 15,            // Identity envelope can last for 15 days
                refreshInSeconds: 1800  // Identity envelope will be updated every 30 minutes
            }
        }],
        syncDelay: 3000                 // 3 seconds after the first auction
    }
});

Identity envelope stored in local storage:

pbjs.setConfig({
    userSync: {
        userIds: [{
            name: "identityLink",
            params: {
                pid: '999',             // Set your ATS Placement ID here
                notUse3P: true/false    // If you want to generate a RampID based on a LiveRamp 3p cookie (from a previous authentication) until ATS can generate a new RampID, set this property to false.
            },
            storage: {
                type: "html5",
                name: "idl_env",        // "idl_env" is the required storage name
                expires: 15,            // Identity envelope can last for 15 days
                refreshInSeconds: 1800  // Identity envelope will be updated every 30 minutes
            }
        }],
        syncDelay: 3000                 // 3 seconds after the first auction
    }
});

Passing to both RampID and Google PAIR ID Modules (Optional)

If you've included the Google PAIR ID module in your Prebid configuration, you can pass the required information to both Ramp ID and Google PAIR ID modules at the same time. The code example below illustrates how this can be done whether your envelopes are stored in a cookie or local storage:

pbjs.setConfig({
    userSync: {
        userIds: [{
        name: 'pairId',
        params: {
                liveramp: {
                    storageKey: '_lr_pairId'
                }
            },
      }]
    }
});

Navigate to one of the pages of your website where ATS is installed and provide the identifier.

To ensure that your ATS.js (ATS for Web) or ATS API-only implementation was able to resolve the identifier and store the identity envelope in configured storage, open the browser console and enter window.ats.retrieveEnvelope();. The response should contain an identity envelope in a string value. If you've implemented the Google PAIR ID Module, you should also see a PAIR ID.

Open a Prebid-enabled page on your site.

To ensure that Prebid returns an identity envelope, open the browser console and enter pbjs.getUserIds();. You should see an idl_env object and, if you implemented the Google PAIR ID Module, a pairId object.

Switch to the "Network" tab and see if the envelopes (and PAIR IDs) are being pushed to SSPs (Suply-Side Platforms) in ad calls. Any POST should surface eids that would include the identity envelope and PAIR ID if implemented. See the example below: