Skip to main content

Premium.jpxApi

Using this component, you can easily access the jpxAPI from within the PremiumJS library. The jpxAPI is an interface with the adproduct code (the infrastructure that serves the ad formats). It is only available when the creative is running live or from a preview link. However, many of the functions have a fallback enabling the format to behave the same when running locally. The following is a list of functions that Premium.jpxApi can directly interface and/or has a fallback equivalent:

  • Premium.jpxApi.on()
  • Premium.jpxApi.addSheet() *
  • Premium.jpxApi.getPercentageVisibility() or Premium.jpxApi.getPercVis()
  • Premium.jpxApi.track()
  • Premium.jpxApi.pushUp()
  • Premium.jpxApi.pushDown()
  • Premium.jpxApi.isMobile()
  • Premium.jpxApi.geo() *
  • Premium.jpxApi.createVideo()
  • Premium.jpxApi.videoEvent()
  • Premium.jpxApi.setCollapsedHeight()
  • Premium.jpxApi.setExpandedHeight()
  • Premium.jpxApi.setHeight() *
  • Premium.jpxApi.makeFixedHeight() *
  • Premium.jpxApi.getFixedElemPosition()

* no local fallback

Full documentation for the jpxApi can be found here: jpxApi