Configurer le SDK UMP

Sélectionnez une plate-forme : Android iOS Unity Flutter React Native Android (ancienne version)

Le SDK Google User Messaging Platform (UMP) est un outil de confidentialité et de messagerie qui vous aide à gérer les options de confidentialité. Pour en savoir plus, consultez À propos de Confidentialité et messages.

Créer un type de message

Créez des messages utilisateur avec l'un des types de messages utilisateur disponibles dans l'onglet Confidentialité et messages de votre compte AdMob. Le SDK UMP tente d'afficher un message de confidentialité créé à partir de l'ID d'application AdMob défini dans votre projet.

Obtenir les informations sur le consentement de l'utilisateur

Vous devez demander une mise à jour des informations de consentement de l'utilisateur à chaque lancement de l'application, à l'aide de requestConsentInfoUpdate(). Cette requête vérifie les points suivants :

• Si le consentement est requis. Par exemple, le consentement est requis pour la première fois ou la décision de consentement précédente a expiré.
• Si un point d'entrée pour les options de confidentialité est requis. Certains messages de confidentialité exigent que les applications permettent aux utilisateurs de modifier leurs options de confidentialité à tout moment.

/**
 * Requests consent information update on app launch.
 */
export function requestConsent(onComplete?: () => void) {
  requestConsentInfoUpdate({}, (error) => {
    if (error) {
      console.warn('Consent info update error:', error.message);
    } else {
      console.log('Consent info update complete.');
    }

    // Load and show consent form if required.
    loadAndPresentConsentForm(onComplete);
  });
}

Avertissement : Nous vous déconseillons de vérifier l'état du consentement d'une autre manière, par exemple en utilisant le cache de votre application ou une chaîne de consentement précédemment enregistrée. Ces méthodes peuvent renvoyer des données de consentement utilisateur obsolètes.

Charger et présenter le formulaire de message sur la confidentialité

Une fois que vous avez reçu le statut du consentement le plus récent, appelez loadAndShowConsentFormIfRequired() pour charger les formulaires requis pour recueillir le consentement utilisateur. Une fois chargés, les formulaires s'affichent immédiatement.

Point clé : Si aucun formulaire de message sur la confidentialité ne nécessite de recueillir le consentement utilisateur avant de demander des annonces, le rappel est appelé immédiatement.

/**
 * Loads and presents the privacy message form if required to collect user consent.
 */
export function loadAndPresentConsentForm(onComplete?: () => void) {
  loadAndShowConsentFormIfRequired((formError) => {
    if (formError) {
      console.warn('Consent form error:', formError.message);
    } else {
      console.log('Consent gathering complete.');
    }

    // Execute logic that depends on consent state (for example, initialize the SDK).
    onComplete?.();
  });
}

Options de confidentialité

Certains formulaires de message sur la confidentialité sont présentés à partir d'un point d'entrée des options de confidentialité affiché par l'éditeur, ce qui permet aux utilisateurs de gérer leurs options de confidentialité à tout moment. Pour en savoir plus sur le message que vos utilisateurs verront au point d'entrée des options de confidentialité, consultez Types de messages utilisateur disponibles.

Vérifier si un point d'entrée pour les options de confidentialité est requis

Après avoir appelé requestConsentInfoUpdate(), vérifiez getPrivacyOptionsRequirementStatus() pour déterminer si un point d'entrée pour les options de confidentialité est requis pour votre application. Si un point d'entrée est requis, ajoutez un élément d'interface utilisateur visible et interactif à votre application qui présente le formulaire d'options de confidentialité. Si un point d'entrée de confidentialité n'est pas requis, configurez votre élément d'interface utilisateur pour qu'il ne soit pas visible ni interactif.

/**
 * Helper to determine if the privacy options entry point is required.
 */
export function isPrivacyOptionsRequired(): boolean {
  return (
    getPrivacyOptionsRequirementStatus() ===
    PrivacyOptionsRequirementStatus.REQUIRED
  );
}

Pour obtenir la liste complète des états des exigences concernant les options de confidentialité, consultez PrivacyOptionsRequirementStatus.

Présenter le formulaire d'options de confidentialité

Lorsque l'utilisateur interagit avec votre élément, présentez le formulaire d'options de confidentialité :

/**
 * Renders a privacy options button if required by user consent policy.
 */
export function PrivacyOptionsButton({
  onDismissed,
}: {
  onDismissed?: (error?: FormError) => void;
}) {
  const isRequired =
    getPrivacyOptionsRequirementStatus() ===
    PrivacyOptionsRequirementStatus.REQUIRED;

  if (!isRequired) {
    return null;
  }

  const handleShowPrivacyOptions = () => {
    showPrivacyOptionsForm((error) => {
      if (error) {
        console.error('Failed to show privacy options form:', error.message);
      } else {
        console.log('Privacy options form dismissed.');
      }

      // Execute custom logic after form is dismissed.
      onDismissed?.(error);
    });
  };

  return <Button title="Privacy Settings" onPress={handleShowPrivacyOptions} />;
}

Demander des annonces avec le consentement de l'utilisateur

Avant de demander des annonces, utilisez canRequestAds() pour vérifier si vous avez obtenu le consentement de l'utilisateur :

/**
 * Checks whether user consent allows requesting ads and initializes the SDK.
 */
let isMobileAdsInitialized = false;

export function initializeMobileAdsSdkIfConsentGiven() {
  if (canRequestAds()) {
    if (!isMobileAdsInitialized) {
      isMobileAdsInitialized = true;
      initialize({}, (status) => {
        console.log('Google Mobile Ads SDK initialized:', status);
      });
    }
  }
}

Voici les endroits où vous pouvez vérifier si vous pouvez demander des annonces tout en recueillant le consentement :

• Après que le SDK UMP a recueilli le consentement lors de la session en cours.
• Immédiatement après avoir appelé requestConsentInfoUpdate(). Le SDK UMP a peut-être obtenu le consentement lors de la session précédente de l'application.

Important : canRequestAds() renvoie toujours false tant que vous n'avez pas appelé requestConsentInfoUpdate()

Si une erreur se produit lors du processus de collecte du consentement, vérifiez si vous pouvez demander des annonces. Le SDK UMP utilise l'état du consentement de la session d'application précédente.

Éviter les demandes d'annonces redondantes

Lorsque vous vérifiez canRequestAds() après avoir recueilli le consentement et après avoir appelé requestConsentInfoUpdate(), assurez-vous que votre logique empêche les demandes d'annonces redondantes qui pourraient entraîner le renvoi de true par les deux vérifications. Par exemple, avec une variable booléenne.

Tests

Si vous souhaitez tester l'intégration dans votre application pendant que vous la développez, suivez ces étapes pour enregistrer votre appareil de test de manière programmatique. Veillez à supprimer le code qui définit ces ID d'appareils de test avant de publier votre application.

1. Appelez requestConsentInfoUpdate().

2. Dans la sortie du journal, recherchez un message semblable à celui ci-dessous, qui vous indique l'ID de votre appareil et comment l'ajouter en tant qu'appareil de test :

   Android

   Use new ConsentDebugSettings.Builder().addTestDeviceHashedId("33BE2250B43518CCDA7DE426D04EE231")
   to set this as a debug device.
   

   iOS

   <UMP SDK>To enable debug mode for this device,
   set: UMPDebugSettings.testDeviceIdentifiers = @[2077ef9a63d2b398840261c8221a0c9b]
   

3. Copiez l'ID de votre appareil de test dans le presse-papiers.

4. Modifiez votre code pour appeler consentDebugSettings.testDeviceIdentifiers et transmettez la liste des ID de vos appareils de test.

   /**
    * Registers a test device for testing consent flows.
    */
   export function configureTestDevice() {
     requestConsentInfoUpdate(
       {
         consentDebugSettings: {
           debugGeography: DebugGeography.DISABLED,
           testDeviceIdentifiers: ["TEST_DEVICE_HASHED_ID"],
         },
       },
       (error) => {
         if (!error) {
           console.log('Test device registered.');
         }
       },
     );
   }

Forcer une zone géographique

Le SDK UMP vous permet de tester le comportement de votre application comme si l'appareil se trouvait dans différentes régions, telles que l'Espace économique européen (EEE), le Royaume-Uni et la Suisse, à l'aide de DebugGeography. Notez que les paramètres de débogage ne fonctionnent que sur les appareils de test.

/**
 * Configures debug settings to force EEA geography on a test device.
 */
export function configureDebugGeography() {
  requestConsentInfoUpdate(
    {
      consentDebugSettings: {
        debugGeography: DebugGeography.EEA,
        testDeviceIdentifiers: ["TEST_DEVICE_HASHED_ID"],
      },
    },
    (error) => {
      if (!error) {
        console.log('Consent debug test configuration loaded.');
      }
    },
  );
}

Réinitialiser l'état du consentement

Lorsque vous testez votre application avec le SDK UMP, il peut être utile de réinitialiser l'état du SDK afin de simuler la première installation d'un utilisateur. Le SDK fournit la méthode reset() pour ce faire.

/**
 * Resets consent state for testing purposes.
 */
export function resetConsentState() {
  reset();
}

Attention : Cette méthode est destinée à être utilisée à des fins de test uniquement. Vous ne devez pas appeler reset() dans le code de production.