com.pubmatic.sdk.common.ssp

Class PMAdRequest

java.lang.Object

com.pubmatic.sdk.common.ssp.PMAdRequest

public class PMAdRequest
extends java.lang.Object

This class represents an ad request for PubMatic SSP platform. Use the object of this class to set different targeting parameters for your ad request.

Constructor Summary

Constructors

Constructor and Description
PMAdRequest(java.lang.String pubId, java.lang.String siteId, java.lang.String adId) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdId()
protected java.lang.String	getAdPosition()
protected java.lang.String	getCustomParamValue() Method is used generate custom parameter string and retrieve
java.lang.String	getKeywords()
protected java.lang.String	getPMZoneId()
java.lang.String	getPubId()
java.lang.String	getSiteId()
void	setAdId(java.lang.String adId) Sets Ad tag ID.
void	setCustomParams(java.lang.String key, java.lang.String value) Method is used to set custom paramter using key and value string
void	setKeywords(java.lang.String keywords) Sets a comma-separated list of keywords indicating the consumer's interests or intent.
void	setPmZoneId(java.lang.String pmZoneId) Sets PubMatic zone id.
void	setPubId(java.lang.String pubId) Sets Publisher ID.
void	setSiteId(java.lang.String siteId) Sets Site ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

PMAdRequest

public PMAdRequest(java.lang.String pubId,
                   java.lang.String siteId,
                   java.lang.String adId)

Constructor

Parameters:

pubId - Publisher id

siteId - Publisher's site id

adId - Publisher's ad tag id

Method Detail

getPubId

public java.lang.String getPubId()

setPubId

public void setPubId(java.lang.String pubId)

Sets Publisher ID. This value can be obtained from the pubId parameter in the PubMatic ad tag.

Parameters:

pubId - Publisher id

getSiteId

public java.lang.String getSiteId()

setSiteId

public void setSiteId(java.lang.String siteId)

Sets Site ID. This value can be obtained from the siteId parameter in the PubMatic's tag.

Parameters:

siteId - Site id

getAdId

public java.lang.String getAdId()

setAdId

public void setAdId(java.lang.String adId)

Sets Ad tag ID. This value can be obtained from the adId parameter in the PubMatic ad tag.

Parameters:

adId - Ad tag ID

getPMZoneId

protected java.lang.String getPMZoneId()

setPmZoneId

public void setPmZoneId(java.lang.String pmZoneId)

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

Parameters:

pmZoneId - PubMatic zone id

getAdPosition

protected java.lang.String getAdPosition()

getKeywords

public java.lang.String getKeywords()

setKeywords

public void setKeywords(java.lang.String keywords)

Sets a comma-separated list of keywords indicating the consumer's interests or intent.

Parameters:

keywords - list of keywords

getCustomParamValue

protected java.lang.String getCustomParamValue()

Method is used generate custom parameter string and retrieve

Returns:

Custom parameters list

setCustomParams

public void setCustomParams(java.lang.String key,
                            java.lang.String value)

Method is used to set custom paramter using key and value string

Parameters:

key - of custom parameter

value - of the specific key