Index (openwrapcore API)

A B C D E G H I K N O P R S T V

A

AD_SERVER_AUCTION_LOST_MSG - Static variable in class com.pubmatic.sdk.openwrap.core.POBBidderTrackingUtil
AD_SERVER_NOTIFICATION_FAILURE_LOST_MSG - Static variable in class com.pubmatic.sdk.openwrap.core.POBBidderTrackingUtil
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(POBAdResponse<POBBid>) - 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.POBBid.Builder: Builds the new bid with builder parameters
build() - Method in class com.pubmatic.sdk.openwrap.core.POBRequestBuilder: Method prepares the PMHttpRequest from the necessary member variables
Builder(POBBid) - Constructor for class com.pubmatic.sdk.openwrap.core.POBBid.Builder: Constructor build with bid instance
buildWithRefreshAndExpiryTimeout(int, int) - Method in class com.pubmatic.sdk.openwrap.core.POBBid

C

CLIENT_SIDE_AUCTION_LOST_MSG - Static variable in class com.pubmatic.sdk.openwrap.core.POBBidderTrackingUtil
clientBidTargeting(POBDataType.POBBidTargetingType) - Method in class com.pubmatic.sdk.openwrap.core.POBBid: Method to add buyer prioritization keys.
com.pubmatic.sdk.openwrap.core - package com.pubmatic.sdk.openwrap.core
com.pubmatic.sdk.openwrap.core.internal - package com.pubmatic.sdk.openwrap.core.internal
convertToPOBError(POBBidEvent.BidEventError) - Static method in class com.pubmatic.sdk.openwrap.core.POBBidEventHelper: Converts BidEventError into POBError
create(POBBid, Map<String, String>) - Static method in class com.pubmatic.sdk.openwrap.core.POBBid
create(POBBid, boolean, POBDataType.POBBidTargetingType) - 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.
createWithRefreshInterval(POBBid, int) - Static method in class com.pubmatic.sdk.openwrap.core.POBBid

D

DEFAULT_REWARD_AMOUNT_VALUE - Static variable in class com.pubmatic.sdk.openwrap.core.POBReward: This reward amount value should only be used when there is no reward amount received
DEFAULT_REWARD_TYPE_LABEL - Static variable in class com.pubmatic.sdk.openwrap.core.POBReward: This reward type should only be used when there is no reward type received.
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.

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.
equals(Object) - Method in class com.pubmatic.sdk.openwrap.core.POBBid: Deep comparison by using hashcode
executeLogger(POBAdResponse<POBBid>, Map<String, POBPartnerInfo>, Map<String, POBBidderResult<POBBid>>, String) - Method in class com.pubmatic.sdk.openwrap.core.POBBidderAnalytics: Logger call is executed only for client-side bidders, irrespective of success/failure.
executeLogger(POBAdResponse<POBBid>, Map<String, POBPartnerInfo>, POBRequest, Map<String, POBBidderResult>, POBTrackerHandler, String) - Static method in class com.pubmatic.sdk.openwrap.core.POBPartnerTrackerHelper: Logger call is executed only for client-side bidders, irrespective of success/failure.
executeTracker(POBAdResponse<POBBid>, POBPartnerInfo) - Method in class com.pubmatic.sdk.openwrap.core.POBBidderAnalytics: Helper method to execute OpenWrap tracker url for client side partner, if tracker url is not null or not empty then it replaces macros else uses default tracker url and execute it.
executeTracker(POBTrackerHandler, POBAdResponse<POBBid>, POBRequest, POBPartnerInfo) - Static method in class com.pubmatic.sdk.openwrap.core.POBPartnerTrackerHelper: Helper method to execute OpenWrap tracker url for client side partner, if tracker url is not null or not empty then it replaces macros else uses default tracker url and execute it.

G

getAdPosition() - Method in class com.pubmatic.sdk.openwrap.core.POBImpression: Returns the Fold placement of the ad to be served.
getAdResponse() - Method in class com.pubmatic.sdk.openwrap.core.POBBiddingManager
getAdResponse() - Method in class com.pubmatic.sdk.openwrap.core.POBManager
getAdServerUrl() - Method in class com.pubmatic.sdk.openwrap.core.POBRequest: Returns value of Ad Server Url if it is set by method
getAdUnitId() - Method in class com.pubmatic.sdk.openwrap.core.POBImpression: Returns the unique identifier which represents an ad placement on the app screen.
getAdUnitId() - Method in class com.pubmatic.sdk.openwrap.core.POBRequest: Returns the Ad unit ID from the 0th index of impression array.
getAmount() - Method in class com.pubmatic.sdk.openwrap.core.POBReward: Getter for Reward amount
getAppJson(String) - Method in class com.pubmatic.sdk.openwrap.core.POBRequestBuilder: Used to get app json.
getBid() - Method in interface com.pubmatic.sdk.openwrap.core.POBBidEvent: Used to get bid instance
getBidderName() - Method in class com.pubmatic.sdk.openwrap.core.POBBid.POBSummary: Returns bidder name
getBidderResults() - Method in class com.pubmatic.sdk.openwrap.core.POBBiddingManager
getBidderResults() - Method in class com.pubmatic.sdk.openwrap.core.POBManager
getBidId() - Method in class com.pubmatic.sdk.openwrap.core.POBBid: Deprecated.
Use getId() instead.
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
getCreativeType() - Method in class com.pubmatic.sdk.openwrap.core.POBBid
getCurrencyJson() - Method in class com.pubmatic.sdk.openwrap.core.POBRequestBuilder: Get currency json array
getCurrencyType() - Method in class com.pubmatic.sdk.openwrap.core.POBReward: Getter for Reward currency type
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 POBDeviceInfo 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
getErrorMessage() - Method in enum com.pubmatic.sdk.openwrap.core.POBBidEvent.BidEventError
getFirstReward() - Method in class com.pubmatic.sdk.openwrap.core.POBBid: Returns the first Reward object (if any) from the rewards array under bid extension.
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.POBBid: Return bid id of the 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
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
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, POBPartnerInfo>) - 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
getPartnerId() - Method in class com.pubmatic.sdk.openwrap.core.internal.POBBidsBuilder: Returns the OpenWrap partner Id of this bid
getPartnerId() - Method in class com.pubmatic.sdk.openwrap.core.POBBid: Returns the OpenWrap partner Id of this bid
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
getProfileId() - Method in class com.pubmatic.sdk.openwrap.core.POBRequest: Returns the profile Id.
getPubId() - Method in class com.pubmatic.sdk.openwrap.core.POBRequest
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
getRemainingExpirationTime() - Method in class com.pubmatic.sdk.openwrap.core.POBBid: Gives the remaining time for bid expiry.
getRenderableContent() - Method in class com.pubmatic.sdk.openwrap.core.POBBid: Returns the winning creative to be render
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
getVersionId() - Method in class com.pubmatic.sdk.openwrap.core.POBRequest: Returns OpenWrap version Id
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
getWinningBid(POBAdResponse<POBBid>) - Static method in class com.pubmatic.sdk.openwrap.core.POBBiddingManager: Helper method to return winning from Ad Response

H

hashCode() - Method in class com.pubmatic.sdk.openwrap.core.POBBid: Custom hash code generation by using concatenation of (rawbid + impression + status)
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
isDebugStateEnabled() - Method in class com.pubmatic.sdk.openwrap.core.POBRequest: Returns the debug state.
isExpired() - Method in class com.pubmatic.sdk.openwrap.core.POBBid: The bid expires after the below timeouts it was received based on ad format.
isInterstitial() - Method in class com.pubmatic.sdk.openwrap.core.POBImpression
isServerSideAuctionWinner() - Method in class com.pubmatic.sdk.openwrap.core.POBBid: Return true if server-side auction wins
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_LOGINFO - 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_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_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

N

NO_CLIENT_BIDDER_AVAILABLE_MSG - Static variable in class com.pubmatic.sdk.openwrap.core.POBBidderAnalytics
NO_CLIENT_BIDDER_AVAILABLE_MSG - Static variable in class com.pubmatic.sdk.openwrap.core.POBPartnerTrackerHelper
notifyBidderBidWin(POBNetworkHandler, POBBid, Map<String, POBPartnerInfo>) - Static method in class com.pubmatic.sdk.openwrap.core.POBBidderTrackingUtil: Notify the bidder who has the winning bid, to execute its win tracker
notifyBidderLoss(POBNetworkHandler, Map<String, POBPartnerInfo>, POBBid, POBError) - Static method in class com.pubmatic.sdk.openwrap.core.POBBidderTrackingUtil: Notify the bidder to execute its loss tracker for the given bid and provided error code.
notifyBidderLossWithError(POBNetworkHandler, POBBid, Map<String, POBPartnerInfo>, String, POBError, Map<String, POBBidderResult<POBBid>>) - Static method in class com.pubmatic.sdk.openwrap.core.POBBidderTrackingUtil: Notify the bidder to execute its loss tracker with specific error message, While executing loss tracker it excludes winning bid

O

onBidFailed(POBBidEvent, POBError) - Method in interface com.pubmatic.sdk.openwrap.core.POBBidEventListener: Notifies the delegate of an error encountered while fetching the bid
onBidReceived(POBBidEvent, POBBid) - Method in interface com.pubmatic.sdk.openwrap.core.POBBidEventListener: Notifies the delegate that bid has been successfully received
onBidsFailed(POBBidding<POBBid>, POBError) - Method in class com.pubmatic.sdk.openwrap.core.POBBiddingManager
onBidsFetched(POBBidding<POBBid>, POBAdResponse<POBBid>) - Method in class com.pubmatic.sdk.openwrap.core.POBBiddingManager
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
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.Builder - Class in com.pubmatic.sdk.openwrap.core: Builder class to build POBBid, this is an extensible approach can be used for enhancement This helps to make POBBid immutable
POBBid.POBSummary - Class in com.pubmatic.sdk.openwrap.core: POBSummary class instance holds the information of a single bid which participated in the auction.
POBBidderAnalytics - Class in com.pubmatic.sdk.openwrap.core: Helper class definition to handler partner tracker calls
POBBidderAnalytics(POBRequest, POBTrackerHandler) - Constructor for class com.pubmatic.sdk.openwrap.core.POBBidderAnalytics
POBBidderIdentifier - Interface in com.pubmatic.sdk.openwrap.core
POBBidderTrackingUtil - Class in com.pubmatic.sdk.openwrap.core: This is a Util class having the common methods to be called from all ad formats.
POBBidderTrackingUtil() - Constructor for class com.pubmatic.sdk.openwrap.core.POBBidderTrackingUtil
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
POBBidEvent - Interface in com.pubmatic.sdk.openwrap.core: Interface definition to handle bidding events
POBBidEvent.BidEventError - Enum in com.pubmatic.sdk.openwrap.core: Enum to maintain BidEvent error
POBBidEvent.POBBidProceedState - Enum in com.pubmatic.sdk.openwrap.core
POBBidEventHelper - Class in com.pubmatic.sdk.openwrap.core: Helper class to handler bid event util functionality
POBBidEventHelper() - Constructor for class com.pubmatic.sdk.openwrap.core.POBBidEventHelper
POBBidEventListener - Interface in com.pubmatic.sdk.openwrap.core: Interface definition to notifie bid events
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
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: Constructor
POBImpression(String, String, boolean, boolean) - Constructor for class com.pubmatic.sdk.openwrap.core.POBImpression: Constructor to be used for creating Impression object for the Rewarded Ad
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(POBCommunicator<POBBid>) - Constructor for class com.pubmatic.sdk.openwrap.core.POBManager: Constructs Manager
POBPartnerTrackerHelper - Class in com.pubmatic.sdk.openwrap.core: Helper class definition to handler partner tracker calls
POBPartnerTrackerHelper() - Constructor for class com.pubmatic.sdk.openwrap.core.POBPartnerTrackerHelper
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
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
POBReward - Class in com.pubmatic.sdk.openwrap.core: Modal class to hold information of rewards.
POBReward(String, int) - Constructor for class com.pubmatic.sdk.openwrap.core.POBReward: Constructor.
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
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
proceedOnError(POBBidEvent.BidEventError) - Method in interface com.pubmatic.sdk.openwrap.core.POBBidEvent: Proceeds with error, If integration type is of primary ad server case like DFP and MoPub, the execution is continued by invoking ad server call ignoring OpenWrap's bid.
proceedToLoadAd() - Method in interface com.pubmatic.sdk.openwrap.core.POBBidEvent: Proceeds with bid flow, This method should be called only when POBBidEventListener is set Note: Should be called from Main/UI thread.
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

requestAd(POBBid) - Method in interface com.pubmatic.sdk.openwrap.core.POBBaseEvent: OpenWrap SDK calls this method to make a request to primary SDK.
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

S

serverBidTargeting(POBDataType.POBBidTargetingType) - Method in class com.pubmatic.sdk.openwrap.core.POBBid: Method to remove winning bid targeting from targeting received from server side This method will be used mainly for server side bids as one of them will have winning targeting.
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(POBAppInfo) - 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
setBidEventListener(POBBidEventListener) - Method in interface com.pubmatic.sdk.openwrap.core.POBBidEvent: Sets Bid event listener to notify bid events
setCompanionAds(JSONArray) - Method in class com.pubmatic.sdk.openwrap.core.POBVideo: Setter to Json Array of Banner objects, if companion ads are available
setCreativeType(String) - Method in class com.pubmatic.sdk.openwrap.core.internal.POBBidsBuilder: Set creative type if not available in the bid response.
setCreativeType(String) - Method in class com.pubmatic.sdk.openwrap.core.POBBid.Builder: Set Creative type for bid
setCustomParam(Map<String, List<String>>) - Method in class com.pubmatic.sdk.openwrap.core.POBImpression: Adds custom key-value parameters in an Ad request.
setDeviceInfo(POBDeviceInfo) - Method in class com.pubmatic.sdk.openwrap.core.POBRequestBuilder: The method takes value of PMDeviceInfo and set it to specific reference variable
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.Builder: Set Bid height
setInterstitial(boolean) - Method in class com.pubmatic.sdk.openwrap.core.POBImpression
setListener(POBAdBuilding.PMAdBuilderListener<POBBid>) - Method in class com.pubmatic.sdk.openwrap.core.internal.POBBidsBuilder
setListener(POBResponseParsing.PMResponseParserListener<POBBid>) - Method in class com.pubmatic.sdk.openwrap.core.internal.POBResponseParser: Method is used to set PMResponseParserListener
setLocationDetector(POBLocationDetector) - 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.
setPartnerId(String) - Method in class com.pubmatic.sdk.openwrap.core.internal.POBBidsBuilder
setPartnerId(String) - Method in class com.pubmatic.sdk.openwrap.core.POBBid.Builder: Set Bid partner id
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
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
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.Builder: Set Bid width

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
toString() - Method in class com.pubmatic.sdk.openwrap.core.POBReward
trackClick() - Method in interface com.pubmatic.sdk.openwrap.core.POBBaseEvent: Optional method to receive instruction to track the ad click.
trackImpression() - Method in interface com.pubmatic.sdk.openwrap.core.POBBaseEvent: Optional method to receive instruction to track the impression.

V

valueOf(String) - Static method in enum com.pubmatic.sdk.openwrap.core.POBBidEvent.BidEventError: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pubmatic.sdk.openwrap.core.POBBidEvent.POBBidProceedState: Returns the enum constant of this type with the specified name.
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.POBBidEvent.BidEventError: 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.POBBidEvent.POBBidProceedState: 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.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 N O P R S T V