Zum Inhalt springen

API

method initialize(...)

initialize(options?: AdMobInitializationOptions | undefined) => Promise<void>

Initialisiert das Google Mobile Ads SDK.

Parameter Typ Beschreibung
options AdMobInitializationOptions Optionale Einstellungen zur SDK-Initialisierung.

Seit: 1.1.2


method trackingAuthorizationStatus()

trackingAuthorizationStatus() => Promise<TrackingAuthorizationStatusInterface>

Liefert unter iOS 14 und neuer den aktuellen App-Tracking-Transparency-Autorisierungsstatus.
Auf älteren iOS-Versionen, Android und im Web wird authorized zurückgegeben.

Rückgabe: Promise<TrackingAuthorizationStatusInterface>

Seit: 3.1.0


method requestTrackingAuthorization()

requestTrackingAuthorization() => Promise<void>

Fordert unter iOS 14 und neuer die App-Tracking-Transparency-Autorisierung an.
Auf älteren iOS-Versionen, Android und im Web wird der Aufruf ohne Aktion aufgelöst.

Seit: 5.2.0


method setApplicationMuted(...)

setApplicationMuted(options: ApplicationMutedOptions) => Promise<void>

Teilt dem Google Mobile Ads SDK mit, ob der Anwendungston stummgeschaltet ist.

Parameter Typ
options ApplicationMutedOptions

Seit: 4.1.1


method setApplicationVolume(...)

setApplicationVolume(options: ApplicationVolumeOptions) => Promise<void>

Teilt dem Google Mobile Ads SDK die Audiolautstärke der Anwendung mit.

Parameter Typ
options ApplicationVolumeOptions

Seit: 4.1.1


method loadAppOpen(...)

loadAppOpen(options: AppOpenAdOptions) => Promise<AdLoadInfo>

Lädt eine App-Open-Anzeige und gibt die Kennung des geladenen Anzeigenblocks zurück.

Parameter Typ
options AppOpenAdOptions

Rückgabe: Promise<AdLoadInfo>


method showAppOpen(...)

showAppOpen(options?: AdShowOptions | undefined) => Promise<void>

Zeigt eine geladene App-Open-Anzeige an.

Parameter Typ Beschreibung
options AdShowOptions Optional. Übergeben Sie { adId }, um eine bestimmte vorbereitete Anzeige statt der neuesten anzuzeigen.

method isAppOpenLoaded(...)

isAppOpenLoaded(options?: AdShowOptions | undefined) => Promise<{ value: boolean; }>

Prüft, ob eine App-Open-Anzeige geladen ist.

Parameter Typ Beschreibung
options AdShowOptions Optional. Übergeben Sie eine adId, um eine bestimmte vorbereitete Anzeige statt der neuesten zu prüfen.

Rückgabe: Promise<{ value: boolean; }>


method addListener(AppOpenAdPluginEvents.Loaded, ...)

addListener(eventName: AppOpenAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für das Laden von App-Open-Anzeigen.

Parameter Typ
eventName AppOpenAdPluginEvents.Loaded
listenerFunc (info: AdLoadInfo) => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(AppOpenAdPluginEvents.FailedToLoad, ...)

addListener(eventName: AppOpenAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für Ladefehler von App-Open-Anzeigen.

Parameter Typ
eventName AppOpenAdPluginEvents.FailedToLoad
listenerFunc (error: AdMobError) => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(AppOpenAdPluginEvents.Opened, ...)

addListener(eventName: AppOpenAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>

Registriert einen Listener für das Öffnen von App-Open-Anzeigen.

Parameter Typ
eventName AppOpenAdPluginEvents.Opened
listenerFunc () => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(AppOpenAdPluginEvents.Closed, ...)

addListener(eventName: AppOpenAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>

Registriert einen Listener für das Schließen von App-Open-Anzeigen.

Parameter Typ
eventName AppOpenAdPluginEvents.Closed
listenerFunc () => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(AppOpenAdPluginEvents.FailedToShow, ...)

addListener(eventName: AppOpenAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für Anzeigefehler von App-Open-Anzeigen.

Parameter Typ
eventName AppOpenAdPluginEvents.FailedToShow
listenerFunc (error: AdMobError) => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(AppOpenAdPluginEvents.AdImpression, ...)

addListener(eventName: AppOpenAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für Erlösereignisse auf Impressionsebene bei App-Open-Anzeigen.

Parameter Typ
eventName AppOpenAdPluginEvents.AdImpression
listenerFunc (data: AdMobRevenueData) => void

Rückgabe: Promise<PluginListenerHandle>


method showBanner(...)

showBanner(options: BannerAdOptions) => Promise<void>

Zeigt eine Banneranzeige an.

Parameter Typ Beschreibung
options BannerAdOptions AdOptions

Seit: 1.1.2


method hideBanner()

hideBanner() => Promise<void>

Blendet das aktuelle Banner aus, ohne es zu zerstören.

Seit: 1.1.2


method resumeBanner()

resumeBanner() => Promise<void>

Zeigt ein zuvor ausgeblendetes Banner an.

Seit: 1.1.2


method removeBanner()

removeBanner() => Promise<void>

Zerstört das aktuelle Banner und entfernt es vom Bildschirm.

Seit: 1.1.2


method addListener(BannerAdPluginEvents.SizeChanged, ...)

addListener(eventName: BannerAdPluginEvents.SizeChanged, listenerFunc: (info: AdMobBannerSize) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für Änderungen der angezeigten Bannerabmessungen.

Parameter Typ Beschreibung
eventName BannerAdPluginEvents.SizeChanged bannerAdSizeChanged
listenerFunc (info: AdMobBannerSize) => void

Rückgabe: Promise<PluginListenerHandle>

Seit: 3.0.0


method addListener(BannerAdPluginEvents.Loaded, ...)

addListener(eventName: BannerAdPluginEvents.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

Registriert einen Listener für das Laden von Banneranzeigen.

Parameter Typ Beschreibung
eventName BannerAdPluginEvents.Loaded bannerAdLoaded
listenerFunc () => void

Rückgabe: Promise<PluginListenerHandle>

Seit: 3.0.0


method addListener(BannerAdPluginEvents.FailedToLoad, ...)

addListener(eventName: BannerAdPluginEvents.FailedToLoad, listenerFunc: (info: AdMobError) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für Ladefehler von Banneranzeigen.

Parameter Typ Beschreibung
eventName BannerAdPluginEvents.FailedToLoad bannerAdFailedToLoad
listenerFunc (info: AdMobError) => void

Rückgabe: Promise<PluginListenerHandle>

Seit: 3.0.0


method addListener(BannerAdPluginEvents.Opened, ...)

addListener(eventName: BannerAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>

Registriert einen Listener für das Öffnen eines Banner-Overlays.

Parameter Typ Beschreibung
eventName BannerAdPluginEvents.Opened bannerAdOpened
listenerFunc () => void

Rückgabe: Promise<PluginListenerHandle>

Seit: 3.0.0


method addListener(BannerAdPluginEvents.Closed, ...)

addListener(eventName: BannerAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>

Registriert einen Listener für das Schließen eines Banner-Overlays.

Parameter Typ Beschreibung
eventName BannerAdPluginEvents.Closed bannerAdClosed
listenerFunc () => void

Rückgabe: Promise<PluginListenerHandle>

Seit: 3.0.0


method addListener(BannerAdPluginEvents.AdImpression, ...)

addListener(eventName: BannerAdPluginEvents.AdImpression, listenerFunc: () => void) => Promise<PluginListenerHandle>

Registriert einen Listener für Banner-Impressionen.

Parameter Typ Beschreibung
eventName BannerAdPluginEvents.AdImpression AdImpression
listenerFunc () => void

Rückgabe: Promise<PluginListenerHandle>

Seit: 3.0.0


method addListener(BannerAdPluginEvents.AdPaid, ...)

addListener(eventName: BannerAdPluginEvents.AdPaid, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für Erlösereignisse auf Impressionsebene bei Bannern.

Parameter Typ
eventName BannerAdPluginEvents.AdPaid
listenerFunc (data: AdMobRevenueData) => void

Rückgabe: Promise<PluginListenerHandle>


method requestConsentInfo(...)

requestConsentInfo(options?: AdmobConsentRequestOptions | undefined) => Promise<AdmobConsentInfo>

Informationen zur Einwilligung des Nutzers anfordern

Parameter Typ Beschreibung
options AdmobConsentRequestOptions ConsentRequestOptions

Rückgabe: Promise<AdmobConsentInfo>

Seit: 5.0.0


method showPrivacyOptionsForm()

showPrivacyOptionsForm() => Promise<void>

Zeigt ein Google-Formular für Datenschutzoptionen an, das aus Ihrer Konfiguration für DSGVO-Meldungen erstellt wird.

Seit: 7.0.3


method showConsentForm()

showConsentForm() => Promise<AdmobConsentInfo>

Zeigt ein Google-Einwilligungsformular an, das aus Ihrer Konfiguration für DSGVO-Meldungen erstellt wird.

Rückgabe: Promise<AdmobConsentInfo>

Seit: 5.0.0


method resetConsentInfo()

resetConsentInfo() => Promise<void>

Setzt den Zustand des UMP SDK zurück. requestConsentInfo erneut aufrufen, damit der Nutzer seine Einwilligung ändern kann.

Seit: 5.0.0


method prepareInterstitial(...)

prepareInterstitial(options: AdOptions) => Promise<AdLoadInfo>

Lädt eine Interstitial-Anzeige und gibt die Kennung des geladenen Anzeigenblocks zurück.

Parameter Typ Beschreibung
options AdOptions AdOptions

Rückgabe: Promise<AdLoadInfo>

Seit: 1.1.2


method showInterstitial(...)

showInterstitial(options?: AdShowOptions | undefined) => Promise<void>

Zeigt eine geladene Interstitial-Anzeige an.

Parameter Typ Beschreibung
options AdShowOptions Optional. Übergeben Sie { adId }, um eine bestimmte vorbereitete Anzeige statt der neuesten anzuzeigen.

Seit: 1.1.2


method addListener(InterstitialAdPluginEvents.FailedToLoad, ...)

addListener(eventName: InterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für Ladefehler von Interstitial-Anzeigen.

Parameter Typ
eventName InterstitialAdPluginEvents.FailedToLoad
listenerFunc (error: AdMobError) => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(InterstitialAdPluginEvents.Loaded, ...)

addListener(eventName: InterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für das Laden von Interstitial-Anzeigen.

Parameter Typ
eventName InterstitialAdPluginEvents.Loaded
listenerFunc (info: AdLoadInfo) => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(InterstitialAdPluginEvents.Dismissed, ...)

addListener(eventName: InterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>

Registriert einen Listener für das Schließen von Interstitial-Anzeigen.

Parameter Typ
eventName InterstitialAdPluginEvents.Dismissed
listenerFunc () => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(InterstitialAdPluginEvents.FailedToShow, ...)

addListener(eventName: InterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für Anzeigefehler von Interstitial-Anzeigen.

Parameter Typ
eventName InterstitialAdPluginEvents.FailedToShow
listenerFunc (error: AdMobError) => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(InterstitialAdPluginEvents.Showed, ...)

addListener(eventName: InterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>

Registriert einen Listener für die Anzeige von Interstitial-Anzeigen.

Parameter Typ
eventName InterstitialAdPluginEvents.Showed
listenerFunc () => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(InterstitialAdPluginEvents.AdImpression, ...)

addListener(eventName: InterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für Erlösereignisse auf Impressionsebene bei Interstitial-Anzeigen.

Parameter Typ
eventName InterstitialAdPluginEvents.AdImpression
listenerFunc (data: AdMobRevenueData) => void

Rückgabe: Promise<PluginListenerHandle>


method prepareRewardVideoAd(...)

prepareRewardVideoAd(options: RewardAdOptions) => Promise<AdLoadInfo>

Lädt eine Rewarded-Anzeige und gibt die Kennung des geladenen Anzeigenblocks zurück.

Parameter Typ Beschreibung
options RewardAdOptions RewardAdOptions

Rückgabe: Promise<AdLoadInfo>

Seit: 1.1.2


method showRewardVideoAd(...)

showRewardVideoAd(options?: AdShowOptions | undefined) => Promise<AdMobRewardItem>

Zeigt eine geladene Rewarded-Anzeige an und wird aufgelöst, wenn der Nutzer die Belohnung erhält.

Parameter Typ Beschreibung
options AdShowOptions Optional. Übergeben Sie { adId }, um eine bestimmte vorbereitete Anzeige statt der neuesten anzuzeigen.

Rückgabe: Promise<AdMobRewardItem>

Seit: 1.1.2


method addListener(RewardAdPluginEvents.FailedToLoad, ...)

addListener(eventName: RewardAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für Ladefehler von Rewarded-Anzeigen.

Parameter Typ
eventName RewardAdPluginEvents.FailedToLoad
listenerFunc (error: AdMobError) => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(RewardAdPluginEvents.Loaded, ...)

addListener(eventName: RewardAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für das Laden von Rewarded-Anzeigen.

Parameter Typ
eventName RewardAdPluginEvents.Loaded
listenerFunc (info: AdLoadInfo) => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(RewardAdPluginEvents.Rewarded, ...)

addListener(eventName: RewardAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardItem) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für erhaltene Belohnungen.

Parameter Typ
eventName RewardAdPluginEvents.Rewarded
listenerFunc (reward: AdMobRewardItem) => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(RewardAdPluginEvents.Dismissed, ...)

addListener(eventName: RewardAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>

Registriert einen Listener für das Schließen von Rewarded-Anzeigen.

Parameter Typ
eventName RewardAdPluginEvents.Dismissed
listenerFunc () => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(RewardAdPluginEvents.FailedToShow, ...)

addListener(eventName: RewardAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für Anzeigefehler von Rewarded-Anzeigen.

Parameter Typ
eventName RewardAdPluginEvents.FailedToShow
listenerFunc (error: AdMobError) => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(RewardAdPluginEvents.Showed, ...)

addListener(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>

Registriert einen Listener für die Anzeige von Rewarded-Anzeigen.

Parameter Typ
eventName RewardAdPluginEvents.Showed
listenerFunc () => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(RewardAdPluginEvents.AdImpression, ...)

addListener(eventName: RewardAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für Erlösereignisse auf Impressionsebene bei Rewarded-Anzeigen.

Parameter Typ
eventName RewardAdPluginEvents.AdImpression
listenerFunc (data: AdMobRevenueData) => void

Rückgabe: Promise<PluginListenerHandle>


method prepareRewardInterstitialAd(...)

prepareRewardInterstitialAd(options: RewardInterstitialAdOptions) => Promise<AdLoadInfo>

Lädt eine Rewarded-Interstitial-Anzeige und gibt die Kennung des geladenen Anzeigenblocks zurück.

Parameter Typ Beschreibung
options RewardInterstitialAdOptions RewardInterstitialAdOptions

Rückgabe: Promise<AdLoadInfo>

Seit: 1.1.2


method showRewardInterstitialAd(...)

showRewardInterstitialAd(options?: AdShowOptions | undefined) => Promise<AdMobRewardInterstitialItem>

Zeigt eine geladene Rewarded-Interstitial-Anzeige an und wird aufgelöst, wenn der Nutzer die Belohnung erhält.

Parameter Typ Beschreibung
options AdShowOptions Optional. Übergeben Sie { adId }, um eine bestimmte vorbereitete Anzeige statt der neuesten anzuzeigen.

Rückgabe: Promise<AdMobRewardInterstitialItem>

Seit: 1.1.2


method addListener(RewardInterstitialAdPluginEvents.FailedToLoad, ...)

addListener(eventName: RewardInterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für Ladefehler von Rewarded-Interstitial-Anzeigen.

Parameter Typ
eventName RewardInterstitialAdPluginEvents.FailedToLoad
listenerFunc (error: AdMobError) => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(RewardInterstitialAdPluginEvents.Loaded, ...)

addListener(eventName: RewardInterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für das Laden von Rewarded-Interstitial-Anzeigen.

Parameter Typ
eventName RewardInterstitialAdPluginEvents.Loaded
listenerFunc (info: AdLoadInfo) => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(RewardInterstitialAdPluginEvents.Rewarded, ...)

addListener(eventName: RewardInterstitialAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardInterstitialItem) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für erhaltene Belohnungen.

Parameter Typ
eventName RewardInterstitialAdPluginEvents.Rewarded
listenerFunc (reward: AdMobRewardInterstitialItem) => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(RewardInterstitialAdPluginEvents.Dismissed, ...)

addListener(eventName: RewardInterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>

Registriert einen Listener für das Schließen von Rewarded-Interstitial-Anzeigen.

Parameter Typ
eventName RewardInterstitialAdPluginEvents.Dismissed
listenerFunc () => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(RewardInterstitialAdPluginEvents.FailedToShow, ...)

addListener(eventName: RewardInterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für Anzeigefehler von Rewarded-Interstitial-Anzeigen.

Parameter Typ
eventName RewardInterstitialAdPluginEvents.FailedToShow
listenerFunc (error: AdMobError) => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(RewardInterstitialAdPluginEvents.Showed, ...)

addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>

Registriert einen Listener für die Anzeige von Rewarded-Interstitial-Anzeigen.

Parameter Typ
eventName RewardInterstitialAdPluginEvents.Showed
listenerFunc () => void

Rückgabe: Promise<PluginListenerHandle>


method addListener(RewardInterstitialAdPluginEvents.AdImpression, ...)

addListener(eventName: RewardInterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>

Registriert einen Listener für Erlösereignisse auf Impressionsebene bei Rewarded-Interstitial-Anzeigen.

Parameter Typ
eventName RewardInterstitialAdPluginEvents.AdImpression
listenerFunc (data: AdMobRevenueData) => void

Rückgabe: Promise<PluginListenerHandle>


Interfaces

interface AdMobInitializationOptions

Eigenschaft Typ Beschreibung Standard Seit
testingDevices string[] Geräte-IDs, die als Testgeräte registriert werden, wenn {@link AdMobInitializationOptions.initializeForTesting} true ist. Anfragen von registrierten Geräten erhalten Testanzeigen und erzeugen keinen ungültigen Traffic. 1.2.0
initializeForTesting boolean Ob {@link AdMobInitializationOptions.testingDevices} als Testgeräte registriert werden sollen. false 1.2.0
tagForChildDirectedTreatment boolean Für die Anforderungen des Children’s Online Privacy Protection Act (COPPA) gibt es die Einstellung tagForChildDirectedTreatment. 3.1.0
tagForUnderAgeOfConsent boolean Bei Verwendung dieser Funktion wird allen zukünftigen Anzeigenanfragen ein TFUA-Parameter für Nutzer unterhalb des europäischen Einwilligungsalters hinzugefügt. 3.1.0
maxAdContentRating MaxAdContentRating Maximale Inhaltsbewertung für alle Anzeigenanfragen. Anzeigen mit einer höheren Bewertung werden ausgeschlossen. 3.1.0

interface TrackingAuthorizationStatusInterface

Aktueller App-Tracking-Transparency-Autorisierungsstatus unter iOS.

Eigenschaft Typ Beschreibung
status 'authorized' \| 'denied' \| 'notDetermined' \| 'restricted' Von App Tracking Transparency gemeldeter Autorisierungsstatus.

interface ApplicationMutedOptions

Eigenschaft Typ Beschreibung Seit
muted boolean Teilt dem SDK mit, dass die App-Lautstärke stummgeschaltet wurde. Hinweis: Videoanzeigen, die nicht mit stummgeschaltetem Ton angezeigt werden dürfen, werden bei Anzeigenanfragen nicht zurückgegeben, wenn die App-Lautstärke als stumm oder als Wert 0 gemeldet wird. Dadurch kann ein Teil des verfügbaren Angebots an Videoanzeigen ausgeschlossen werden. 4.1.1

interface ApplicationVolumeOptions

Eigenschaft Typ Beschreibung Seit
volume 0 \| 1 \| 0.1 \| 0.2 \| 0.3 \| 0.4 \| 0.5 \| 0.6 \| 0.7 \| 0.8 \| 0.9 Wenn Ihre App eigene Lautstärkeregler hat, etwa für Musik oder Soundeffekte, können Videoanzeigen diese Einstellungen berücksichtigen, wenn die App-Lautstärke dem Google Mobile Ads SDK mitgeteilt wird. Einen unterstützten Wert zwischen 0.0 (stumm) und 1.0 (volle Lautstärke) verwenden. 4.1.1

interface AdLoadInfo

Nach dem erfolgreichen Laden einer Anzeige zurückgegebene Informationen.

Eigenschaft Typ Beschreibung
adUnitId string Kennung des geladenen Anzeigenblocks.

interface AppOpenAdOptions

Optionen zum Laden einer App-Open-Anzeige.

Eigenschaft Typ Beschreibung
adId string Kennung des zu ladenden App-Open-Anzeigenblocks.

interface AdShowOptions

Optionen zum Auswählen einer bereits geladenen Anzeige für die Anzeige oder Prüfung.

Eigenschaft Typ Beschreibung Seit
adId string Kennung des zuvor vorbereiteten Anzeigenblocks, auf den sich der Vorgang bezieht. Wenn sie fehlt, wird die zuletzt vorbereitete Anzeige verwendet. 8.0.1

interface PluginListenerHandle

Eigenschaft Typ
remove () => Promise<void>

interface AdMobError

Ein vom Google Mobile Ads SDK zurückgegebener Fehler.

Eigenschaft Typ Beschreibung
code number Liefert den Fehlercode.
message string Liefert die Meldung, die den Fehler beschreibt.

interface AdMobRevenueData

Von einem bezahlten Anzeigenereignis gelieferte Erlösdaten auf Impressionsebene.

Eigenschaft Typ Beschreibung
adUnitId string Dem bezahlten Anzeigenereignis zugeordnete Anzeigenblockkennung.
valueMicros number Anzeigenwert in Mikros; 1.000.000 Mikros entsprechen einer Währungseinheit.
currencyCode string ISO-4217-Währungscode für valueMicros.
precision AdValuePrecision Genauigkeit des gemeldeten Anzeigenwerts.
networkName string Klassenname des Vermittlungsadapters, der die Impression ausgeliefert hat, oder eine leere Zeichenfolge, wenn er nicht verfügbar ist.
impressionId string Der Impression zugeordnete Antwortkennung oder eine leere Zeichenfolge, wenn sie nicht verfügbar ist.

interface BannerAdOptions

Optionen zur Anzeige einer Banneranzeige.

Diese Schnittstelle erweitert AdOptions.

Eigenschaft Typ Beschreibung Standard Seit
adSize BannerAdSize Größe des anzuzeigenden Banners. ADAPTIVE_BANNER 3.0.0
position BannerAdPosition Position, an der das Banner angezeigt wird. TOP_CENTER 1.1.2
adId string Kennung des zu ladenden Anzeigenblocks. 1.1.2
isTesting boolean Ob eine Testanzeige angefordert werden soll. false 1.1.2
margin number Bannerabstand in logischen Anzeigeeinheiten (dp unter Android und Punkte unter iOS). Bei BOTTOM_CENTER ist dies der untere Abstand, bei TOP_CENTER der obere. 0 1.1.2
npa boolean Ob nicht personalisierte Anzeigen angefordert werden sollen. false 1.2.0
immersiveMode boolean Ob eine Vollbildanzeige unter Android im immersiven Modus angezeigt werden soll. 7.0.3

interface AdMobBannerSize

Angezeigte Bannerabmessungen in logischen Anzeigeeinheiten (dp unter Android und Punkte unter iOS).
Ein ausgeblendetes, entferntes oder fehlgeschlagenes Banner kann für beide Abmessungen 0 melden.

Eigenschaft Typ Beschreibung
width number Angezeigte Bannerbreite.
height number Angezeigte Bannerhöhe.

interface AdmobConsentInfo

Eigenschaft Typ Beschreibung Seit
status AdmobConsentStatus Einwilligungsstatus des Nutzers. 5.0.0
isConsentFormAvailable boolean Bei true ist ein Einwilligungsformular verfügbar; andernfalls nicht. 5.0.0
canRequestAds boolean Bei true kann eine Anzeige angezeigt werden. 7.0.3
privacyOptionsRequirementStatus PrivacyOptionsRequirementStatus Status der erforderlichen Datenschutzoptionen des Nutzers. 7.0.3

interface AdmobConsentRequestOptions

Eigenschaft Typ Beschreibung Standard Seit
debugGeography AdmobConsentDebugGeography Legt die Debug-Geografie fest, um die Einwilligung lokal zu testen. 5.0.0
testDeviceIdentifiers string[] Ein Array zulässiger Testgeräte-IDs. Hinweis: Unter iOS kann die ID nach einer Deinstallation und Neuinstallation der App erneuert werden. 5.0.0
tagForUnderAgeOfConsent boolean Auf true setzen, um dem Nutzer die Möglichkeit zu geben, der Anzeige personalisierter Werbung zuzustimmen. false 5.0.0

interface AdOptions

Gemeinsame Optionen zum Anfordern einer Anzeige.

Eigenschaft Typ Beschreibung Standard Seit
adId string Kennung des zu ladenden Anzeigenblocks. 1.1.2
isTesting boolean Ob eine Testanzeige angefordert werden soll. false 1.1.2
margin number Bannerabstand in logischen Anzeigeeinheiten (dp unter Android und Punkte unter iOS). Bei BOTTOM_CENTER ist dies der untere Abstand, bei TOP_CENTER der obere. 0 1.1.2
npa boolean Ob nicht personalisierte Anzeigen angefordert werden sollen. false 1.2.0
immersiveMode boolean Ob eine Vollbildanzeige unter Android im immersiven Modus angezeigt werden soll. 7.0.3

interface RewardAdOptions

Optionen zum Laden einer Rewarded-Anzeige.

Eigenschaft Typ Beschreibung Standard Seit
ssv AtLeastOne<{ /** * A user identifier passed to the SSV callback. */ userId: string; /** * Custom data passed to the SSV callback. */ customData: string; }> Optionen für die serverseitige Verifizierung einer Rewarded-Anzeige. Mindestens einen der Werte userId oder customData angeben.
adId string Kennung des zu ladenden Anzeigenblocks. 1.1.2
isTesting boolean Ob eine Testanzeige angefordert werden soll. false 1.1.2
margin number Bannerabstand in logischen Anzeigeeinheiten (dp unter Android und Punkte unter iOS). Bei BOTTOM_CENTER ist dies der untere Abstand, bei TOP_CENTER der obere. 0 1.1.2
npa boolean Ob nicht personalisierte Anzeigen angefordert werden sollen. false 1.2.0
immersiveMode boolean Ob eine Vollbildanzeige unter Android im immersiven Modus angezeigt werden soll. 7.0.3

interface AdMobRewardItem

Belohnung, die der Nutzer nach dem Ansehen einer Rewarded-Anzeige erhalten hat.

Eigenschaft Typ Beschreibung
type string Für den Anzeigenblock konfigurierter Typ des Belohnungsartikels.
amount number Vom Nutzer erhaltener Belohnungsbetrag.

interface RewardInterstitialAdOptions

Optionen zum Laden einer Rewarded-Interstitial-Anzeige.

Eigenschaft Typ Beschreibung Standard Seit
ssv AtLeastOne<{ /** * A user identifier passed to the SSV callback. */ userId: string; /** * Custom data passed to the SSV callback. */ customData: string; }> Optionen für die serverseitige Verifizierung einer Rewarded-Interstitial-Anzeige. Mindestens einen der Werte userId oder customData angeben.
adId string Kennung des zu ladenden Anzeigenblocks. 1.1.2
isTesting boolean Ob eine Testanzeige angefordert werden soll. false 1.1.2
margin number Bannerabstand in logischen Anzeigeeinheiten (dp unter Android und Punkte unter iOS). Bei BOTTOM_CENTER ist dies der untere Abstand, bei TOP_CENTER der obere. 0 1.1.2
npa boolean Ob nicht personalisierte Anzeigen angefordert werden sollen. false 1.2.0
immersiveMode boolean Ob eine Vollbildanzeige unter Android im immersiven Modus angezeigt werden soll. 7.0.3

interface AdMobRewardInterstitialItem

Belohnung, die der Nutzer nach dem Ansehen einer Rewarded-Interstitial-Anzeige erhalten hat.

Eigenschaft Typ Beschreibung
type string Für den Anzeigenblock konfigurierter Typ des Belohnungsartikels.
amount number Vom Nutzer erhaltener Belohnungsbetrag.

Typaliase

type alias AtLeastOne

{[K in keyof T]: Pick<T, K>}[keyof T]

type alias Pick

Wählt aus T eine Menge von Properties, deren Schlüssel in der Union K enthalten sind

{ [P in K]: T[P]; }

Enums

enum MaxAdContentRating

Member Wert Beschreibung
General 'General' Inhalte für ein allgemeines Publikum, einschließlich Familien.
ParentalGuidance 'ParentalGuidance' Inhalte für die meisten Zielgruppen mit elterlicher Begleitung.
Teen 'Teen' Inhalte für Jugendliche und ältere Zielgruppen.
MatureAudience 'MatureAudience' Inhalte ausschließlich für Erwachsene.

enum AppOpenAdPluginEvents

Member Wert Beschreibung
Loaded 'appOpenAdLoaded' Wird ausgelöst, wenn eine App-Open-Anzeige geladen wurde.
FailedToLoad 'appOpenAdFailedToLoad' Wird ausgelöst, wenn eine App-Open-Anzeige nicht geladen werden kann.
Opened 'appOpenAdOpened' Wird ausgelöst, wenn eine App-Open-Anzeige angezeigt wird.
Closed 'appOpenAdClosed' Wird ausgelöst, wenn eine App-Open-Anzeige geschlossen wird.
FailedToShow 'appOpenAdFailedToShow' Wird ausgelöst, wenn eine geladene App-Open-Anzeige nicht angezeigt werden kann.
AdImpression 'appOpenAdImpression' Liefert Erlösdaten auf Impressionsebene, wenn ein bezahltes Anzeigenereignis erfasst wird.

enum AdValuePrecision

Member Wert Beschreibung
Unknown 0 Die Genauigkeit des Anzeigenwerts ist unbekannt.
Estimated 1 Der Anzeigenwert wird aus aggregierten Daten geschätzt.
PublisherProvided 2 Der Anzeigenwert wurde vom Publisher bereitgestellt.
Precise 3 Der Anzeigenwert entspricht dem genauen für diese Anzeige bezahlten Betrag.

enum BannerAdSize

Member Wert Beschreibung
BANNER 'BANNER' Banner-Anzeigengröße der Mobile Marketing Association (MMA) (320x50 dichteunabhängige Pixel).
FULL_BANNER 'FULL_BANNER' Full-Banner-Anzeigengröße des Interactive Advertising Bureau (IAB) (468x60 dichteunabhängige Pixel).
LARGE_BANNER 'LARGE_BANNER' Anzeigengröße für ein großes Banner (320x100 dichteunabhängige Pixel).
MEDIUM_RECTANGLE 'MEDIUM_RECTANGLE' Medium-Rectangle-Anzeigengröße des Interactive Advertising Bureau (IAB) (300x250 dichteunabhängige Pixel).
LEADERBOARD 'LEADERBOARD' Leaderboard-Anzeigengröße des Interactive Advertising Bureau (IAB) (728x90 dichteunabhängige Pixel).
ADAPTIVE_BANNER 'ADAPTIVE_BANNER' Ein Banner mit dynamischer Größe, das die gesamte Breite nutzt und seine Höhe automatisch anpasst.
SMART_BANNER 'SMART_BANNER' Ein älteres Smart Banner, dessen Größe sich an der Bildschirmbreite orientiert. Aus Kompatibilitätsgründen beibehalten; für neue Integrationen ADAPTIVE_BANNER verwenden.

enum BannerAdPosition

Member Wert Beschreibung
TOP_CENTER 'TOP_CENTER' Positioniert das Banner oben mittig auf dem Bildschirm.
CENTER 'CENTER' Positioniert das Banner in der Bildschirmmitte.
BOTTOM_CENTER 'BOTTOM_CENTER' Positioniert das Banner unten mittig auf dem Bildschirm.

enum BannerAdPluginEvents

Member Wert Beschreibung
SizeChanged "bannerAdSizeChanged" Wird ausgelöst, wenn sich die Größe des angezeigten Banners ändert.
Loaded "bannerAdLoaded" Wird ausgelöst, wenn eine Banneranzeige geladen wurde.
FailedToLoad "bannerAdFailedToLoad" Wird ausgelöst, wenn eine Banneranzeige nicht geladen werden kann.
Opened "bannerAdOpened" Wird ausgelöst, wenn ein Banner nach einer Berührung durch den Nutzer ein Overlay öffnet.
Closed "bannerAdClosed" Wird ausgelöst, wenn das Banner-Overlay geschlossen wird.
AdImpression "bannerAdImpression" Wird ausgelöst, wenn eine Impression der Banneranzeige erfasst wird.
AdPaid "bannerAdPaid" Liefert Erlösdaten auf Impressionsebene, wenn ein bezahltes Anzeigenereignis erfasst wird.

enum AdmobConsentStatus

Member Wert Beschreibung
NOT_REQUIRED 'NOT_REQUIRED' Die Einwilligung des Nutzers ist nicht erforderlich.
OBTAINED 'OBTAINED' Die Einwilligung des Nutzers liegt bereits vor.
REQUIRED 'REQUIRED' Die Einwilligung des Nutzers ist erforderlich, liegt aber noch nicht vor.
UNKNOWN 'UNKNOWN' Unbekannter Einwilligungsstatus. AdsConsent.requestInfoUpdate muss aufgerufen werden, um ihn zu aktualisieren.

enum PrivacyOptionsRequirementStatus

Member Wert Beschreibung
NOT_REQUIRED 'NOT_REQUIRED' Ein Einstiegspunkt für Datenschutzoptionen ist nicht erforderlich.
REQUIRED 'REQUIRED' Ein Einstiegspunkt für Datenschutzoptionen ist erforderlich.
UNKNOWN 'UNKNOWN' Ob ein Einstiegspunkt für Datenschutzoptionen erforderlich ist, ist unbekannt.

enum AdmobConsentDebugGeography

Member Wert Beschreibung
DISABLED 0 Debug-Geografie deaktiviert.
EEA 1 Die geografische Zuordnung wird für Debug-Geräte als innerhalb des EWR dargestellt.
NOT_EEA 2 Die geografische Zuordnung wird für Debug-Geräte als außerhalb des EWR dargestellt.
US 3 Die geografische Zuordnung wird für Debug-Geräte als regulierter US-Bundesstaat dargestellt.
OTHER 4 Die geografische Zuordnung wird für Debug-Geräte als OTHER dargestellt.

enum InterstitialAdPluginEvents

Member Wert Beschreibung
Loaded 'interstitialAdLoaded' Wird ausgelöst, wenn eine Interstitial-Anzeige geladen und zur Anzeige bereit ist.
FailedToLoad 'interstitialAdFailedToLoad' Wird ausgelöst, wenn eine Interstitial-Anzeige nicht geladen werden kann.
Showed 'interstitialAdShowed' Wird ausgelöst, wenn eine Interstitial-Anzeige angezeigt wird.
FailedToShow 'interstitialAdFailedToShow' Wird ausgelöst, wenn eine geladene Interstitial-Anzeige nicht angezeigt werden kann.
Dismissed 'interstitialAdDismissed' Wird ausgelöst, wenn eine Interstitial-Anzeige geschlossen wird.
AdImpression 'interstitialAdImpression' Liefert Erlösdaten auf Impressionsebene, wenn ein bezahltes Anzeigenereignis erfasst wird.

enum RewardAdPluginEvents

Member Wert Beschreibung
Loaded 'onRewardedVideoAdLoaded' Wird ausgelöst, wenn eine Rewarded-Anzeige geladen und zur Anzeige bereit ist.
FailedToLoad 'onRewardedVideoAdFailedToLoad' Wird ausgelöst, wenn eine Rewarded-Anzeige nicht geladen werden kann.
Showed 'onRewardedVideoAdShowed' Wird ausgelöst, wenn eine Rewarded-Anzeige angezeigt wird.
FailedToShow 'onRewardedVideoAdFailedToShow' Wird ausgelöst, wenn eine geladene Rewarded-Anzeige nicht angezeigt werden kann.
Dismissed 'onRewardedVideoAdDismissed' Wird ausgelöst, wenn eine Rewarded-Anzeige geschlossen wird. Dieses Ereignis sagt nicht aus, ob der Nutzer eine Belohnung erhalten hat. Separat auf Rewarded reagieren, bevor die Belohnung gewährt wird.
Rewarded 'onRewardedVideoAdReward' Wird ausgelöst, wenn der Nutzer die angekündigte Belohnung erhält.
AdImpression 'onRewardedVideoAdImpression' Liefert Erlösdaten auf Impressionsebene, wenn ein bezahltes Anzeigenereignis erfasst wird.

enum RewardInterstitialAdPluginEvents

Member Wert Beschreibung
Loaded 'onRewardedInterstitialAdLoaded' Wird ausgelöst, wenn eine Rewarded-Interstitial-Anzeige geladen und zur Anzeige bereit ist.
FailedToLoad 'onRewardedInterstitialAdFailedToLoad' Wird ausgelöst, wenn eine Rewarded-Interstitial-Anzeige nicht geladen werden kann.
Showed 'onRewardedInterstitialAdShowed' Wird ausgelöst, wenn eine Rewarded-Interstitial-Anzeige angezeigt wird.
FailedToShow 'onRewardedInterstitialAdFailedToShow' Wird ausgelöst, wenn eine geladene Rewarded-Interstitial-Anzeige nicht angezeigt werden kann.
Dismissed 'onRewardedInterstitialAdDismissed' Wird ausgelöst, wenn eine Rewarded-Interstitial-Anzeige geschlossen wird. Dieses Ereignis sagt nicht aus, ob der Nutzer eine Belohnung erhalten hat. Separat auf Rewarded reagieren, bevor die Belohnung gewährt wird.
Rewarded 'onRewardedInterstitialAdReward' Wird ausgelöst, wenn der Nutzer die angekündigte Belohnung erhält.
AdImpression 'onRewardedInterstitialAdImpression' Liefert Erlösdaten auf Impressionsebene, wenn ein bezahltes Anzeigenereignis erfasst wird.