API
initialize(...)trackingAuthorizationStatus()requestTrackingAuthorization()setApplicationMuted(...)setApplicationVolume(...)loadAppOpen(...)showAppOpen(...)isAppOpenLoaded(...)addListener(AppOpenAdPluginEvents.Loaded, ...)addListener(AppOpenAdPluginEvents.FailedToLoad, ...)addListener(AppOpenAdPluginEvents.Opened, ...)addListener(AppOpenAdPluginEvents.Closed, ...)addListener(AppOpenAdPluginEvents.FailedToShow, ...)addListener(AppOpenAdPluginEvents.AdImpression, ...)showBanner(...)hideBanner()resumeBanner()removeBanner()addListener(BannerAdPluginEvents.SizeChanged, ...)addListener(BannerAdPluginEvents.Loaded, ...)addListener(BannerAdPluginEvents.FailedToLoad, ...)addListener(BannerAdPluginEvents.Opened, ...)addListener(BannerAdPluginEvents.Closed, ...)addListener(BannerAdPluginEvents.AdImpression, ...)addListener(BannerAdPluginEvents.AdPaid, ...)requestConsentInfo(...)showPrivacyOptionsForm()showConsentForm()resetConsentInfo()prepareInterstitial(...)showInterstitial(...)addListener(InterstitialAdPluginEvents.FailedToLoad, ...)addListener(InterstitialAdPluginEvents.Loaded, ...)addListener(InterstitialAdPluginEvents.Dismissed, ...)addListener(InterstitialAdPluginEvents.FailedToShow, ...)addListener(InterstitialAdPluginEvents.Showed, ...)addListener(InterstitialAdPluginEvents.AdImpression, ...)prepareRewardVideoAd(...)showRewardVideoAd(...)addListener(RewardAdPluginEvents.FailedToLoad, ...)addListener(RewardAdPluginEvents.Loaded, ...)addListener(RewardAdPluginEvents.Rewarded, ...)addListener(RewardAdPluginEvents.Dismissed, ...)addListener(RewardAdPluginEvents.FailedToShow, ...)addListener(RewardAdPluginEvents.Showed, ...)addListener(RewardAdPluginEvents.AdImpression, ...)prepareRewardInterstitialAd(...)showRewardInterstitialAd(...)addListener(RewardInterstitialAdPluginEvents.FailedToLoad, ...)addListener(RewardInterstitialAdPluginEvents.Loaded, ...)addListener(RewardInterstitialAdPluginEvents.Rewarded, ...)addListener(RewardInterstitialAdPluginEvents.Dismissed, ...)addListener(RewardInterstitialAdPluginEvents.FailedToShow, ...)addListener(RewardInterstitialAdPluginEvents.Showed, ...)addListener(RewardInterstitialAdPluginEvents.AdImpression, ...)- Interfaces
- Alias de types
- Énumérations
method initialize(...)
initialize(options?: AdMobInitializationOptions | undefined) => Promise<void>
Initialise le SDK Google Mobile Ads.
| Paramètre | Type | Description |
|---|---|---|
options |
AdMobInitializationOptions |
Paramètres facultatifs d’initialisation du SDK. |
Depuis : 1.1.2
method trackingAuthorizationStatus()
trackingAuthorizationStatus() => Promise<TrackingAuthorizationStatusInterface>
Renvoie l’état actuel d’autorisation App Tracking Transparency sur iOS 14 et versions ultérieures.
Renvoie authorized sur les versions antérieures d’iOS, Android et le Web.
Renvoie : Promise<TrackingAuthorizationStatusInterface>
Depuis : 3.1.0
method requestTrackingAuthorization()
requestTrackingAuthorization() => Promise<void>
Demande l’autorisation App Tracking Transparency sur iOS 14 et versions ultérieures.
Se résout sans action sur les versions antérieures d’iOS, Android et le Web.
Depuis : 5.2.0
method setApplicationMuted(...)
setApplicationMuted(options: ApplicationMutedOptions) => Promise<void>
Indique au SDK Google Mobile Ads si le son de l’application est coupé.
| Paramètre | Type |
|---|---|
options |
ApplicationMutedOptions |
Depuis : 4.1.1
method setApplicationVolume(...)
setApplicationVolume(options: ApplicationVolumeOptions) => Promise<void>
Transmet le volume audio de l’application au SDK Google Mobile Ads.
| Paramètre | Type |
|---|---|
options |
ApplicationVolumeOptions |
Depuis : 4.1.1
method loadAppOpen(...)
loadAppOpen(options: AppOpenAdOptions) => Promise<AdLoadInfo>
Charge une annonce à l’ouverture de l’application et renvoie l’identifiant du bloc d’annonces chargé.
| Paramètre | Type |
|---|---|
options |
AppOpenAdOptions |
Renvoie : Promise<AdLoadInfo>
method showAppOpen(...)
showAppOpen(options?: AdShowOptions | undefined) => Promise<void>
Affiche une annonce à l’ouverture de l’application déjà chargée.
| Paramètre | Type | Description |
|---|---|---|
options |
AdShowOptions |
Facultatif. Passez { adId } pour afficher une annonce préparée précise plutôt que la plus récente. |
method isAppOpenLoaded(...)
isAppOpenLoaded(options?: AdShowOptions | undefined) => Promise<{ value: boolean; }>
Vérifie si une annonce à l’ouverture de l’application est chargée.
| Paramètre | Type | Description |
|---|---|---|
options |
AdShowOptions |
Facultatif. Passez un adId pour vérifier une annonce préparée précise plutôt que la plus récente. |
Renvoie : Promise<{ value: boolean; }>
method addListener(AppOpenAdPluginEvents.Loaded, ...)
addListener(eventName: AppOpenAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
Écoute les événements de chargement des annonces à l’ouverture de l’application.
| Paramètre | Type |
|---|---|
eventName |
AppOpenAdPluginEvents.Loaded |
listenerFunc |
(info: AdLoadInfo) => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(AppOpenAdPluginEvents.FailedToLoad, ...)
addListener(eventName: AppOpenAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
Écoute les échecs de chargement des annonces à l’ouverture de l’application.
| Paramètre | Type |
|---|---|
eventName |
AppOpenAdPluginEvents.FailedToLoad |
listenerFunc |
(error: AdMobError) => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(AppOpenAdPluginEvents.Opened, ...)
addListener(eventName: AppOpenAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>
Écoute les événements d’ouverture des annonces à l’ouverture de l’application.
| Paramètre | Type |
|---|---|
eventName |
AppOpenAdPluginEvents.Opened |
listenerFunc |
() => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(AppOpenAdPluginEvents.Closed, ...)
addListener(eventName: AppOpenAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>
Écoute les événements de fermeture des annonces à l’ouverture de l’application.
| Paramètre | Type |
|---|---|
eventName |
AppOpenAdPluginEvents.Closed |
listenerFunc |
() => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(AppOpenAdPluginEvents.FailedToShow, ...)
addListener(eventName: AppOpenAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
Écoute les échecs d’affichage des annonces à l’ouverture de l’application.
| Paramètre | Type |
|---|---|
eventName |
AppOpenAdPluginEvents.FailedToShow |
listenerFunc |
(error: AdMobError) => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(AppOpenAdPluginEvents.AdImpression, ...)
addListener(eventName: AppOpenAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
Écoute les événements de revenus par impression des annonces à l’ouverture de l’application.
| Paramètre | Type |
|---|---|
eventName |
AppOpenAdPluginEvents.AdImpression |
listenerFunc |
(data: AdMobRevenueData) => void |
Renvoie : Promise<PluginListenerHandle>
method showBanner(...)
showBanner(options: BannerAdOptions) => Promise<void>
Affiche une bannière publicitaire.
| Paramètre | Type | Description |
|---|---|---|
options |
BannerAdOptions |
AdOptions |
Depuis : 1.1.2
method hideBanner()
hideBanner() => Promise<void>
Masque la bannière actuelle sans la détruire.
Depuis : 1.1.2
method resumeBanner()
resumeBanner() => Promise<void>
Affiche une bannière précédemment masquée.
Depuis : 1.1.2
method removeBanner()
removeBanner() => Promise<void>
Détruit la bannière actuelle et la retire de l’écran.
Depuis : 1.1.2
method addListener(BannerAdPluginEvents.SizeChanged, ...)
addListener(eventName: BannerAdPluginEvents.SizeChanged, listenerFunc: (info: AdMobBannerSize) => void) => Promise<PluginListenerHandle>
Écoute les changements de dimensions de la bannière affichée.
| Paramètre | Type | Description |
|---|---|---|
eventName |
BannerAdPluginEvents.SizeChanged |
bannerAdSizeChanged |
listenerFunc |
(info: AdMobBannerSize) => void |
Renvoie : Promise<PluginListenerHandle>
Depuis : 3.0.0
method addListener(BannerAdPluginEvents.Loaded, ...)
addListener(eventName: BannerAdPluginEvents.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>
Écoute les événements de chargement des bannières publicitaires.
| Paramètre | Type | Description |
|---|---|---|
eventName |
BannerAdPluginEvents.Loaded |
bannerAdLoaded |
listenerFunc |
() => void |
Renvoie : Promise<PluginListenerHandle>
Depuis : 3.0.0
method addListener(BannerAdPluginEvents.FailedToLoad, ...)
addListener(eventName: BannerAdPluginEvents.FailedToLoad, listenerFunc: (info: AdMobError) => void) => Promise<PluginListenerHandle>
Écoute les échecs de chargement des bannières publicitaires.
| Paramètre | Type | Description |
|---|---|---|
eventName |
BannerAdPluginEvents.FailedToLoad |
bannerAdFailedToLoad |
listenerFunc |
(info: AdMobError) => void |
Renvoie : Promise<PluginListenerHandle>
Depuis : 3.0.0
method addListener(BannerAdPluginEvents.Opened, ...)
addListener(eventName: BannerAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>
Écoute les événements d’ouverture de l’overlay des bannières.
| Paramètre | Type | Description |
|---|---|---|
eventName |
BannerAdPluginEvents.Opened |
bannerAdOpened |
listenerFunc |
() => void |
Renvoie : Promise<PluginListenerHandle>
Depuis : 3.0.0
method addListener(BannerAdPluginEvents.Closed, ...)
addListener(eventName: BannerAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>
Écoute les événements de fermeture de l’overlay des bannières.
| Paramètre | Type | Description |
|---|---|---|
eventName |
BannerAdPluginEvents.Closed |
bannerAdClosed |
listenerFunc |
() => void |
Renvoie : Promise<PluginListenerHandle>
Depuis : 3.0.0
method addListener(BannerAdPluginEvents.AdImpression, ...)
addListener(eventName: BannerAdPluginEvents.AdImpression, listenerFunc: () => void) => Promise<PluginListenerHandle>
Écoute les événements d’impression des bannières.
| Paramètre | Type | Description |
|---|---|---|
eventName |
BannerAdPluginEvents.AdImpression |
AdImpression |
listenerFunc |
() => void |
Renvoie : Promise<PluginListenerHandle>
Depuis : 3.0.0
method addListener(BannerAdPluginEvents.AdPaid, ...)
addListener(eventName: BannerAdPluginEvents.AdPaid, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
Écoute les événements de revenus par impression des bannières.
| Paramètre | Type |
|---|---|
eventName |
BannerAdPluginEvents.AdPaid |
listenerFunc |
(data: AdMobRevenueData) => void |
Renvoie : Promise<PluginListenerHandle>
method requestConsentInfo(...)
requestConsentInfo(options?: AdmobConsentRequestOptions | undefined) => Promise<AdmobConsentInfo>
Demande les informations de consentement de l’utilisateur
| Paramètre | Type | Description |
|---|---|---|
options |
AdmobConsentRequestOptions |
ConsentRequestOptions |
Renvoie : Promise<AdmobConsentInfo>
Depuis : 5.0.0
method showPrivacyOptionsForm()
showPrivacyOptionsForm() => Promise<void>
Affiche un formulaire Google d’options de confidentialité, généré à partir de la configuration de votre message RGPD.
Depuis : 7.0.3
method showConsentForm()
showConsentForm() => Promise<AdmobConsentInfo>
Affiche un formulaire Google de consentement utilisateur, généré à partir de la configuration de votre message RGPD.
Renvoie : Promise<AdmobConsentInfo>
Depuis : 5.0.0
method resetConsentInfo()
resetConsentInfo() => Promise<void>
Réinitialise l’état du SDK UMP. Appelez à nouveau la fonction requestConsentInfo pour permettre à l’utilisateur de modifier son consentement.
Depuis : 5.0.0
method prepareInterstitial(...)
prepareInterstitial(options: AdOptions) => Promise<AdLoadInfo>
Charge une annonce interstitielle et renvoie l’identifiant du bloc d’annonces chargé.
| Paramètre | Type | Description |
|---|---|---|
options |
AdOptions |
AdOptions |
Renvoie : Promise<AdLoadInfo>
Depuis : 1.1.2
method showInterstitial(...)
showInterstitial(options?: AdShowOptions | undefined) => Promise<void>
Affiche une annonce interstitielle déjà chargée.
| Paramètre | Type | Description |
|---|---|---|
options |
AdShowOptions |
Facultatif. Passez { adId } pour afficher une annonce préparée précise plutôt que la plus récente. |
Depuis : 1.1.2
method addListener(InterstitialAdPluginEvents.FailedToLoad, ...)
addListener(eventName: InterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
Écoute les échecs de chargement des annonces interstitielles.
| Paramètre | Type |
|---|---|
eventName |
InterstitialAdPluginEvents.FailedToLoad |
listenerFunc |
(error: AdMobError) => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(InterstitialAdPluginEvents.Loaded, ...)
addListener(eventName: InterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
Écoute les événements de chargement des annonces interstitielles.
| Paramètre | Type |
|---|---|
eventName |
InterstitialAdPluginEvents.Loaded |
listenerFunc |
(info: AdLoadInfo) => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(InterstitialAdPluginEvents.Dismissed, ...)
addListener(eventName: InterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
Écoute les événements de fermeture des annonces interstitielles.
| Paramètre | Type |
|---|---|
eventName |
InterstitialAdPluginEvents.Dismissed |
listenerFunc |
() => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(InterstitialAdPluginEvents.FailedToShow, ...)
addListener(eventName: InterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
Écoute les échecs d’affichage des annonces interstitielles.
| Paramètre | Type |
|---|---|
eventName |
InterstitialAdPluginEvents.FailedToShow |
listenerFunc |
(error: AdMobError) => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(InterstitialAdPluginEvents.Showed, ...)
addListener(eventName: InterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
Écoute les événements d’affichage des annonces interstitielles.
| Paramètre | Type |
|---|---|
eventName |
InterstitialAdPluginEvents.Showed |
listenerFunc |
() => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(InterstitialAdPluginEvents.AdImpression, ...)
addListener(eventName: InterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
Écoute les événements de revenus par impression des annonces interstitielles.
| Paramètre | Type |
|---|---|
eventName |
InterstitialAdPluginEvents.AdImpression |
listenerFunc |
(data: AdMobRevenueData) => void |
Renvoie : Promise<PluginListenerHandle>
method prepareRewardVideoAd(...)
prepareRewardVideoAd(options: RewardAdOptions) => Promise<AdLoadInfo>
Charge une annonce récompensée et renvoie l’identifiant du bloc d’annonces chargé.
| Paramètre | Type | Description |
|---|---|---|
options |
RewardAdOptions |
RewardAdOptions |
Renvoie : Promise<AdLoadInfo>
Depuis : 1.1.2
method showRewardVideoAd(...)
showRewardVideoAd(options?: AdShowOptions | undefined) => Promise<AdMobRewardItem>
Affiche une annonce récompensée chargée et se résout lorsque l’utilisateur obtient la récompense.
| Paramètre | Type | Description |
|---|---|---|
options |
AdShowOptions |
Facultatif. Passez { adId } pour afficher une annonce préparée précise plutôt que la plus récente. |
Renvoie : Promise<AdMobRewardItem>
Depuis : 1.1.2
method addListener(RewardAdPluginEvents.FailedToLoad, ...)
addListener(eventName: RewardAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
Écoute les échecs de chargement des annonces récompensées.
| Paramètre | Type |
|---|---|
eventName |
RewardAdPluginEvents.FailedToLoad |
listenerFunc |
(error: AdMobError) => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(RewardAdPluginEvents.Loaded, ...)
addListener(eventName: RewardAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
Écoute les événements de chargement des annonces récompensées.
| Paramètre | Type |
|---|---|
eventName |
RewardAdPluginEvents.Loaded |
listenerFunc |
(info: AdLoadInfo) => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(RewardAdPluginEvents.Rewarded, ...)
addListener(eventName: RewardAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardItem) => void) => Promise<PluginListenerHandle>
Écoute les événements d’attribution d’une récompense.
| Paramètre | Type |
|---|---|
eventName |
RewardAdPluginEvents.Rewarded |
listenerFunc |
(reward: AdMobRewardItem) => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(RewardAdPluginEvents.Dismissed, ...)
addListener(eventName: RewardAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
Écoute les événements de fermeture des annonces récompensées.
| Paramètre | Type |
|---|---|
eventName |
RewardAdPluginEvents.Dismissed |
listenerFunc |
() => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(RewardAdPluginEvents.FailedToShow, ...)
addListener(eventName: RewardAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
Écoute les échecs d’affichage des annonces récompensées.
| Paramètre | Type |
|---|---|
eventName |
RewardAdPluginEvents.FailedToShow |
listenerFunc |
(error: AdMobError) => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(RewardAdPluginEvents.Showed, ...)
addListener(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
Écoute les événements d’affichage des annonces récompensées.
| Paramètre | Type |
|---|---|
eventName |
RewardAdPluginEvents.Showed |
listenerFunc |
() => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(RewardAdPluginEvents.AdImpression, ...)
addListener(eventName: RewardAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
Écoute les événements de revenus par impression des annonces récompensées.
| Paramètre | Type |
|---|---|
eventName |
RewardAdPluginEvents.AdImpression |
listenerFunc |
(data: AdMobRevenueData) => void |
Renvoie : Promise<PluginListenerHandle>
method prepareRewardInterstitialAd(...)
prepareRewardInterstitialAd(options: RewardInterstitialAdOptions) => Promise<AdLoadInfo>
Charge une annonce interstitielle récompensée et renvoie l’identifiant du bloc d’annonces chargé.
| Paramètre | Type | Description |
|---|---|---|
options |
RewardInterstitialAdOptions |
RewardInterstitialAdOptions |
Renvoie : Promise<AdLoadInfo>
Depuis : 1.1.2
method showRewardInterstitialAd(...)
showRewardInterstitialAd(options?: AdShowOptions | undefined) => Promise<AdMobRewardInterstitialItem>
Affiche une annonce interstitielle récompensée chargée et se résout lorsque l’utilisateur obtient la récompense.
| Paramètre | Type | Description |
|---|---|---|
options |
AdShowOptions |
Facultatif. Passez { adId } pour afficher une annonce préparée précise plutôt que la plus récente. |
Renvoie : Promise<AdMobRewardInterstitialItem>
Depuis : 1.1.2
method addListener(RewardInterstitialAdPluginEvents.FailedToLoad, ...)
addListener(eventName: RewardInterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
Écoute les échecs de chargement des annonces interstitielles récompensées.
| Paramètre | Type |
|---|---|
eventName |
RewardInterstitialAdPluginEvents.FailedToLoad |
listenerFunc |
(error: AdMobError) => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(RewardInterstitialAdPluginEvents.Loaded, ...)
addListener(eventName: RewardInterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
Écoute les événements de chargement des annonces interstitielles récompensées.
| Paramètre | Type |
|---|---|
eventName |
RewardInterstitialAdPluginEvents.Loaded |
listenerFunc |
(info: AdLoadInfo) => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(RewardInterstitialAdPluginEvents.Rewarded, ...)
addListener(eventName: RewardInterstitialAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardInterstitialItem) => void) => Promise<PluginListenerHandle>
Écoute les événements d’attribution d’une récompense.
| Paramètre | Type |
|---|---|
eventName |
RewardInterstitialAdPluginEvents.Rewarded |
listenerFunc |
(reward: AdMobRewardInterstitialItem) => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(RewardInterstitialAdPluginEvents.Dismissed, ...)
addListener(eventName: RewardInterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
Écoute les événements de fermeture des annonces interstitielles récompensées.
| Paramètre | Type |
|---|---|
eventName |
RewardInterstitialAdPluginEvents.Dismissed |
listenerFunc |
() => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(RewardInterstitialAdPluginEvents.FailedToShow, ...)
addListener(eventName: RewardInterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
Écoute les échecs d’affichage des annonces interstitielles récompensées.
| Paramètre | Type |
|---|---|
eventName |
RewardInterstitialAdPluginEvents.FailedToShow |
listenerFunc |
(error: AdMobError) => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(RewardInterstitialAdPluginEvents.Showed, ...)
addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
Écoute les événements d’affichage des annonces interstitielles récompensées.
| Paramètre | Type |
|---|---|
eventName |
RewardInterstitialAdPluginEvents.Showed |
listenerFunc |
() => void |
Renvoie : Promise<PluginListenerHandle>
method addListener(RewardInterstitialAdPluginEvents.AdImpression, ...)
addListener(eventName: RewardInterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
Écoute les événements de revenus par impression des annonces interstitielles récompensées.
| Paramètre | Type |
|---|---|
eventName |
RewardInterstitialAdPluginEvents.AdImpression |
listenerFunc |
(data: AdMobRevenueData) => void |
Renvoie : Promise<PluginListenerHandle>
Interfaces
interface AdMobInitializationOptions
| Propriété | Type | Description | Valeur par défaut | Depuis |
|---|---|---|---|---|
testingDevices |
string[] |
Identifiants des appareils à enregistrer comme appareils de test lorsque {@link AdMobInitializationOptions.initializeForTesting} vaut true. Les requêtes provenant des appareils enregistrés reçoivent des annonces de test et ne génèrent pas de trafic incorrect. |
1.2.0 | |
initializeForTesting |
boolean |
Indique si {@link AdMobInitializationOptions.testingDevices} doit être enregistré comme appareils de test. | false |
1.2.0 |
tagForChildDirectedTreatment |
boolean |
Pour l’application de la loi américaine Children’s Online Privacy Protection Act (COPPA), un paramètre nommé tagForChildDirectedTreatment est disponible. | 3.1.0 | |
tagForUnderAgeOfConsent |
boolean |
Lorsque cette fonction est utilisée, un paramètre Tag For Users under the Age of Consent in Europe (TFUA), destiné aux utilisateurs n’ayant pas atteint l’âge du consentement en Europe, est inclus dans toutes les demandes d’annonces suivantes. | 3.1.0 | |
maxAdContentRating |
MaxAdContentRating |
Classification maximale du contenu publicitaire appliquée à toutes les demandes d’annonces. Les annonces de classification supérieure sont exclues. | 3.1.0 |
interface TrackingAuthorizationStatusInterface
État actuel de l’autorisation App Tracking Transparency sur iOS.
| Propriété | Type | Description |
|---|---|---|
status |
'authorized' \| 'denied' \| 'notDetermined' \| 'restricted' |
État d’autorisation signalé par App Tracking Transparency. |
interface ApplicationMutedOptions
| Propriété | Type | Description | Depuis |
|---|---|---|---|
muted |
boolean |
Informe le SDK que le son de l’application est coupé. Remarque : les annonces vidéo qui ne peuvent pas être affichées sans son ne sont pas renvoyées pour les demandes d’annonces lorsque le volume de l’application est signalé comme coupé ou réglé sur 0. Cela peut limiter la diffusion d’une partie du catalogue d’annonces vidéo. | 4.1.1 |
interface ApplicationVolumeOptions
| Propriété | Type | Description | Depuis |
|---|---|---|---|
volume |
0 \| 1 \| 0.1 \| 0.2 \| 0.3 \| 0.4 \| 0.5 \| 0.6 \| 0.7 \| 0.8 \| 0.9 |
Si votre application possède ses propres réglages de volume, par exemple pour la musique ou les effets sonores, transmettre son volume au SDK Google Mobile Ads permet aux annonces vidéo de respecter ces réglages. Utilisez une valeur prise en charge comprise entre 0.0 (silencieux) et 1.0 (volume maximal). | 4.1.1 |
interface AdLoadInfo
Informations renvoyées après le chargement réussi d’une annonce.
| Propriété | Type | Description |
|---|---|---|
adUnitId |
string |
Identifiant du bloc de l’annonce chargée. |
interface AppOpenAdOptions
Options de chargement d’une annonce à l’ouverture de l’application.
| Propriété | Type | Description |
|---|---|---|
adId |
string |
Identifiant du bloc d’annonces à l’ouverture de l’application à charger. |
interface AdShowOptions
Options de sélection d’une annonce déjà chargée à afficher ou à examiner.
| Propriété | Type | Description | Depuis |
|---|---|---|---|
adId |
string |
Identifiant du bloc d’une annonce précédemment préparée à cibler. S’il est omis, l’opération cible l’annonce préparée le plus récemment. | 8.0.1 |
interface PluginListenerHandle
| Propriété | Type |
|---|---|
remove |
() => Promise<void> |
interface AdMobError
Erreur renvoyée par le SDK Google Mobile Ads.
| Propriété | Type | Description |
|---|---|---|
code |
number |
Obtient le code de l’erreur. |
message |
string |
Obtient le message décrivant l’erreur. |
interface AdMobRevenueData
Données de revenus publicitaires par impression émises par un événement de paiement.
| Propriété | Type | Description |
|---|---|---|
adUnitId |
string |
Identifiant du bloc d’annonces associé à l’événement de paiement. |
valueMicros |
number |
Valeur de l’annonce en micros ; 1 000 000 de micros équivaut à une unité de devise. |
currencyCode |
string |
Code de devise ISO 4217 pour valueMicros. |
precision |
AdValuePrecision |
Précision de la valeur publicitaire signalée. |
networkName |
string |
Nom de la classe de l’adaptateur de médiation qui a servi l’impression, ou chaîne vide s’il est indisponible. |
impressionId |
string |
Identifiant de réponse associé à l’impression, ou chaîne vide s’il est indisponible. |
interface BannerAdOptions
Options d’affichage d’une bannière publicitaire.
Cette interface étend AdOptions.
| Propriété | Type | Description | Valeur par défaut | Depuis |
|---|---|---|---|---|
adSize |
BannerAdSize |
Taille de la bannière à afficher. | ADAPTIVE_BANNER |
3.0.0 |
position |
BannerAdPosition |
Position d’affichage de la bannière. | TOP_CENTER |
1.1.2 |
adId |
string |
Identifiant du bloc d’annonces à charger. | 1.1.2 | |
isTesting |
boolean |
Indique si une annonce de test doit être demandée. | false |
1.1.2 |
margin |
number |
Marge de la bannière en unités logiques d’affichage : dp sur Android et points sur iOS. Pour BOTTOM_CENTER, il s’agit de la marge inférieure. Pour TOP_CENTER, il s’agit de la marge supérieure. |
0 |
1.1.2 |
npa |
boolean |
Indique si des annonces non personnalisées doivent être demandées. | false |
1.2.0 |
immersiveMode |
boolean |
Indique si une annonce plein écran doit être affichée en mode immersif sur Android. | 7.0.3 |
interface AdMobBannerSize
Dimensions de la bannière affichée en unités logiques d’affichage : dp sur Android et points sur iOS.
Une bannière masquée, supprimée ou en échec peut signaler 0 pour les deux dimensions.
| Propriété | Type | Description |
|---|---|---|
width |
number |
Largeur de la bannière affichée. |
height |
number |
Hauteur de la bannière affichée. |
interface AdmobConsentInfo
| Propriété | Type | Description | Depuis |
|---|---|---|---|
status |
AdmobConsentStatus |
État du consentement de l’utilisateur. | 5.0.0 |
isConsentFormAvailable |
boolean |
Si la valeur est true, un formulaire de consentement est disponible ; sinon, aucun formulaire n’est disponible. |
5.0.0 |
canRequestAds |
boolean |
Si la valeur est true, une annonce peut être affichée. |
7.0.3 |
privacyOptionsRequirementStatus |
PrivacyOptionsRequirementStatus |
État indiquant si les options de confidentialité sont requises pour l’utilisateur. | 7.0.3 |
interface AdmobConsentRequestOptions
| Propriété | Type | Description | Valeur par défaut | Depuis |
|---|---|---|---|---|
debugGeography |
AdmobConsentDebugGeography |
Définit la simulation géographique de débogage pour tester le consentement en local. | 5.0.0 | |
testDeviceIdentifiers |
string[] |
Tableau des identifiants d’appareils de test à autoriser. Remarque : sur iOS, l’identifiant peut changer si vous désinstallez puis réinstallez l’application. | 5.0.0 | |
tagForUnderAgeOfConsent |
boolean |
Définissez la valeur sur true pour offrir à l’utilisateur la possibilité d’accepter l’affichage d’annonces personnalisées. |
false |
5.0.0 |
interface AdOptions
Options communes de demande d’annonce.
| Propriété | Type | Description | Valeur par défaut | Depuis |
|---|---|---|---|---|
adId |
string |
Identifiant du bloc d’annonces à charger. | 1.1.2 | |
isTesting |
boolean |
Indique si une annonce de test doit être demandée. | false |
1.1.2 |
margin |
number |
Marge de la bannière en unités logiques d’affichage : dp sur Android et points sur iOS. Pour BOTTOM_CENTER, il s’agit de la marge inférieure. Pour TOP_CENTER, il s’agit de la marge supérieure. |
0 |
1.1.2 |
npa |
boolean |
Indique si des annonces non personnalisées doivent être demandées. | false |
1.2.0 |
immersiveMode |
boolean |
Indique si une annonce plein écran doit être affichée en mode immersif sur Android. | 7.0.3 |
interface RewardAdOptions
Options de chargement d’une annonce récompensée.
| Propriété | Type | Description | Valeur par défaut | Depuis |
|---|---|---|---|---|
ssv |
AtLeastOne<{ /** * A user identifier passed to the SSV callback. */ userId: string; /** * Custom data passed to the SSV callback. */ customData: string; }> |
Options de vérification côté serveur pour l’annonce récompensée. Fournissez au moins l’un des paramètres userId ou customData. |
||
adId |
string |
Identifiant du bloc d’annonces à charger. | 1.1.2 | |
isTesting |
boolean |
Indique si une annonce de test doit être demandée. | false |
1.1.2 |
margin |
number |
Marge de la bannière en unités logiques d’affichage : dp sur Android et points sur iOS. Pour BOTTOM_CENTER, il s’agit de la marge inférieure. Pour TOP_CENTER, il s’agit de la marge supérieure. |
0 |
1.1.2 |
npa |
boolean |
Indique si des annonces non personnalisées doivent être demandées. | false |
1.2.0 |
immersiveMode |
boolean |
Indique si une annonce plein écran doit être affichée en mode immersif sur Android. | 7.0.3 |
interface AdMobRewardItem
Récompense obtenue par l’utilisateur après avoir regardé une annonce récompensée.
| Propriété | Type | Description |
|---|---|---|
type |
string |
Type de récompense configuré pour le bloc d’annonces. |
amount |
number |
Montant de la récompense obtenue par l’utilisateur. |
interface RewardInterstitialAdOptions
Options de chargement d’une annonce interstitielle récompensée.
| Propriété | Type | Description | Valeur par défaut | Depuis |
|---|---|---|---|---|
ssv |
AtLeastOne<{ /** * A user identifier passed to the SSV callback. */ userId: string; /** * Custom data passed to the SSV callback. */ customData: string; }> |
Options de vérification côté serveur pour l’annonce interstitielle récompensée. Fournissez au moins l’un des paramètres userId ou customData. |
||
adId |
string |
Identifiant du bloc d’annonces à charger. | 1.1.2 | |
isTesting |
boolean |
Indique si une annonce de test doit être demandée. | false |
1.1.2 |
margin |
number |
Marge de la bannière en unités logiques d’affichage : dp sur Android et points sur iOS. Pour BOTTOM_CENTER, il s’agit de la marge inférieure. Pour TOP_CENTER, il s’agit de la marge supérieure. |
0 |
1.1.2 |
npa |
boolean |
Indique si des annonces non personnalisées doivent être demandées. | false |
1.2.0 |
immersiveMode |
boolean |
Indique si une annonce plein écran doit être affichée en mode immersif sur Android. | 7.0.3 |
interface AdMobRewardInterstitialItem
Récompense obtenue par l’utilisateur après avoir regardé une annonce interstitielle récompensée.
| Propriété | Type | Description |
|---|---|---|
type |
string |
Type de récompense configuré pour le bloc d’annonces. |
amount |
number |
Montant de la récompense obtenue par l’utilisateur. |
Alias de types
type alias AtLeastOne
{[K in keyof T]: Pick<T, K>}[keyof T]
type alias Pick
À partir de T, sélectionne un ensemble de propriétés dont les clés figurent dans l’union K
{
[P in K]: T[P];
}
Énumérations
enum MaxAdContentRating
| Membres | Valeur | Description |
|---|---|---|
General |
'General' |
Contenu adapté à tous les publics, y compris les familles. |
ParentalGuidance |
'ParentalGuidance' |
Contenu adapté à la plupart des publics sous la supervision des parents. |
Teen |
'Teen' |
Contenu adapté aux adolescents et aux adultes. |
MatureAudience |
'MatureAudience' |
Contenu réservé aux adultes. |
enum AppOpenAdPluginEvents
| Membres | Valeur | Description |
|---|---|---|
Loaded |
'appOpenAdLoaded' |
Émis lorsqu’une annonce à l’ouverture de l’application est chargée. |
FailedToLoad |
'appOpenAdFailedToLoad' |
Émis lorsque le chargement d’une annonce à l’ouverture de l’application échoue. |
Opened |
'appOpenAdOpened' |
Émis lorsqu’une annonce à l’ouverture de l’application est affichée. |
Closed |
'appOpenAdClosed' |
Émis lorsqu’une annonce à l’ouverture de l’application est fermée. |
FailedToShow |
'appOpenAdFailedToShow' |
Émis lorsque l’affichage d’une annonce à l’ouverture de l’application déjà chargée échoue. |
AdImpression |
'appOpenAdImpression' |
Émet les données de revenus publicitaires par impression lorsqu’un événement de paiement est enregistré. |
enum AdValuePrecision
| Membres | Valeur | Description |
|---|---|---|
Unknown |
0 |
La précision de la valeur de l’annonce est inconnue. |
Estimated |
1 |
La valeur de l’annonce est estimée à partir de données agrégées. |
PublisherProvided |
2 |
La valeur de l’annonce a été fournie par l’éditeur. |
Precise |
3 |
La valeur de l’annonce est le montant exact payé pour cette annonce. |
enum BannerAdSize
| Membres | Valeur | Description |
|---|---|---|
BANNER |
'BANNER' |
Format de bannière de la Mobile Marketing Association (MMA) : 320x50 pixels indépendants de la densité. |
FULL_BANNER |
'FULL_BANNER' |
Format de bannière complète de l’Interactive Advertising Bureau (IAB) : 468x60 pixels indépendants de la densité. |
LARGE_BANNER |
'LARGE_BANNER' |
Format de grande bannière : 320x100 pixels indépendants de la densité. |
MEDIUM_RECTANGLE |
'MEDIUM_RECTANGLE' |
Format de rectangle moyen de l’Interactive Advertising Bureau (IAB) : 300x250 pixels indépendants de la densité. |
LEADERBOARD |
'LEADERBOARD' |
Format de grande bannière leaderboard de l’Interactive Advertising Bureau (IAB) : 728x90 pixels indépendants de la densité. |
ADAPTIVE_BANNER |
'ADAPTIVE_BANNER' |
Bannière à taille dynamique, sur toute la largeur et à hauteur automatique. |
SMART_BANNER |
'SMART_BANNER' |
Ancienne bannière intelligente adaptée à la largeur de l’écran. Conservée pour compatibilité ; utilisez ADAPTIVE_BANNER pour les nouvelles intégrations. |
enum BannerAdPosition
| Membres | Valeur | Description |
|---|---|---|
TOP_CENTER |
'TOP_CENTER' |
Positionne la bannière en haut, au centre de l’écran. |
CENTER |
'CENTER' |
Positionne la bannière au centre de l’écran. |
BOTTOM_CENTER |
'BOTTOM_CENTER' |
Positionne la bannière en bas, au centre de l’écran. |
enum BannerAdPluginEvents
| Membres | Valeur | Description |
|---|---|---|
SizeChanged |
"bannerAdSizeChanged" |
Émis lorsque la taille de la bannière affichée change. |
Loaded |
"bannerAdLoaded" |
Émis lorsqu’une bannière publicitaire est chargée. |
FailedToLoad |
"bannerAdFailedToLoad" |
Émis lorsque le chargement d’une bannière publicitaire échoue. |
Opened |
"bannerAdOpened" |
Émis lorsqu’une bannière ouvre un overlay après un appui de l’utilisateur. |
Closed |
"bannerAdClosed" |
Émis lorsque l’overlay de la bannière est fermé. |
AdImpression |
"bannerAdImpression" |
Émis lorsqu’une impression est enregistrée pour la bannière publicitaire. |
AdPaid |
"bannerAdPaid" |
Émet les données de revenus publicitaires par impression lorsqu’un événement de paiement est enregistré. |
enum AdmobConsentStatus
| Membres | Valeur | Description |
|---|---|---|
NOT_REQUIRED |
'NOT_REQUIRED' |
Consentement utilisateur non requis. |
OBTAINED |
'OBTAINED' |
Consentement utilisateur déjà obtenu. |
REQUIRED |
'REQUIRED' |
Consentement utilisateur requis, mais pas encore obtenu. |
UNKNOWN |
'UNKNOWN' |
État du consentement inconnu ; AdsConsent.requestInfoUpdate doit être appelé pour l’actualiser. |
enum PrivacyOptionsRequirementStatus
| Membres | Valeur | Description |
|---|---|---|
NOT_REQUIRED |
'NOT_REQUIRED' |
Un point d’accès aux options de confidentialité n’est pas requis. |
REQUIRED |
'REQUIRED' |
Un point d’accès aux options de confidentialité est requis. |
UNKNOWN |
'UNKNOWN' |
La nécessité d’un point d’accès aux options de confidentialité est inconnue. |
enum AdmobConsentDebugGeography
| Membres | Valeur | Description |
|---|---|---|
DISABLED |
0 |
Simulation géographique de débogage désactivée. |
EEA |
1 |
Simule une localisation dans l’EEE pour les appareils de débogage. |
NOT_EEA |
2 |
Simule une localisation hors de l’EEE pour les appareils de débogage. |
US |
3 |
Simule une localisation dans un État américain réglementé pour les appareils de débogage. |
OTHER |
4 |
Simule la zone géographique OTHER pour les appareils de débogage. |
enum InterstitialAdPluginEvents
| Membres | Valeur | Description |
|---|---|---|
Loaded |
'interstitialAdLoaded' |
Émis lorsqu’une annonce interstitielle est chargée et prête à être affichée. |
FailedToLoad |
'interstitialAdFailedToLoad' |
Émis lorsque le chargement d’une annonce interstitielle échoue. |
Showed |
'interstitialAdShowed' |
Émis lorsqu’une annonce interstitielle est affichée. |
FailedToShow |
'interstitialAdFailedToShow' |
Émis lorsque l’affichage d’une annonce interstitielle déjà chargée échoue. |
Dismissed |
'interstitialAdDismissed' |
Émis lorsqu’une annonce interstitielle est fermée. |
AdImpression |
'interstitialAdImpression' |
Émet les données de revenus publicitaires par impression lorsqu’un événement de paiement est enregistré. |
enum RewardAdPluginEvents
| Membres | Valeur | Description |
|---|---|---|
Loaded |
'onRewardedVideoAdLoaded' |
Émis lorsqu’une annonce récompensée est chargée et prête à être affichée. |
FailedToLoad |
'onRewardedVideoAdFailedToLoad' |
Émis lorsque le chargement d’une annonce récompensée échoue. |
Showed |
'onRewardedVideoAdShowed' |
Émis lorsqu’une annonce récompensée est affichée. |
FailedToShow |
'onRewardedVideoAdFailedToShow' |
Émis lorsque l’affichage d’une annonce récompensée déjà chargée échoue. |
Dismissed |
'onRewardedVideoAdDismissed' |
Émis lorsqu’une annonce récompensée est fermée. Cet événement n’indique pas si l’utilisateur a obtenu une récompense. Écoutez séparément Rewarded avant d’attribuer la récompense. |
Rewarded |
'onRewardedVideoAdReward' |
Émis lorsque l’utilisateur obtient la récompense annoncée. |
AdImpression |
'onRewardedVideoAdImpression' |
Émet les données de revenus publicitaires par impression lorsqu’un événement de paiement est enregistré. |
enum RewardInterstitialAdPluginEvents
| Membres | Valeur | Description |
|---|---|---|
Loaded |
'onRewardedInterstitialAdLoaded' |
Émis lorsqu’une annonce interstitielle récompensée est chargée et prête à être affichée. |
FailedToLoad |
'onRewardedInterstitialAdFailedToLoad' |
Émis lorsque le chargement d’une annonce interstitielle récompensée échoue. |
Showed |
'onRewardedInterstitialAdShowed' |
Émis lorsqu’une annonce interstitielle récompensée est affichée. |
FailedToShow |
'onRewardedInterstitialAdFailedToShow' |
Émis lorsque l’affichage d’une annonce interstitielle récompensée déjà chargée échoue. |
Dismissed |
'onRewardedInterstitialAdDismissed' |
Émis lorsqu’une annonce interstitielle récompensée est fermée. Cet événement n’indique pas si l’utilisateur a obtenu une récompense. Écoutez séparément Rewarded avant d’attribuer la récompense. |
Rewarded |
'onRewardedInterstitialAdReward' |
Émis lorsque l’utilisateur obtient la récompense annoncée. |
AdImpression |
'onRewardedInterstitialAdImpression' |
Émet les données de revenus publicitaires par impression lorsqu’un événement de paiement est enregistré. |