google_admob_sdk library

Classes

Base class for all self-managed ads in google_admob_sdk.
AdAnalyticsLogger
Abstract logger interface for all analytics events defined in the Databuckets Data Tracking Plan.
AdapterResponseInfo
Metadata about a specific mediation or bidding adapter in the ad response.
AdapterStatus
Status of a single ad network adapter (AdMob or 3rd-party mediation partner).
AdCountdownConfig
Configuration model for customizing the countdown dialog appearance, duration, and text.
AdCountdownDialog
Standard countdown notice dialog displayed prior to full-screen ads.
AdError
Represents an error that occurred during an ad operation.
AdHealthMonitor
Realtime diagnostic monitor for tracking AdMob inventory health.
AdIdConfig
Configuration class for managing Ad Unit IDs and 3rd-party fallback waterfalls across Android & iOS.
AdInspectorError
Error returned by MobileAds.instance.openAdInspector in the Next-Gen SDK.
AdInstanceManager
High-speed, self-managed native bridge and instance manager for Google AdMob and 3rd-Party Mediation networks.
AdLoadTracker
Helper utility for measuring load duration.
AdmobNativeStyles
Factory class for creating NativeTemplateStyle instances matching all Figma designs.
AdPlacementConfig
Configuration for a screen placement that references an ordered priority list of AdUnitSlotConfig.unitKeys, mirroring AdPlacement (priority_ads: "unit1;unit2") in ads-module.
AdRequest
Targeting and configuration parameters for an ad request.
AdRetryPolicy
Policy for managing ad load retry attempts, exponential backoff, and circuit breaking.
AdShimmerEffect
High-performance, GPU-accelerated sweeping shimmer effect using ShaderMask.
AdShimmerStyle
Visual configuration for NativeAdShimmer and BannerAdShimmer.
AdSize
Represents the size of a Banner Ad in logical pixels.
AdUnitSlotConfig
Configuration for a shared 1-slot Ad Unit pool (unitKey), mirroring units in ads-module.
AdWidget
Renders an AdWithView (BannerAd or NativeAd) as a Flutter widget.
AdWithoutView
Base class for full-screen overlay ads (InterstitialAd, RewardedAd, RewardedInterstitialAd, AppOpenAd).
AdWithView
Base class for inline view-based ads (BannerAd, NativeAd) displayed via AdWidget.
AdWithViewListener
Listener for inline AdWithView lifecycle events.
AnalyticsCallOptions
Additional options that can be passed to Analytics method calls. Note; these options are only used on the web.
AnalyticsEventItem
Interface that defines the required attributes of an analytics Item. https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.Param https://developers.google.com/analytics/devguides/collection/ga4/reference/events
AnalyticsEvents
Constants for all analytics event names from the Databuckets Data Tracking Plan.
AnalyticsParams
Constants for all analytics parameter names from the Databuckets Data Tracking Plan.
AnalyticsUserProperties
Constants for user property names from the Databuckets Data Tracking Plan.
AppLifecycleReactor
Helper class that observes app lifecycle state transitions and automatically presents an App Open Ad when the user returns to the application from the background.
AppOpenAd
Self-managed App Open Ad for cold starts and background-to-foreground transitions.
AppOpenAdLoadCallback
Load callback for AppOpenAd.load.
AppOpenAdManager
Helper class for loading, caching, logging performance, waterfall fallback, and showing App Open Ads.
AppOpenAdPreloader
Google Mobile Ads Next-Gen SDK Preloader for AppOpenAd.
AppOpenAdRequest
Next-Gen SDK format-specific request for App Open Ads.
BannerAd
Self-managed Banner Ad supporting standard, adaptive, and collapsible banners.
BannerAdListener
Listener for BannerAd lifecycle events.
BannerAdPool
High-speed global pool for caching, pre-warming, and coalescing BannerAd instances.
BannerAdPreloader
Google Mobile Ads Next-Gen SDK Preloader for BannerAd.
BannerAdRequest
Next-Gen SDK format-specific request for Banner Ads (Standard, Adaptive, Collapsible).
BannerAdShimmer
Layout-accurate Shimmer placeholder for BannerAdWidget adapting to any AdSize.
BannerAdWidget
Pre-built Widget for displaying Banner Ads with built-in load time tracking, 0ms synchronous adaptive sizing, Hot-Swap Standby Pool, 3rd-party mediation tracking, and hedged waterfall fallback.
CompositeAdLogger
Composite logger that delegates to multiple loggers (e.g. Firebase + Console).
ConsentDebugSettings
Debug settings for testing UMP consent flows.
ConsentForm
Self-managed UMP ConsentForm bridge.
ConsentInformation
Self-managed UMP ConsentInformation bridge.
ConsentRequestParameters
Parameters for requesting a UMP consent info update.
ConsoleAdLogger
Console & Device Logger for debugging.
FigmaNativeAdPreview
Pure-Flutter Frame #1 (0.0ms) instant visual layer for a loaded NativeAd matching all Figma Native and Native Fullscreen templates.
Firebase
The entry point for accessing Firebase.
FirebaseAdLogger
Firebase Analytics logger implementation for all Databuckets tracking events.
FirebaseAnalytics
Firebase Analytics API.
FirebaseAnalyticsObserver
A NavigatorObserver that sends events to Firebase Analytics when the currently active ModalRoute changes.
FirebaseApp
Represents a single Firebase app instance.
FirebaseOptions
The options used to configure a Firebase app.
FirebaseService
A marker interface for Firebase services that can be registered in FirebaseApp.
FormError
Error returned during UMP consent operations.
FullScreenAdManager<T extends AdWithoutView>
Loading, waterfall fallback, frequency capping, Databuckets analytics and show logic shared by the fullscreen formats.
FullScreenContentCallback<T extends AdWithoutView>
Callbacks for full-screen presentation events on InterstitialAd, RewardedAd, RewardedInterstitialAd, and AppOpenAd.
GenericMediationExtras
Standard key-value mediation extras for 3rd-party networks.
GoogleAdmobSdk
Main entrance point for initializing and managing the self-managed Google AdMob and 3rd-Party Mediation SDK.
InitializationConfig
Next-Gen SDK initialization configuration (InitializationConfig).
InitializationStatus
Result of initializing the Ad SDK and its registered 3rd-party mediation adapters.
InterstitialAd
Self-managed Full-Screen Interstitial Ad.
InterstitialAdLoadCallback
Load callback for InterstitialAd.load.
InterstitialAdManager
Helper class for loading, caching, logging performance, waterfall fallback, and showing Interstitial Ads.
InterstitialAdPreloader
Google Mobile Ads Next-Gen SDK Preloader for InterstitialAd.
InterstitialAdRequest
Next-Gen SDK format-specific request for Interstitial Ads.
LoadAdError
Represents an error that occurred while loading an ad, including ResponseInfo.
MaxAdContentRating
Maximum ad content rating constants.
MediationConfig
Centralized configuration for 3rd-party ad networks, privacy consent forwarding, RTB pre-warming, and waterfall fallback.
MediationExtras
Custom extras passed to a specific 3rd-party mediation adapter.
MediationManager
Singleton manager for 3rd-party ad networks, adapter health inspection, privacy consent synchronization, and network name resolution.
MobileAds
Self-managed entry point for the underlying Native Mobile Ads engine, upgraded for Google Mobile Ads (GMA) Next-Gen SDK.
NativeAd
Self-managed Native Ad supporting XML/XIB factoryId layouts and NativeTemplateStyle.
NativeAdInterstitialDialog
A Fullscreen Dialog Widget reproducing all 12 Figma "Ads Interstitial" (12:323) variants.
NativeAdListener
Listener for NativeAd lifecycle events.
NativeAdLoader
Next-Gen SDK static loader for NativeAd (NativeAdLoader.load).
NativeAdMetadata
Lightweight Native Ad payload extracted at onAdLoaded time for Frame #1 (0ms) Dual-Layer Instant Flutter rendering while the underlying PlatformView surface attaches.
NativeAdOptions
Configuration options for loading a Native Ad.
NativeAdPool
High-speed global pool for caching, pre-warming, and coalescing NativeAd instances across widgets.
NativeAdPreloader
Google Mobile Ads Next-Gen SDK Preloader for NativeAd.
NativeAdRequest
Next-Gen SDK format-specific request for Native Ads.
NativeAdShimmer
Layout-accurate Shimmer placeholder for NativeAdWidget supporting all Figma Native and Native Fullscreen templates.
NativeAdWidget
Pre-built Widget for displaying Native Ads with built-in load tracking, state management, Hot-Swap Standby Pool, 3rd-party mediation tracking, hedged waterfall fallback, and Figma-inspired presets.
NativeFullScreenAdWidget
Embeddable Fullscreen Native + Video Ad Widget supporting all 12 Figma Ads Interstitial (12:323) variants.
NativeTemplateStyle
Styling configuration for Native Ad templates.
NativeTemplateTextStyle
Text style configuration for a native ad template text slot.
NextGenAdPreloaderBase<T extends Ad>
Base Next-Gen SDK Ad Preloader engine managing buffered inventory, TTL freshness, Databuckets Sheet 41 telemetry, and PreloadCallback (PreloadCallbackV2) lifecycle notifications.
ParallelAdPoolManager
High-speed two-tier (UnitKey + Placement) parallel ad pool orchestrator, bringing ads-module's SharedOzinyAdsPoolStore & Advertisement.kt architecture to Flutter.
PlatformAdIds
Holds primary and optional fallback/3rd-party Ad Unit IDs for Android and iOS per ad type.
PreloadCallback
Callback interface for Next-Gen SDK ad preloading (PreloadCallback / PreloadCallbackV2).
PreloadConfiguration
Next-Gen SDK configuration for preloading ads (PreloadConfiguration).
RequestConfiguration
Global configuration for ad requests, test devices, and COPPA/GDPR compliance.
ResponseInfo
Information about the ad response, including the winning mediation network.
RewardedAd
Self-managed Full-Screen Rewarded Video Ad.
RewardedAdLoadCallback
Load callback for RewardedAd.load.
RewardedAdManager
Helper class for loading, caching, logging performance, waterfall fallback, and showing Rewarded Ads.
RewardedAdPreloader
Google Mobile Ads Next-Gen SDK Preloader for RewardedAd.
RewardedAdRequest
Next-Gen SDK format-specific request for Rewarded Ads.
RewardedInterstitialAd
Self-managed Full-Screen Rewarded Interstitial Ad.
RewardedInterstitialAdLoadCallback
Load callback for RewardedInterstitialAd.load.
RewardedInterstitialAdManager
Helper class for loading, caching, logging performance, waterfall fallback, and showing Rewarded Interstitial Ads.
RewardedInterstitialAdPreloader
Google Mobile Ads Next-Gen SDK Preloader for RewardedInterstitialAd.
RewardedInterstitialAdRequest
Next-Gen SDK format-specific request for Rewarded Interstitial Ads.
RewardItem
Reward item earned by the user after watching a Rewarded or Rewarded Interstitial ad.
ServerSideVerificationOptions
Options for Server-Side Verification (SSV) on Rewarded and Rewarded Interstitial ads.
SharedAdUnitSlot
Manages a single 1-slot shared ad unit (SLOT = 0), mirroring BaseOzinyAdManager in ads-module.
SplashAdCandidate
Represents a single prioritized candidate in a Splash Ad priority race.
SplashAdRaceController
Event-driven Splash Ad Priority Race Controller, mirroring OzinySplashShowHandler.kt in ads-module.
SplashRaceResult
Detailed result returned when SplashAdRaceController.loadAndShow completes.
TagForChildDirectedTreatment
Child-directed treatment (COPPA) constants.
TagForUnderAgeOfConsent
Under-age-of-consent treatment (GDPR-K) constants.
ThirdPartyMediationExtras
Helper factory for building MediationExtras for specific 3rd-party ad networks.
ThirdPartyNetworkCredentials
Optional credentials and initialization parameters for a specific ThirdPartyAdNetwork.
VideoOptions
Video playback options for Native Ads.

Enums

AdapterInitializationState
Initialization state of an ad network adapter.
AdChoicesPlacement
Placement of the AdChoices overlay icon in a Native Ad.
AdFormat
Ad formats supported by the Google Mobile Ads Next-Gen Preloader Engine.
AdSlotState
Four-state lifecycle of a single 1-slot unit manager, mirroring DataState in ads-module.
AdType
CollapsiblePlacement
Placement of the collapsible banner overlay.
ConsentStatus
UMP Consent Status values.
DebugGeography
Geography simulation setting for UMP testing.
MediaAspectRatio
Aspect ratio preference for Native Ad media content.
NativeFullScreenVariant
Complete catalog of all 12 Figma Ads Interstitial / Native full screen ads + video variants (12:323).
NativeShimmerLayout
Layout variants for NativeAdShimmer matching each Figma Native and Native Full template.
NativeTemplateFontStyle
Font style for native ad template text elements.
NativeTemplatePreset
Predefined presets for Native Ad styles matching all Figma Native & Native Full designs.
PrecisionType
Precision type of the ad value reported by ILRD (onPaidEvent).
PrivacyOptionsRequirementStatus
UMP Privacy Options requirement status.
SplashRaceResultType
Outcome of a SplashAdRaceController execution.
TemplateType
Built-in template types for Native Ads.
ThirdPartyAdNetwork
Supported 3rd-party ad networks integrated into google_admob_sdk for Real-Time Bidding (RTB) and Waterfall Mediation (Legacy & GMA Next-Gen SDK).

Mixins

RewardedFullScreenAd<T extends AdWithoutView>
Server-side verification and reward handling shared by RewardedAdManager and RewardedInterstitialAdManager. ad_complete reports end_type done | quit.

Extensions

NativeFullScreenVariantExt on NativeFullScreenVariant
Metadata helper for NativeFullScreenVariant.
NativeTemplatePresetLayoutExt on NativeTemplatePreset
Extension providing layout metadata, default Figma dimensions, and native factory IDs for every NativeTemplatePreset.

Constants

defaultFirebaseAppName → const String
The default Firebase application name.
valueAndCurrencyMustBeTogetherError → const String

Functions

defaultNameExtractor(RouteSettings settings) → String?
defaultRouteFilter(Route? route) → bool
filterOutNulls(Map<String, Object?> parameters) → Map<String, Object>
Creates a new map containing all of the key/value pairs from parameters except those whose value is null.
getMappedHost(String originalHost) → String
showNativeAdInterstitialDialog({required BuildContext context, NativeFullScreenVariant variant = NativeFullScreenVariant.classicCard, String? adUnitId, String? adKey = 'native_interstitial', String? screenName = 'scrInterstitial', String? adPlacement = 'scrInterstitial', String? adUnitName = 'Native_Interstitial', NativeTemplatePreset? templatePreset, NativeTemplateStyle? nativeTemplateStyle, String? cacheKey, NativeAd? preloadedAd, VoidCallback? onAdClosed, VoidCallback? onAdClicked, void onAdLoaded(NativeAd ad)?, void onAdFailedToLoad(LoadAdError error)?, void onAdImpression(NativeAd ad)?, OnPaidEventCallback? onPaidEvent, bool barrierDismissible = false, Color? backgroundColor, double? height, bool? showProgressBar, Color? progressColor, int currentAdIndex = 1, int totalAdsCount = 2, int countdownSeconds = 0, Widget? closeButton, Widget? topBar, EdgeInsetsGeometry? contentPadding}) → Future<void>
Displays a Fullscreen Native + Video Ad Dialog matching all 12 Figma "Ads Interstitial" (Native full screen ads + video, Node 12:323) variants.

Typedefs

AdSlotStateListener = void Function(String unitKey, AdSlotState state)
Callback invoked synchronously (0ms) whenever a SharedAdUnitSlot's AdSlotState changes.
AgeRestrictedTreatment = int
Type alias for age-restricted treatment values (int from TagForChildDirectedTreatment or TagForUnderAgeOfConsent).
AppOpenAdEventCallback = FullScreenContentCallback<AppOpenAd>
Next-Gen SDK unified event callback for AppOpenAd.
BannerAdEventCallback = BannerAdListener
Next-Gen SDK unified event callback for BannerAd.
InterstitialAdEventCallback = FullScreenContentCallback<InterstitialAd>
Next-Gen SDK unified event callback for InterstitialAd.
NativeAdEventCallback = NativeAdListener
Next-Gen SDK unified event callback for NativeAd.
OnPaidEventCallback = void Function(Ad ad, double valueMicros, PrecisionType precision, String currencyCode)
Callback signature for ILRD (Impression-Level Revenue Data) events.
OnUserEarnedRewardCallback = void Function(AdWithoutView ad, RewardItem reward)
Callback signature when a user earns a reward from a RewardedAd or RewardedInterstitialAd.
PreloadCallbackV2 = PreloadCallback
Next-Gen SDK PreloadCallbackV2 alias for PreloadCallback.
RewardedAdEventCallback = FullScreenContentCallback<RewardedAd>
Next-Gen SDK unified event callback for RewardedAd.
RewardedInterstitialAdEventCallback = FullScreenContentCallback<RewardedInterstitialAd>
Next-Gen SDK unified event callback for RewardedInterstitialAd.
RouteFilter = bool Function(Route? route)
RouteFilter allows to filter out routes that should not be tracked.
ScreenNameExtractor = String? Function(RouteSettings settings)
Signature for a function that extracts a screen name from RouteSettings.

Exceptions / Errors

FirebaseException
A generic class which provides exceptions in a Firebase-friendly format to users.