com.pubmatic.sdk.openbid.core

Class POBImpression

java.lang.Object

com.pubmatic.sdk.openbid.core.POBImpression

Direct Known Subclasses:

POBBannerImpression, POBInterstitialImpression

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 boolean	interstitial
protected java.lang.String	pmZoneId This parameter is used to pass a zone ID for reporting.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	POBImpression(java.lang.String id, java.lang.String adUnitId) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdUnitId() Returns the unique identifier which represents an ad placement on the app screen.
org.json.JSONObject	getImpressionJson() (Internal for OpenBid SDK)
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	setPMZoneId(java.lang.String pmZoneId) Set the zone id.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected final java.lang.String id

This parameter is used to hold impression identifier

adUnitId

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 OpenBid dashboard.

pmZoneId

protected java.lang.String pmZoneId

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

interstitial

protected boolean interstitial

adPosition

protected POBRequest.AdPosition adPosition

Constructor Detail

POBImpression

protected POBImpression(java.lang.String id,
                        java.lang.String adUnitId)

Constructor. Initializes POBImpression object with given impression details. This class serves as base for other concrete impression classes, do not directly create an instance of this class.

Parameters:

id - Unique identifier of the impression

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 OpenBid dashboard.

Method Detail

getAdUnitId

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 OpenBid dashboard.

Returns:

OpenBid specific ad unit ID.

setPMZoneId

public void setPMZoneId(java.lang.String pmZoneId)

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

Parameters:

pmZoneId - zone id

setCustomParam

public void setCustomParam(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

getImpressionJson

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

(Internal for OpenBid SDK)

Returns:

Returns JSONObject

Throws:

org.json.JSONException - throws JSONException