com.pubmatic.sdk.common.models

Class POBPartnerInfo

java.lang.Object

com.pubmatic.sdk.common.models.POBPartnerInfo

public class POBPartnerInfo
extends java.lang.Object

Model class which parses the partner JSON and provides the getter to access its fields.

Constructor Summary

Constructors

Constructor and Description
POBPartnerInfo()

Method Summary

Modifier and Type	Method and Description
static POBPartnerInfo	build(org.json.JSONObject partnerJsonObject) Initializes and returns POBPartnerInfo object with given partner details
static POBPartnerInfo	build(POBPartnerInfo partnerInfo, java.lang.String adunit, POBAdSize[] adSizes) Initializes and returns POBPartnerInfo object with given partner details
java.lang.String	getAccountName() Returns the Partner name for the given publisher account
java.lang.String	getBidderCode() Returns the Bidder code of the partner.
java.lang.String	getKeyGenerationPattern() Returns the Key generation pattern based upon the selected mapping template.
java.lang.String	getName() Returns the PubMatic Partner name
java.util.Map	getPlacementMappings() Returns the Map structure that contains the partner mappings based on the selected Key generation pattern (kgp).
java.lang.String	getPubMaticPartnerId() Returns the PubMatic (Global) partner ID
double	getRevShare() Returns the Bid adjustment (%)
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	getSlotInfoMappings() Returns the filtered slot level mapping for the AdUnit and sizes
long	getTimeout() Returns the Timeout value for the selected partner
boolean	isVideo() Returns true if the selected partner is enabled for Video platform else return false

Methods inherited from class java.lang.Object

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

Constructor Detail

POBPartnerInfo

public POBPartnerInfo()

Method Detail

build

@NonNull
public static POBPartnerInfo build(@NonNull
                                            POBPartnerInfo partnerInfo,
                                            @NonNull
                                            java.lang.String adunit,
                                            @NonNull
                                            POBAdSize[] adSizes)

Initializes and returns POBPartnerInfo object with given partner details

Parameters:

partnerInfo - object of the partner info

Returns:

Instance of POBPartnerInfo

build

@NonNull
public static POBPartnerInfo build(@NonNull
                                            org.json.JSONObject partnerJsonObject)

Initializes and returns POBPartnerInfo object with given partner details

Parameters:

partnerJsonObject - JSON object for the partner info

Returns:

Instance of POBPartnerInfo

getSlotInfoMappings

@Nullable
public java.util.List<java.util.Map<java.lang.String,java.lang.String>> getSlotInfoMappings()

Returns the filtered slot level mapping for the AdUnit and sizes

Returns:

Filtered slot level mapping

getPubMaticPartnerId

@Nullable
public java.lang.String getPubMaticPartnerId()

Returns the PubMatic (Global) partner ID

Returns:

PubMatic (Global) partner ID

getName

@Nullable
public java.lang.String getName()

Returns the PubMatic Partner name

Returns:

PubMatic Partner name

getAccountName

@Nullable
public java.lang.String getAccountName()

Returns the Partner name for the given publisher account

Returns:

Partner name for the given publisher account

getRevShare

public double getRevShare()

Returns the Bid adjustment (%)

Returns:

Bid adjustment (%)

getTimeout

public long getTimeout()

Returns the Timeout value for the selected partner

Returns:

Timeout value for the selected partner

getKeyGenerationPattern

@Nullable
public java.lang.String getKeyGenerationPattern()

Returns the Key generation pattern based upon the selected mapping template. For e.g. if the selected mapping template is "AdUnit Size", then the KGP is "_AU_@_W_x_H_"

Returns:

Key generation pattern based upon the selected mapping template.

isVideo

public boolean isVideo()

Returns true if the selected partner is enabled for Video platform else return false

Returns:

Flag to indicate if the selected partner is enabled for Video platform

getPlacementMappings

@Nullable
public java.util.Map getPlacementMappings()

Returns the Map structure that contains the partner mappings based on the selected Key generation pattern (kgp). The mappings are in key-value format where the key is the slot key generated using the selected kgp and value is the mapping value.

Returns:

Map structure that contains the partner mappings

getBidderCode

@Nullable
public java.lang.String getBidderCode()

Returns the Bidder code of the partner.

Returns:

Bidder code of the partner.