API
Reference for @capacitor-community/admob v8.1.0.
Methods
method initialize(...)
Initializes the Google Mobile Ads SDK.
initialize(options?: AdMobInitializationOptions | undefined) => Promise<void>
method trackingAuthorizationStatus()
Returns the current App Tracking Transparency authorization status on iOS 14 and later.
Returns authorized on earlier iOS versions, Android, and web.
trackingAuthorizationStatus() => Promise<TrackingAuthorizationStatusInterface>
method requestTrackingAuthorization()
Requests App Tracking Transparency authorization on iOS 14 and later.
Resolves without taking action on earlier iOS versions, Android, and web.
requestTrackingAuthorization() => Promise<void>
method setApplicationMuted(...)
Reports whether the application audio is muted to the Google Mobile Ads SDK.
setApplicationMuted(options: ApplicationMutedOptions) => Promise<void>
method setApplicationVolume(...)
Reports the application audio volume to the Google Mobile Ads SDK.
setApplicationVolume(options: ApplicationVolumeOptions) => Promise<void>
method loadAppOpen(...)
Loads an App Open ad and returns the loaded ad unit ID.
loadAppOpen(options: AppOpenAdOptions) => Promise<AdLoadInfo>
method showAppOpen(...)
Shows a loaded App Open ad.
showAppOpen(options?: AdShowOptions | undefined) => Promise<void>
method isAppOpenLoaded(...)
Checks whether an App Open ad is loaded.
isAppOpenLoaded(options?: AdShowOptions | undefined) => Promise<{ value: boolean; }>
method showBanner(...)
Displays a banner ad.
showBanner(options: BannerAdOptions) => Promise<void>
method hideBanner()
Hides the current banner without destroying it.
hideBanner() => Promise<void>
method resumeBanner()
Shows a previously hidden banner.
resumeBanner() => Promise<void>
method removeBanner()
Destroys the current banner and removes it from the screen.
removeBanner() => Promise<void>
method requestConsentInfo(...)
Request user consent information
requestConsentInfo(options?: AdmobConsentRequestOptions | undefined) => Promise<AdmobConsentInfo>
method showPrivacyOptionsForm()
Shows a google privacy options form (rendered from your GDPR message config).
showPrivacyOptionsForm() => Promise<void>
method showConsentForm()
Shows a google user consent form (rendered from your GDPR message config).
showConsentForm() => Promise<AdmobConsentInfo>
method resetConsentInfo()
Resets the UMP SDK state. Call requestConsentInfo function again to allow user modify their consent
resetConsentInfo() => Promise<void>
method prepareInterstitial(...)
Loads an interstitial ad and returns the loaded ad unit ID.
prepareInterstitial(options: AdOptions) => Promise<AdLoadInfo>
method showInterstitial(...)
Shows a loaded interstitial ad.
showInterstitial(options?: AdShowOptions | undefined) => Promise<void>
method prepareRewardVideoAd(...)
Loads a rewarded ad and returns the loaded ad unit ID.
prepareRewardVideoAd(options: RewardAdOptions) => Promise<AdLoadInfo>
method showRewardVideoAd(...)
Shows a loaded rewarded ad and resolves when the user earns the reward.
showRewardVideoAd(options?: AdShowOptions | undefined) => Promise<AdMobRewardItem>
method prepareRewardInterstitialAd(...)
Loads a rewarded interstitial ad and returns the loaded ad unit ID.
prepareRewardInterstitialAd(options: RewardInterstitialAdOptions) => Promise<AdLoadInfo>
method showRewardInterstitialAd(...)
Shows a loaded rewarded interstitial ad and resolves when the user earns the reward.
showRewardInterstitialAd(options?: AdShowOptions | undefined) => Promise<AdMobRewardInterstitialItem>
method addListener(AppOpenAdPluginEvents.Loaded, ...)
Listens for App Open ad load events.
addListener(eventName: AppOpenAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
method addListener(AppOpenAdPluginEvents.FailedToLoad, ...)
Listens for App Open ad load failures.
addListener(eventName: AppOpenAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
method addListener(AppOpenAdPluginEvents.Opened, ...)
Listens for App Open ad opened events.
addListener(eventName: AppOpenAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(AppOpenAdPluginEvents.Closed, ...)
Listens for App Open ad closed events.
addListener(eventName: AppOpenAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(AppOpenAdPluginEvents.FailedToShow, ...)
Listens for App Open ad show failures.
addListener(eventName: AppOpenAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
method addListener(AppOpenAdPluginEvents.AdImpression, ...)
Listens for App Open impression-level ad revenue events.
addListener(eventName: AppOpenAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
method addListener(BannerAdPluginEvents.SizeChanged, ...)
Listens for changes to the displayed banner dimensions.
addListener(eventName: BannerAdPluginEvents.SizeChanged, listenerFunc: (info: AdMobBannerSize) => void) => Promise<PluginListenerHandle>
method addListener(BannerAdPluginEvents.Loaded, ...)
Listens for banner ad load events.
addListener(eventName: BannerAdPluginEvents.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(BannerAdPluginEvents.FailedToLoad, ...)
Listens for banner ad load failures.
addListener(eventName: BannerAdPluginEvents.FailedToLoad, listenerFunc: (info: AdMobError) => void) => Promise<PluginListenerHandle>
method addListener(BannerAdPluginEvents.Opened, ...)
Listens for banner overlay opened events.
addListener(eventName: BannerAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(BannerAdPluginEvents.Closed, ...)
Listens for banner overlay closed events.
addListener(eventName: BannerAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(BannerAdPluginEvents.AdImpression, ...)
Listens for banner impression events.
addListener(eventName: BannerAdPluginEvents.AdImpression, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(BannerAdPluginEvents.AdPaid, ...)
Listens for banner impression-level ad revenue events.
addListener(eventName: BannerAdPluginEvents.AdPaid, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
method addListener(InterstitialAdPluginEvents.FailedToLoad, ...)
Listens for interstitial ad load failures.
addListener(eventName: InterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
method addListener(InterstitialAdPluginEvents.Loaded, ...)
Listens for interstitial ad load events.
addListener(eventName: InterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
method addListener(InterstitialAdPluginEvents.Dismissed, ...)
Listens for interstitial ad dismissed events.
addListener(eventName: InterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(InterstitialAdPluginEvents.FailedToShow, ...)
Listens for interstitial ad show failures.
addListener(eventName: InterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
method addListener(InterstitialAdPluginEvents.Showed, ...)
Listens for interstitial ad shown events.
addListener(eventName: InterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(InterstitialAdPluginEvents.AdImpression, ...)
Listens for interstitial impression-level ad revenue events.
addListener(eventName: InterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
method addListener(RewardAdPluginEvents.FailedToLoad, ...)
Listens for rewarded ad load failures.
addListener(eventName: RewardAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
method addListener(RewardAdPluginEvents.Loaded, ...)
Listens for rewarded ad load events.
addListener(eventName: RewardAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
method addListener(RewardAdPluginEvents.Rewarded, ...)
Listens for earned reward events.
addListener(eventName: RewardAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardItem) => void) => Promise<PluginListenerHandle>
method addListener(RewardAdPluginEvents.Dismissed, ...)
Listens for rewarded ad dismissed events.
addListener(eventName: RewardAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(RewardAdPluginEvents.FailedToShow, ...)
Listens for rewarded ad show failures.
addListener(eventName: RewardAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
method addListener(RewardAdPluginEvents.Showed, ...)
Listens for rewarded ad shown events.
addListener(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(RewardAdPluginEvents.AdImpression, ...)
Listens for rewarded impression-level ad revenue events.
addListener(eventName: RewardAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
method addListener(RewardInterstitialAdPluginEvents.FailedToLoad, ...)
Listens for rewarded interstitial ad load failures.
addListener(eventName: RewardInterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
method addListener(RewardInterstitialAdPluginEvents.Loaded, ...)
Listens for rewarded interstitial ad load events.
addListener(eventName: RewardInterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
method addListener(RewardInterstitialAdPluginEvents.Rewarded, ...)
Listens for earned reward events.
addListener(eventName: RewardInterstitialAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardInterstitialItem) => void) => Promise<PluginListenerHandle>
method addListener(RewardInterstitialAdPluginEvents.Dismissed, ...)
Listens for rewarded interstitial ad dismissed events.
addListener(eventName: RewardInterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(RewardInterstitialAdPluginEvents.FailedToShow, ...)
Listens for rewarded interstitial ad show failures.
addListener(eventName: RewardInterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
method addListener(RewardInterstitialAdPluginEvents.Showed, ...)
Listens for rewarded interstitial ad shown events.
addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
method addListener(RewardInterstitialAdPluginEvents.AdImpression, ...)
Listens for rewarded interstitial impression-level ad revenue events.
addListener(eventName: RewardInterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
addListener contains the typed overloads for all event enums.
Interfaces
interface AdMobInitializationOptions
| Prop | Type | Description | Default | Since |
|---|---|---|---|---|
testingDevices |
string[] |
Device IDs to register as test devices when {@link AdMobInitializationOptions.initializeForTesting} is true. Requests from registered devices receive test ads and do not generate invalid traffic. |
1.2.0 | |
initializeForTesting |
boolean |
Whether to register {@link AdMobInitializationOptions.testingDevices} as test devices. | false | 1.2.0 |
tagForChildDirectedTreatment |
boolean |
For purposes of the Children's Online Privacy Protection Act (COPPA), there is a setting called tagForChildDirectedTreatment. | 3.1.0 | |
tagForUnderAgeOfConsent |
boolean |
When using this feature, a Tag For Users under the Age of Consent in Europe (TFUA) parameter will be included in all future ad requests. | 3.1.0 | |
maxAdContentRating |
MaxAdContentRating |
The maximum ad content rating applied to all ad requests. Ads with a higher rating are excluded. | 3.1.0 |
interface TrackingAuthorizationStatusInterface
The current iOS App Tracking Transparency authorization status.
| Prop | Type | Description |
|---|---|---|
status |
'authorized' | 'denied' | 'notDetermined' | 'restricted' |
The authorization status reported by App Tracking Transparency. |
interface ApplicationMutedOptions
| Prop | Type | Description | Since |
|---|---|---|---|
muted |
boolean |
To inform the SDK that the app volume has been muted. Note: Video ads that are ineligible to be shown with muted audio are not returned for ad requests made, when the app volume is reported as muted or set to a value of 0. This may restrict a subset of the broader video ads pool from serving. | 4.1.1 |
interface ApplicationVolumeOptions
| Prop | Type | Description | Since |
|---|---|---|---|
volume |
0 | 1 | 0.1 | 0.2 | 0.3 | 0.4 | 0.5 | 0.6 | 0.7 | 0.8 | 0.9 |
If your app has its own volume controls (such as custom music or sound effect volumes), disclosing app volume to the Google Mobile Ads SDK allows video ads to respect app volume settings. Use a supported value from 0.0 (silent) to 1.0 (full volume). | 4.1.1 |
interface AdLoadInfo
Information returned after an ad loads successfully.
| Prop | Type | Description |
|---|---|---|
adUnitId |
string |
The ad unit ID of the loaded ad. |
interface AppOpenAdOptions
Options for loading an App Open ad.
| Prop | Type | Description |
|---|---|---|
adId |
string |
The App Open ad unit ID to load. |
interface AdShowOptions
Options for selecting a previously loaded ad to show or inspect.
| Prop | Type | Description | Since |
|---|---|---|---|
adId |
string |
The ad unit ID of a previously prepared ad to target. If omitted, the operation targets the most recently prepared ad. | 8.0.1 |
interface BannerAdOptions
Options for displaying a banner ad.
This interface extends <a href="#adoptions">AdOptions</a>.
| Prop | Type | Description | Default | Since |
|---|---|---|---|---|
adSize |
BannerAdSize |
The banner size to display. | ADAPTIVE_BANNER | 3.0.0 |
position |
BannerAdPosition |
The position where the banner is displayed. | TOP_CENTER | 1.1.2 |
adId |
string |
The ad unit ID to load. | 1.1.2 | |
isTesting |
boolean |
Whether to request a test ad. | false | 1.1.2 |
margin |
number |
The banner margin in logical display units (dp on Android and points on iOS). For BOTTOM_CENTER, this is the bottom margin. For TOP_CENTER, this is the top margin. |
0 | 1.1.2 |
npa |
boolean |
Whether to request non-personalized ads. | false | 1.2.0 |
immersiveMode |
boolean |
Whether to display a full-screen ad in immersive mode on Android. | 7.0.3 |
interface AdMobBannerSize
The displayed banner dimensions in logical display units (dp on Android and points on iOS).
A hidden, removed, or failed banner can report both dimensions as 0.
| Prop | Type | Description |
|---|---|---|
width |
number |
The displayed banner width. |
height |
number |
The displayed banner height. |
interface AdmobConsentInfo
| Prop | Type | Description | Since |
|---|---|---|---|
status |
AdmobConsentStatus |
The consent status of the user. | 5.0.0 |
isConsentFormAvailable |
boolean |
If true a consent form is available and vice versa. |
5.0.0 |
canRequestAds |
boolean |
If true an ad can be shown. |
7.0.3 |
privacyOptionsRequirementStatus |
PrivacyOptionsRequirementStatus |
Privacy options requirement status of the user. | 7.0.3 |
interface AdmobConsentRequestOptions
| Prop | Type | Description | Default | Since |
|---|---|---|---|---|
debugGeography |
AdmobConsentDebugGeography |
Sets the debug geography to test the consent locally. | 5.0.0 | |
testDeviceIdentifiers |
string[] |
An array of test device IDs to allow. Note: On iOS, the ID may renew if you uninstall and reinstall the app. | 5.0.0 | |
tagForUnderAgeOfConsent |
boolean |
Set to true to provide the option for the user to accept being shown personalized ads. |
false | 5.0.0 |
interface AdOptions
Common options for requesting an ad.
| Prop | Type | Description | Default | Since |
|---|---|---|---|---|
adId |
string |
The ad unit ID to load. | 1.1.2 | |
isTesting |
boolean |
Whether to request a test ad. | false | 1.1.2 |
margin |
number |
The banner margin in logical display units (dp on Android and points on iOS). For BOTTOM_CENTER, this is the bottom margin. For TOP_CENTER, this is the top margin. |
0 | 1.1.2 |
npa |
boolean |
Whether to request non-personalized ads. | false | 1.2.0 |
immersiveMode |
boolean |
Whether to display a full-screen ad in immersive mode on Android. | 7.0.3 |
interface RewardAdOptions
Options for loading a rewarded ad.
| Prop | Type | Description | Default | Since |
|---|---|---|---|---|
ssv |
AtLeastOne<{ /** * A user identifier passed to the SSV callback. */ userId: string; /** * Custom data passed to the SSV callback. */ customData: string; }> |
Server-side verification options for the rewarded ad. Provide at least one of userId or customData. |
||
adId |
string |
The ad unit ID to load. | 1.1.2 | |
isTesting |
boolean |
Whether to request a test ad. | false | 1.1.2 |
margin |
number |
The banner margin in logical display units (dp on Android and points on iOS). For BOTTOM_CENTER, this is the bottom margin. For TOP_CENTER, this is the top margin. |
0 | 1.1.2 |
npa |
boolean |
Whether to request non-personalized ads. | false | 1.2.0 |
immersiveMode |
boolean |
Whether to display a full-screen ad in immersive mode on Android. | 7.0.3 |
interface AdMobRewardItem
The reward earned by the user after viewing a rewarded ad.
| Prop | Type | Description |
|---|---|---|
type |
string |
The reward item type configured for the ad unit. |
amount |
number |
The reward amount earned by the user. |
interface RewardInterstitialAdOptions
Options for loading a rewarded interstitial ad.
| Prop | Type | Description | Default | Since |
|---|---|---|---|---|
ssv |
AtLeastOne<{ /** * A user identifier passed to the SSV callback. */ userId: string; /** * Custom data passed to the SSV callback. */ customData: string; }> |
Server-side verification options for the rewarded interstitial ad. Provide at least one of userId or customData. |
||
adId |
string |
The ad unit ID to load. | 1.1.2 | |
isTesting |
boolean |
Whether to request a test ad. | false | 1.1.2 |
margin |
number |
The banner margin in logical display units (dp on Android and points on iOS). For BOTTOM_CENTER, this is the bottom margin. For TOP_CENTER, this is the top margin. |
0 | 1.1.2 |
npa |
boolean |
Whether to request non-personalized ads. | false | 1.2.0 |
immersiveMode |
boolean |
Whether to display a full-screen ad in immersive mode on Android. | 7.0.3 |
interface AdMobRewardInterstitialItem
The reward earned by the user after viewing a rewarded interstitial ad.
| Prop | Type | Description |
|---|---|---|
type |
string |
The reward item type configured for the ad unit. |
amount |
number |
The reward amount earned by the user. |
interface AdMobError
An error returned by the Google Mobile Ads SDK.
| Prop | Type | Description |
|---|---|---|
code |
number |
Gets the error's code. |
message |
string |
Gets the message describing the error. |
interface AdMobRevenueData
Impression-level ad revenue data emitted by a paid event.
| Prop | Type | Description |
|---|---|---|
adUnitId |
string |
The ad unit ID associated with the paid event. |
valueMicros |
number |
The ad value in micros, where 1,000,000 micros equals one currency unit. |
currencyCode |
string |
The ISO 4217 currency code for valueMicros. |
precision |
AdValuePrecision |
The precision of the reported ad value. |
networkName |
string |
The mediation adapter class name that served the impression, or an empty string when unavailable. |
impressionId |
string |
The response identifier associated with the impression, or an empty string when unavailable. |
interface PluginListenerHandle
| Prop | Type |
|---|---|
remove |
() => Promise<void> |
Enums
enum MaxAdContentRating
| Member | Value | Description |
|---|---|---|
General |
'General' |
Content suitable for general audiences, including families. |
ParentalGuidance |
'ParentalGuidance' |
Content suitable for most audiences with parental guidance. |
Teen |
'Teen' |
Content suitable for teen and older audiences. |
MatureAudience |
'MatureAudience' |
Content suitable only for mature audiences. |
enum AppOpenAdPluginEvents
| Member | Value | Description |
|---|---|---|
Loaded |
'appOpenAdLoaded' |
Emits when an App Open ad has loaded. |
FailedToLoad |
'appOpenAdFailedToLoad' |
Emits when an App Open ad fails to load. |
Opened |
'appOpenAdOpened' |
Emits when an App Open ad is shown. |
Closed |
'appOpenAdClosed' |
Emits when an App Open ad is dismissed. |
FailedToShow |
'appOpenAdFailedToShow' |
Emits when a loaded App Open ad fails to show. |
AdImpression |
'appOpenAdImpression' |
Emits impression-level ad revenue data when a paid event is recorded. |
enum AdValuePrecision
| Member | Value | Description |
|---|---|---|
Unknown |
0 |
The ad value precision is unknown. |
Estimated |
1 |
The ad value is estimated from aggregated data. |
PublisherProvided |
2 |
The ad value was provided by the publisher. |
Precise |
3 |
The ad value is the precise value paid for this ad. |
enum BannerAdSize
| Member | Value | Description |
|---|---|---|
BANNER |
'BANNER' |
Mobile Marketing Association (MMA) banner ad size (320x50 density-independent pixels). |
FULL_BANNER |
'FULL_BANNER' |
Interactive Advertising Bureau (IAB) full banner ad size (468x60 density-independent pixels). |
LARGE_BANNER |
'LARGE_BANNER' |
Large banner ad size (320x100 density-independent pixels). |
MEDIUM_RECTANGLE |
'MEDIUM_RECTANGLE' |
Interactive Advertising Bureau (IAB) medium rectangle ad size (300x250 density-independent pixels). |
LEADERBOARD |
'LEADERBOARD' |
Interactive Advertising Bureau (IAB) leaderboard ad size (728x90 density-independent pixels). |
ADAPTIVE_BANNER |
'ADAPTIVE_BANNER' |
A dynamically sized banner that is full-width and auto-height. |
SMART_BANNER |
'SMART_BANNER' |
A legacy smart banner sized to the screen width. Retained for compatibility; use ADAPTIVE_BANNER for new integrations. |
enum BannerAdPosition
| Member | Value | Description |
|---|---|---|
TOP_CENTER |
'TOP_CENTER' |
Positions the banner at the top center of the screen. |
CENTER |
'CENTER' |
Positions the banner at the center of the screen. |
BOTTOM_CENTER |
'BOTTOM_CENTER' |
Positions the banner at the bottom center of the screen. |
enum BannerAdPluginEvents
| Member | Value | Description |
|---|---|---|
SizeChanged |
"bannerAdSizeChanged" |
Emits when the displayed banner size changes. |
Loaded |
"bannerAdLoaded" |
Emits when a banner ad has loaded. |
FailedToLoad |
"bannerAdFailedToLoad" |
Emits when a banner ad fails to load. |
Opened |
"bannerAdOpened" |
Emits when a banner opens an overlay after the user taps it. |
Closed |
"bannerAdClosed" |
Emits when the banner overlay is closed. |
AdImpression |
"bannerAdImpression" |
Emits when an impression is recorded for the banner ad. |
AdPaid |
"bannerAdPaid" |
Emits impression-level ad revenue data when a paid event is recorded. |
enum AdmobConsentStatus
| Member | Value | Description |
|---|---|---|
NOT_REQUIRED |
'NOT_REQUIRED' |
User consent not required. |
OBTAINED |
'OBTAINED' |
User consent already obtained. |
REQUIRED |
'REQUIRED' |
User consent required but not yet obtained. |
UNKNOWN |
'UNKNOWN' |
Unknown consent status, AdsConsent.requestInfoUpdate needs to be called to update it. |
enum PrivacyOptionsRequirementStatus
| Member | Value | Description |
|---|---|---|
NOT_REQUIRED |
'NOT_REQUIRED' |
Privacy options entry point is not required. |
REQUIRED |
'REQUIRED' |
Privacy options entry point is required. |
UNKNOWN |
'UNKNOWN' |
Privacy options requirement status is unknown. |
enum AdmobConsentDebugGeography
| Member | Value | Description |
|---|---|---|
DISABLED |
0 |
Debug geography disabled. |
EEA |
1 |
Geography appears as in EEA for debug devices. |
NOT_EEA |
2 |
Geography appears as not in EEA for debug devices. |
US |
3 |
Geography appears as in regulated US state for debug devices. |
OTHER |
4 |
Geography appears as OTHER state for debug devices. |
enum InterstitialAdPluginEvents
| Member | Value | Description |
|---|---|---|
Loaded |
'interstitialAdLoaded' |
Emits when an interstitial ad has loaded and is ready to show. |
FailedToLoad |
'interstitialAdFailedToLoad' |
Emits when an interstitial ad fails to load. |
Showed |
'interstitialAdShowed' |
Emits when an interstitial ad is shown. |
FailedToShow |
'interstitialAdFailedToShow' |
Emits when a loaded interstitial ad fails to show. |
Dismissed |
'interstitialAdDismissed' |
Emits when an interstitial ad is dismissed. |
AdImpression |
'interstitialAdImpression' |
Emits impression-level ad revenue data when a paid event is recorded. |
enum RewardAdPluginEvents
| Member | Value | Description |
|---|---|---|
Loaded |
'onRewardedVideoAdLoaded' |
Emits when a rewarded ad has loaded and is ready to show. |
FailedToLoad |
'onRewardedVideoAdFailedToLoad' |
Emits when a rewarded ad fails to load. |
Showed |
'onRewardedVideoAdShowed' |
Emits when a rewarded ad is shown. |
FailedToShow |
'onRewardedVideoAdFailedToShow' |
Emits when a loaded rewarded ad fails to show. |
Dismissed |
'onRewardedVideoAdDismissed' |
Emits when a rewarded ad is dismissed. This event does not indicate whether the user earned a reward. Listen for Rewarded separately before granting the reward. |
Rewarded |
'onRewardedVideoAdReward' |
Emits when the user earns the advertised reward. |
AdImpression |
'onRewardedVideoAdImpression' |
Emits impression-level ad revenue data when a paid event is recorded. |
enum RewardInterstitialAdPluginEvents
| Member | Value | Description |
|---|---|---|
Loaded |
'onRewardedInterstitialAdLoaded' |
Emits when a rewarded interstitial ad has loaded and is ready to show. |
FailedToLoad |
'onRewardedInterstitialAdFailedToLoad' |
Emits when a rewarded interstitial ad fails to load. |
Showed |
'onRewardedInterstitialAdShowed' |
Emits when a rewarded interstitial ad is shown. |
FailedToShow |
'onRewardedInterstitialAdFailedToShow' |
Emits when a loaded rewarded interstitial ad fails to show. |
Dismissed |
'onRewardedInterstitialAdDismissed' |
Emits when a rewarded interstitial ad is dismissed. This event does not indicate whether the user earned a reward. Listen for Rewarded separately before granting the reward. |
Rewarded |
'onRewardedInterstitialAdReward' |
Emits when the user earns the advertised reward. |
AdImpression |
'onRewardedInterstitialAdImpression' |
Emits impression-level ad revenue data when a paid event is recorded. |