E-Planning SSP can be implemented through Prebid.js and compete as any source within it.

In order to proceed towards its implementation, E-Planning must be included into its Prebid.js version and configured accordingly.

Content

Prebid.js Download

  1. Go to the Prebid official site and then to the Download section. You can also click here to be redirected automatically.

  2. Select E-Planning and the sources you wish to implement.


    Please note that from Prebid.js version 4.0 onwards it is important to include the userId modules as they are required for the auction.

  3. Once you have selected, download your Prebid.js version and implement it in your site following the detailed instructions in the official docs.

Settings

Once you have installed your new Prebid.js version, you must configure the E-Planning adapter accordingly. The only parameter needed for implementation is ci, which has a unique value regardless of the site, space, or size where it is implemented.

How to Get the ci Parameter

To obtain the ci value for your account, access the platform with your ID and then follow these steps:

  1. Click on Implementation
  2. Click on the Implementation for display chart
  3. Select Pre-bid
  4. Copy the displayed value

Configuration in Prebid.js

Plug the following code into each adUnit within the bids key. You must add your ci value. For example, if your ci value is 18f66:

pbjs.que.push(function() {
    var adUnits = [
        {
            code: 'div-gpt-ad-1438287399331-0',
            sizes: [
                [300, 250],
                [300, 600]
            ],
            bids: [
                {
                    bidder: 'eplanning',
                    params: { ci: '18f66' }
                }
            ]
        }
    ];
});


You can use the example described in the official docs as a guide.

Configuration in bidderSettings

From Prebid.js 7.0 onwards, it is necessary to grant access to the storage. E-Planning stores viewability data, which is necessary for targeting for a large part of our demand. Please include the following values in your Prebid.js configuration:

bidderSettings = {
	eplanning: {
		storageAllowed: true
	}
};


For more information, please refer to the following documentation:
https://docs.prebid.org/dev-docs/publisher-api-reference/bidderSettings.html

Configuration for video inventory

We support video auctions using Prebid.js both for instream and outstream inventory.

To do so, configure the adUnits you want to auction as video by adding mediaType video and the context (instream/outstream). Video takes precedence over Banner, so if an adUnit is configured in both modes it will only be auctioned for video.

In all contexts our adapter will return a VAST document, so it is up to the publisher to implement a video player for rendering.

Please find attached an example of implementation:

<script>
    var pbjs = pbjs || {};
    pbjs.que = pbjs.que || [];
 
    /* Prebid video ad unit */
 
    var videoAdUnit = {
        code: 'video1',
        mediaTypes: {
            video: {
                context: 'instream',
                useCacheKey: 1,
                playerSize: [320, 480],
                mimes: ['video/mp4'],
                protocols: [1, 2, 3, 4, 5, 6, 7, 8],
                playbackmethod: [2],
                skip: 1,
                renderer: {
                    render: function (bid) {
                        invokeVideoPlayer(bid.vastUrl);
                   }
               }
            }
        },
        bids: [{
            bidder: 'eplanning',
            params: {
                ci: "..."
            }
        }]
    };
 
    pbjs.que.push(function() {
        pbjs.addAdUnits(videoAdUnit);
 
        pbjs.setConfig({
            debug: true,
            cache: {
                url: 'https://prebid.adnxs.com/pbc/v1/cache'
            }
        });
 
        pbjs.requestBids({
            bidsBackHandler: function(bids) {
                invokeVideoPlayer(bids.video1.bids[0].vastUrl);
            }
        });
    });
 
</script>

More information and examples can be found in the official Prebid.js documentation for video.

Creation of the Inventory

The corresponding inventory is automatically generated in our platform. Once implementation has completed and E-Planning starts receiving traffic, you will find your sites and spaces within the platform. The platform automatically creates a space for each size received. Given this, if your site is example.com, you will get a taxonomy of this type:

example.com

This configuration can be modified to use the real names of each space within the platform. However, we strongly advise against its use unless it is necessary as the granularity of the created inventory may make its configuration something ambitious. Nonetheless, if you insist in its activation, you can do it through the optional ml parameter that must be added in the Prebid.js configuration.

Additional Docs

You can find additional information on Prebid.js and E-Planning in Prebid.js. We recommend the following external links for further reference: