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

SASNativeAdElement

open class SASNativeAdElement : Serializable, SCSViewabilityManagerListener, SASAdElementInfo

This class represents a native ad object as returned by the ad servers.

Constructors

Link copied to clipboard
constructor(@NonNull context: Context)
Default constructor

Types

Link copied to clipboard
interface ClickHandler
Interface to be implemented by Objects that will handle clicks on native ads in a custom fashion.
Link copied to clipboard
open class ImageElement
Member class representing an image, part of a native ad
Link copied to clipboard
interface OnClickListener
Interface to implement to be warn when a click is performed on the native ad.

Properties

Link copied to clipboard
open var adCallDate: Long
The ad call date of the ad (EPOCH, in milliseconds).
Link copied to clipboard
@Nullable
@get:Nullable
open var adResponseString: String
The AdResponse string the AdElement is created from.
Link copied to clipboard
@Nullable
@get:Nullable
open var body: String
The body of the native ad.
Link copied to clipboard
@Nullable
@get:Nullable
open var calltoAction: String
The callToAction of the native ad.
Link copied to clipboard
@Nullable
@get:Nullable
open var clickHandler: SASNativeAdElement.ClickHandler
The ClickHandler on this SASNativeAdElement
Link copied to clipboard
@Nullable
@get:Nullable
open var clickUrl: String
The 'click url' property value of the native ad.
Link copied to clipboard
@Nullable
@get:Nullable
open val coverImage: SASNativeAdElement.ImageElement
The coverImage of the native ad.
Link copied to clipboard
open var downloads: Long
The downloads of the native ad.
Link copied to clipboard
@Nullable
@get:Nullable
open val icon: SASNativeAdElement.ImageElement
The icon of the native ad.
Link copied to clipboard
open var inventoryId: Long
The inventory id of the ad.
Link copied to clipboard
open var likes: Long
The likes of the native ad.
Link copied to clipboard
@Nullable
@get:Nullable
open var mediaElement: SASNativeVideoAdElement
The media element of the native ad.
Link copied to clipboard
open var networkId: Int
The network id of the native ad.
Link copied to clipboard
@Nullable
@get:Nullable
open var noAdUrl: String
No Ad url to call if mediation fails
Link copied to clipboard
@Nullable
@get:Nullable
open var price: String
The price of the native ad.
Link copied to clipboard
@Nullable
@get:Nullable
open var privacyUrl: String
The privacy url of the native ad.
Link copied to clipboard
open var rating: Float
The rating of the native ad.
Link copied to clipboard
val SAS_UNDEFINED_VALUE: Int = -1
Value indicating that the property value was not yet set.
Link copied to clipboard
@Nullable
@get:Nullable
open var sponsored: String
The sponsored value of the native ad.
Link copied to clipboard
@Nullable
@get:Nullable
open var subtitle: String
The subtitle of the native ad.
Link copied to clipboard
@Nullable
@get:Nullable
open var title: String
The title of the native ad.
Link copied to clipboard
@Nullable
@get:Nullable
open var trackClickUrls: Array<String>
An array of click tracking urls from the internal String description.

Functions

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
@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
@NonNull
open fun getImpressionUrls(): Array<String>
Returns an array of impression pixel urls from the internal String description
Link copied to clipboard
open fun getInsertionId(): Int
Returns the insertion Id of this SASNativeAdElement
Link copied to clipboard
@Nullable
open fun getOnClickListener(): SASNativeAdElement.OnClickListener
Gets the OnClickListener currently set on this SASNativeAdElement
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 registerView(@NonNull v: View)
open fun registerView(@NonNull v: View, @NonNull clickableViews: Array<View>)
Marks the specified View as the View that renders this SASNativeAdElement.
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 setCoverImage(@NonNull url: String, width: Int, height: Int)
Sets the 'cover image' property value
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 setIcon(@NonNull url: String, width: Int, height: Int)
Sets the 'icon' property value
Link copied to clipboard
open fun setImpressionUrlString(@Nullable impressionUrls: String)
Sets the impression pixel list, as comma separated strings
Link copied to clipboard
open fun setInsertionId(mInsertionId: Int)
Sets the insertion Id of this SASNativeAdElement
Link copied to clipboard
open fun setOnClickListener(@Nullable onClickListener: SASNativeAdElement.OnClickListener)
Sets the OnClickListener on this SASNativeAdElement
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
@NonNull
open fun toString(): String
Returns a String representation of this instance
Link copied to clipboard
open fun triggerClickCount()
Link copied to clipboard
Link copied to clipboard
open fun unregisterView(@NonNull v: View)