Freewheel Module

This module was removed in Prebid.js 11.0. See the Prebid.js 11 release notes.

This module returns the targeting key value pairs for the FreeWheel ad server.

How to use the module

If you are using FreeWheel as your ad server for long-form header bidding then include this module while creating Prebid.js build. Use the exposed getTargeting method to get targeting key value pairs.

Example

pbjs.adServers.freewheel.getTargeting({
    codes: [adUnitCode1],
    callback: function(err, targeting) {
        //pass targeting to player api
    }
});

// Sample return value when brandCategoryExclusion flag is set to true
{
  'adUnitCode-1': [
    {
      'hb_pb_cat_dur': '10.00_400_15s'
    },
    {
      'hb_pb_cat_dur': '15.00_402_30s'
    },
    {
      'hb_cache_id': '123'
    }
  ]
}

// Sample return value
{
  'adUnitCode-1': [
    {
      'hb_pb_cat_dur': '10.00_15s'
    },
    {
      'hb_pb_cat_dur': '15.00_30s'
    },
    {
      'hb_cache_id': '123'
    }
  ]
}

Parameters

Name Type Description Required Default
codes Array AdUnit codes to retrieve targeting for yes n/a
callback Function Function invoked with error and targeting map yes n/a

The values returned by getTargeting are concatenation of CPM, industy code, and video duration. FreeWheel SDK will send those values to FreeWheel Ad Server within the following query:

http://[customerId].v.fwmrm.net/ad/g/1[globalParams];hb_pb_cat_dur=10.00_400_15s&hb_pb_cat_dur=15.00_402_30s&hb_cacheid=123;[ParamsForSlot1];[ParamsForSlot2];...;[ParamsForSlotN];

Further Reading