- getAdRequest() - Method in class com.pubmatic.sdk.openbid.banner.POBBannerView
-
Returns an Object representing OpenBid ad request.
- getAdRequest() - Method in class com.pubmatic.sdk.openbid.core.POBManager
-
- getAdRequest() - Method in class com.pubmatic.sdk.openbid.interstitial.POBInterstitial
-
Returns an instance of POBRequest, required for setting targeting parameters.
- getAdServerUrl() - Method in class com.pubmatic.sdk.openbid.core.POBRequest
-
Returns value of Ad Server Url if it is set by method
- getAdSize() - Method in interface com.pubmatic.sdk.openbid.banner.POBBannerEvent
-
OpenBid SDK calls this method to get the size of the ad rendered by the ad server SDK
- getAdSize() - Method in class com.pubmatic.sdk.openbid.banner.POBDefaultBannerEventHandler
-
- getAdUnitId() - Method in class com.pubmatic.sdk.openbid.core.POBImpression
-
Returns the unique identifier which represents an ad placement on the app screen.
- getBannerRenderer(Context) - Static method in class com.pubmatic.sdk.openbid.core.POBRenderer
-
Method to get Renderer for Banner Ad
- getBidderName() - Method in class com.pubmatic.sdk.openbid.core.POBBid.POBSummary
-
Returns bidder name
- getBidValue() - Method in class com.pubmatic.sdk.openbid.core.POBBid.POBSummary
-
Returns bid value
- getCreative() - Method in class com.pubmatic.sdk.openbid.core.POBBid
-
Returns ad creative
- getCreativeId() - Method in class com.pubmatic.sdk.openbid.core.POBBid
-
Returns the creative Id
- getCreativeSize() - Method in class com.pubmatic.sdk.openbid.banner.POBBannerView
-
Returns the Size of the rendered ad creative
- getCustomData() - Method in interface com.pubmatic.sdk.openbid.interstitial.POBInterstitialEventListener
-
Call this to fetch any additional custom data for handling ad server calls or rendering
- getDealId() - Method in class com.pubmatic.sdk.openbid.core.POBBid
-
Returns deal Id.
- getErrorCode() - Method in class com.pubmatic.sdk.openbid.core.POBBid.POBSummary
-
Returns error code
- getErrorMessage() - Method in class com.pubmatic.sdk.openbid.core.POBBid.POBSummary
-
Returns error message
- getHeight() - Method in class com.pubmatic.sdk.openbid.core.POBBid
-
Returns Height of bid creative
- getHeight() - Method in class com.pubmatic.sdk.openbid.core.POBBid.POBSummary
-
Returns height of a current bid
- getImpression() - Method in class com.pubmatic.sdk.openbid.banner.POBBannerView
-
Returns an instance of impression object created internally.
- getImpression() - Method in class com.pubmatic.sdk.openbid.interstitial.POBInterstitial
-
Returns an instance of POBInterstitialImpression which gets created internally.
- getImpressionId() - Method in class com.pubmatic.sdk.openbid.core.POBBid
-
Returns an Impression Id.
- getImpressionJson() - Method in class com.pubmatic.sdk.openbid.core.POBBannerImpression
-
(Internal for OpenBid SDK)
- getImpressionJson() - Method in class com.pubmatic.sdk.openbid.core.POBImpression
-
(Internal for OpenBid SDK)
- getImpressionJson() - Method in class com.pubmatic.sdk.openbid.core.POBInterstitialImpression
-
- getImpressions() - Method in class com.pubmatic.sdk.openbid.core.POBRequest
-
Returns the array of impression object
- getInterstitialRenderer(Context) - Static method in class com.pubmatic.sdk.openbid.core.POBRenderer
-
Method to get Renderer for Interstitial Ad
- getNetworkTimeout() - Method in class com.pubmatic.sdk.openbid.core.POBRequest
-
Returns the network timeout (in seconds) for making an Ad request.
- getnURL() - Method in class com.pubmatic.sdk.openbid.core.POBBid
-
Returns Win notice URL called by the exchange if the bid wins
- getPartnerName() - Method in class com.pubmatic.sdk.openbid.core.POBBid
-
Returns the name of the winning partner
- getPrice() - Method in class com.pubmatic.sdk.openbid.core.POBBid
-
Returns Price/bid value
- getRefreshInterval() - Method in class com.pubmatic.sdk.openbid.core.POBBid
-
Returns the refresh interval received in ad response
- getRenderableContent() - Method in class com.pubmatic.sdk.openbid.core.POBBid
-
- getRenderer(String) - Method in interface com.pubmatic.sdk.openbid.banner.POBBannerEvent
-
OpenBid SDK calls this method to get the implementation of POBBannerRendering interface to
render ad in custom rendering component.
- getRenderer(String) - Method in class com.pubmatic.sdk.openbid.banner.POBDefaultBannerEventHandler
-
- getRenderer(String) - Method in class com.pubmatic.sdk.openbid.interstitial.POBDefaultInterstitialEventHandler
-
- getRenderer(String) - Method in interface com.pubmatic.sdk.openbid.interstitial.POBInterstitialEvent
-
Optional method to provide implementation of POBInterstitialRendering interface to render ad
in custom rendering component.
- getStatus() - Method in class com.pubmatic.sdk.openbid.core.POBBid
-
Returns Bid status
- getSummary() - Method in class com.pubmatic.sdk.openbid.core.POBBid
-
Returns bid summary for debugging purpose
- getTargetingInfo() - Method in class com.pubmatic.sdk.openbid.core.POBBid
-
Returns the map of targeting information, that needs to be passed to ad server SDK.
- getTargetingInfoWithPricePrecision(int) - Method in class com.pubmatic.sdk.openbid.core.POBBid
-
Returns the map of targeting information, that needs to be passed to ad server SDK with specified price
precision.
- getUserKeywords() - Method in class com.pubmatic.sdk.openbid.core.POBRequest
-
Returns the userKeywords list in the form of comma separated String.
- getValue() - Method in enum com.pubmatic.sdk.openbid.core.POBRequest.AdPosition
-
- getValue() - Method in enum com.pubmatic.sdk.openbid.core.POBRequest.API
-
- getWidth() - Method in class com.pubmatic.sdk.openbid.core.POBBid
-
Returns Width of bid creative
- getWidth() - Method in class com.pubmatic.sdk.openbid.core.POBBid.POBSummary
-
Returns width of a current bid
- onAdClick() - Method in interface com.pubmatic.sdk.openbid.banner.POBBannerEventListener
-
Call this when the ad server SDK informs about click happened on Ad
- onAdClick(POBBannerView) - Method in class com.pubmatic.sdk.openbid.banner.POBBannerView.POBBannerViewListener
-
Notifies that the ad has been clicked
- onAdClick() - Method in interface com.pubmatic.sdk.openbid.interstitial.POBInterstitialEventListener
-
Notifies the listener that the user clicked the ad
- onAdClicked(POBInterstitial) - Method in class com.pubmatic.sdk.openbid.interstitial.POBInterstitial.POBInterstitialListener
-
Notifies that the interstitial ad has been clicked
- onAdClosed() - Method in interface com.pubmatic.sdk.openbid.banner.POBBannerEventListener
-
Call this when the ad server SDK is about to close / collapse an Ad
- onAdClosed(POBBannerView) - Method in class com.pubmatic.sdk.openbid.banner.POBBannerView.POBBannerViewListener
-
Notifies that the banner view has closed the ad on top of the current view.
- onAdClosed(POBInterstitial) - Method in class com.pubmatic.sdk.openbid.interstitial.POBInterstitial.POBInterstitialListener
-
Notifies that the OpenBid view has closed the ad on top of the current view.
- onAdClosed() - Method in interface com.pubmatic.sdk.openbid.interstitial.POBInterstitialEventListener
-
Publisher should call this method to notify the OpenBid SDK about ad close / collapse state
when primary SDK renders the creative.
- onAdFailed(POBBannerView, POBError) - Method in class com.pubmatic.sdk.openbid.banner.POBBannerView.POBBannerViewListener
-
Notifies the listener of an error encountered while loading or rendering an ad.
- onAdFailed(POBInterstitial, POBError) - Method in class com.pubmatic.sdk.openbid.interstitial.POBInterstitial.POBInterstitialListener
-
Notifies the listener of an error encountered while loading or rendering an ad.
- onAdLeftApplication() - Method in interface com.pubmatic.sdk.openbid.banner.POBBannerEventListener
-
Call this when the ad server SDK informs about app leave event as a result of user
interaction.
- onAdLeftApplication() - Method in interface com.pubmatic.sdk.openbid.interstitial.POBInterstitialEventListener
-
Notifies the listener whenever current app goes in the background due to user click
- onAdOpened() - Method in interface com.pubmatic.sdk.openbid.banner.POBBannerEventListener
-
Call this when the ad server SDK is about to open / expand an Ad
- onAdOpened(POBBannerView) - Method in class com.pubmatic.sdk.openbid.banner.POBBannerView.POBBannerViewListener
-
Notifies listener that the banner view has open the ad on top of the current
view/screen, as a result of user interaction.
- onAdOpened(POBInterstitial) - Method in class com.pubmatic.sdk.openbid.interstitial.POBInterstitial.POBInterstitialListener
-
Notifies that the OpenBid view will open an ad on top of the current view.
- onAdOpened() - Method in interface com.pubmatic.sdk.openbid.interstitial.POBInterstitialEventListener
-
Publisher should call this method to notify the OpenBid SDK about ad open / expand state
when primary SDK renders the creative.
- onAdReceived(POBBannerView) - Method in class com.pubmatic.sdk.openbid.banner.POBBannerView.POBBannerViewListener
-
Notifies the listener that an ad has been successfully loaded and rendered.
- onAdReceived(POBInterstitial) - Method in class com.pubmatic.sdk.openbid.interstitial.POBInterstitial.POBInterstitialListener
-
Notifies the listener that an ad has been received successfully.
- onAdServerWin(View) - Method in interface com.pubmatic.sdk.openbid.banner.POBBannerEventListener
-
Call this when the ad server SDK renders its own ad
- onAdServerWin() - Method in interface com.pubmatic.sdk.openbid.interstitial.POBInterstitialEventListener
-
Publisher should call this method to notify the OpenBid SDK about ad server SDK renders its
own ad
- onAppLeaving(POBBannerView) - Method in class com.pubmatic.sdk.openbid.banner.POBBannerView.POBBannerViewListener
-
Notifies the listener whenever current app goes in the background due to user click.
- onAppLeaving(POBInterstitial) - Method in class com.pubmatic.sdk.openbid.interstitial.POBInterstitial.POBInterstitialListener
-
Notifies the listener that a user interaction will open another app (e.g.
- onAttachedToWindow() - Method in class com.pubmatic.sdk.openbid.banner.POBBannerView
-
Default View callback method
- onBidsFailed(POBError) - Method in interface com.pubmatic.sdk.openbid.core.POBManager.PMWrapperManagerListener
-
Failure callback for prefetch.
- onBidsFetched(Map<String, POBBid>) - Method in interface com.pubmatic.sdk.openbid.core.POBManager.PMWrapperManagerListener
-
Success callback for prefetch request on PubMatic Server.
- onDetachedFromWindow() - Method in class com.pubmatic.sdk.openbid.banner.POBBannerView
-
- onFailed(POBError) - Method in interface com.pubmatic.sdk.openbid.banner.POBBannerEventListener
-
Call this when the ad server SDK fails to load the ad
- onFailed(POBError) - Method in interface com.pubmatic.sdk.openbid.interstitial.POBInterstitialEventListener
-
Publisher should call this method to notify the OpenBid SDK about any kind of error
scenario may be when primary SDK gives error.
- onOpenBidPartnerWin() - Method in interface com.pubmatic.sdk.openbid.banner.POBBannerEventListener
-
Call this when the ad server SDK signals about PubMatic OpenBid bid win
- onOpenBidPartnerWin() - Method in interface com.pubmatic.sdk.openbid.interstitial.POBInterstitialEventListener
-
Publisher should call this method to notify the OpenBid SDK if partner's bid win.
- ORIENTATION_KEY - Static variable in class com.pubmatic.sdk.openbid.interstitial.POBInterstitial
-
- ORTB_VERSION - Static variable in class com.pubmatic.sdk.openbid.core.POBConstants
-
- ORTB_VERSION_PARAM - Static variable in class com.pubmatic.sdk.openbid.core.POBConstants
-
- parse(JSONObject) - Method in class com.pubmatic.sdk.openbid.core.internal.POBResponseParser
-
Method is used to parse the response data and post response on
PMResponseParserListener specific callback methods
- pmZoneId - Variable in class com.pubmatic.sdk.openbid.core.POBImpression
-
This parameter is used to pass a zone ID for reporting.
- POBBannerEvent - Interface in com.pubmatic.sdk.openbid.banner
-
The banner custom event interface.
- POBBannerEventListener - Interface in com.pubmatic.sdk.openbid.banner
-
The banner custom event listener.
- POBBannerImpression - Class in com.pubmatic.sdk.openbid.core
-
This class holds the information of banner impression.
- POBBannerView - Class in com.pubmatic.sdk.openbid.banner
-
The view class that displays the banner ad.
- POBBannerView(Context) - Constructor for class com.pubmatic.sdk.openbid.banner.POBBannerView
-
Used to create instances when placed in XML layouts.
- POBBannerView(Context, AttributeSet) - Constructor for class com.pubmatic.sdk.openbid.banner.POBBannerView
-
Used to create instances when placed in XML layouts.
- POBBannerView(Context, AttributeSet, int) - Constructor for class com.pubmatic.sdk.openbid.banner.POBBannerView
-
Used to create instances when placed in XML layouts with default style.
- POBBannerView(Context, String, int, String, POBBannerEvent) - Constructor for class com.pubmatic.sdk.openbid.banner.POBBannerView
-
Constructor
Initializes and returns a newly allocated banner view object
Publisher should create object of POBBannerView using this constructor when instantiating
from java code.
- POBBannerView(Context, String, int, String, POBAdSize...) - Constructor for class com.pubmatic.sdk.openbid.banner.POBBannerView
-
Constructor
Initializes and returns a newly allocated banner view object for supporting ‘No Ad Server Configuration’
Publisher should create object of POBBannerView using this constructor when instantiating
from code.
- POBBannerView.POBBannerViewListener - Class in com.pubmatic.sdk.openbid.banner
-
Static member class for interaction with the POBBannerView.
- POBBannerViewListener() - Constructor for class com.pubmatic.sdk.openbid.banner.POBBannerView.POBBannerViewListener
-
- POBBid - Class in com.pubmatic.sdk.openbid.core
-
Holds information of winning bid along with all the bids that participated in the auction.
- POBBid() - Constructor for class com.pubmatic.sdk.openbid.core.POBBid
-
- POBBid.POBSummary - Class in com.pubmatic.sdk.openbid.core
-
POBSummary class instance holds the information of a single bid which participated in the
auction.
- POBBidsBuilder - Class in com.pubmatic.sdk.openbid.core.internal
-
POBBidsBuilder class builds the wrapper ad descriptor object for rendering wrapper ad
from the provided ad response (Generic model for ad) object
- POBBidsBuilder() - Constructor for class com.pubmatic.sdk.openbid.core.internal.POBBidsBuilder
-
- POBConstants - Class in com.pubmatic.sdk.openbid.core
-
- POBConstants() - Constructor for class com.pubmatic.sdk.openbid.core.POBConstants
-
- POBDefaultBannerEventHandler - Class in com.pubmatic.sdk.openbid.banner
-
This is EventHandler class used when publisher do not want to support primary ad server.
- POBDefaultBannerEventHandler(POBAdSize...) - Constructor for class com.pubmatic.sdk.openbid.banner.POBDefaultBannerEventHandler
-
Constructor
Accepts POBAdSize and initialize POBDefaultBannerEventHandler
- POBDefaultInterstitialEventHandler - Class in com.pubmatic.sdk.openbid.interstitial
-
This is EventHandler class used when publisher do not want to support primary ad server.
- POBDefaultInterstitialEventHandler() - Constructor for class com.pubmatic.sdk.openbid.interstitial.POBDefaultInterstitialEventHandler
-
- POBImpression - Class in com.pubmatic.sdk.openbid.core
-
Holds the general information about an ad impression.
- POBImpression(String, String) - Constructor for class com.pubmatic.sdk.openbid.core.POBImpression
-
Constructor.
- POBInterstitial - Class in com.pubmatic.sdk.openbid.interstitial
-
Displays full-screen interstitial ads.
- POBInterstitial(Context, String, int, String, POBInterstitialEvent) - Constructor for class com.pubmatic.sdk.openbid.interstitial.POBInterstitial
-
Constructor.
- POBInterstitial(Context, String, int, String) - Constructor for class com.pubmatic.sdk.openbid.interstitial.POBInterstitial
-
Constructor.
- POBInterstitial.POBInterstitialListener - Class in com.pubmatic.sdk.openbid.interstitial
-
Static member class for interaction with the POBInterstitial instance.
- POBInterstitialEvent - Interface in com.pubmatic.sdk.openbid.interstitial
-
The OpenBid interstitial custom event interface.
- POBInterstitialEventListener - Interface in com.pubmatic.sdk.openbid.interstitial
-
OpenBid interstitial custom event listener.
- POBInterstitialImpression - Class in com.pubmatic.sdk.openbid.core
-
This class object holds the information of banner impression.
- POBInterstitialListener() - Constructor for class com.pubmatic.sdk.openbid.interstitial.POBInterstitial.POBInterstitialListener
-
- POBManager - Class in com.pubmatic.sdk.openbid.core
-
This class is responsible for fetching the bids from PubMatic ad server.
- POBManager(POBRequest, Context) - Constructor for class com.pubmatic.sdk.openbid.core.POBManager
-
Constructor
- POBManager.PMWrapperManagerListener - Interface in com.pubmatic.sdk.openbid.core
-
Listener to channel result events of a prefetch request.
- POBRenderer - Class in com.pubmatic.sdk.openbid.core
-
- POBRenderer() - Constructor for class com.pubmatic.sdk.openbid.core.POBRenderer
-
- POBRequest - Class in com.pubmatic.sdk.openbid.core
-
Class to represent the OpenBid ad request.
- POBRequest.AdPosition - Enum in com.pubmatic.sdk.openbid.core
-
Fold placement of the ad to be served.
- POBRequest.API - Enum in com.pubmatic.sdk.openbid.core
-
Supported API of the ad to be served.
- POBResponseParser - Class in com.pubmatic.sdk.openbid.core.internal
-
POBResponseParser class parses the PubMatic wrapper ad response and revert the status with
the callback methods of PMResponseParserListener
- POBResponseParser() - Constructor for class com.pubmatic.sdk.openbid.core.internal.POBResponseParser
-
- POBSummary() - Constructor for class com.pubmatic.sdk.openbid.core.POBBid.POBSummary
-
- PUBMATIC_DM_SERVER_SECURE_URL - Static variable in class com.pubmatic.sdk.openbid.core.POBConstants
-
- PUBMATIC_DM_SERVER_URL - Static variable in class com.pubmatic.sdk.openbid.core.POBConstants
-
- setAdPosition(POBRequest.AdPosition) - Method in class com.pubmatic.sdk.openbid.core.POBBannerImpression
-
Sets the fold placement of the ad to be served.
- setAdServerUrl(String) - Method in class com.pubmatic.sdk.openbid.core.POBRequest
-
Setter method to set Ad Server Url
Custom server URL for debugging purpose.
- setAdSizes(POBAdSize...) - Method in class com.pubmatic.sdk.openbid.core.POBBannerImpression
-
Set the required ad sizes.
- setCustomParam(Map<String, List<String>>) - Method in class com.pubmatic.sdk.openbid.core.POBImpression
-
Adds custom key-value parameters in an Ad request.
- setEventListener(POBBannerEventListener) - Method in interface com.pubmatic.sdk.openbid.banner.POBBannerEvent
-
OpenBid SDK calls this method to set POBBannerEventListener, so OpenBid custom event handler
can inform the OpenBid SDK about the events related to the ad server communication.
- setEventListener(POBBannerEventListener) - Method in class com.pubmatic.sdk.openbid.banner.POBDefaultBannerEventHandler
-
Method to set POBBannerEventListener to get request ad callback
- setEventListener(POBInterstitialEventListener) - Method in class com.pubmatic.sdk.openbid.interstitial.POBDefaultInterstitialEventHandler
-
Method to set POBBannerEventListener to get request ad callback
- setEventListener(POBInterstitialEventListener) - Method in interface com.pubmatic.sdk.openbid.interstitial.POBInterstitialEvent
-
OpenBid SDK calls this method to pass the EventListener to publisher.
- setListener(POBBannerView.POBBannerViewListener) - Method in class com.pubmatic.sdk.openbid.banner.POBBannerView
-
Sets instance of POBBannerViewListener for the ad view.
- setListener(PMAdBuilding.PMAdBuilderListener<Map<String, POBBid>>) - Method in class com.pubmatic.sdk.openbid.core.internal.POBBidsBuilder
-
- setListener(PMResponseParsing.PMResponseParserListener) - Method in class com.pubmatic.sdk.openbid.core.internal.POBResponseParser
-
Method is used to set PMResponseParserListener
- setListener(POBInterstitial.POBInterstitialListener) - Method in class com.pubmatic.sdk.openbid.interstitial.POBInterstitial
-
Sets instance of POBInterstitialListener for getting callbacks
- setNetworkTimeout(int) - Method in class com.pubmatic.sdk.openbid.core.POBRequest
-
Sets the network timeout (in seconds) for making an Ad request.
- setPMZoneId(String) - Method in class com.pubmatic.sdk.openbid.core.POBImpression
-
Set the zone id.
- setUserKeywords(String) - Method in class com.pubmatic.sdk.openbid.core.POBRequest
-
Sets the userKeywords list in the form of comma separated String.
- setVersionId(int) - Method in class com.pubmatic.sdk.openbid.core.POBRequest
-
This is an optional OpenBid version Id of the publisher.
- setVisibility(int) - Method in class com.pubmatic.sdk.openbid.banner.POBBannerView
-
Default View visibility setter
- setWrapperListener(POBManager.PMWrapperManagerListener) - Method in class com.pubmatic.sdk.openbid.core.POBManager
-
Sets the listener to get the callback of PubMatic Wrapper bids
- show() - Method in class com.pubmatic.sdk.openbid.interstitial.POBDefaultInterstitialEventHandler
-
- show() - Method in class com.pubmatic.sdk.openbid.interstitial.POBInterstitial
-
Presents an interstitial ad in full screen view until the user dismisses it.
- show() - Method in interface com.pubmatic.sdk.openbid.interstitial.POBInterstitialEvent
-
OpenBid SDK will call this method when publisher app calls show on POBInterstitial.