Skip to main content
Skip table of contents

Anonymised Real-Time Data Module for Prebid

This should be the easiest method of deployment and used for most installations.

Ensure you are using Prebid v8.47.0 [May 1st 2024] or later.

You may either download Prebid.js and include the Anonymised Real-Time Data (RTD) Module, or build from source code making sure you build including the Anonymised RTD module, for example: gulp build --modules=rtdModule,anonymisedRtdProvider

In either case, use the setConfig command to instruct Prebid.js to initialise the RTD module as follows:

CODE
 pbjs.setConfig({
   realTimeData: {
     dataProviders: [
       {
         name: 'anonymised',
         waitForIt: true,
         params: {
           cohortStorageKey: 'cohort_ids',
           bidders: ['appnexus', 'criteo', 'ix', 'onetag', 'pubmatic', 'smartadserver'],
           segtax: 1000
         }
       }
     ]
   }
 });

Configuration syntax details

Parameter

Parameter type

Description

Notes

name

String

Anonymised RTD module name

Always ‘anonymsied’

waitForIt

Boolean

Required to ensure that the auction is delayed until prefetch is complete

Optional. Defaults to false.

params.cohortStorageKey

String

the localStorage key, where Anonymised segments are located

Always 'cohort_ids'

params.bidders

Array

Bid adaptors to which the segments will sent

Optional but recommended

params.segtax

Integer

The taxonomy for Anonymised

Always '1000' unless guided by support

If you are using TCF Control Module (formerly GDPR Enforcement Module) for Prebid v8.47.0 to v9.4.0 please follow these steps to allow localStorage access from within the RTD module. From Prebid v9.5.0 onwards you do not need to take these steps.

Our RTD module will continue to work with or without this base module.

  1. Review the documentation at https://docs.prebid.org/dev-docs/modules/tcfControl.html and in particular step 2 which discusses DeviceAccess.

  2. Implement the code as suggested, adding anonymised to the vendorExceptions, see example below:

CODE
   ...
   rules: [{
     purpose: "storage",
     enforcePurpose: true,
     enforceVendor: true,
     vendorExceptions: ["anonymised"]
   }]
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.