Le module @google/mobile-ads fournit les interfaces, les classes et les fonctions de premier niveau TypeScript de base pour intégrer Google Mobile Ads aux applications React Native.
Présentation
-
Cycle de vie et initialisation du SDK : utilisez
initializeavecInitializationConfigpour initialiser le SDK, et inspectez les états d'initialisation de l'adaptateur avecgetInitializationStatusetInitializationStatus. -
User Messaging Platform (UMP) : gérez le consentement utilisateur avec
requestConsentInfoUpdate,loadAndShowConsentFormIfRequired,showPrivacyOptionsFormet inspectez l'état du consentement avecgetConsentStatusetcanRequestAds. -
Configuration de la demande : définissez les paramètres de ciblage et de règles généraux avec
setRequestConfigurationetRequestConfiguration, en configurant des options telles queAgeRestrictedTreatment,MaxAdContentRatingetPublisherPrivacyPersonalizationState. -
Formats d'annonces : chargez et présentez des annonces à l'aide de classes de format telles que
AppOpenAd,InterstitialAd,RewardedAdetRewardedInterstitialAd. -
Outils pour les développeurs : inspectez la diffusion des annonces, l'état de l'adaptateur et les configurations du SDK en temps réel à l'aide de
openAdInspectorouopenDebugMenu.
| Alias de type | |
|---|---|
Adapter
|
Représente les états d'initialisation possibles d'un adaptateur de médiation.
|
Ad
|
Positions de l'icône Choisir sa pub dans la vue de l'annonce. |
Ad
|
Format de l'annonce demandée. |
Ad
|
Informations sur l'erreur expliquant pourquoi l'inspecteur d'annonces a échoué.
|
Ad
|
Erreurs affectant l'ouverture ou le fonctionnement de l'inspecteur d'annonces.
|
Ad
|
Options d'orientation pour les bannières adaptatives intégrées et les grandes bannières adaptatives ancrées.
|
Ad
|
Représente les dimensions d'une annonce. |
Age
|
Définit les options de traitement avec restriction d'âge pour les demandes d'annonces.
|
Consent
|
Valeurs de l'état du consentement. |
Debug
|
Valeurs de débogage pour tester la zone géographique. |
Form
|
Représente les codes d'erreur en cas d'échec des opérations du formulaire User Messaging Platform (UMP).
|
Full
|
|
Load
|
Représente les codes d'erreur en cas d'échec de l'opération de chargement des annonces.
|
Max
|
Définit la classification maximale du contenu des annonces pour l'application, en classant les types d'annonces pouvant être diffusées.
|
Native
|
Noms utilisés pour identifier les composants standards des annonces natives.
|
Native
|
Identifie le format d'une annonce native chargée. |
Native
|
Préférences pour le format des éléments multimédias des annonces natives renvoyées.
|
On
|
Définition d'interface pour un rappel à appeler lorsque l'UI de l'inspecteur d'annonces se ferme.
|
Precision
|
Précision de la valeur de l'annonce indiquée. |
Privacy
|
État des exigences concernant les options de confidentialité. |
Publisher
|
Indique les états de personnalisation du traitement de la confidentialité pour les éditeurs.
|
Resize
|
Options permettant de personnaliser le mode de redimensionnement du contenu d'image dans NativeAdMediaView.
|
Resolved
|
Représente l'état final résolu d'une taille d'annonce après le chargement d'une annonce.
|
Swipe
|
Instructions pour les gestes de clic et de balayage personnalisés. |
| Variables | |
|---|---|
Ad
|
Tailles d'annonces prédéfinies et méthodes d'assistance pour créer des tailles adaptatives et personnalisées.
|
| Fonctions | |
|---|---|
can
|
Vérifie si l'état actuel du consentement vous permet de demander des annonces.
|
get
|
Obtient l'état actuel du consentement de l'utilisateur. |
get
|
Obtient l'état d'initialisation du SDK. |
get
|
Vérifie si un point d'entrée pour les options de confidentialité est requis pour votre application.
|
get
|
Obtient la configuration globale de la requête. |
initialize
|
Initialise le SDK Google Mobile Ads. |
is
|
Vérifie si un formulaire de consentement est disponible. |
load
|
Charge un formulaire de consentement et le présente à l'utilisateur si son état de consentement actuel l'exige (par exemple, si l'état est "REQUIRED").
|
open
|
Ouvre la superposition de l'inspecteur d'annonces du SDK Google Mobile Ads.
|
open
|
Ouvre le menu de débogage. |
parse
|
Analyse une erreur native générée lors du chargement d'une annonce et l'encapsule dans un objet LoadAdError.
|
request
|
Demande une mise à jour des informations sur le consentement. |
reset
|
Efface tous les états de consentement du stockage persistant.
|
set
|
Détermine si l'ID first party de l'éditeur est activé.
|
set
|
Définit la configuration globale des demandes pour la conformité et le ciblage.
|
set
|
Définit le volume audio de l'application contrôlée par l'utilisateur.
|
set
|
Indique si l'application est mise en sourdine. |
show
|
Affiche le formulaire des options de confidentialité. |
Alias de type
AdapterState
AdapterState: typeof AdapterState[keyof typeof AdapterState]
AdChoicesPlacement
AdChoicesPlacement:
typeof AdChoicesPlacement[keyof typeof AdChoicesPlacement]
| Propriétés | |
|---|---|
BOTTOM_
|
En bas à gauche de l'annonce. |
BOTTOM_
|
En bas à droite de l'annonce. |
TOP_
|
Angle supérieur gauche de l'annonce. |
TOP_
|
en haut à droite de l'annonce. |
AdFormat
Format de l'annonce demandée.
AdInspectorError
AdInspectorError:
BaseError<AdInspectorErrorCode>
AdInspectorErrorCode
AdInspectorErrorCode:
typeof AdInspectorErrorCode[keyof typeof AdInspectorErrorCode]
AdOrientation
AdOrientation: typeof AdOrientation[keyof typeof AdOrientation]
| Propriétés | |
|---|---|
CURRENT
|
|
LANDSCAPE
|
|
PORTRAIT
|
|
AdSize
Représente les dimensions d'une annonce.
Il peut s'agir d'un ensemble de tailles prédéfinies (par exemple, AdSize.LARGE_BANNER) ou d'une taille adaptative.
Il peut s'agir d'un ensemble de tailles prédéfinies (par exemple, AdSize.LARGE_BANNER) ou d'une taille adaptative.
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]
| Propriétés | |
|---|---|
AD_
|
L'annonce a déjà été diffusée. |
AD_
|
L'annonce n'est pas prête à être diffusée. |
AD_
|
L'annonce est trop grande pour la scène (iOS uniquement). |
APP_
|
L'application n'est pas au premier plan. |
INTERNAL_
|
Un problème interne s'est produit. Par exemple, une exception s'est produite lors de la préparation de l'affichage du contenu de l'annonce.
|
MEDIATION_
|
L'adaptateur de médiation n'a pas réussi à afficher l'annonce. Consultez FullScreenContentError.mediationAdError pour connaître la cause sous-jacente.
|
UNKNOWN
|
Le code d'erreur n'a pas pu être associé à un code d'erreur connu.
|
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]
| Propriétés | |
|---|---|
BANNER
|
Bannière publicitaire. |
CUSTOM_
|
Annonce au format natif personnalisé. |
NATIVE
|
Annonce native. |
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
Pour la plupart des annonces, cette valeur est résolue en FixedAdSize avec des dimensions
width et height exactes.
Pour les bannières de taille dynamique, cela correspond à un FluidAdSize où les dimensions sont gérées par la hiérarchie des vues.
SwipeGestureDirection
SwipeGestureDirection:
typeof SwipeGestureDirection[keyof typeof SwipeGestureDirection]
| Propriétés | |
|---|---|
DOWN
|
Balayez l'écran vers le bas. |
LEFT
|
Balayez vers la gauche. |
RIGHT
|
Balayez l'écran vers la droite. |
UP
|
Balayez l'écran vers le haut. |
Variables
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;
}
Fonctions
canRequestAds
canRequestAds(): boolean
Vérifie si l'état actuel du consentement vous permet de demander des annonces.
| Renvoie | |
|---|---|
boolean
|
true si vous pouvez demander des annonces, false dans le cas contraire.
|
getConsentStatus
getConsentStatus(): ConsentStatus
Obtient l'état actuel du consentement de l'utilisateur.
| Renvoie | |
|---|---|
ConsentStatus
|
État actuel du consentement. |
getInitializationStatus
getInitializationStatus(): InitializationStatus
Obtient l'état d'initialisation du SDK.
Utilisez cette méthode pour vérifier si le SDK a fini de s'initialiser et pour inspecter l'état des adaptateurs de médiation individuels.
Utilisez cette méthode pour vérifier si le SDK a fini de s'initialiser et pour inspecter l'état des adaptateurs de médiation individuels.
| Renvoie | |
|---|---|
InitializationStatus
|
État actuel de l'initialisation. |
getPrivacyOptionsRequirementStatus
getPrivacyOptionsRequirementStatus(): PrivacyOptionsRequirementStatus
Vérifie si un point d'entrée des options de confidentialité est requis pour votre application.
Si un point d'entrée est requis, ajoutez à votre application un élément d'interface utilisateur visible et interactif qui appelle showPrivacyOptionsForm pour afficher le formulaire des options de confidentialité. Si un point d'entrée n'est pas requis, configurez votre élément d'interface utilisateur pour qu'il ne soit pas visible ni interactif.
Si un point d'entrée est requis, ajoutez à votre application un élément d'interface utilisateur visible et interactif qui appelle showPrivacyOptionsForm pour afficher le formulaire des options de confidentialité. Si un point d'entrée n'est pas requis, configurez votre élément d'interface utilisateur pour qu'il ne soit pas visible ni interactif.
| Renvoie | |
|---|---|
PrivacyOptionsRequirementStatus
|
État de l'exigence concernant les options de confidentialité. |
getRequestConfiguration
getRequestConfiguration(): RequestConfiguration
Obtient la configuration globale des requêtes.
Utilisez cette méthode pour récupérer la configuration actuelle des requêtes qui a été appliquée de manière globale.
Utilisez cette méthode pour récupérer la configuration actuelle des requêtes qui a été appliquée de manière globale.
| Renvoie | |
|---|---|
RequestConfiguration
|
Configuration actuelle des requêtes globales. |
initialize
initialize(config,
onInitializationComplete?): void
Initialise le SDK Google Mobile Ads.
Appelez cette méthode avant de charger une annonce et avant d'interagir avec le reste du SDK Google Mobile Ads.
Appelez cette méthode avant de charger une annonce et avant d'interagir avec le reste du SDK Google Mobile Ads.
| Paramètres | |
|---|---|
config:
InitializationConfig
|
Options permettant de contrôler l'initialisation du SDK. |
|
Fonction de rappel à exécuter lorsque le SDK a terminé l'initialisation. |
isConsentFormAvailable
isConsentFormAvailable(): boolean
Vérifie si un formulaire de consentement est disponible.
| Renvoie | |
|---|---|
boolean
|
true si un formulaire de consentement est disponible, false sinon.
|
loadAndShowConsentFormIfRequired
loadAndShowConsentFormIfRequired(onDismissed?): void
Charge un formulaire de consentement et le présente à l'utilisateur si son état de consentement actuel l'exige (par exemple, si l'état est "REQUIRED").
| Paramètres | |
|---|---|
|
Fonction de rappel appelée lorsque le formulaire est fermé ou si aucun formulaire n'est requis, avec un FormError facultatif si la présentation a échoué. |
openAdInspector
openAdInspector(_listener): void
Ouvre le calque de l'inspecteur d'annonces du SDK Google Mobile Ads.
Utilisez cette méthode pour déboguer les configurations de médiation et les sources d'annonces.
Utilisez cette méthode pour déboguer les configurations de médiation et les sources d'annonces.
| Paramètres | |
|---|---|
_listener:
OnAdInspectorClosedListener
|
|
openDebugMenu
openDebugMenu(adUnitId): void
Ouvre le menu de débogage.
Utilisez cette méthode pour ouvrir le menu de débogage d'un bloc d'annonces spécifique afin de faciliter les tests et le dépannage des configurations d'annonces.
Utilisez cette méthode pour ouvrir le menu de débogage d'un bloc d'annonces spécifique afin de faciliter les tests et le dépannage des configurations d'annonces.
| Paramètres | |
|---|---|
adUnitId: string
|
ID du bloc d'annonces pour lequel ouvrir le menu de débogage. |
parseLoadAdError
parseLoadAdError(error): LoadAdError
Analyse une erreur native générée lors du chargement de l'annonce et l'encapsule dans un objet LoadAdError.
| Paramètres | |
|---|---|
error: unknown
|
Objet d'erreur généré par le module natif. |
| Renvoie | |
|---|---|
LoadAdError
|
Objet LoadAdError analysé. |
requestConsentInfoUpdate
requestConsentInfoUpdate(params?, onComplete?): void
Demande une mise à jour des informations sur le consentement.
Cette API doit être appelée dans chaque session d'application avant d'appeler getConsentStatus.
Une fois cette API appelée, la valeur renvoyée par getConsentStatus est mise à jour de manière synchrone pour contenir l'état du consentement de la session d'application précédente, le cas échéant.
getConsentStatus peut être mis à jour à nouveau pour refléter l'état actuel après l'appel du rappel
Cette API doit être appelée dans chaque session d'application avant d'appeler getConsentStatus.
Une fois cette API appelée, la valeur renvoyée par getConsentStatus est mise à jour de manière synchrone pour contenir l'état du consentement de la session d'application précédente, le cas échéant.
getConsentStatus peut être mis à jour à nouveau pour refléter l'état actuel après l'appel du rappel
onComplete.
| Paramètres | |
|---|---|
|
Configurations facultatives pour le débogage et le ciblage. |
|
Fonction de rappel appelée lorsque la mise à jour des informations de consentement est terminée, avec un FormError facultatif si la requête a échoué. |
reset
reset(): void
Efface tous les états de consentement du stockage persistant.
Utilisez à des fins de débogage uniquement.
Utilisez à des fins de débogage uniquement.
setPublisherFirstPartyIdEnabled
setPublisherFirstPartyIdEnabled(enabled): void
Contrôle si l'ID first party de l'éditeur est activé.
Active ou désactive l'ID first party de l'éditeur du SDK Google Mobile Ads, anciennement appelé "clé d'application identique".
Active ou désactive l'ID first party de l'éditeur du SDK Google Mobile Ads, anciennement appelé "clé d'application identique".
- Voir aussi
| Paramètres | |
|---|---|
enabled: boolean
|
"True" pour activer l'ID first party de l'éditeur, "false" pour le désactiver. La valeur par défaut est true.
|
setRequestConfiguration
setRequestConfiguration(_config): void
Définit la configuration globale des demandes pour la conformité et le ciblage.
Utilisez cette méthode pour spécifier les détails du ciblage, tels que la classification maximale du contenu des annonces, les paramètres de conformité (comme le tag de traitement selon l'âge) et les ID des appareils de test.
Utilisez cette méthode pour spécifier les détails du ciblage, tels que la classification maximale du contenu des annonces, les paramètres de conformité (comme le tag de traitement selon l'âge) et les ID des appareils de test.
| Paramètres | |
|---|---|
_config:
RequestConfiguration
|
|
setUserControlledAppVolume
setUserControlledAppVolume(volume): void
Définit le volume audio de l'application contrôlée par l'utilisateur.
Utilisez cette méthode pour ajuster le volume audio de toutes les annonces par rapport aux autres sorties audio de l'appareil.
Utilisez cette méthode pour ajuster le volume audio de toutes les annonces par rapport aux autres sorties audio de l'appareil.
| Paramètres | |
|---|---|
volume: number
|
Niveau de volume, entre 0,0 (silencieux) et 1,0 (maximum). Toute valeur à virgule flottante comprise dans cette plage est valide (par exemple, 0,001 ou 0,33333). La valeur n'est pas limitée à des incréments de taille de pas spécifiques, tels que 0,1. |
setUserMutedApp
setUserMutedApp(muted): void
Définit si l'application est en mode silencieux.
Utilisez cette méthode pour contrôler l'état de mise en sourdine initial de l'audio des annonces suivantes.
Utilisez cette méthode pour contrôler l'état de mise en sourdine initial de l'audio des annonces suivantes.
| Paramètres | |
|---|---|
muted: boolean
|
Indique si le son de l'application doit être coupé. La valeur par défaut est false.
|
showPrivacyOptionsForm
showPrivacyOptionsForm(onDismissed?): void
Affiche le formulaire des options de confidentialité.
Présente un formulaire d'options de confidentialité si getPrivacyOptionsRequirementStatus est défini sur
Cette méthode ne doit être appelée qu'en réponse à une saisie utilisateur pour demander l'affichage d'un formulaire d'options de confidentialité.
Le formulaire d'options de confidentialité est préchargé automatiquement par le SDK lorsqu'un formulaire devient disponible. Si aucun formulaire n'a été préchargé, le SDK tentera d'en charger un de manière asynchrone.
Le rappel
Présente un formulaire d'options de confidentialité si getPrivacyOptionsRequirementStatus est défini sur
REQUIRED.Cette méthode ne doit être appelée qu'en réponse à une saisie utilisateur pour demander l'affichage d'un formulaire d'options de confidentialité.
Le formulaire d'options de confidentialité est préchargé automatiquement par le SDK lorsqu'un formulaire devient disponible. Si aucun formulaire n'a été préchargé, le SDK tentera d'en charger un de manière asynchrone.
Le rappel
onDismissed est appelé une fois que le formulaire a été présenté à l'utilisateur, qu'il a sélectionné une option et qu'il a fermé le formulaire. Il peut également renvoyer une FormError si :
- Le formulaire n'est pas disponible.
- Le formulaire ne s'affiche pas.
- Le formulaire est toujours en cours de préchargement.
| Paramètres | |
|---|---|
|
Fonction de rappel appelée lorsque le formulaire est fermé, avec un FormError facultatif si la présentation a échoué. |