Class POBCompanion
-
- All Implemented Interfaces:
-
com.pubmatic.sdk.common.base.POBAdDescriptor,com.pubmatic.sdk.video.xmlserialiser.POBXMLNodeListener
public class POBCompanion extends POBVastCreative implements POBAdDescriptor
Class represent companion ad associated with InLine or Wrapper Ad
-
-
Field Summary
Fields Modifier and Type Field Description public StringrenderingModepublic final static intBID_STATUS_OKpublic final static intBID_STATUS_NOT_OKpublic final static StringSTATIC_PRICE_BIDpublic final static StringDYNAMIC_PRICE_BIDpublic final static StringCREATIVE_TYPE_BANNERpublic final static StringCREATIVE_TYPE_VIDEOpublic final static StringCREATIVE_TYPE_NATIVE
-
Constructor Summary
Constructors Constructor Description POBCompanion()
-
Method Summary
Modifier and Type Method Description StringgetRenderingMode()voidsetRenderingMode(@Nullable() String renderingMode)voidbuild(@NonNull() POBNodeBuilder builder)POBXMLParser calls this method to build model class object with node builder intgetWidth()Returns the width of placement slot intgetHeight()Returns the height of placement slot intgetAssetWidth()The pixel width of the creative. intgetAssetHeight()The pixel width of the creative. StringgetApiFramework()The API necessary to communicate with the creative if available POBResourcegetResource()Companion resources to be displayed StringgetClickThroughURL()A URI to open when companion ad is clicked. List<String>getClickTrackers()A URI to notify the player that ad was clicked. List<POBTracking>getTrackingEvents()List of event tracker URL's POBVastCreative.CreativeTypegetVastCreativeType()Getter method, provides type of creative which is implemented at child classes specific event type classes StringgetUniversalAdId()A unique creative identifier StringgetRenderableContent()booleanisVideo()booleanisCompanion()intgetContentWidth()intgetContentHeight()JSONObjectgetRawBid()intgetRefreshInterval()StringgetId()Returns null as default implementation StringgetCreativeType()intgetStatus()Map<String, String>getTargetingInfo()POBAdDescriptorbuildWithRefreshAndExpiryTimeout(int refreshInterval, int expiryTimeout)StringtoString()StringgetBundle()StringgetPaidBy()booleanenableDsaInfoIcon()StringgetDisplayedOnBehalfOf()List<POBDSATransparencyInfo>getTransparencyData()POBImpressionCountingMethodgetImpressionCountingMethod()-
-
Method Detail
-
getRenderingMode
@Nullable() String getRenderingMode()
-
setRenderingMode
void setRenderingMode(@Nullable() String renderingMode)
-
build
void build(@NonNull() POBNodeBuilder builder)
POBXMLParser calls this method to build model class object with node builder
- Parameters:
builder- Instance of POBNodeBuilder, to be used for building the model class object
-
getWidth
int getWidth()
Returns the width of placement slot
- Returns:
width of ad
-
getHeight
int getHeight()
Returns the height of placement slot
- Returns:
height of ad
-
getAssetWidth
int getAssetWidth()
The pixel width of the creative.
- Returns:
width of creative
-
getAssetHeight
int getAssetHeight()
The pixel width of the creative.
- Returns:
height of creative
-
getApiFramework
@Nullable() String getApiFramework()
The API necessary to communicate with the creative if available
- Returns:
api framework
-
getResource
@Nullable() POBResource getResource()
Companion resources to be displayed
- Returns:
POBResource
-
getClickThroughURL
@Nullable() String getClickThroughURL()
A URI to open when companion ad is clicked.
- Returns:
click through URL
-
getClickTrackers
@Nullable() List<String> getClickTrackers()
A URI to notify the player that ad was clicked.
- Returns:
click trcking URL
-
getTrackingEvents
@Nullable() List<POBTracking> getTrackingEvents()
List of event tracker URL's
- Returns:
List of the tracking URL specific model class
-
getVastCreativeType
POBVastCreative.CreativeType getVastCreativeType()
Getter method, provides type of creative which is implemented at child classes specific event type classes
- Returns:
creative type(linear, non-linear, campanion)
-
getUniversalAdId
@Nullable() String getUniversalAdId()
A unique creative identifier
- Returns:
creative id
-
getRenderableContent
@Nullable() String getRenderableContent()
-
isVideo
boolean isVideo()
-
isCompanion
boolean isCompanion()
-
getContentWidth
int getContentWidth()
-
getContentHeight
int getContentHeight()
-
getRawBid
@Nullable() JSONObject getRawBid()
-
getRefreshInterval
int getRefreshInterval()
-
getId
@Nullable() String getId()
Returns null as default implementation
- Returns:
null as default implementation
-
getCreativeType
@Nullable() String getCreativeType()
-
getStatus
int getStatus()
-
getTargetingInfo
@Nullable() Map<String, String> getTargetingInfo()
-
buildWithRefreshAndExpiryTimeout
@Nullable() POBAdDescriptor buildWithRefreshAndExpiryTimeout(int refreshInterval, int expiryTimeout)
-
enableDsaInfoIcon
boolean enableDsaInfoIcon()
-
getDisplayedOnBehalfOf
@Nullable() String getDisplayedOnBehalfOf()
-
getTransparencyData
@Nullable() List<POBDSATransparencyInfo> getTransparencyData()
-
getImpressionCountingMethod
@NonNull() POBImpressionCountingMethod getImpressionCountingMethod()
-
-
-
-