Display SDK/com.smartadserver.android.library.model/SASAdElement

SASAdElement

open class SASAdElement : Serializable, Cloneable, SASAdElementInfo

This class represents an ad object as returned by the ad servers.

Inheritors

Constructors

Link copied to clipboard
constructor()
Constructor

Properties

Link copied to clipboard
@Nullable
open var adLoadedTrackingPixels: ArrayList<String>
ArrayList of adloaded tracking pixels.
Link copied to clipboard
@Nullable
@get:Nullable
open var biddingAdPrice: SASBiddingAdPrice
The Bidding Ad Price of the SASAdElement, if any.
Link copied to clipboard
val BUTTON_BOTTOM_CENTER: Int = 5
Constant value for a centered bottom close button.
Link copied to clipboard
val BUTTON_BOTTOM_LEFT: Int = 2
Constant value for a bottom left close button.
Link copied to clipboard
val BUTTON_BOTTOM_RIGHT: Int = 3
Constant value for a bottom right close button.
Link copied to clipboard
val BUTTON_CENTER: Int = 6
Constant value for a centered close button.
Link copied to clipboard
val BUTTON_TOP_CENTER: Int = 4
Constant value for a centered top close button.
Link copied to clipboard
val BUTTON_TOP_LEFT: Int = 0
Constant value for a top left close button.
Link copied to clipboard
val BUTTON_TOP_RIGHT: Int = 1
Constant value for a top right close button.
Link copied to clipboard
val CREATIVE_SIZE_NOT_DEFINED: Int = 0
Constant value set when the creative size is not defined.
Link copied to clipboard
@Nullable
@get:Nullable
open var noAdUrl: String
No Ad url to call if mediation fails
Link copied to clipboard
@Nullable
open var viewabilityTrackingEvents: Array<SASViewabilityTrackingEvent>
Array of tracking events.

Functions

Link copied to clipboard
@NonNull
open fun clone(): Any
Link copied to clipboard
open fun getAdCallDate(): Long
returns the Ad call date of the ad (EPOCH)
Link copied to clipboard
open fun getAdDuration(): Int
Returns Ad display duration (for interstitial only)
Link copied to clipboard
@Nullable
open fun getAdResponseString(): String
Returns the AdResponse string the AdElement is created from.
Link copied to clipboard
@Nullable
open fun getBaseUrl(): String
Returns the Base url for html contents of this SASAdElement instance
Link copied to clipboard
@Nullable
open fun getCandidateMediationAds(): Array<SASMediationAdElement>
Returns the list of mediation ads received from the ad delivery
Link copied to clipboard
@Nullable
open fun getClickPixelUrl(): String
Returns the click pixel URL called when this ad is clicked
Link copied to clipboard
@NonNull
open fun getClickUrl(): String
Returns the click url for this SASAdElement instance
Link copied to clipboard
open fun getCloseButtonAppearanceDelay(): Int
Returns the close button appearance delay
Link copied to clipboard
open fun getCloseButtonPosition(): Int
Returns the close button position on the SASAdView internal WebView
Link copied to clipboard
@NonNull
open fun getDebugInfo(): String
Return a debug info String that describes this creative
Link copied to clipboard
@Nullable
open fun getExtraParameters(): HashMap<String, Any>
Returns a HashMap containing the extra parameters present in the ad, if any.
Link copied to clipboard
@NonNull
open fun getFormatType(): SASFormatType
Returns the format type of this SASAdElement
Link copied to clipboard
@Nullable
open fun getHtmlContents(): String
Returns the html contents of this SASAdElement instance
Link copied to clipboard
@Nullable
open fun getImpressionUrlString(): String
Returns the impression pixel list, as comma separated string
Link copied to clipboard
@NonNull
open fun getImpUrls(): Array<String>
Returns an array of impression pixel urls from the internal String description
Link copied to clipboard
open fun getInsertionId(): Int
Returns Ad insertion id
Link copied to clipboard
open fun getInventoryId(): Long
Returns the inventory Id of the ad.
Link copied to clipboard
open fun getLandscapeHeight(): Int
Returns the creative height in landscape mode if available or SASAdElement.
Link copied to clipboard
open fun getLandscapeWidth(): Int
Returns the creative width in landscape mode if available or SASAdElement.
Link copied to clipboard
open fun getNetworkId(): Int
Returns the network id of the ad.
Link copied to clipboard
open fun getPortraitHeight(): Int
Returns the creative height if available or SASAdElement.
Link copied to clipboard
open fun getPortraitWidth(): Int
Returns the creative width if available or SASAdElement.
Link copied to clipboard
@Nullable
open fun getScriptUrl(): String
Returns the creative script url
Link copied to clipboard
@Nullable
open fun getSelectedMediationAd(): SASMediationAdElement
Returns the mediation ad that was selected from the list and will be displayed
Link copied to clipboard
open fun getTimeToLive(): Long
Returns the expiration date of this Ad
Link copied to clipboard
@Nullable
open fun getTrackingScript(): String
Returns the tracking script that should be loaded alongside the creative.
Link copied to clipboard
open fun isCloseOnClick(): Boolean
Returns whether the creative be closed when it is clicked.
Link copied to clipboard
open fun isDisplayCloseAppearanceCountDown(): Boolean
Returns whether a countdown should be displayed while waiting for the close button to appear
open fun isDisplayInterstitialViewOnCurrentActivity(): Boolean
Returns whether this ad (only for interstitial) should be displayed on top of current activity
Link copied to clipboard
open fun isImpressionPixelInAdMarkup(): Boolean
Returns TRUE if there is an impression pixel in the ad markup, false otherwise.
Link copied to clipboard
open fun isSwipeToClose(): Boolean
Returns whether an ad can be closed using a swipe gesture.
Link copied to clipboard
open fun setAdCallDate(mAdCallDate: Long)
Sets the ad call date of the ad (milliseconds, EPOCH).
Link copied to clipboard
open fun setAdDuration(adDuration: Int)
Sets Ad display duration (for interstitial only)
Link copied to clipboard
open fun setAdResponseString(@Nullable adResponseString: String)
Sets the AdResponse string this AdElement is created from.
Link copied to clipboard
open fun setBaseUrl(@Nullable baseUrl: String)
Returns the html contents to set on this SASAdElement instance
Link copied to clipboard
open fun setCandidateMediationAds(@Nullable mediationAds: Array<SASMediationAdElement>)
Sets the list of mediation ads received from the ad delivery
Link copied to clipboard
open fun setClickPixelUrl(@Nullable clickPixelUrl: String)
Sets the click pixel URL called when this ad is clicked
Link copied to clipboard
open fun setClickUrl(@NonNull clickUrl: String)
Sets the click url for this SASAdElement instance
Link copied to clipboard
open fun setCloseButtonAppearanceDelay(closeAppearanceDelay: Int)
Sets the close button appearance delay
Link copied to clipboard
open fun setCloseButtonPosition(mCloseButtonPosition: Int)
Sets the close button position on the SASAdView internal WebView
Link copied to clipboard
open fun setCloseOnClick(mCloseOnClick: Boolean)
Sets whether the creative be closed when it is clicked.
Link copied to clipboard
open fun setDisplayCloseAppearanceCountDown(displayCountDown: Boolean)
Sets whether a countdown should be displayed while waiting for the close button to appear
open fun setDisplayInterstitialViewOnCurrentActivity(displayInterstitialViewOnCurrentActivity: Boolean)
Sets whether this ad (only for interstitial) should be displayed on top of current activity
Link copied to clipboard
open fun setExtraParameters(@Nullable extraParameterMap: HashMap<String, Any>)
Sets a HashMap containing the extra parameters for this ad.
Link copied to clipboard
open fun setFormatType(@NonNull formatType: SASFormatType)
Sets the format type for this SASAdElement
Link copied to clipboard
open fun setHtmlContents(@Nullable html: String)
Returns the html contents to set on this SASAdElement instance
Link copied to clipboard
open fun setImpressionPixelInAdMarkup(impressionPixelInAdMarkup: Boolean)
Sets the information about the impression pixel in the ad markup.
Link copied to clipboard
open fun setImpressionUrlString(@Nullable impressionUrlString: String)
Sets the impression pixel list, as comma separated string
Link copied to clipboard
open fun setInsertionId(insertionId: Int)
Sets Ad insertion id
Link copied to clipboard
open fun setInventoryId(mInventoryId: Long)
Sets the inventory Id of the ad.
Link copied to clipboard
open fun setLandscapeHeight(landscapeHeight: Int)
Sets the height of the creative in landscape mode
Link copied to clipboard
open fun setLandscapeWidth(landscapeWidth: Int)
Sets the width of the creative in landscape mode
Link copied to clipboard
open fun setNetworkId(mNetworkId: Int)
Sets the network id of the ad.
Link copied to clipboard
open fun setPortraitHeight(portraitHeight: Int)
Sets the the creative height
Link copied to clipboard
open fun setPortraitWidth(portraitWidth: Int)
Sets creative width
Link copied to clipboard
open fun setScriptUrl(@Nullable scriptUrl: String)
Sets the creative script url
Link copied to clipboard
open fun setSelectedMediationAd(@Nullable selectedMediationAd: SASMediationAdElement)
Sets the mediation ad that was selected from the list and will be displayed
Link copied to clipboard
open fun setSwipeToClose(swipeToClose: Boolean)
Sets whether an ad can be closed using a swipe gesture.
Link copied to clipboard
open fun setTimeToLive(timeToLive: Long)
Sets the expiration date for this Ad
Link copied to clipboard
open fun setTrackingScript(@Nullable trackingScript: String)
Sets the tracking script that should be loaded alongside the creative.