Class Ad
-
- All Implemented Interfaces:
public final class AdIndividual ad object containing all ad-specific data and configuration.
This class represents a single ad unit with all its associated metadata, content, tracking information, and configuration. It provides lazy initialization for features and pub content to optimize memory usage and parsing performance.
-
-
Field Summary
Fields Modifier and Type Field Description private LonginsertionTimestampInMillisprivate LongexpiryTimestampInMillisprivate final StringmarkupTypeprivate final Stringtrackingprivate final Longexpiryprivate final BooleanallowAutoRedirectionprivate final StringcreativeIdprivate final StringimpressionIdprivate final StringtelemetryMetadataBlobprivate final List<Viewability>viewabilityprivate final JSONObjecttransactionprivate final Map<String, String>rewardsprivate final StringbaseEventUrlprivate final MetaInfometaInfoprivate final ContextDatacontextDataprivate final AdQualityControladQualityControlprivate final StringbidBundleprivate StringwebVastprivate final AdResponseFeaturesfeatures
-
Constructor Summary
Constructors Constructor Description Ad()
-
Method Summary
Modifier and Type Method Description final LonggetInsertionTimestampInMillis()Timestamp when the ad was inserted into the response. final UnitsetInsertionTimestampInMillis(Long insertionTimestampInMillis)Timestamp when the ad was inserted into the response. final LonggetExpiryTimestampInMillis()Can contain INVALID_AD_EXPIRY(-1) value if invalid values received in response final UnitsetExpiryTimestampInMillis(Long expiryTimestampInMillis)Can contain INVALID_AD_EXPIRY(-1) value if invalid values received in response final StringgetMarkupType()The markup type from MarkupType (HTML, JSON, etc.), set internally. final StringgetTracking()The tracking type from TrackingType for tracking configuration. final LonggetExpiry()The expiry duration in seconds for this individual ad, set internally. final BooleangetAllowAutoRedirection()Flag indicating if automatic redirects are allowed. final StringgetCreativeId()The unique identifier for the ad creative. final StringgetImpressionId()The unique identifier for impression tracking. final StringgetTelemetryMetadataBlob()Serialized telemetry metadata for this ad. final List<Viewability>getViewability()List of Viewability objects defining impression tracking criteria. final JSONObjectgetTransaction()JSONObject containing transaction-specific data. final Map<String, String>getRewards()Map of reward key-value pairs for rewarded ads. final StringgetBaseEventUrl()Optional base URL for event tracking, nullable. final MetaInfogetMetaInfo()Optional MetaInfo containing creative metadata, nullable. final ContextDatagetContextData()Optional ContextData containing contextual information, nullable. final AdQualityControlgetAdQualityControl()Optional AdQualityControl containing quality settings, nullable. final StringgetBidBundle()final StringgetWebVast()VAST XML content for web-based video ads. final UnitsetWebVast(String webVast)VAST XML content for web-based video ads. final AdResponseFeaturesgetFeatures()final PubContentgetPubContent()Parses and returns the pub content based on the ad's markup type. -
-
Method Detail
-
getInsertionTimestampInMillis
final Long getInsertionTimestampInMillis()
Timestamp when the ad was inserted into the response.
-
setInsertionTimestampInMillis
final Unit setInsertionTimestampInMillis(Long insertionTimestampInMillis)
Timestamp when the ad was inserted into the response.
-
getExpiryTimestampInMillis
final Long getExpiryTimestampInMillis()
Can contain INVALID_AD_EXPIRY(-1) value if invalid values received in response
-
setExpiryTimestampInMillis
final Unit setExpiryTimestampInMillis(Long expiryTimestampInMillis)
Can contain INVALID_AD_EXPIRY(-1) value if invalid values received in response
-
getMarkupType
final String getMarkupType()
The markup type from MarkupType (HTML, JSON, etc.), set internally.
-
getTracking
final String getTracking()
The tracking type from TrackingType for tracking configuration.
-
getExpiry
final Long getExpiry()
The expiry duration in seconds for this individual ad, set internally.
-
getAllowAutoRedirection
final Boolean getAllowAutoRedirection()
Flag indicating if automatic redirects are allowed.
-
getCreativeId
final String getCreativeId()
The unique identifier for the ad creative.
-
getImpressionId
final String getImpressionId()
The unique identifier for impression tracking.
-
getTelemetryMetadataBlob
final String getTelemetryMetadataBlob()
Serialized telemetry metadata for this ad.
-
getViewability
final List<Viewability> getViewability()
List of Viewability objects defining impression tracking criteria.
-
getTransaction
final JSONObject getTransaction()
JSONObject containing transaction-specific data.
-
getRewards
final Map<String, String> getRewards()
Map of reward key-value pairs for rewarded ads.
-
getBaseEventUrl
final String getBaseEventUrl()
Optional base URL for event tracking, nullable.
-
getMetaInfo
final MetaInfo getMetaInfo()
Optional MetaInfo containing creative metadata, nullable.
-
getContextData
final ContextData getContextData()
Optional ContextData containing contextual information, nullable.
-
getAdQualityControl
final AdQualityControl getAdQualityControl()
Optional AdQualityControl containing quality settings, nullable.
-
getBidBundle
final String getBidBundle()
-
getWebVast
final String getWebVast()
VAST XML content for web-based video ads.
-
setWebVast
final Unit setWebVast(String webVast)
VAST XML content for web-based video ads.
-
getFeatures
final AdResponseFeatures getFeatures()
-
getPubContent
final PubContent getPubContent()
Parses and returns the pub content based on the ad's markup type.
This method creates a PubContent object using the PubContentFactory based on the ad's markup type. The content is cached after first access for performance.
- Returns:
The parsed PubContent object containing the ad creative content.
-
-
-
-