0

How to Build Prebid From Source to Include The Lotame Panorama User ID Module

  • updated 8 mths ago

For publishers looking to have the most direct control over the code running on their sites for performance optimization, unit testing and customization then building the prebid.js library with your choice of adaptors and modules yourself is the best option.

For engineering teams who want to inspect any Prebid.org approved code including the modules and adaptors their github repository is public. The git repo also includes complete instructions for building your own library.

https://github.com/prebid/Prebid.js

ReadMe available directly at https://github.com/prebid/Prebid.js/blob/master/README.md

(Details subject to change)

The instructions for using this documented approach to build your very own copy of prebid.js update regularly with version changes of the tools but at a high level the process requires the following tool chain:

  • git—To clone and access the repo.
  • Babel—A javascript compiler
  • node.js—The javascript run time environment
  • NPM—The node package manager
  • gulp—The task runner used in the build process to automate the package management, run tests

 

Instructions for including the Lotame Panorama ID User ID module

It should be noted per the high level prebid.js article that the production version of prebid.js is a single library. A single file. The addition of User ID modules are additional pieces of code that are added to the single generated javascript library that the build process produces. 

Full details of available modules and their functionality are available here 

https://docs.prebid.org/dev-docs/modules/

The instructions for teams building prebid with the Lotame Panorama ID are listed here:

https://docs.prebid.org/dev-docs/modules/userId.html#lotame-panorama-id

The build instructions provide the gulp task runner instructions to include the necessary Lotame Panorama ID User ID code. 

gulp build –modules=lotamePanoramaIdSystem

 

The Lotame User ID module code is available for review at the Prebid github repo here:

https://github.com/prebid/Prebid.js/blob/master/modules/lotamePanoramaIdSystem.js

At time of writing the module is 360 lines and 9.27 KB in size. Details subject to change.

 

Alternative Directly Managed Solutions

Prebid also provides an on demand, web based custom build tool. This service manages the build process server side for you.

https://docs.prebid.org/download

Simply check the boxes as the features that you’d like to include and you can download a functional version of the prebid.js to the latest version.

This is a useful tool that allows you to quickly test older versions of Prebid, current version at time of writing is 6.2.0, or the implications of using specific modules and adaptors together in testing conditions. 

Use of the dynamically generated prebid.js library in production environments is at the discretion of the publisher. 

Configuring the Lotame Panorama User ID Module

Once the Lotame Panorama ID User ID module has been added to the prebid.js library you need to add the configuration in the client side code that defines how the prebid module is used in the page. 

The client side markup for this configuration can be found on the Prebid.org website at

https://docs.prebid.org/dev-docs/modules/userId.html#lotame-panorama-id

The client side code is:

pbjs.setConfig({
    userSync: {
        userIds: [{
            name: "lotamePanoramaId",
        }]
    }
});


Without this the prebid.js library won’t use the Lotame User ID module that it was built with. 

Here is a test page that has both built the prebid.js library with the Lotame User ID module and added the setConfig() JSON settings.

https://www.lotame.com/projects/prebid/

You can see in the source of the page the userSync object in the setConfig() method is called after the pbjs object is initialized. 

 

Refer to the How to Test the Lotame Panorama User ID Module article to test the implementation with the call to: 

pbjs.getUserIds()

.. in order to return the Panorama ID on your browser

Related articles

Upvote Follow
  • 8 mths agoLast active
  • 175Views
  • 1 Following
Log In