Package-level declarations

Functions

Link copied to clipboard
@RequiresPermission(value = "android.permission.INTERNET")
@Composable
actual fun BannerAd(ad: BannerAdHandler)

Displays a pre-loaded banner ad from a BannerAdHandler.

@RequiresPermission(value = "android.permission.INTERNET")
@Composable
actual fun BannerAd(adUnitId: String, adSize: AdSize, onLoad: () -> Unit)

Loads and displays a banner ad.

@Composable
expect fun BannerAd(ad: BannerAdHandler)
@Composable
expect fun BannerAd(adUnitId: String = AdUnitId.BANNER_DEFAULT, adSize: AdSize = AdSize.FULL_BANNER, onLoad: () -> Unit = {})

Loads and displays a Banner Ad using a Composable.

@Composable
actual fun BannerAd(ad: BannerAdHandler)
@Composable
actual fun BannerAd(adUnitId: String, adSize: AdSize, onLoad: () -> Unit)
Link copied to clipboard
@Composable
fun ConsentPopup(activity: Any?, onFailure: (Exception) -> Unit = {})

A composable function that requests and updates user consent information using the Google User Messaging Platform (UMP) SDK. It is designed to be used within a Composable UI context.

@Composable
fun ConsentPopup(onFailure: (Exception) -> Unit = {}, onLoaded: () -> Unit = {}, onShown: () -> Unit = {})
@Composable
fun ConsentPopup(consent: Consent, onFailure: (Exception) -> Unit = {}, onLoaded: () -> Unit = {}, onShown: () -> Unit = {})

A Composable function that requests an update to the consent information.

Link copied to clipboard
@Composable
fun InterstitialAd(loadedAd: InterstitialAdHandler, onDismissed: () -> Unit = {}, onShown: () -> Unit = {}, onImpression: () -> Unit = {}, onClick: () -> Unit = {}, onFailure: (Exception) -> Unit = {})

Displays a pre-loaded Interstitial Ad using a Composable.

@Composable
fun InterstitialAd(adUnitId: String = AdUnitId.INTERSTITIAL_DEFAULT, onDismissed: () -> Unit = {}, onShown: () -> Unit = {}, onImpression: () -> Unit = {}, onClick: () -> Unit = {}, onFailure: (Exception) -> Unit = {}, onLoad: () -> Unit = {})
@Composable
fun InterstitialAd(activity: Any?, adUnitId: String = AdUnitId.INTERSTITIAL_DEFAULT, onDismissed: () -> Unit = {}, onShown: () -> Unit = {}, onImpression: () -> Unit = {}, onClick: () -> Unit = {}, onFailure: (Exception) -> Unit = {}, onLoad: () -> Unit = {})

Loads and displays an Interstitial Ad using a Composable.

Link copied to clipboard
@Composable
actual fun NativeAd(loadedAd: NativeAdHandler, nativeAdTemplate: NativeAdTemplate)

A composable that displays a pre-loaded native ad from a NativeAdHandler.

@RequiresPermission(value = "android.permission.INTERNET")
@Composable
actual fun NativeAd(nativeAdTemplate: NativeAdTemplate, adUnitId: String, onDismissed: () -> Unit, onShown: () -> Unit, onImpression: () -> Unit, onClick: () -> Unit, onFailure: (Exception) -> Unit, onLoad: () -> Unit)
@RequiresPermission(value = "android.permission.INTERNET")
@Composable
actual fun NativeAd(activity: Any?, nativeAdTemplate: NativeAdTemplate, adUnitId: String, onDismissed: () -> Unit, onShown: () -> Unit, onImpression: () -> Unit, onClick: () -> Unit, onFailure: (Exception) -> Unit, onLoad: () -> Unit)

A composable that loads and displays a native ad.

@Composable
expect fun NativeAd(loadedAd: NativeAdHandler, nativeAdTemplate: NativeAdTemplate = NativeAdDefault())
@Composable
expect fun NativeAd(nativeAdTemplate: NativeAdTemplate = NativeAdDefault(), adUnitId: String = AdUnitId.NATIVE_DEFAULT, onDismissed: () -> Unit = {}, onShown: () -> Unit = {}, onImpression: () -> Unit = {}, onClick: () -> Unit = {}, onFailure: (Exception) -> Unit = {}, onLoad: () -> Unit = {})
@Composable
expect fun NativeAd(activity: Any? = null, nativeAdTemplate: NativeAdTemplate = NativeAdDefault(), adUnitId: String = AdUnitId.NATIVE_DEFAULT, onDismissed: () -> Unit = {}, onShown: () -> Unit = {}, onImpression: () -> Unit = {}, onClick: () -> Unit = {}, onFailure: (Exception) -> Unit = {}, onLoad: () -> Unit = {})

A composable that displays a native ad.

@Composable
actual fun NativeAd(loadedAd: NativeAdHandler, nativeAdTemplate: NativeAdTemplate)
@Composable
actual fun NativeAd(nativeAdTemplate: NativeAdTemplate, adUnitId: String, onDismissed: () -> Unit, onShown: () -> Unit, onImpression: () -> Unit, onClick: () -> Unit, onFailure: (Exception) -> Unit, onLoad: () -> Unit)
@Composable
actual fun NativeAd(activity: Any?, nativeAdTemplate: NativeAdTemplate, adUnitId: String, onDismissed: () -> Unit, onShown: () -> Unit, onImpression: () -> Unit, onClick: () -> Unit, onFailure: (Exception) -> Unit, onLoad: () -> Unit)

A composable that displays a native ad.

Link copied to clipboard
@RequiresPermission(value = "android.permission.INTERNET")
@Composable
actual fun rememberBannerAd(adUnitId: String, adSize: AdSize, onLoad: () -> Unit, onFailure: (Exception) -> Unit, onDismissed: () -> Unit, onShown: () -> Unit, onImpression: () -> Unit, onClick: () -> Unit): MutableState<BannerAdHandler>
@RequiresPermission(value = "android.permission.INTERNET")
@Composable
actual fun rememberBannerAd(activity: Any?, adUnitId: String, adSize: AdSize, onLoad: () -> Unit, onFailure: (Exception) -> Unit, onDismissed: () -> Unit, onShown: () -> Unit, onImpression: () -> Unit, onClick: () -> Unit): MutableState<BannerAdHandler>

A Composable function that remembers a BannerAdHandler across compositions.

@Composable
expect fun rememberBannerAd(adUnitId: String = AdUnitId.BANNER_DEFAULT, adSize: AdSize = AdSize.FULL_BANNER, onLoad: () -> Unit = {}, onFailure: (Exception) -> Unit = {}, onDismissed: () -> Unit = {}, onShown: () -> Unit = {}, onImpression: () -> Unit = {}, onClick: () -> Unit = {}): MutableState<BannerAdHandler>
@Composable
expect fun rememberBannerAd(activity: Any?, adUnitId: String = AdUnitId.BANNER_DEFAULT, adSize: AdSize = AdSize.FULL_BANNER, onLoad: () -> Unit = {}, onFailure: (Exception) -> Unit = {}, onDismissed: () -> Unit = {}, onShown: () -> Unit = {}, onImpression: () -> Unit = {}, onClick: () -> Unit = {}): MutableState<BannerAdHandler>

A Composable function that remembers a BannerAdHandler across compositions.

@Composable
actual fun rememberBannerAd(adUnitId: String, adSize: AdSize, onLoad: () -> Unit, onFailure: (Exception) -> Unit, onDismissed: () -> Unit, onShown: () -> Unit, onImpression: () -> Unit, onClick: () -> Unit): MutableState<BannerAdHandler>
@Composable
actual fun rememberBannerAd(activity: Any?, adUnitId: String, adSize: AdSize, onLoad: () -> Unit, onFailure: (Exception) -> Unit, onDismissed: () -> Unit, onShown: () -> Unit, onImpression: () -> Unit, onClick: () -> Unit): MutableState<BannerAdHandler>

A Composable function that remembers a BannerAdHandler across compositions.

Link copied to clipboard
@Composable
actual fun rememberConsent(): MutableState<Consent>
@Composable
actual fun rememberConsent(debugSettings: ConsentDebugSettings): MutableState<Consent>
@Composable
actual fun rememberConsent(requestParameters: ConsentRequestParameters): MutableState<Consent>
@Composable
actual fun rememberConsent(activity: Any?): MutableState<Consent>

Composable function to remember and manage user consent for ads.

@Composable
expect fun rememberConsent(): MutableState<Consent>
@Composable
expect fun rememberConsent(debugSettings: ConsentDebugSettings): MutableState<Consent>
@Composable
expect fun rememberConsent(requestParameters: ConsentRequestParameters): MutableState<Consent>
@Composable
expect fun rememberConsent(activity: Any?): MutableState<Consent>

Composable function to remember and manage user consent for ads.

@Composable
actual fun rememberConsent(): MutableState<Consent>
@Composable
actual fun rememberConsent(debugSettings: ConsentDebugSettings): MutableState<Consent>
@Composable
actual fun rememberConsent(requestParameters: ConsentRequestParameters): MutableState<Consent>
@Composable
actual fun rememberConsent(activity: Any?): MutableState<Consent>

Composable function to remember and manage user consent for ads.

Link copied to clipboard
@Composable
actual fun rememberInterstitialAd(adUnitId: String, onLoad: () -> Unit, onFailure: (Exception) -> Unit): MutableState<InterstitialAdHandler>
@Composable
actual fun rememberInterstitialAd(activity: Any?, adUnitId: String, onLoad: () -> Unit, onFailure: (Exception) -> Unit): MutableState<InterstitialAdHandler>

Composable function to remember an interstitial ad.

@Composable
expect fun rememberInterstitialAd(adUnitId: String = AdUnitId.INTERSTITIAL_DEFAULT, onLoad: () -> Unit = {}, onFailure: (Exception) -> Unit = {}): MutableState<InterstitialAdHandler>
@Composable
expect fun rememberInterstitialAd(activity: Any?, adUnitId: String = AdUnitId.INTERSTITIAL_DEFAULT, onLoad: () -> Unit = {}, onFailure: (Exception) -> Unit = {}): MutableState<InterstitialAdHandler>

Composable function to remember an interstitial ad.

@Composable
actual fun rememberInterstitialAd(adUnitId: String, onLoad: () -> Unit, onFailure: (Exception) -> Unit): MutableState<InterstitialAdHandler>
@Composable
actual fun rememberInterstitialAd(activity: Any?, adUnitId: String, onLoad: () -> Unit, onFailure: (Exception) -> Unit): MutableState<InterstitialAdHandler>

Composable function to remember an interstitial ad.

Link copied to clipboard
@RequiresPermission(value = "android.permission.INTERNET")
@Composable
actual fun rememberNativeAd(adUnitId: String, onLoad: () -> Unit, onFailure: (Exception) -> Unit, onDismissed: () -> Unit, onShown: () -> Unit, onImpression: () -> Unit, onClick: () -> Unit): MutableState<NativeAdHandler>
@RequiresPermission(value = "android.permission.INTERNET")
@Composable
actual fun rememberNativeAd(activity: Any?, adUnitId: String, onLoad: () -> Unit, onFailure: (Exception) -> Unit, onDismissed: () -> Unit, onShown: () -> Unit, onImpression: () -> Unit, onClick: () -> Unit): MutableState<NativeAdHandler>

Remembers a NativeAdHandler across compositions.

@Composable
expect fun rememberNativeAd(adUnitId: String = AdUnitId.NATIVE_DEFAULT, onLoad: () -> Unit = {}, onFailure: (Exception) -> Unit = {}, onDismissed: () -> Unit = {}, onShown: () -> Unit = {}, onImpression: () -> Unit = {}, onClick: () -> Unit = {}): MutableState<NativeAdHandler>
@Composable
expect fun rememberNativeAd(activity: Any?, adUnitId: String = AdUnitId.NATIVE_DEFAULT, onLoad: () -> Unit = {}, onFailure: (Exception) -> Unit = {}, onDismissed: () -> Unit = {}, onShown: () -> Unit = {}, onImpression: () -> Unit = {}, onClick: () -> Unit = {}): MutableState<NativeAdHandler>

Remembers a NativeAdHandler across compositions.

@Composable
actual fun rememberNativeAd(adUnitId: String, onLoad: () -> Unit, onFailure: (Exception) -> Unit, onDismissed: () -> Unit, onShown: () -> Unit, onImpression: () -> Unit, onClick: () -> Unit): MutableState<NativeAdHandler>
@Composable
actual fun rememberNativeAd(activity: Any?, adUnitId: String, onLoad: () -> Unit, onFailure: (Exception) -> Unit, onDismissed: () -> Unit, onShown: () -> Unit, onImpression: () -> Unit, onClick: () -> Unit): MutableState<NativeAdHandler>

Remembers a NativeAdHandler across compositions.

Link copied to clipboard
@Composable
actual fun rememberRewardedAd(adUnitId: String, onLoad: () -> Unit, onFailure: (Exception) -> Unit): MutableState<RewardedAdHandler>
@Composable
actual fun rememberRewardedAd(activity: Any?, adUnitId: String, onLoad: () -> Unit, onFailure: (Exception) -> Unit): MutableState<RewardedAdHandler>
@Composable
actual fun rememberRewardedAd(userId: String, customData: String, adUnitId: String, onLoad: () -> Unit, onFailure: (Exception) -> Unit): MutableState<RewardedAdHandler>
@Composable
actual fun rememberRewardedAd(activity: Any?, userId: String, customData: String, adUnitId: String, onLoad: () -> Unit, onFailure: (Exception) -> Unit): MutableState<RewardedAdHandler>

Remembers a RewardedAdHandler, which is used to load and show rewarded ads.

@Composable
expect fun rememberRewardedAd(adUnitId: String = AdUnitId.REWARDED_DEFAULT, onLoad: () -> Unit = {}, onFailure: (Exception) -> Unit = {}): MutableState<RewardedAdHandler>
@Composable
expect fun rememberRewardedAd(activity: Any?, adUnitId: String = AdUnitId.REWARDED_DEFAULT, onLoad: () -> Unit = {}, onFailure: (Exception) -> Unit = {}): MutableState<RewardedAdHandler>
@Composable
expect fun rememberRewardedAd(userId: String, customData: String, adUnitId: String = AdUnitId.REWARDED_DEFAULT, onLoad: () -> Unit = {}, onFailure: (Exception) -> Unit = {}): MutableState<RewardedAdHandler>
@Composable
expect fun rememberRewardedAd(activity: Any?, userId: String, customData: String, adUnitId: String = AdUnitId.REWARDED_DEFAULT, onLoad: () -> Unit = {}, onFailure: (Exception) -> Unit = {}): MutableState<RewardedAdHandler>

Remembers a RewardedAdHandler, which is used to load and show rewarded ads.

@Composable
actual fun rememberRewardedAd(adUnitId: String, onLoad: () -> Unit, onFailure: (Exception) -> Unit): MutableState<RewardedAdHandler>
@Composable
actual fun rememberRewardedAd(activity: Any?, adUnitId: String, onLoad: () -> Unit, onFailure: (Exception) -> Unit): MutableState<RewardedAdHandler>
@Composable
actual fun rememberRewardedAd(userId: String, customData: String, adUnitId: String, onLoad: () -> Unit, onFailure: (Exception) -> Unit): MutableState<RewardedAdHandler>
@Composable
actual fun rememberRewardedAd(activity: Any?, userId: String, customData: String, adUnitId: String, onLoad: () -> Unit, onFailure: (Exception) -> Unit): MutableState<RewardedAdHandler>

Remembers a RewardedAdHandler, which is used to load and show rewarded ads.

Link copied to clipboard
@Composable
actual fun rememberRewardedInterstitialAd(adUnitId: String, onLoad: () -> Unit, onFailure: (Exception) -> Unit): MutableState<RewardedInterstitialAdHandler>
@Composable
actual fun rememberRewardedInterstitialAd(activity: Any?, adUnitId: String, onLoad: () -> Unit, onFailure: (Exception) -> Unit): MutableState<RewardedInterstitialAdHandler>

A composable function that remembers and manages a RewardedInterstitialAdHandler.

@Composable
expect fun rememberRewardedInterstitialAd(adUnitId: String = AdUnitId.REWARDED_INTERSTITIAL_DEFAULT, onLoad: () -> Unit = {}, onFailure: (Exception) -> Unit = {}): MutableState<RewardedInterstitialAdHandler>
@Composable
expect fun rememberRewardedInterstitialAd(activity: Any?, adUnitId: String = AdUnitId.REWARDED_INTERSTITIAL_DEFAULT, onLoad: () -> Unit = {}, onFailure: (Exception) -> Unit = {}): MutableState<RewardedInterstitialAdHandler>

A composable function that remembers and manages a RewardedInterstitialAdHandler.

@Composable
actual fun rememberRewardedInterstitialAd(adUnitId: String, onLoad: () -> Unit, onFailure: (Exception) -> Unit): MutableState<RewardedInterstitialAdHandler>
@Composable
actual fun rememberRewardedInterstitialAd(activity: Any?, adUnitId: String, onLoad: () -> Unit, onFailure: (Exception) -> Unit): MutableState<RewardedInterstitialAdHandler>

A composable function that remembers and manages a RewardedInterstitialAdHandler.

Link copied to clipboard
@Composable
fun RewardedAd(loadedAd: RewardedAdHandler, onRewardEarned: (RewardItem) -> Unit, onDismissed: () -> Unit = {}, onShown: () -> Unit = {}, onImpression: () -> Unit = {}, onClick: () -> Unit = {}, onFailure: (Exception) -> Unit = {})

Displays a pre-loaded Rewarded Ad using a Composable.

@Composable
fun RewardedAd(adUnitId: String = AdUnitId.REWARDED_DEFAULT, onRewardEarned: (RewardItem) -> Unit, onDismissed: () -> Unit = {}, onShown: () -> Unit = {}, onImpression: () -> Unit = {}, onClick: () -> Unit = {}, onFailure: (Exception) -> Unit = {}, onLoad: () -> Unit = {})
@Composable
fun RewardedAd(activity: Any?, adUnitId: String = AdUnitId.REWARDED_DEFAULT, onRewardEarned: (RewardItem) -> Unit, onDismissed: () -> Unit = {}, onShown: () -> Unit = {}, onImpression: () -> Unit = {}, onClick: () -> Unit = {}, onFailure: (Exception) -> Unit = {}, onLoad: () -> Unit = {})
@Composable
fun RewardedAd(userId: String, customData: String, adUnitId: String = AdUnitId.REWARDED_DEFAULT, onRewardEarned: (RewardItem) -> Unit, onDismissed: () -> Unit = {}, onShown: () -> Unit = {}, onImpression: () -> Unit = {}, onClick: () -> Unit = {}, onFailure: (Exception) -> Unit = {}, onLoad: () -> Unit = {})
@Composable
fun RewardedAd(activity: Any?, userId: String, customData: String, adUnitId: String = AdUnitId.REWARDED_DEFAULT, onRewardEarned: (RewardItem) -> Unit, onDismissed: () -> Unit = {}, onShown: () -> Unit = {}, onImpression: () -> Unit = {}, onClick: () -> Unit = {}, onFailure: (Exception) -> Unit = {}, onLoad: () -> Unit = {})

Loads and displays a Rewarded Ad using a Composable.

Link copied to clipboard
@Composable
fun RewardedInterstitialAd(loadedAd: RewardedInterstitialAdHandler, onRewardEarned: () -> Unit, onDismissed: () -> Unit = {}, onShown: () -> Unit = {}, onImpression: () -> Unit = {}, onClick: () -> Unit = {}, onFailure: (Exception) -> Unit = {})

Displays a pre-loaded Rewarded Interstitial Ad using a Composable.

@Composable
fun RewardedInterstitialAd(adUnitId: String = AdUnitId.REWARDED_INTERSTITIAL_DEFAULT, onRewardEarned: () -> Unit, onDismissed: () -> Unit = {}, onShown: () -> Unit = {}, onImpression: () -> Unit = {}, onClick: () -> Unit = {}, onFailure: (Exception) -> Unit = {}, onLoad: () -> Unit = {})
@Composable
fun RewardedInterstitialAd(activity: Any?, adUnitId: String = AdUnitId.REWARDED_INTERSTITIAL_DEFAULT, onRewardEarned: () -> Unit, onDismissed: () -> Unit = {}, onShown: () -> Unit = {}, onImpression: () -> Unit = {}, onClick: () -> Unit = {}, onFailure: (Exception) -> Unit = {}, onLoad: () -> Unit = {})

Loads and displays a Rewarded Interstitial Ad using a Composable.