prebid.github.io icon indicating copy to clipboard operation
prebid.github.io copied to clipboard

Add undocumented methods to Publisher API Reference

Open rmloveland opened this issue 7 years ago • 5 comments

Found the following methods in the browser console:

  • bidsAvailableForAdapter
  • clearAuction
  • createBid
  • getAdserverTargetingForAdUnitCodeStr
  • loadScript
  • registerAnalyticsAdapter
  • registerBidAdapter
  • setS2SConfig (Documented in Prebid Server setup docs, but not in API ref)
  • triggerUserSyncs (Partially documented elsewhere on page, but has no entry)

rmloveland avatar Nov 16 '17 22:11 rmloveland

Went through the functions again. Some aren't available in 1.0. This is the updated list:

Adapter-facing

  • createBid
  • registerAnalyticsAdapter
  • registerBidAdapter

Publisher-Facing

  • libloaded
  • cbtimeout
  • version
  • getAdserverTargetingForAdUnitCodeStr + getAdserverTargetingForAdUnitCode - These functions return the query string targeting parameters available at this moment for a given ad unit
  • triggerUserSyncs

bretg avatar Aug 21 '18 19:08 bretg

registerBidAdapter is publisher facing to a degree, see https://gist.github.com/Heray/277d421bda2b827f43da for an example of how a publisher might use this function

patmmccann avatar Mar 11 '21 19:03 patmmccann

@patmmccann Is it possible to use registerAnalyticsAdapter the same way? I can't find any example for it.

EskelCz avatar Feb 14 '22 19:02 EskelCz

I believe so, yes

patmmccann avatar Dec 13 '22 19:12 patmmccann

Discussed in prebid docs committee today

  • as @bretg described, we want to split APIs between public/publisher API and internal/adapter APIs
  • suggestion would be to create a separate file under Reference / Internal API Refernce and clearly mark those an internal

muuki88 avatar Sep 07 '23 14:09 muuki88