API Reference

This page lists the classes, enums, and callbacks provided by the Godot AdMob Plugin.

Classes

Class	Description
MobileAds	Global configurations and SDK initialization entry point.
RequestConfiguration	Configuration settings applied globally to all ad requests.
AdRequest	Request parameters used to load ads.
AdSize	Width and height definitions for Banner ads.
AdPosition	Screen alignment layout for banner and native overlay ads.
AdView	A Godot node that loads and displays banner ads.
AdVideoOptions	Playback behavior for video elements inside native ads.
AppOpenAd	Full-screen ad format shown when users open the app.
AppOpenAdLoader	Loader class responsible for fetching App Open Ads.
InterstitialAd	Full-screen interstitial ad format.
InterstitialAdLoader	Loader class responsible for fetching Interstitial Ads.
RewardedAd	Full-screen rewarded ad format.
RewardedAdLoader	Loader class responsible for fetching Rewarded Ads.
RewardedInterstitialAd	Rewarded Interstitial ad format (semi-transparent overlay).
RewardedInterstitialAdLoader	Loader class responsible for fetching Rewarded Interstitial Ads.
NativeOverlayAd	Native ad format overlaid on top of Godot scenes.
NativeAdOptions	Preferences for rendering native overlay ads.
NativeTemplateStyle	Visual styling template for native overlay ads.
NativeTemplateTextStyle	Font and color configuration for text elements.
ResponseInfo	Contains metadata and adapter response info for loaded ads.
AdapterResponseInfo	Metadata from a specific mediation network adapter.
AdError	Information about errors occurring during ad display.
LoadAdError	Information about errors occurring during ad loading.
AdValue	Represents the monetary value of an ad impression.
RewardedItem	Represents a reward earned by the user (amount and type).
InitializationStatus	Contains initialization status details for MobileAds.
AdapterStatus	Represents initialization status for a single mediation adapter.
ServerSideVerificationOptions	Security configurations for server-side rewarded callbacks.
UserMessagingPlatform	Entry point for GDPR and privacy consent flows.
ConsentInformation	Checks and updates the user's consent status.
ConsentForm	Consent form that can be shown to the user.
ConsentRequestParameters	Parameters for requesting consent information updates.
ConsentDebugSettings	Testing configuration for the consent flow.
FormError	Error information for consent form operations.

Enums

Enum	Description
AdPosition	Screen alignment preset values for banner and native overlay ads.
AdChoicesPlacement	Corner placement for the AdChoices icon.
NativeMediaAspectRatio	Media aspect ratio preference for native ads.
NativeTemplateFontStyle	Typographical font weights for native ad text fields.
AdValue.PrecisionType	Precision level of the ad revenue value.
AdapterStatus.InitializationState	Indicates whether a mediation adapter is ready.
RequestConfiguration.TagForChildDirectedTreatment	Child-directed treatment for COPPA compliance.
RequestConfiguration.TagForUnderAgeOfConsent	Under age of consent for GDPR compliance.
DebugGeography	Debug geography for testing consent flow.
ConsentInformation.ConsentStatus	User's consent status for privacy regulations.
ConsentInformation.PrivacyOptionsRequirementStatus	Whether privacy options are required.

Interfaces / Callbacks

Callback	Description
OnInitializationCompleteListener	Callback triggered when the SDK initialization completes.
AdListener	Receives banner and overlay events.
FullScreenContentCallback	Receives presentation events for full-screen formats.
OnUserEarnedRewardListener	Receives event when user earns a reward.
AppOpenAdLoadCallback	Handles loading outcomes for App Open Ads.
InterstitialAdLoadCallback	Handles loading outcomes for Interstitial Ads.
RewardedAdLoadCallback	Handles loading outcomes for Rewarded Ads.
RewardedInterstitialAdLoadCallback	Handles loading outcomes for Rewarded Interstitial Ads.
AdInspectorClosedListener	Triggers when the native Ad Inspector is closed.