AdSdk class abstract interface

The seam between ad_flow and google_mobile_ads — the ONLY door to the plugin.

Everything above this interface is plugin-agnostic and fully testable with FakeAdSdk; GmaAdSdk maps it onto the real plugin (legacy or Next-Gen native SDK alike).

All load* methods complete with a handle on success and throw an AdFlowError (kind loadFailed) on failure.

Implementers

Properties

appForegroundEvents Stream<AppForegroundEvent>
Emits every time the app returns to the foreground (warm start).
no setter
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

canRequestAds() Future<bool>
Whether ads may be requested. THE gate: no load* call is allowed until this is true.
getConsentStatus() Future<AdConsentStatus>
Current consent status.
getPrivacyOptionsRequirementStatus() Future<PrivacyOptionsRequirement>
Whether the app must surface a privacy-options entry point.
getTrackingAuthorizationStatus() Future<AttStatus>
The current ATT authorization status. Android/others → AttStatus.notSupported.
initialize() Future<void>
Initializes the underlying Mobile Ads SDK.
isConsentFormAvailable() Future<bool>
Whether a consent form is available to show.
loadAndShowConsentFormIfRequired() Future<void>
Loads and shows the consent form if consent is required; completes when dismissed. Throws an AdFlowError (kind consent) on form error.
loadAppOpen(String adUnitId, AdRequestOptions options) Future<AppOpenHandle>
Loads an app open ad.
loadBanner(BannerLoadSpec spec) Future<BannerHandle>
Loads a banner ad per spec.
loadInterstitial(String adUnitId, AdRequestOptions options) Future<InterstitialHandle>
Loads an interstitial ad.
loadNative(NativeLoadSpec spec) Future<NativeHandle>
Loads a native ad per spec.
loadRewarded(String adUnitId, AdRequestOptions options, {ServerSideVerification? ssv}) Future<RewardedHandle>
Loads a rewarded ad. ssv configures server-side reward verification.
loadRewardedInterstitial(String adUnitId, AdRequestOptions options, {ServerSideVerification? ssv}) Future<RewardedInterstitialHandle>
Loads a rewarded interstitial ad. ssv configures server-side reward verification.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
openAdInspector() Future<AdInspectorResult>
Opens the Ad Inspector debug overlay.
requestConsentInfoUpdate({bool? tagForUnderAgeOfConsent, ConsentDebugOptions? debug}) Future<void>
Refreshes UMP consent info. Call once every app launch.
requestTrackingAuthorization() Future<AttStatus>
Shows the iOS system tracking prompt (only when the current status is AttStatus.notDetermined) and resolves to the resulting status. A no-op returning AttStatus.notSupported off iOS.
resetConsent() Future<void>
Resets UMP consent state. Testing only — never call in production.
showPrivacyOptionsForm() Future<void>
Shows the privacy-options form (the "Manage consent" surface). Throws an AdFlowError (kind consent) on form error.
toString() String
A string representation of this object.
inherited
updateRequestConfiguration(AdRequestConfig config) Future<void>
Applies global request configuration (test devices, content rating, COPPA/underage tags).

Operators

operator ==(Object other) bool
The equality operator.
inherited