UnifiedNativeAdMapper
abstract class UnifiedNativeAdMapper
Maps a third party native ad to a Google native ad.
Mediation adapters that load a native ad must extend this class to provide a mapping from the mediated ad network's native ad object to com.google.android.gms.ads.formats.UnifiedNativeAd.
Summary
Public constructors |
|---|
UnifiedNativeAdMapper( |
Public functions |
|
|---|---|
open Unit |
destroy()Subclasses should implement this method if the ad network offers a way to destroy the native ad object. |
open Unit |
handleClick(view: View)Subclasses should implement this method if overrideClickHandling is false. |
open Unit |
Subclasses should implement this method if overrideImpressionRecording is false. |
open Unit |
trackViews(Subclasses should implement this method if the ad network requires access to the native ad asset views, for example to handle impression and click tracking. |
open Unit |
untrackView(view: View)Subclasses should implement this method if the ad network offers a way to stop tracking a native ad view for the ad mapped by this object. |
Public properties |
|
|---|---|
View? |
A view to be used as AdChoices content. |
String? |
A text that identifies the advertiser. |
NativeAd.AdChoicesInfo? |
|
String? |
The body text asset. |
String? |
The ad's call to action (such as "Buy" or "Install"). |
Bundle |
A bundle of extras containing assets or attributes that do not directly map to those expected for a Google native ad object (headline, body, etc). |
Boolean |
The current ad has video content. |
String? |
The primary text headline. |
NativeAd.Image? |
A small image identifying the advertiser. |
List<NativeAd.Image>? |
A list of large images. |
Float |
The aspect ratio of the media to be rendered. |
View? |
mediated view that displays media. |
Any? |
The mediated native ad object. |
Boolean |
A boolean representing whether the ad network does click handling on its own. |
Boolean |
A boolean representing whether the ad network does impression tracking on its own. |
String? |
A string representing how much the app costs. |
Double? |
A star rating from 0 to 5 representing how many stars the app has in the store offering it. |
String? |
The name of the store offering the app for download. |
VideoController? |
Playback controller for native video ads. |
Public constructors
UnifiedNativeAdMapper
UnifiedNativeAdMapper(
headline: String? = null,
images: List<NativeAd.Image>? = null,
body: String? = null,
icon: NativeAd.Image? = null,
callToAction: String? = null,
advertiser: String? = null,
starRating: Double? = null,
store: String? = null,
price: String? = null,
videoController: VideoController? = null,
hasVideoContent: Boolean = false,
attributionInfo: NativeAd.AdChoicesInfo? = null,
adChoicesContent: View? = null,
mediaView: View? = null,
mediatedAd: Any? = null,
extras: Bundle = Bundle(),
overrideImpressionRecording: Boolean = false,
overrideClickHandling: Boolean = false,
mediaContentAspectRatio: Float = 0.0f
)
Public functions
destroy
open fun destroy(): Unit
Subclasses should implement this method if the ad network offers a way to destroy the native ad object.
handleClick
open fun handleClick(view: View): Unit
Subclasses should implement this method if overrideClickHandling is false.
recordImpression
open fun recordImpression(): Unit
Subclasses should implement this method if overrideImpressionRecording is false.
trackViews
open fun trackViews(
containerView: View,
clickableAssetViews: Map<String, View>,
nonclickableAssetViews: Map<String, View>
): Unit
Subclasses should implement this method if the ad network requires access to the native ad asset views, for example to handle impression and click tracking.
| Parameters | |
|---|---|
containerView: View |
The container |
clickableAssetViews: Map<String, View> |
The |
nonclickableAssetViews: Map<String, View> |
The |
untrackView
open fun untrackView(view: View): Unit
Subclasses should implement this method if the ad network offers a way to stop tracking a native ad view for the ad mapped by this object.
Public properties
body
var body: String?
The body text asset. Adapters should always map this asset since it is always included for Google ads.
callToAction
var callToAction: String?
The ad's call to action (such as "Buy" or "Install"). Adapters should always map this asset since it is always included for Google ads.
extras
var extras: Bundle
A bundle of extras containing assets or attributes that do not directly map to those expected for a Google native ad object (headline, body, etc).
headline
var headline: String?
The primary text headline. Adapters should always map this asset since it is always included for Google ads.
images
var images: List<NativeAd.Image>?
A list of large images. Adapters should always map this asset since it is always included for Google ads.
mediaContentAspectRatio
var mediaContentAspectRatio: Float
The aspect ratio of the media to be rendered.
mediaView
var mediaView: View?
mediated view that displays media. This is typically the View provided by the mediated SDK to display video content for an ad, but should display an image asset if no video is present. Adapters are expected to set a View for this property for every ad.
mediatedAd
var mediatedAd: Any?
The mediated native ad object. Publishers have the option of accessing it directly to use APIs not fully mapped by the Mobile Ads SDK.
overrideClickHandling
var overrideClickHandling: Boolean
A boolean representing whether the ad network does click handling on its own.
overrideImpressionRecording
var overrideImpressionRecording: Boolean
A boolean representing whether the ad network does impression tracking on its own.
starRating
var starRating: Double?
A star rating from 0 to 5 representing how many stars the app has in the store offering it.