class BannerAdListener(val onLoad: () -> Unit, val onFailure: (Exception) -> Unit, val onDismissed: () -> Unit, val onShown: () -> Unit, val onImpression: () -> Unit, val onClick: () -> Unit) : AdListener

An AdListener for banner ads.

BannerView

typealias BannerView = AdView

A typealias for AdView on Android.

typealias BannerView = GADBannerView

BannerViewDelegate

class BannerViewDelegate(onLoad: () -> Unit, onWillDismiss: () -> Unit, onDismissed: () -> Unit, onShown: () -> Unit, onImpression: () -> Unit, onClick: () -> Unit, onFailure: (Exception) -> Unit) : NSObject, GADBannerViewDelegateProtocol

BasicAds

actual object BasicAds

A utility object for initializing the Mobile Ads SDK.

expect object BasicAds

A utility object for initializing and configuring the Mobile Ads SDK.

actual object BasicAds

Consent

actual class Consent(activity: Any?)

expect class Consent(activity: Any?)

Manages consent and privacy forms using the Google User Messaging Platform (UMP) SDK.

actual class Consent(activity: Any?)

ConsentDebugSettings

actual class ConsentDebugSettings

expect class ConsentDebugSettings

Debug settings to hardcode in test requests to Consent.requestConsentInfoUpdate.

actual class ConsentDebugSettings

ConsentException

class ConsentException(message: String?) : Exception

Indicates an issue with the User Messaging Platform (UMP) module, which is responsible for obtaining, loading, or showing consent information from the user.

ConsentRequestParameters

actual class ConsentRequestParameters

expect class ConsentRequestParameters

Parameters sent when updating user consent information.

actual class ConsentRequestParameters

DependsOnGoogleMobileAds

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class DependsOnGoogleMobileAds

For Android, complete the steps in AdMob's instructions:

DependsOnGoogleUserMessagingPlatform

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class DependsOnGoogleUserMessagingPlatform

Annotation for APIs that depend on the Google User Messaging Platform (UMP) library.

ExperimentalBasicAdsFeature

@Target(allowedTargets = [AnnotationTarget.TYPEALIAS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.CLASS])

annotation class ExperimentalBasicAdsFeature

Annotation for Basic-Ads APIs that are experimental and may be deprecated between releases.

FullScreenContentDelegate

class FullScreenContentDelegate(onDismissed: () -> Unit, onShown: () -> Unit, onImpression: () -> Unit, onClick: () -> Unit, onFailure: (Exception) -> Unit) : NSObject, GADFullScreenContentDelegateProtocol

FullscreenContentDelegate

class FullscreenContentDelegate(onDismissed: () -> Unit, onShown: () -> Unit, onImpression: () -> Unit, onClick: () -> Unit, onFailure: (Exception) -> Unit) : FullScreenContentCallback

A FullScreenContentCallback for handling full-screen ad content events.

InterstitialAdHandler

actual class InterstitialAdHandler(activity: Any?)

A handler for interstitial ads on Android.

expect class InterstitialAdHandler(activity: Any?)

An InterstitialAdHandler is a full-screen ad that cover the interface of the host app. They're typically displayed at natural transition points in the flow of an app, such as between activities or during the pause between levels in a game. When an app shows an interstitial ad, the user has the choice to either tap on the ad and continue to its destination or close it and return to the app.

actual class InterstitialAdHandler(activity: Any?)

RequestConfiguration

data class RequestConfiguration(val maxAdContentRating: String?, val publisherPrivacyPersonalizationState: RequestConfiguration.PublisherPrivacyPersonalizationState, val tagForChildDirectedTreatment: Int, val tagForUnderAgeOfConsent: Int, val testDeviceIds: List<String?>?)

Sets the initial configuration of your AdMob instance for Android and iOS

RewardedAdHandler

actual class RewardedAdHandler(activity: Any?)

A handler for rewarded ads on Android.

expect class RewardedAdHandler(activity: Any?)

An RewardedAdHandler is a full-screen ad that cover the interface of the host app. They're typically displayed at natural transition points in the flow of an app, such as between activities or during the pause between levels in a game. When an app shows an rewarded ad, the user has the choice to either tap on the ad and continue to its destination or close it and return to the app.

actual class RewardedAdHandler(activity: Any?)

RewardedInterstitialAdHandler

actual class RewardedInterstitialAdHandler(activity: Any?)

A handler for rewarded interstitial ads on Android.

expect class RewardedInterstitialAdHandler(activity: Any?)

An RewardedInterstitialAdHandler is a full-screen ad that cover the interface of the host app. They're typically displayed at natural transition points in the flow of an app, such as between activities or during the pause between levels in a game. When an app shows an RewardedInterstitial ad, the user has the choice to either tap on the ad and continue to its destination or close it and return to the app.

actual class RewardedInterstitialAdHandler(activity: Any?)

RewardItem

actual class RewardItem

A reward item earned by the user.

expect class RewardItem

actual class RewardItem

Functions

height

fun CValue<CGRect>.height(): Int

Returns the height of the CGRect.

toAdSize

fun CValue<GADAdSize>.toAdSize(): AdSize

Converts a CValue of GADAdSize to a common AdSize.

fun CValue<CGRect>.toAdSize(): AdSize

Converts a CValue of CGRect to a common AdSize.

toAndroid

fun AdSize.toAndroid(): AdSize

Converts a common AdSize to a com.google.android.gms.ads.AdSize.

fun RequestConfiguration.toAndroid(): RequestConfiguration

Converts a common RequestConfiguration to a com.google.android.gms.ads.RequestConfiguration.

fun RequestConfiguration.PublisherPrivacyPersonalizationState.toAndroid(): RequestConfiguration.PublisherPrivacyPersonalizationState

Converts a common RequestConfiguration.PublisherPrivacyPersonalizationState to a com.google.android.gms.ads.RequestConfiguration.PublisherPrivacyPersonalizationState.

toCGRectCValue

fun AdSize.toCGRectCValue(): CValue<CGRect>

Converts a common AdSize to a CValue of CGRect.

fun GADAdSize.toCGRectCValue(): CValue<CGRect>

Converts an iOS-specific GADAdSize to a CValue of CGRect.

toCommon

fun AdSize.toCommon(): AdSize

Converts a com.google.android.gms.ads.AdSize to a common AdSize.

fun RequestConfiguration.toCommon(): RequestConfiguration

Converts a com.google.android.gms.ads.RequestConfiguration to a common RequestConfiguration.

fun RequestConfiguration.PublisherPrivacyPersonalizationState.toCommon(): RequestConfiguration.PublisherPrivacyPersonalizationState

Converts a com.google.android.gms.ads.RequestConfiguration.PublisherPrivacyPersonalizationState to a common RequestConfiguration.PublisherPrivacyPersonalizationState.

fun GADAdSize.toCommon(): AdSize

Converts an iOS-specific GADAdSize to a common AdSize.

width

fun CValue<CGRect>.width(): Int

Returns the width of the CGRect.