Publisher API Reference

This page has documentation for the public API methods of Prebid.js.

Find a method

pbjs

  • pbjs.adServers.dfp.buildAdpodVideoUrl(options) [Alpha]
  • pbjs.adServers.dfp.buildVideoUrl(options)
  • pbjs.adServers.freewheel.getTargeting(options)
  • pbjs.addAdUnits(Array|Object)
  • pbjs.aliasBidder(adapterName, aliasedName, options)
  • pbjs.aliasRegistry
  • pbjs.bidderSettings
  • pbjs.enableAnalytics(config)
  • pbjs.getAdserverTargeting()
  • pbjs.getAdserverTargetingForAdUnitCode([adunitCode])
  • pbjs.getAllPrebidWinningBids()
  • pbjs.getAllWinningBids()
  • pbjs.getBidResponses()
  • pbjs.getBidResponsesForAdUnitCode(adUnitCode)
  • pbjs.getConfig([string])
  • pbjs.getConsentMetadata()
  • pbjs.getEvents()
  • pbjs.getHighestCpmBids([adUnitCode])
  • pbjs.getHighestUnusedBidResponseForAdUnitCode(adUnitCode)
  • pbjs.getNoBids()
  • pbjs.getNoBidsForAdUnitCode(adUnitCode)
  • pbjs.getPAAPIBids(options)
  • pbjs.getPAAPIConfig(options)
  • pbjs.getUserIds()
  • pbjs.getUserIdsAsEids()
  • pbjs.getUserIdsAsync()
  • pbjs.installedModules
  • pbjs.markWinningBidAsUsed(markBidRequest)
  • pbjs.mergeBidderConfig(options)
  • pbjs.mergeConfig(options)
  • pbjs.offEvent(eventType, handler, id)
  • pbjs.onEvent(eventType, handler, id)
  • pbjs.readConfig([string])
  • pbjs.refreshUserIds(options, callback)
  • pbjs.registerSignalSources()
  • pbjs.removeAdUnit(adUnitCode)
  • pbjs.renderAd(doc, id, options)
  • pbjs.requestBids(requestObj)
  • pbjs.setBidderConfig(options, mergeFlag)
  • pbjs.setConfig(options)
  • pbjs.setPAAPIConfigForGPT(options)
  • pbjs.setTargetingForAst(adUnitCode)
  • pbjs.setTargetingForGPTAsync([codeArr], customSlotMatching)
  • pbjs.triggerBilling