com.pubmatic.sdk.openwrap.core

Class POBImpression

java.lang.Object

com.pubmatic.sdk.openwrap.core.POBImpression

public class POBImpression
extends java.lang.Object

Holds the general information about an ad impression. It is required to pass the impression level information in bid request.

Field Summary

Fields

Modifier and Type	Field and Description
protected POBRequest.AdPosition	adPosition
protected java.lang.String	adUnitId The unique identifier which represents an ad placement on the app screen.
protected java.lang.String	id This parameter is used to hold impression identifier
protected java.lang.String	pmZoneId This parameter is used to pass a zone ID for reporting.
protected java.lang.String	testCreativeId This parameter is used to request a test creative.

Constructor Summary

Constructors

Constructor and Description
POBImpression(java.lang.String id, java.lang.String adUnitId) Constructor
POBImpression(java.lang.String id, java.lang.String adUnitId, boolean isRewardedAd, boolean isInterstitial) Constructor to be used for creating Impression object for the Rewarded Ad

Method Summary

Modifier and Type	Method and Description
POBRequest.AdPosition	getAdPosition() Returns the Fold placement of the ad to be served.
java.lang.String	getAdUnitId() Returns the unique identifier which represents an ad placement on the app screen.
com.pubmatic.sdk.openwrap.core.POBBanner	getBanner() ORTB banner object
protected java.lang.String	getCustomData()
protected JSONObject	getExtJson(JSONArray pubmaticJsonArray)
java.lang.String	getId() Returns the unique identifier of the impression.
JSONObject	getImpressionJson() (Internal for OpenWrap SDK)
com.pubmatic.sdk.openwrap.core.POBNative	getNative() ORTB native object
java.lang.String	getTestCreativeId() Returns a test creative id.
com.pubmatic.sdk.openwrap.core.POBVideo	getVideo() ORTB video object
boolean	isInterstitial() Returns true if this impression is configured for Interstitials ad, else return false
boolean	isRewardedAd() Returns true if this impression is configured for Rewarded ad, else return false
protected JSONObject	putKeyValueObject(java.lang.String key, java.lang.Object... array)
void	setAdPosition(POBRequest.AdPosition adPosition) Sets the fold placement of the ad to be served.
void	setBanner(com.pubmatic.sdk.openwrap.core.POBBanner banner) To set ortb banner
void	setCustomParam(java.util.Map<java.lang.String,java.util.List<java.lang.String>> map) Adds custom key-value parameters in an Ad request.
void	setInterstitial(boolean interstitial) Set true if the impression is configured for insterstitial
void	setNative(com.pubmatic.sdk.openwrap.core.POBNative pobNative) Sets the oRTB native object
void	setPMZoneId(java.lang.String pmZoneId) Set the zone id.
void	setTestCreativeId(java.lang.String testCreativeId) This parameter is used to request a test creative.
void	setVideo(com.pubmatic.sdk.openwrap.core.POBVideo video) To set Ortb video

Methods inherited from class java.lang.Object

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

Field Detail

id

@NonNull
protected final java.lang.String id

This parameter is used to hold impression identifier

adUnitId

@NonNull
protected final java.lang.String adUnitId

The unique identifier which represents an ad placement on the app screen. This is the one you defined while creating profile mappings on the OpenWrap dashboard.

pmZoneId

@Nullable
protected java.lang.String pmZoneId

This parameter is used to pass a zone ID for reporting.

testCreativeId

@Nullable
protected java.lang.String testCreativeId

This parameter is used to request a test creative.

adPosition

@NonNull
protected POBRequest.AdPosition adPosition

Constructor Detail

POBImpression

public POBImpression(@NonNull
                     java.lang.String id,
                     @NonNull
                     java.lang.String adUnitId)

Constructor

Parameters:

id - Impression Id

adUnitId - Ad unit Id

POBImpression

public POBImpression(@NonNull
                     java.lang.String id,
                     @NonNull
                     java.lang.String adUnitId,
                     boolean isRewardedAd,
                     boolean isInterstitial)

Constructor to be used for creating Impression object for the Rewarded Ad

Parameters:

id - Impression Id

adUnitId - Ad unit Id

isRewardedAd - true for identifying as Rewarded Ad

isInterstitial - true for identifying as Interstitial Rewarded Ad

Method Detail

setNative

public void setNative(@Nullable
                      com.pubmatic.sdk.openwrap.core.POBNative pobNative)

Sets the oRTB native object

Parameters:

pobNative - oRTB object for Native Ad

getNative

@Nullable
public com.pubmatic.sdk.openwrap.core.POBNative getNative()

ORTB native object

Returns:

ORTB native object

setVideo

public void setVideo(@Nullable
                     com.pubmatic.sdk.openwrap.core.POBVideo video)

To set Ortb video

Parameters:

video - the POBVideo

getVideo

@Nullable
public com.pubmatic.sdk.openwrap.core.POBVideo getVideo()

ORTB video object

Returns:

ORTB video object

setBanner

public void setBanner(@Nullable
                      com.pubmatic.sdk.openwrap.core.POBBanner banner)

To set ortb banner

Parameters:

banner - the POBBanner

getBanner

@Nullable
public com.pubmatic.sdk.openwrap.core.POBBanner getBanner()

ORTB banner object

Returns:

ORTB banner object

isInterstitial

public boolean isInterstitial()

Returns true if this impression is configured for Interstitials ad, else return false

Returns:

true if interstitial is configured else false

setInterstitial

public void setInterstitial(boolean interstitial)

Set true if the impression is configured for insterstitial

Parameters:

interstitial - true if the impression is configured for insterstitial, else false

isRewardedAd

public boolean isRewardedAd()

Returns true if this impression is configured for Rewarded ad, else return false

Returns:

true if Rewarded is configured else false

getImpressionJson

@NonNull
public JSONObject getImpressionJson()
                                      throws JSONException

(Internal for OpenWrap SDK)

Returns:

Returns JSONObject

Throws:

JSONException - throws JSONException

getId

@NonNull
public java.lang.String getId()

Returns the unique identifier of the impression.

Returns:

Impression ID.

getAdUnitId

@NonNull
public java.lang.String getAdUnitId()

Returns the unique identifier which represents an ad placement on the app screen. This is the one you defined while creating profile mappings on the OpenWrap dashboard.

Returns:

OpenWrap specific ad unit ID.

setPMZoneId

public void setPMZoneId(@Nullable
                        java.lang.String pmZoneId)

Set the zone id. This parameter is used to pass a zone ID for reporting.

Parameters:

pmZoneId - zone id

putKeyValueObject

@NonNull
protected JSONObject putKeyValueObject(@Nullable
                                                java.lang.String key,
                                                @Nullable
                                                java.lang.Object... array)

getTestCreativeId

@Nullable
public java.lang.String getTestCreativeId()

Returns a test creative id.

Returns:

test creative id

setTestCreativeId

public void setTestCreativeId(@Nullable
                              java.lang.String testCreativeId)

This parameter is used to request a test creative.

Parameters:

testCreativeId - test creative id.

getCustomData

@Nullable
protected java.lang.String getCustomData()

getExtJson

@Nullable
protected JSONObject getExtJson(@Nullable
                                          JSONArray pubmaticJsonArray)

setCustomParam

public void setCustomParam(@Nullable
                           java.util.Map<java.lang.String,java.util.List<java.lang.String>> map)

Adds custom key-value parameters in an Ad request. Multiple values against the same key can be passed in list.

Parameters:

map - map of key-value pair

getAdPosition

@NonNull
public POBRequest.AdPosition getAdPosition()

Returns the Fold placement of the ad to be served.

Returns:

Fold placement of the ad

setAdPosition

public void setAdPosition(@NonNull
                          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