Aller au contenu
rdlabo.devdocs

Consentement

Le SDK User Messaging Platform (UMP) de Google est l’outil de confidentialité et de messagerie permettant de recueillir le consentement avant de demander des annonces. Les guides UMP de Google pour Android et iOS expliquent ce parcours.

Ce plugin expose UMP et App Tracking Transparency d’iOS via une même API. Avant d’utiliser UMP, créez vos messages RGPD (règlement général sur la protection des données) dans AdMob. Vous pouvez également configurer les messages Identifier for Advertisers (IDFA). Lorsque les messages IDFA sont publiés, UMP les présente avec la demande App Tracking Transparency ; n’appelez pas en plus requestTrackingAuthorization().

Ordre recommandé

  1. Appelez AdMob.initialize(). Consultez Configuration.
  2. Appelez AdMob.requestConsentInfo().
  3. Si nécessaire, appelez AdMob.showConsentForm().
  4. Ne chargez des annonces que lorsque consentInfo.canRequestAds vaut true.
import { AdMob, AdmobConsentStatus } from '@capacitor-community/admob';

await AdMob.initialize();

let consentInfo = await AdMob.requestConsentInfo();
if (consentInfo.isConsentFormAvailable && consentInfo.status === AdmobConsentStatus.REQUIRED) {
  consentInfo = await AdMob.showConsentForm();
}

if (consentInfo.canRequestAds) {
  // Les annonces peuvent maintenant être demandées.
}

method requestConsentInfo(...)

Demande les informations de consentement de l’utilisateur

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

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 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

enum AdmobConsentStatus

Membre 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.

method showConsentForm()

Affiche un formulaire Google de consentement utilisateur, généré à partir de la configuration de votre message RGPD.

showConsentForm() => Promise<AdmobConsentInfo>

Utilisez canRequestAds comme critère de décision. Un formulaire de consentement peut être indisponible ou inutile selon l’utilisateur et les messages configurés.

Autorisation de suivi sur iOS

Si vous n’utilisez pas les messages IDFA d’UMP, demandez vous-même App Tracking Transparency lorsque l’état est notDetermined. Ignorez cette section lorsque les messages Identifier for Advertisers sont configurés dans AdMob ; UMP affiche cette demande.

const tracking = await AdMob.trackingAuthorizationStatus();
if (tracking.status === 'notDetermined') {
  /**
   * Pour expliquer le suivi avant la boîte de dialogue iOS,
   * présentez votre propre interface ici, puis poursuivez.
   */
  await AdMob.requestTrackingAuthorization();
}

requestTrackingAuthorization() ne fait rien sur Android, sur le Web et sur les versions d’iOS antérieures à 14.

method trackingAuthorizationStatus()

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.

trackingAuthorizationStatus() => Promise<TrackingAuthorizationStatusInterface>

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.

method requestTrackingAuthorization()

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.

requestTrackingAuthorization() => Promise<void>

Options de confidentialité

Si votre message de confidentialité exige un point d’accès dans l’application, proposez une action dans les paramètres qui appelle :

await AdMob.showPrivacyOptionsForm();

method showPrivacyOptionsForm()

Affiche un formulaire Google d’options de confidentialité, généré à partir de la configuration de votre message RGPD.

showPrivacyOptionsForm() => Promise<void>

Réinitialiser le consentement

resetConsentInfo() est destiné aux tests. Ne l’utilisez pas pour effacer le choix de consentement d’un utilisateur en production.

method resetConsentInfo()

Réinitialise l’état du SDK UMP. Appelez à nouveau la fonction requestConsentInfo pour permettre à l’utilisateur de modifier son consentement.

resetConsentInfo() => Promise<void>

Pour la géographie de débogage et les identifiants d’appareils de test, consultez Tests.

Modifier cette page sur GitHub