Skip navigation links
A B C D E G H I K L O P R S T V 

A

addBidderSlotInfo(String, Map) - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView
To add slot details for a specific bidder.
addBidderSlotInfo(String, Map) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial
To add slot details for a specific bidder.
addParamToJson(JSONObject, String, String) - Method in class com.pubmatic.sdk.openwrap.core.POBRequestBuilder
Utitity method to pub key values to provided json object
adPosition - Variable in class com.pubmatic.sdk.openwrap.core.POBImpression
 
adUnitId - Variable in class com.pubmatic.sdk.openwrap.core.POBImpression
The unique identifier which represents an ad placement on the app screen.
AUCTION_ID_KEY - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
AUCTION_PRICE_KEY - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 

B

BIDDER_RESP_BIDS_KEY - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
BIDDER_RESP_ERROR_KEY - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
BIDDER_RESP_REQUEST_OBJECT_KEY - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
build(PMAdResponse) - Method in class com.pubmatic.sdk.openwrap.core.internal.POBBidsBuilder
 
build(String, JSONObject) - Static method in class com.pubmatic.sdk.openwrap.core.POBBid
Initializes and returns POBBid object with given bid details and partner name
build() - Method in class com.pubmatic.sdk.openwrap.core.POBRequestBuilder
Method prepares the PMHttpRequest from the necessary member variables

C

com.pubmatic.sdk.openwrap.banner - package com.pubmatic.sdk.openwrap.banner
 
com.pubmatic.sdk.openwrap.core - package com.pubmatic.sdk.openwrap.core
 
com.pubmatic.sdk.openwrap.core.internal - package com.pubmatic.sdk.openwrap.core.internal
 
com.pubmatic.sdk.openwrap.interstitial - package com.pubmatic.sdk.openwrap.interstitial
 
create(POBBid, Map<String, String>) - Static method in class com.pubmatic.sdk.openwrap.core.POBBid
 
createInstance(String, int, POBImpression...) - Static method in class com.pubmatic.sdk.openwrap.core.POBRequest
Returns the object of the POBRequest with provided parameters.

D

destroy() - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView
Invoke this method when your activity/fragment is about to destroy.
destroy() - Method in class com.pubmatic.sdk.openwrap.banner.POBDefaultBannerEventHandler
Method to do the cleanup
destroy() - Method in interface com.pubmatic.sdk.openwrap.core.POBBaseEvent
OpenWrap SDK calls this method to perform any final cleanup.
destroy() - Method in class com.pubmatic.sdk.openwrap.core.POBBiddingManager
 
destroy() - Method in class com.pubmatic.sdk.openwrap.core.POBManager
Release resources, clear maps and reset the adViews used.
destroy() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBDefaultInterstitialEventHandler
Method to do cleanup
destroy() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial
Invoke this method when your activity/fragment is about to destroy.

E

enableBidSummary(boolean) - Method in class com.pubmatic.sdk.openwrap.core.POBRequest
Set to true if summary in response should be enabled.
enableDebugState(boolean) - Method in class com.pubmatic.sdk.openwrap.core.POBRequest
Enable/Disable debug information in the response.
enableTestMode(boolean) - Method in class com.pubmatic.sdk.openwrap.core.POBRequest
Setter method to set Test mode of the request By default set to false When set to true, PubMatic may deliver only test ads which are not billable.

G

getAdPosition() - Method in class com.pubmatic.sdk.openwrap.core.POBImpression
Returns the Fold placement of the ad to be served.
getAdRequest() - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView
Returns an Object representing OpenWrap ad request.
getAdRequest() - Method in class com.pubmatic.sdk.openwrap.core.POBManager
 
getAdRequest() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial
Returns an instance of POBRequest, required for setting targeting parameters.
getAdServerUrl() - Method in class com.pubmatic.sdk.openwrap.core.POBRequest
Returns value of Ad Server Url if it is set by method
getAdSize() - Method in interface com.pubmatic.sdk.openwrap.banner.POBBannerEvent
OpenWrap SDK calls this method to get the size of the ad rendered by the ad server SDK
getAdSize() - Method in class com.pubmatic.sdk.openwrap.banner.POBDefaultBannerEventHandler
 
getAdUnitId() - Method in class com.pubmatic.sdk.openwrap.core.POBImpression
Returns the unique identifier which represents an ad placement on the app screen.
getAppJson(String) - Method in class com.pubmatic.sdk.openwrap.core.POBRequestBuilder
Used to get app json.
getBannerRenderer(Context) - Static method in class com.pubmatic.sdk.openwrap.core.POBRenderer
Method to get Renderer for Banner Ad
getBidderName() - Method in class com.pubmatic.sdk.openwrap.core.POBBid.POBSummary
Returns bidder name
getBidValue() - Method in class com.pubmatic.sdk.openwrap.core.POBBid.POBSummary
Returns bid value
getBody() - Method in class com.pubmatic.sdk.openwrap.core.POBRequestBuilder
Create ortb request body for ad
getContentHeight() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
 
getContentWidth() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
 
getCreative() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
Returns ad creative
getCreativeId() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
Returns the creative Id
getCreativeSize() - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView
Returns the Size of the rendered ad creative
getCrType() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
Returns type of creative is going to serve
getCurrencyJson() - Method in class com.pubmatic.sdk.openwrap.core.POBRequestBuilder
Get currency json array
getCustomData() - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEventListener
Call this to fetch any additional custom data for handling ad server calls or rendering
getDealId() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
Returns deal Id.
getDeviceObject() - Method in class com.pubmatic.sdk.openwrap.core.POBRequestBuilder
Builds oRTB specific device info json, Internally it uses device info PMDeviceInfo to fetch device specific values.
getErrorCode() - Method in class com.pubmatic.sdk.openwrap.core.POBBid.POBSummary
Returns error code
getErrorMessage() - Method in class com.pubmatic.sdk.openwrap.core.POBBid.POBSummary
Returns error message
getHeight() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
Returns Height of bid creative
getHeight() - Method in class com.pubmatic.sdk.openwrap.core.POBBid.POBSummary
Returns height of a current bid
getId() - Method in class com.pubmatic.sdk.openwrap.core.POBImpression
Returns the unique identifier of the impression.
getIdentifier() - Method in interface com.pubmatic.sdk.openwrap.core.POBBidderIdentifier
 
getImpression() - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView
Returns an instance of impression object created internally.
getImpression() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial
Returns an instance of POBImpression which gets created internally.
getImpressionId() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
Returns an Impression Id.
getImpressionJson() - Method in class com.pubmatic.sdk.openwrap.core.POBImpression
(Internal for OpenWrap SDK)
getImpressions() - Method in class com.pubmatic.sdk.openwrap.core.POBRequest
Returns the array of impression object
getInterstitialRenderer(Context) - Static method in class com.pubmatic.sdk.openwrap.core.POBRenderer
To get Renderer for Interstitial Ad
getlURL() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
Returns Loss notice URL called by the exchange if the bid lose.
getNetworkTimeout() - Method in class com.pubmatic.sdk.openwrap.core.POBRequest
Returns the network timeout (in seconds) for making an Ad request.
getNewInstance(Context, POBBiddingPartnerService<POBBid>, POBRequest, Map<String, Map>) - Static method in class com.pubmatic.sdk.openwrap.core.POBBiddingManager
Creates the the bidding manager instance, sets auction executor & adds runtime bidders using POBBiddingPartnerService implementor.
getnURL() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
Returns Win notice URL called by the exchange if the bid wins
getOWConfig() - Method in class com.pubmatic.sdk.openwrap.core.POBBiddingManager
 
getOWConfig() - Method in class com.pubmatic.sdk.openwrap.core.POBManager
 
getPartnerName() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
Returns the name of the winning partner
getPrice() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
Returns Price/bid value
getRawBid() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
 
getRefreshInterval() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
Returns the refresh interval received in ad response
getRegsJson() - Method in class com.pubmatic.sdk.openwrap.core.POBRequestBuilder
Create ortb regs json for ad request
getRenderableContent() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
 
getRenderer(String) - Method in interface com.pubmatic.sdk.openwrap.banner.POBBannerEvent
OpenWrap 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.openwrap.banner.POBDefaultBannerEventHandler
 
getRenderer(String) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBDefaultInterstitialEventHandler
 
getRenderer(String) - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEvent
Optional method to provide implementation of POBInterstitialRendering interface to render ad in custom rendering component.
getRTBJson(Set<Integer>) - Method in class com.pubmatic.sdk.openwrap.core.POBBanner
(Internal for OpenWrap SDK)
getRTBJson() - Method in class com.pubmatic.sdk.openwrap.core.POBVideo
Used to create Video Json object on impression
getSizeArray(POBAdSize...) - Method in class com.pubmatic.sdk.openwrap.core.POBBanner
Provides Json Array for (Internal for OpenWrap SDK)
getStatus() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
Returns Bid status
getSummary() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
Returns bid summary for debugging purpose
getSupportedAPIs() - Method in class com.pubmatic.sdk.openwrap.core.POBBanner
List of supported API frameworks for this banner.
getTargetingInfo() - Method in class com.pubmatic.sdk.openwrap.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.openwrap.core.POBBid
Returns the map of targeting information, that needs to be passed to ad server SDK with specified price precision.
getTestCreativeId() - Method in class com.pubmatic.sdk.openwrap.core.POBImpression
Returns a test creative id.
getTestMode() - Method in class com.pubmatic.sdk.openwrap.core.POBRequest
Returns test Mode of the OpenWrap request
getValue() - Method in enum com.pubmatic.sdk.openwrap.core.POBRequest.AdPosition
 
getValue() - Method in enum com.pubmatic.sdk.openwrap.core.POBRequest.API
 
getValue() - Method in enum com.pubmatic.sdk.openwrap.core.POBVideo.Linearity
 
getValue() - Method in enum com.pubmatic.sdk.openwrap.core.POBVideo.Placement
 
getWidth() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
Returns Width of bid creative
getWidth() - Method in class com.pubmatic.sdk.openwrap.core.POBBid.POBSummary
Returns width of a current bid

H

hasWon() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
To get winning status with respect to primary ad server.

I

id - Variable in class com.pubmatic.sdk.openwrap.core.POBImpression
This parameter is used to hold impression identifier
init(String, int, String, POBBannerEvent) - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView
Initializes newly allocated banner view object.
init(String, int, String, POBAdSize...) - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView
Initializes newly allocated banner view object for supporting ‘No Ad Server Configuration’ Invoke this method only if POBBannerView is inflated via xml resource.
isDebugStateEnabled() - Method in class com.pubmatic.sdk.openwrap.core.POBRequest
Returns the debug state.
isInterstitial() - Method in class com.pubmatic.sdk.openwrap.core.POBImpression
 
isReady() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial
Method to check whether the ad is loaded and ready to show InterstitialAd.
isVideo() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
 

K

KEY_APP - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_AT - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_BANNER - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_BUNDLE - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_CARRIER - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_CLICK_BROWSER - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_CONNECTION_TYPE - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_CURRENCY - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_DEVICE - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_DEVICE_TYPE - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_DISPLAY_MANAGER - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_DISPLAY_MANAGER_VERSION - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_EXTENSION - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_FORMAT - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_GDPR - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_GDPR_CONSENT - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_H - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_ID - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_IFA - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_IMPRESSION - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_INTERSTITIAL - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_JS - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_LANGUAGE - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_LMT - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_MAKE - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_MCCMNC - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_MD5 - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_MODEL - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_OS - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_OS_VERSION - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_POSITION - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_PUBLISHER - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_PXRATIO - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_REGS - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_SECURE - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_SHA1 - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_SOURCE - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_TAG_ID - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_USER - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_USER_AGENT - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_VERSION - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_VIDEO - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_W - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
KEY_WRAPPER - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 

L

loadAd() - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView
Initiate the loading of a banner ad
loadAd() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial
Initiate the loading of an interstitial ad

O

onAdClick() - Method in interface com.pubmatic.sdk.openwrap.banner.POBBannerEventListener
Call this when the ad server SDK informs about click happened on Ad
onAdClick() - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEventListener
Notifies the listener that the user clicked the ad
onAdClicked(POBInterstitial) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial.POBInterstitialListener
Notifies that the interstitial ad has been clicked
onAdClosed() - Method in interface com.pubmatic.sdk.openwrap.banner.POBBannerEventListener
Call this when the ad server SDK is about to close / collapse an Ad
onAdClosed(POBBannerView) - Method in class com.pubmatic.sdk.openwrap.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.openwrap.interstitial.POBInterstitial.POBInterstitialListener
Notifies that the OpenWrap view has closed the ad on top of the current view.
onAdClosed() - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEventListener
Publisher should call this method to notify the OpenWrap SDK about ad close / collapse state when primary SDK renders the creative.
onAdExpired(POBInterstitial) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial.POBInterstitialListener
Notifies that the interstitial ad has been expired.
onAdFailed(POBBannerView, POBError) - Method in class com.pubmatic.sdk.openwrap.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.openwrap.interstitial.POBInterstitial.POBInterstitialListener
Notifies the listener of an error encountered while loading or rendering an ad.
onAdLeftApplication() - Method in interface com.pubmatic.sdk.openwrap.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.openwrap.interstitial.POBInterstitialEventListener
Notifies the listener whenever current app goes in the background due to user click
onAdOpened() - Method in interface com.pubmatic.sdk.openwrap.banner.POBBannerEventListener
Call this when the ad server SDK is about to open / expand an Ad
onAdOpened(POBBannerView) - Method in class com.pubmatic.sdk.openwrap.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.openwrap.interstitial.POBInterstitial.POBInterstitialListener
Notifies that the OpenWrap view will open an ad on top of the current view.
onAdOpened() - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEventListener
Publisher should call this method to notify the OpenWrap SDK about ad open / expand state when primary SDK renders the creative.
onAdReceived(POBBannerView) - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView.POBBannerViewListener
Notifies the listener that an ad has been successfully loaded and rendered.
onAdReceived(POBInterstitial) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial.POBInterstitialListener
Notifies the listener that an ad has been received successfully.
onAdServerWin(View) - Method in interface com.pubmatic.sdk.openwrap.banner.POBBannerEventListener
Call this when the ad server SDK renders its own ad
onAdServerWin() - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEventListener
Publisher should call this method to notify the OpenWrap SDK about ad server SDK renders its own ad
onAppLeaving(POBBannerView) - Method in class com.pubmatic.sdk.openwrap.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.openwrap.interstitial.POBInterstitial.POBInterstitialListener
Notifies the listener that a user interaction will open another app (e.g.
onBidsFailed(POBBidding<POBBid>, POBError, Map<String, Map<String, Object>>) - Method in class com.pubmatic.sdk.openwrap.core.POBBiddingManager
 
onBidsFetched(POBBidding<POBBid>, List<POBBid>, Map<String, Map<String, Object>>) - Method in class com.pubmatic.sdk.openwrap.core.POBBiddingManager
 
onFailed(POBError) - Method in interface com.pubmatic.sdk.openwrap.banner.POBBannerEventListener
Call this when the ad server SDK fails to load the ad
onFailed(POBError) - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEventListener
Publisher should call this method to notify the OpenWrap SDK about any kind of error scenario may be when primary SDK gives error.
onOpenWrapPartnerWin() - Method in interface com.pubmatic.sdk.openwrap.banner.POBBannerEventListener
Call this when the ad server SDK signals about PubMatic OpenWrap bid win
onOpenWrapPartnerWin() - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEventListener
Publisher should call this method to notify the OpenWrap SDK if partner's bid win.
onVideoPlaybackCompleted(POBInterstitial) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial.POBVideoListener
Notifies the listener that the playback of the video ad has been completed.
ORTB_VERSION - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
ORTB_VERSION_PARAM - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 

P

parse(JSONObject) - Method in class com.pubmatic.sdk.openwrap.core.internal.POBResponseParser
Method is used to parse the response data and post response on PMResponseParserListener specific callback methods
perform(List<POBBid>) - Method in class com.pubmatic.sdk.openwrap.core.POBPriceBaseAuctioning
 
pmZoneId - Variable in class com.pubmatic.sdk.openwrap.core.POBImpression
This parameter is used to pass a zone ID for reporting.
POBBanner - Class in com.pubmatic.sdk.openwrap.core
This class holds the information of banner impression.
POBBanner(POBAdSize...) - Constructor for class com.pubmatic.sdk.openwrap.core.POBBanner
Constructor
POBBannerEvent - Interface in com.pubmatic.sdk.openwrap.banner
The banner custom event interface.
POBBannerEventListener - Interface in com.pubmatic.sdk.openwrap.banner
The banner custom event listener.
POBBannerView - Class in com.pubmatic.sdk.openwrap.banner
The view class that displays the banner ad.
POBBannerView(Context) - Constructor for class com.pubmatic.sdk.openwrap.banner.POBBannerView
Used to create instances when placed in XML layouts.
POBBannerView(Context, AttributeSet) - Constructor for class com.pubmatic.sdk.openwrap.banner.POBBannerView
Used to create instances when placed in XML layouts.
POBBannerView(Context, AttributeSet, int) - Constructor for class com.pubmatic.sdk.openwrap.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.openwrap.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.openwrap.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.openwrap.banner
Static member class for interaction with the POBBannerView.
POBBannerViewListener() - Constructor for class com.pubmatic.sdk.openwrap.banner.POBBannerView.POBBannerViewListener
 
POBBaseEvent - Interface in com.pubmatic.sdk.openwrap.core
Interface definition to provide ad server implementation.
POBBid - Class in com.pubmatic.sdk.openwrap.core
Holds information of winning bid along with all the bids that participated in the auction.
POBBid() - Constructor for class com.pubmatic.sdk.openwrap.core.POBBid
 
POBBid.POBSummary - Class in com.pubmatic.sdk.openwrap.core
POBSummary class instance holds the information of a single bid which participated in the auction.
POBBidderIdentifier - Interface in com.pubmatic.sdk.openwrap.core
 
POBBiddingManager - Class in com.pubmatic.sdk.openwrap.core
Manages multiple bidders internally.
POBBiddingManager(List<POBBidding<POBBid>>) - Constructor for class com.pubmatic.sdk.openwrap.core.POBBiddingManager
Initialise POBBiddingManager instance
POBBidsBuilder - Class in com.pubmatic.sdk.openwrap.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.openwrap.core.internal.POBBidsBuilder
 
POBConstants - Class in com.pubmatic.sdk.openwrap.core
 
POBConstants() - Constructor for class com.pubmatic.sdk.openwrap.core.POBConstants
 
POBDefaultBannerEventHandler - Class in com.pubmatic.sdk.openwrap.banner
This is EventHandler class used when publisher do not want to support primary ad server.
POBDefaultBannerEventHandler(POBAdSize...) - Constructor for class com.pubmatic.sdk.openwrap.banner.POBDefaultBannerEventHandler
Constructor Accepts POBAdSize and initialize POBDefaultBannerEventHandler
POBDefaultInterstitialEventHandler - Class in com.pubmatic.sdk.openwrap.interstitial
This is EventHandler class used when publisher do not want to support primary ad server.
POBDefaultInterstitialEventHandler() - Constructor for class com.pubmatic.sdk.openwrap.interstitial.POBDefaultInterstitialEventHandler
 
POBImpression - Class in com.pubmatic.sdk.openwrap.core
Holds the general information about an ad impression.
POBImpression(String, String) - Constructor for class com.pubmatic.sdk.openwrap.core.POBImpression
 
POBInterstitial - Class in com.pubmatic.sdk.openwrap.interstitial
Displays full-screen interstitial ads.
POBInterstitial(Context, String, int, String, POBInterstitialEvent) - Constructor for class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial
Constructor.
POBInterstitial(Context, String, int, String) - Constructor for class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial
Constructor.
POBInterstitial.POBInterstitialListener - Class in com.pubmatic.sdk.openwrap.interstitial
Static member class for interaction with the POBInterstitial instance.
POBInterstitial.POBVideoListener - Class in com.pubmatic.sdk.openwrap.interstitial
Static member class for interaction with the POBInterstitial instance for video events.
POBInterstitialEvent - Interface in com.pubmatic.sdk.openwrap.interstitial
The OpenWrap interstitial custom event interface.
POBInterstitialEventListener - Interface in com.pubmatic.sdk.openwrap.interstitial
OpenWrap interstitial custom event listener.
POBInterstitialListener() - Constructor for class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial.POBInterstitialListener
 
POBManager - Class in com.pubmatic.sdk.openwrap.core
This class is responsible for fetching the bids from PubMatic ad server.
POBManager(POBRequest, Context) - Constructor for class com.pubmatic.sdk.openwrap.core.POBManager
Constructor
POBManager(PMCommunicator<POBBid>) - Constructor for class com.pubmatic.sdk.openwrap.core.POBManager
Constructs Manager
POBPriceBaseAuctioning - Class in com.pubmatic.sdk.openwrap.core
Performs price based auction, if multiple bids are having same price, the front most bid is selected from array
POBPriceBaseAuctioning() - Constructor for class com.pubmatic.sdk.openwrap.core.POBPriceBaseAuctioning
 
POBRenderer - Class in com.pubmatic.sdk.openwrap.core
Helper class to create renderer.
POBRenderer() - Constructor for class com.pubmatic.sdk.openwrap.core.POBRenderer
 
POBRequest - Class in com.pubmatic.sdk.openwrap.core
Class to represent the OpenWrap ad request.
POBRequest.AdPosition - Enum in com.pubmatic.sdk.openwrap.core
Fold placement of the ad to be served.
POBRequest.API - Enum in com.pubmatic.sdk.openwrap.core
Supported API of the ad to be served.
POBRequestBuilder - Class in com.pubmatic.sdk.openwrap.core
 
POBRequestBuilder(POBRequest, String, Context) - Constructor for class com.pubmatic.sdk.openwrap.core.POBRequestBuilder
 
POBResponseParser - Class in com.pubmatic.sdk.openwrap.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.openwrap.core.internal.POBResponseParser
 
POBSummary() - Constructor for class com.pubmatic.sdk.openwrap.core.POBBid.POBSummary
 
POBVideo - Class in com.pubmatic.sdk.openwrap.core
Model class to build Video Impression This class holds the information of video impression.
POBVideo(POBVideo.Placement, POBVideo.Linearity, POBAdSize) - Constructor for class com.pubmatic.sdk.openwrap.core.POBVideo
Constructor initialize necessary params
POBVideo.Linearity - Enum in com.pubmatic.sdk.openwrap.core
 
POBVideo.Placement - Enum in com.pubmatic.sdk.openwrap.core
Placement type for the Video impression
POBVideoListener() - Constructor for class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial.POBVideoListener
 
prepareHttpRequest(String, String, String) - Method in class com.pubmatic.sdk.openwrap.core.POBRequestBuilder
Prepare Ortb Http POST request, it also follows request timeout provided in POBRequest
PUBMATIC_DM_SERVER_SECURE_URL - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
PUBMATIC_DM_SERVER_URL - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 

R

REFRESH_INTERVAL_KEY - Static variable in class com.pubmatic.sdk.openwrap.core.POBManager
 
requestAd(POBBid) - Method in class com.pubmatic.sdk.openwrap.banner.POBDefaultBannerEventHandler
Provide onOpenWrapPartnerWin() callback since we are providing 'No Ad Server Configuration feature'
requestAd(POBBid) - Method in interface com.pubmatic.sdk.openwrap.core.POBBaseEvent
OpenWrap SDK calls this method to make a request to primary SDK.
requestAd(POBBid) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBDefaultInterstitialEventHandler
Provide onOpenWrapPartnerWin() callback since this is 'No Ad Server Configuration feature'
requestBid() - Method in class com.pubmatic.sdk.openwrap.core.POBBiddingManager
 
requestBid() - Method in class com.pubmatic.sdk.openwrap.core.POBManager
Execute the PubMatic ad request and notify via PMWrapperManagerListener instance
requestedAdSizes() - Method in interface com.pubmatic.sdk.openwrap.banner.POBBannerEvent
OpenWrap SDK calls this method to get the size for which ad request should be made.
requestedAdSizes() - Method in class com.pubmatic.sdk.openwrap.banner.POBDefaultBannerEventHandler
 

S

setAdPosition(POBRequest.AdPosition) - Method in class com.pubmatic.sdk.openwrap.core.POBBanner
 
setAdPosition(POBRequest.AdPosition) - Method in class com.pubmatic.sdk.openwrap.core.POBImpression
Sets the fold placement of the ad to be served.
setAdServerUrl(String) - Method in class com.pubmatic.sdk.openwrap.core.POBRequest
Setter method to set Ad Server Url Custom server URL for debugging purpose.
setAdSizes(POBAdSize...) - Method in class com.pubmatic.sdk.openwrap.core.POBBanner
Set the required ad sizes.
setAppInfo(PMAppInfo) - Method in class com.pubmatic.sdk.openwrap.core.POBRequestBuilder
The method takes value of PMAppInfo and set it to specific reference variable
setBanner(POBBanner) - Method in class com.pubmatic.sdk.openwrap.core.POBImpression
 
setCompanionAds(JSONArray) - Method in class com.pubmatic.sdk.openwrap.core.POBVideo
Setter to Json Array of Banner objects, if companion ads are available
setCustomParam(Map<String, List<String>>) - Method in class com.pubmatic.sdk.openwrap.core.POBImpression
Adds custom key-value parameters in an Ad request.
setDeviceInfo(PMDeviceInfo) - Method in class com.pubmatic.sdk.openwrap.core.POBRequestBuilder
The method takes value of PMDeviceInfo and set it to specific reference variable
setEventListener(POBBannerEventListener) - Method in interface com.pubmatic.sdk.openwrap.banner.POBBannerEvent
OpenWrap SDK calls this method to set POBBannerEventListener, so OpenWrap custom event handler can inform the OpenWrap SDK about the events related to the ad server communication.
setEventListener(POBBannerEventListener) - Method in class com.pubmatic.sdk.openwrap.banner.POBDefaultBannerEventHandler
Method to set POBBannerEventListener to get request ad callback
setEventListener(POBInterstitialEventListener) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBDefaultInterstitialEventHandler
Method to set POBBannerEventListener to get request ad callback
setEventListener(POBInterstitialEventListener) - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEvent
OpenWrap SDK calls this method to pass the EventListener to publisher.
setHasWon(boolean) - Method in class com.pubmatic.sdk.openwrap.core.POBBid
To update winning status with respect to primary ad server, expected to be updated externally.
setHeight(int) - Method in class com.pubmatic.sdk.openwrap.core.internal.POBBidsBuilder
Set height to bid if no width is available in build response
setHeight(int) - Method in class com.pubmatic.sdk.openwrap.core.POBBid
 
setInterstitial(boolean) - Method in class com.pubmatic.sdk.openwrap.core.POBImpression
 
setListener(POBBannerView.POBBannerViewListener) - Method in class com.pubmatic.sdk.openwrap.banner.POBBannerView
Sets instance of POBBannerViewListener for the ad view.
setListener(PMAdBuilding.PMAdBuilderListener<POBBid>) - Method in class com.pubmatic.sdk.openwrap.core.internal.POBBidsBuilder
 
setListener(PMResponseParsing.PMResponseParserListener) - Method in class com.pubmatic.sdk.openwrap.core.internal.POBResponseParser
Method is used to set PMResponseParserListener
setListener(POBInterstitial.POBInterstitialListener) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial
Sets instance of POBInterstitialListener for getting callbacks
setLocationDetector(PMLocationDetector) - Method in class com.pubmatic.sdk.openwrap.core.POBRequestBuilder
The method takes PMLocationDetector object and sets it to specific reference variable
setNetworkTimeout(int) - Method in class com.pubmatic.sdk.openwrap.core.POBRequest
Sets the network timeout (in seconds) for making an Ad request.
setPartnerName(String) - Method in class com.pubmatic.sdk.openwrap.core.internal.POBBidsBuilder
Used to set partner name to bid, it used when if no partner name is returned in build response
setPMZoneId(String) - Method in class com.pubmatic.sdk.openwrap.core.POBImpression
Set the zone id.
setPosition(POBRequest.AdPosition) - Method in class com.pubmatic.sdk.openwrap.core.POBVideo
Setter to set Ad position on screen
setRefreshInterval(int) - Method in class com.pubmatic.sdk.openwrap.core.POBBid
Sets refresh interval in seconds
setTestCreativeId(String) - Method in class com.pubmatic.sdk.openwrap.core.POBImpression
This parameter is used to request a test creative.
setVersionId(int) - Method in class com.pubmatic.sdk.openwrap.core.POBRequest
This is an optional OpenWrap version Id of the publisher.
setVideo(POBVideo) - Method in class com.pubmatic.sdk.openwrap.core.POBImpression
 
setVideoListener(POBInterstitial.POBVideoListener) - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial
Sets instance of POBVideoListener for getting callbacks of VAST based video ad
setWidth(int) - Method in class com.pubmatic.sdk.openwrap.core.internal.POBBidsBuilder
Set width to bid if no width is available in build response
setWidth(int) - Method in class com.pubmatic.sdk.openwrap.core.POBBid
 
show() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBDefaultInterstitialEventHandler
 
show() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBInterstitial
Presents an interstitial ad in full screen view until the user dismisses it.
show() - Method in interface com.pubmatic.sdk.openwrap.interstitial.POBInterstitialEvent
OpenWrap SDK will call this method when publisher app calls show on POBInterstitial.

T

TEST_MODE - Static variable in class com.pubmatic.sdk.openwrap.core.POBConstants
 
testCreativeId - Variable in class com.pubmatic.sdk.openwrap.core.POBImpression
This parameter is used to request a test creative.
toString() - Method in class com.pubmatic.sdk.openwrap.core.POBBid.POBSummary
 
toString() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
 
trackClick() - Method in class com.pubmatic.sdk.openwrap.banner.POBDefaultBannerEventHandler
 
trackClick() - Method in interface com.pubmatic.sdk.openwrap.core.POBBaseEvent
Optional method to receive instruction to track the ad click.
trackClick() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBDefaultInterstitialEventHandler
 
trackImpression() - Method in class com.pubmatic.sdk.openwrap.banner.POBDefaultBannerEventHandler
 
trackImpression() - Method in interface com.pubmatic.sdk.openwrap.core.POBBaseEvent
Optional method to receive instruction to track the impression.
trackImpression() - Method in class com.pubmatic.sdk.openwrap.interstitial.POBDefaultInterstitialEventHandler
 

V

valueOf(String) - Static method in enum com.pubmatic.sdk.openwrap.core.POBRequest.AdPosition
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pubmatic.sdk.openwrap.core.POBRequest.API
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pubmatic.sdk.openwrap.core.POBVideo.Linearity
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pubmatic.sdk.openwrap.core.POBVideo.Placement
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.pubmatic.sdk.openwrap.core.POBRequest.AdPosition
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pubmatic.sdk.openwrap.core.POBRequest.API
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pubmatic.sdk.openwrap.core.POBVideo.Linearity
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pubmatic.sdk.openwrap.core.POBVideo.Placement
Returns an array containing the constants of this enum type, in the order they are declared.
A B C D E G H I K L O P R S T V 
Skip navigation links