com.pubmatic.sdk.openbid.core

Class POBBannerImpression

java.lang.Object

com.pubmatic.sdk.openbid.core.POBImpression

com.pubmatic.sdk.openbid.core.POBBannerImpression

public class POBBannerImpression
extends POBImpression

This class holds the information of banner impression. It is required to pass the impression level information in bid request for banner ad.

Field Summary

Fields inherited from class com.pubmatic.sdk.openbid.core.POBImpression

adPosition, adUnitId, id, interstitial, pmZoneId

Method Summary

Modifier and Type	Method and Description
static POBBannerImpression	createInstance(java.lang.String id, java.lang.String adUnitId, com.pubmatic.sdk.common.POBAdSize... adSizes) Returns new instance of POBBannerImpression class if all 3 provided arguments are valid else return null.
org.json.JSONObject	getImpressionJson() (Internal for OpenBid SDK)
void	setAdPosition(POBRequest.AdPosition adPosition) Sets the fold placement of the ad to be served.
void	setAdSizes(com.pubmatic.sdk.common.POBAdSize... adSizes) Set the required ad sizes.

Methods inherited from class com.pubmatic.sdk.openbid.core.POBImpression

getAdUnitId, setCustomParam, setPMZoneId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createInstance

public static POBBannerImpression createInstance(@NonNull
                                                 java.lang.String id,
                                                 @NonNull
                                                 java.lang.String adUnitId,
                                                 @NonNull
                                                 com.pubmatic.sdk.common.POBAdSize... adSizes)

Returns new instance of POBBannerImpression class if all 3 provided arguments are valid else return null.

Parameters:

id - Impression Id

adUnitId - The unique identifier which represents ad placement on the app screen. This is the one you defined while creating profile mappings on the PubMatic OpenBid dashboard.

adSizes - Ad sizes with comma separated in case of multiple values

Returns:

Valid object of POBBannerImpression or null

setAdSizes

public void setAdSizes(com.pubmatic.sdk.common.POBAdSize... adSizes)

Set the required ad sizes.

Parameters:

adSizes - Ad sizes with comma separated in case of multiple values

setAdPosition

public void setAdPosition(POBRequest.AdPosition adPosition)

Sets the fold placement of the ad to be served. Possible values are: UNKNOWN ABOVE_THE_FOLD BELOW_THE_FOLD HEADER FOOTER SIDEBAR FULL_SCREEN

Parameters:

adPosition - Value of ad placement

getImpressionJson

public org.json.JSONObject getImpressionJson()
                                      throws org.json.JSONException

(Internal for OpenBid SDK)

Overrides:

getImpressionJson in class POBImpression

Returns:

JSONObject

Throws:

org.json.JSONException - JSONException