Prebid JS Integration Document

Have more questions? Submit a request

Overview

This document explains the prebid.js integration with EXCO as a bidder on the client side (publisher website). 

Prerequisites

Before integrating EXCO prebid adapter, ensure the following:

  • Prebid.js is implemented on your website.
  • You have access to EXCO’s ad server and demand sources.

Support

EXCO adapter supported from prebid.js version 9.33.0 and later. 

Note: You might need to update your prebid version or ask your prebid wrapper vendor to add EXCO adapter for your. For more information, see the setup section below. 

Currently, EXCO's adapter supports two different kinds of video implementations: Instream and Outstream.

Video Implementation

Notes

Outstream

Using the mediaType: banner; in this implementation you can benefit from EXCO’s outstream video script creative templates.

In Stream

Instream video using the mediaType: video, using context: instream and plcmt and placement parameters. In-stream Video ads are defined as video ads that play within the context of a video player, either before, during, or after the primary video content.

Setup EXCO Adapter 

For publishers managing their own Prebid integration

  1. Go to the Prebid.js download page
  2. Select the Bidder Adapter "EXCO" and other needed adapters
  3. Click on Get Prebid.js to download the .js file
  4. Update your Prebid setup to include EXCO adapter.

pbjs.setConfig({

    bidders: ['exco'],

});

The client-side configuration of prebid.js is thoroughly documented on the prebid.org website. A good starting point is the Developer section start page, which offers an overview of all the pertinent documentation.

For publishers using a Prebid Wrapper

If you’re using a managed wrapper, reach out to your Prebid Wrapper vendor account manager to ensure EXCO is enabled in the configuration. Important: Vendors on earlier Prebid.js versions must upgrade to 9.33.0 or later.

Configuration 

Setting Bidder Params

To set up EXCO bidder parameters, you’ll need three key parameters - accountId, publisherId, and tagId, provided by your EXCO account manager.

For more information, review EXCO bidder code and bid parameters page in prebid.org developer section.

Name Scope Type Description Example
accountId Required String EXCO Account ID provided by your EXCO representative. 1234o8299782
publisherId Required String EXCO Publisher ID provided by your EXCO representative. ABSCO192JMSO
tagId Required String A unique tag ID identifier 134556677

User Sync

The user syncing process can be configured to manage how bidders sync user IDs with their DSPs. Prebid.js offers complete documentation on the subject that can be found here.

Ensure that EXCO’s bidder can perform iframe type user syncing by declaring a valid filterSettings.iframe object, as EXCO uses iframe-based user syncing.

pbjs.setConfig({

  userSync: {

    "iframe": {

      "bidders": ["exco"],

      "filter":"include"

  }

});

Prebid.js instream example

For more information about instream video ads, refer to the prebid.js developer documentation here.

Below is a code snippet that demonstrates how to configure an instream video ad unit:

var InstreamAdUnit = [{

  code: 'test-div-video',

  mediaTypes: {

   video: {

context: 'instream',

playerSize: [640, 480]

}

   },

   bids: [{

     bidder: 'exco',

     params: {

       publisherId: 'PUBLIHSHER_ID',// required

       tagId: 'TAG_ID',// required

       accountId: 'ACCOUNT_ID',// required

     }

   }]

}]

Prebid.js Outstream example

The snippet below shows the configuration of an outstream video ad unit using the mediaType banner.

In this implementation you can benefit from EXCO’s outstream video script creative templates.

var OutstreamAdUnit = [{

   code: 'test-div-video',

   bids: [{

     bidder: 'exco',

mediaTypes: {

   banner: {sizes: [[300, 250]]}

     },

     params: {

       publisherId: 'PUBLIHSHER_ID',// required

       tagId: 'TAG_ID',// required

       accountId: 'ACCOUNT_ID',// required

     }

   }]

}]

 

Related articles

Was this article helpful?
0 out of 0 found this helpful