Das Modul @google/mobile-ads bietet die wichtigsten TypeScript-Schnittstellen, -Klassen und -Funktionen der obersten Ebene für die Integration von Google Mobile Ads in React Native-Anwendungen.
Übersicht
-
SDK-Lebenszyklus und -Initialisierung: Verwenden Sie
initializemitInitializationConfig, um das SDK zu initialisieren, und prüfen Sie die Initialisierungsstatus des Adapters mitgetInitializationStatusundInitializationStatus. -
User Messaging Platform (UMP): Nutzer-Einwilligung verwalten mit
requestConsentInfoUpdate,loadAndShowConsentFormIfRequired,showPrivacyOptionsFormund den Einwilligungsstatus prüfen mitgetConsentStatusundcanRequestAds. -
Konfiguration anfordern: Definieren Sie globale Targeting- und Richtlinieneinstellungen mit
setRequestConfigurationundRequestConfigurationund konfigurieren Sie Optionen wieAgeRestrictedTreatment,MaxAdContentRatingundPublisherPrivacyPersonalizationState. -
Anzeigenformate: Anzeigen mit Formatklassen wie
AppOpenAd,InterstitialAd,RewardedAdundRewardedInterstitialAdladen und präsentieren. -
Entwicklertools: Mit
openAdInspectoroderopenDebugMenukönnen Sie die Anzeigenauslieferung, den Adapterstatus und die SDK-Konfigurationen in Echtzeit prüfen.
| Typaliasse | |
|---|---|
Adapter
|
Stellt die möglichen Initialisierungsstatus eines Vermittlungsadapters dar.
|
Ad
|
Positionen für das Datenschutzinfo-Symbol in der Anzeigenansicht. |
Ad
|
Das Format der angeforderten Anzeige. |
Ad
|
Fehlerinformationen dazu, warum das Anzeigenprüftool fehlgeschlagen ist.
|
Ad
|
Fehler, die sich auf das Öffnen oder den Betrieb des Anzeigenprüftools auswirken.
|
Ad
|
Ausrichtungsoptionen für adaptive Inline-Banneranzeigen und große adaptive Ankerbanneranzeigen.
|
Ad
|
Stellt die Abmessungen einer Anzeige dar. |
Age
|
Definiert die Optionen für die Altersbeschränkung für Anzeigenanfragen.
|
Consent
|
Werte für den Einwilligungsstatus. |
Debug
|
Debug-Werte für geografische Tests. |
Form
|
Stellt Fehlercodes für Fehler bei UMP-Formularvorgängen (User Messaging Platform) dar.
|
Full
|
|
Load
|
Stellt Fehlercodes für Fehler beim Laden von Anzeigen dar.
|
Max
|
Definiert die höchste Altersfreigabe für Anzeigeninhalte für die App und klassifiziert die Arten von Anzeigen, die ausgeliefert werden können.
|
Native
|
Namen, die zum Identifizieren von Standard-Assets für native Anzeigen verwendet werden.
|
Native
|
Gibt das Format einer geladenen nativen Anzeige an. |
Native
|
Einstellungen für das Seitenverhältnis der zurückgegebenen Media für native Anzeigen.
|
On
|
Schnittstellendefinition für einen Callback, der aufgerufen wird, wenn die Benutzeroberfläche des Anzeigeninspektors geschlossen wird.
|
Precision
|
Die Genauigkeit des gemeldeten Anzeigenwerts. |
Privacy
|
Status der Anforderungen an Datenschutzoptionen. |
Publisher
|
Gibt die Personalisierungsstatus für Publisher Privacy Treatment an.
|
Resize
|
Optionen zum Anpassen des Skalierungsmodus von Bildinhalten in „NativeAdMediaView“.
|
Resolved
|
Stellt den endgültigen aufgelösten Status einer Anzeigengröße nach dem Laden einer Anzeige dar.
|
Swipe
|
Anleitung für benutzerdefinierte Klick- und Wischgesten. |
| Variablen | |
|---|---|
Ad
|
Vordefinierte Anzeigengrößen und Hilfsmethoden zum Erstellen responsiver und benutzerdefinierter Größen.
|
| Funktionen | |
|---|---|
can
|
Prüft, ob der aktuelle Einwilligungsstatus das Anfordern von Anzeigen zulässt.
|
get
|
Ruft den aktuellen Einwilligungsstatus des Nutzers ab. |
get
|
Gibt den Initialisierungsstatus des SDK zurück. |
get
|
Prüft, ob für Ihre App ein Einstiegspunkt für die Datenschutzoptionen erforderlich ist.
|
get
|
Ruft die globale Anfragekonfiguration ab. |
initialize
|
Initialisiert das Google Mobile Ads SDK. |
is
|
Prüft, ob ein Einwilligungsformular verfügbar ist. |
load
|
Lädt ein Einwilligungsformular und präsentiert es dem Nutzer, wenn sein aktueller Einwilligungsstatus dies erfordert (z.B. wenn der Status „REQUIRED“ ist).
|
open
|
Öffnet das Overlay des Anzeigenprüftools im Google Mobile Ads SDK.
|
open
|
Öffnet das Debug-Menü. |
parse
|
Parst einen nativen Fehler, der beim Laden von Anzeigen ausgelöst wird, und umschließt ihn mit einem LoadAdError.
|
request
|
Fordert eine Aktualisierung der Einwilligungsinformationen an. |
reset
|
Löscht den gesamten Einwilligungsstatus aus dem nichtflüchtigen Speicher.
|
set
|
Steuert, ob die eigene Publisher-ID aktiviert ist.
|
set
|
Legt die globale Anfragekonfiguration für Compliance und Targeting fest.
|
set
|
Legt die Audiolautstärke der vom Nutzer gesteuerten Anwendung fest.
|
set
|
Legt fest, ob die Anwendung stummgeschaltet ist. |
show
|
Zeigt das Formular für Datenschutzoptionen an. |
Typaliasse
AdapterState
AdapterState: typeof AdapterState[keyof typeof AdapterState]
AdChoicesPlacement
AdChoicesPlacement:
typeof AdChoicesPlacement[keyof typeof AdChoicesPlacement]
| Attribute | |
|---|---|
BOTTOM_
|
Linke untere Ecke der Anzeige. |
BOTTOM_
|
Rechte untere Ecke der Anzeige. |
TOP_
|
Linke obere Ecke der Anzeige. |
TOP_
|
Oben rechts in der Anzeige. |
AdFormat
AdInspectorError
AdInspectorError:
BaseError<AdInspectorErrorCode>
AdInspectorErrorCode
AdInspectorErrorCode:
typeof AdInspectorErrorCode[keyof typeof AdInspectorErrorCode]
AdOrientation
AdOrientation: typeof AdOrientation[keyof typeof AdOrientation]
| Attribute | |
|---|---|
CURRENT
|
|
LANDSCAPE
|
|
PORTRAIT
|
|
AdSize
Stellt die Abmessungen einer Anzeige dar.
Kann eine vordefinierte Größe (z.B. AdSize.LARGE_BANNER) oder eine adaptive Größe sein.
Kann eine vordefinierte Größe (z.B. AdSize.LARGE_BANNER) oder eine adaptive Größe sein.
AgeRestrictedTreatment
AgeRestrictedTreatment:
typeof AgeRestrictedTreatment[keyof typeof AgeRestrictedTreatment]
ConsentStatus
ConsentStatus: typeof ConsentStatus[keyof typeof ConsentStatus]
DebugGeography
DebugGeography: typeof DebugGeography[keyof typeof DebugGeography]
FormErrorCode
FormErrorCode: typeof FormErrorCode[keyof typeof FormErrorCode]
FullScreenContentErrorCode
FullScreenContentErrorCode:
typeof FullScreenContentErrorCode[keyof typeof FullScreenContentErrorCode]
| Attribute | |
|---|---|
AD_
|
Die Anzeige wurde bereits ausgeliefert. |
AD_
|
Die Anzeige ist noch nicht bereit für die Auslieferung. |
AD_
|
Die Anzeige ist zu groß für die Szene (nur iOS). |
APP_
|
Die App befindet sich nicht im Vordergrund. |
INTERNAL_
|
Ein interner Fehler ist aufgetreten, z. B. eine Ausnahme beim Vorbereiten der Anzeigeinhalte.
|
MEDIATION_
|
Der Vermittlungsadapter konnte die Anzeige nicht präsentieren. Den zugrunde liegenden Grund finden Sie unter FullScreenContentError.mediationAdError.
|
UNKNOWN
|
Der Fehlercode konnte keinem bekannten Fehlercode zugeordnet werden.
|
LoadAdErrorCode
LoadAdErrorCode: typeof LoadAdErrorCode[keyof typeof LoadAdErrorCode]
MaxAdContentRating
MaxAdContentRating:
typeof MaxAdContentRating[keyof typeof MaxAdContentRating]
NativeAdAssetNames
NativeAdAssetNames:
typeof NativeAdAssetNames[keyof typeof NativeAdAssetNames]
NativeAdType
NativeAdType: typeof NativeAdType[keyof typeof NativeAdType]
| Attribute | |
|---|---|
BANNER
|
Banneranzeige. |
CUSTOM_
|
Anzeige im benutzerdefinierten nativen Format. |
NATIVE
|
Native Anzeige |
NativeMediaAspectRatio
NativeMediaAspectRatio:
typeof NativeMediaAspectRatio[keyof typeof NativeMediaAspectRatio]
OnAdInspectorClosedListener
OnAdInspectorClosedListener:
((error?) => void)
PrecisionType
PrecisionType: typeof PrecisionType[keyof typeof PrecisionType]
PrivacyOptionsRequirementStatus
PrivacyOptionsRequirementStatus:
typeof PrivacyOptionsRequirementStatus[keyof typeof PrivacyOptionsRequirementStatus]
PublisherPrivacyPersonalizationState
PublisherPrivacyPersonalizationState: typeof PublisherPrivacyPersonalizationState[keyof typeof PublisherPrivacyPersonalizationState]
ResizeMode
ResizeMode: typeof ResizeMode[keyof typeof ResizeMode]
ResolvedAdSize
ResolvedAdSize:
FixedAdSize | FluidAdSize
Bei den meisten Anzeigen wird dies zu einer FixedAdSize mit den genauen Abmessungen
width und height aufgelöst.
Bei dynamisch dimensionierten Banneranzeigen wird dies zu einer FluidAdSize aufgelöst, wobei die Dimensionen von der Ansichtshierarchie verwaltet werden.
SwipeGestureDirection
SwipeGestureDirection:
typeof SwipeGestureDirection[keyof typeof SwipeGestureDirection]
| Attribute | |
|---|---|
DOWN
|
Wische nach unten. |
LEFT
|
Wischen Sie nach links. |
RIGHT
|
Wischen Sie nach rechts. |
UP
|
Wischen Sie nach oben. |
Variablen
AdSize
AdSize: {
BANNER: FixedAdSize;
custom: ((width,
height) => FixedAdSize);
FLUID: FluidAdSize;
FULL_BANNER: FixedAdSize;
getCurrentOrientationInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
getInlineAdaptiveBannerAdSize: ((width,
maxHeight) => InlineAdaptiveAdSize);
getLandscapeInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
getLargeAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
getLargeLandscapeAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
getLargePortraitAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
getPortraitInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
LARGE_BANNER: FixedAdSize;
LEADERBOARD: FixedAdSize;
MEDIUM_RECTANGLE: FixedAdSize;
}
Funktionen
canRequestAds
canRequestAds(): boolean
Prüft, ob der aktuelle Einwilligungsstatus das Anfordern von Anzeigen zulässt.
| Ausgabe | |
|---|---|
boolean
|
true, wenn Sie Anzeigen anfordern können,
false andernfalls.
|
getConsentStatus
getConsentStatus(): ConsentStatus
Ruft den aktuellen Einwilligungsstatus des Nutzers ab.
| Ausgabe | |
|---|---|
ConsentStatus
|
Der aktuelle Einwilligungsstatus. |
getInitializationStatus
getInitializationStatus(): InitializationStatus
Gibt den Initialisierungsstatus des SDK zurück.
Mit dieser Methode können Sie prüfen, ob die Initialisierung des SDK abgeschlossen ist, und den Status einzelner Vermittlungsadapter abrufen.
Mit dieser Methode können Sie prüfen, ob die Initialisierung des SDK abgeschlossen ist, und den Status einzelner Vermittlungsadapter abrufen.
| Ausgabe | |
|---|---|
InitializationStatus
|
Der aktuelle Initialisierungsstatus. |
getPrivacyOptionsRequirementStatus
getPrivacyOptionsRequirementStatus(): PrivacyOptionsRequirementStatus
Prüft, ob für Ihre App ein Einstiegspunkt für Datenschutzoptionen erforderlich ist.
Wenn ein Einstiegspunkt erforderlich ist, fügen Sie Ihrer App ein sichtbares und interaktives UI-Element hinzu, das showPrivacyOptionsForm aufruft, um das Formular für Datenschutzoptionen anzuzeigen. Wenn kein Einstiegspunkt erforderlich ist, konfigurieren Sie das UI-Element so, dass es nicht sichtbar und nicht interaktiv ist.
Wenn ein Einstiegspunkt erforderlich ist, fügen Sie Ihrer App ein sichtbares und interaktives UI-Element hinzu, das showPrivacyOptionsForm aufruft, um das Formular für Datenschutzoptionen anzuzeigen. Wenn kein Einstiegspunkt erforderlich ist, konfigurieren Sie das UI-Element so, dass es nicht sichtbar und nicht interaktiv ist.
| Ausgabe | |
|---|---|
PrivacyOptionsRequirementStatus
|
Der Status der Anforderungen an die Datenschutzoptionen. |
getRequestConfiguration
getRequestConfiguration(): RequestConfiguration
Ruft die globale Anfragekonfiguration ab.
Verwenden Sie diese Methode, um die aktuelle Anfragekonfiguration abzurufen, die global angewendet wurde.
Verwenden Sie diese Methode, um die aktuelle Anfragekonfiguration abzurufen, die global angewendet wurde.
| Ausgabe | |
|---|---|
RequestConfiguration
|
Die aktuelle globale Anfragekonfiguration. |
initialize
initialize(config,
onInitializationComplete?): void
Initialisiert das Google Mobile Ads SDK.
Rufen Sie diese Methode auf, bevor Sie eine Anzeige laden und bevor Sie mit dem Rest des Google Mobile Ads SDK interagieren.
Rufen Sie diese Methode auf, bevor Sie eine Anzeige laden und bevor Sie mit dem Rest des Google Mobile Ads SDK interagieren.
| Parameter | |
|---|---|
config:
InitializationConfig
|
Optionen zum Steuern der SDK-Initialisierung. |
|
Eine Callback-Funktion, die ausgeführt wird, wenn die Initialisierung des SDK abgeschlossen ist. |
isConsentFormAvailable
isConsentFormAvailable(): boolean
Prüft, ob ein Einwilligungsformular verfügbar ist.
| Ausgabe | |
|---|---|
boolean
|
true, wenn ein Einwilligungsformular verfügbar ist, andernfalls false.
|
loadAndShowConsentFormIfRequired
loadAndShowConsentFormIfRequired(onDismissed?): void
Lädt ein Einwilligungsformular und präsentiert es dem Nutzer, wenn sein aktueller Einwilligungsstatus dies erfordert (z.B. wenn der Status „REQUIRED“ ist).
| Parameter | |
|---|---|
|
Callback-Funktion, die aufgerufen wird, wenn das Formular geschlossen wird oder kein Formular erforderlich ist. Sie enthält optional einen FormError, wenn die Präsentation fehlgeschlagen ist. |
openAdInspector
openAdInspector(_listener): void
Öffnet das Overlay des Anzeigenprüftools im Google Mobile Ads SDK.
Mit dieser Methode können Sie Vermittlungseinrichtungen und Anzeigenquellen debuggen.
Mit dieser Methode können Sie Vermittlungseinrichtungen und Anzeigenquellen debuggen.
| Parameter | |
|---|---|
_listener:
OnAdInspectorClosedListener
|
|
openDebugMenu
openDebugMenu(adUnitId): void
Öffnet das Debug-Menü.
Mit dieser Methode können Sie das Debug-Menü für einen bestimmten Anzeigenblock öffnen, um Anzeigenkonfigurationen zu testen und Fehler zu beheben.
Mit dieser Methode können Sie das Debug-Menü für einen bestimmten Anzeigenblock öffnen, um Anzeigenkonfigurationen zu testen und Fehler zu beheben.
| Parameter | |
|---|---|
adUnitId: string
|
Die Anzeigenblock-ID, für die das Menü zur Fehlerbehebung geöffnet werden soll. |
parseLoadAdError
parseLoadAdError(error): LoadAdError
Parst einen nativen Fehler, der beim Laden von Anzeigen ausgelöst wird, und umschließt ihn mit einem LoadAdError.
| Parameter | |
|---|---|
error: unknown
|
Das vom nativen Modul ausgelöste Fehlerobjekt. |
| Ausgabe | |
|---|---|
LoadAdError
|
Ein geparstes LoadAdError-Objekt. |
requestConsentInfoUpdate
requestConsentInfoUpdate(params?, onComplete?): void
Fordert eine Aktualisierung der Einwilligungsinformationen an.
Diese API muss in jeder App-Sitzung aufgerufen werden, bevor getConsentStatus aufgerufen wird.
Nachdem diese API aufgerufen wurde, wird der Rückgabewert von getConsentStatus synchron aktualisiert, um den Einwilligungsstatus aus der vorherigen App-Sitzung zu enthalten, sofern eine vorhanden ist.
getConsentStatus kann nach dem Aufruf des
Diese API muss in jeder App-Sitzung aufgerufen werden, bevor getConsentStatus aufgerufen wird.
Nachdem diese API aufgerufen wurde, wird der Rückgabewert von getConsentStatus synchron aktualisiert, um den Einwilligungsstatus aus der vorherigen App-Sitzung zu enthalten, sofern eine vorhanden ist.
getConsentStatus kann nach dem Aufruf des
onComplete-Callbacks noch einmal auf den aktuellen Status aktualisiert werden.
| Parameter | |
|---|---|
|
Optionale Konfigurationen für die Fehlerbehebung und das Targeting. |
|
Callback-Funktion, die aufgerufen wird, wenn die Aktualisierung der Einwilligungsinformationen abgeschlossen ist. Optional wird ein FormError zurückgegeben, wenn die Anfrage fehlgeschlagen ist. |
Zurücksetzen
reset(): void
Löscht den gesamten Einwilligungsstatus aus dem nichtflüchtigen Speicher.
Nur zu Debugging-Zwecken verwenden.
Nur zu Debugging-Zwecken verwenden.
setPublisherFirstPartyIdEnabled
setPublisherFirstPartyIdEnabled(enabled): void
Legt fest, ob die eigene Publisher-ID aktiviert ist.
Aktiviert oder deaktiviert die eigene Publisher-ID im Google Mobile Ads SDK, die früher als App-interner Schlüssel (SameAppKey) bezeichnet wurde.
Aktiviert oder deaktiviert die eigene Publisher-ID im Google Mobile Ads SDK, die früher als App-interner Schlüssel (SameAppKey) bezeichnet wurde.
- Weitere Informationen
| Parameter | |
|---|---|
enabled: boolean
|
„true“, um die eigene Publisher-ID zu aktivieren, „false“, um sie zu deaktivieren. Die Standardeinstellung ist true.
|
setRequestConfiguration
setRequestConfiguration(_config): void
Legt die globale Anfragekonfiguration für Compliance und Targeting fest.
Mit dieser Methode können Sie Targeting-Details wie die höchste Altersfreigabe für Anzeigeninhalte, Compliance-Einstellungen wie das Tag für die Alterskennzeichnung und Testgeräte-IDs angeben.
Mit dieser Methode können Sie Targeting-Details wie die höchste Altersfreigabe für Anzeigeninhalte, Compliance-Einstellungen wie das Tag für die Alterskennzeichnung und Testgeräte-IDs angeben.
| Parameter | |
|---|---|
_config:
RequestConfiguration
|
|
setUserControlledAppVolume
setUserControlledAppVolume(volume): void
Legt die vom Nutzer gesteuerte Lautstärke der Anwendung fest.
Verwenden Sie diese Methode, um die Lautstärke aller Anzeigen im Verhältnis zu anderen Audioausgaben auf dem Gerät anzupassen.
Verwenden Sie diese Methode, um die Lautstärke aller Anzeigen im Verhältnis zu anderen Audioausgaben auf dem Gerät anzupassen.
| Parameter | |
|---|---|
volume: number
|
Die Lautstärke zwischen 0,0 (stumm) und 1,0 (maximal). Jeder Gleitkommawert in diesem Bereich ist gültig (z.B.0,001 oder 0,33333). Der Wert ist nicht auf bestimmte Schrittgrößen wie 0, 1 beschränkt. |
setUserMutedApp
setUserMutedApp(muted): void
Legt fest, ob die Anwendung stummgeschaltet ist.
Verwenden Sie diese Methode, um den anfänglichen Stummschaltungsstatus nachfolgender Anzeigen zu steuern.
Verwenden Sie diese Methode, um den anfänglichen Stummschaltungsstatus nachfolgender Anzeigen zu steuern.
| Parameter | |
|---|---|
muted: boolean
|
Gibt an, ob der Audioausgang der Anwendung stummgeschaltet werden soll. Die Standardeinstellung ist false.
|
showPrivacyOptionsForm
showPrivacyOptionsForm(onDismissed?): void
Zeigt das Formular für Datenschutzoptionen an.
Stellt ein Formular für Datenschutzoptionen bereit, wenn getPrivacyOptionsRequirementStatus
Diese Methode sollte nur als Reaktion auf eine Nutzereingabe aufgerufen werden, um das Formular für Datenschutzoptionen anzuzeigen.
Das Formular für Datenschutzoptionen wird vom SDK automatisch vorab geladen, wenn ein Formular verfügbar ist. Wenn kein Formular vorab geladen wurde, versucht das SDK, eines asynchron zu laden.
Der
Stellt ein Formular für Datenschutzoptionen bereit, wenn getPrivacyOptionsRequirementStatus
REQUIRED ist.Diese Methode sollte nur als Reaktion auf eine Nutzereingabe aufgerufen werden, um das Formular für Datenschutzoptionen anzuzeigen.
Das Formular für Datenschutzoptionen wird vom SDK automatisch vorab geladen, wenn ein Formular verfügbar ist. Wenn kein Formular vorab geladen wurde, versucht das SDK, eines asynchron zu laden.
Der
onDismissed-Callback wird aufgerufen, nachdem dem Nutzer das Formular präsentiert wurde, er eine Option ausgewählt und das Formular geschlossen hat. Es kann auch ein FormError zurückgegeben werden, wenn:
- Das Formular ist nicht verfügbar.
- Das Formular wird nicht angezeigt.
- Das Formular wird noch vorab geladen.
| Parameter | |
|---|---|
|
Callback-Funktion, die aufgerufen wird, wenn das Formular geschlossen wird. Sie enthält optional einen FormError, wenn die Darstellung fehlgeschlagen ist. |