Premiers pas

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

Prérequis

• Niveau d'API Android 21 ou supérieur

Créer un type de message

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

Pour en savoir plus, consultez la section À propos de la confidentialité et des messages.

Installer avec Gradle

Ajoutez la dépendance du SDK Google User Messaging Platform au fichier Gradle au niveau de l'application de votre module (généralement app/build.gradle) :

dependencies {
  implementation("com.google.android.ump:user-messaging-platform:3.1.0")
}

Après avoir apporté les modifications au fichier build.gradle de votre application, veillez à synchroniser votre projet avec les fichiers Gradle.

Ajouter l'ID de l'application

Vous trouverez votre ID d'application dans l'interface utilisateur d'Ad Manager. Ajoutez l'ID à votre AndroidManifest.xml avec l'extrait de code suivant:

<manifest>
  <application>
    <meta-data
        android:name="com.google.android.gms.ads.APPLICATION_ID"
        android:value="ca-app-pub-xxxxxxxxxxxxxxxx~yyyyyyyyyy"/>
  </application>
</manifest>

Obtenir les informations sur le consentement de l'utilisateur

Pour obtenir les informations sur le consentement de l'utilisateur, procédez comme suit:

Déclarez une instance de ConsentInformation:

Java

private final ConsentInformation consentInformation;

Kotlin

private lateinit val consentInformation: ConsentInformation

Initialisez l'instance ConsentInformation:

Java

consentInformation = UserMessagingPlatform.getConsentInformation(context);

Kotlin

consentInformation = UserMessagingPlatform.getConsentInformation(context)

Vous devez demander la mise à jour des informations sur le consentement de l'utilisateur à chaque lancement de l'application, à l'aide de requestConsentInfoUpdate(). Cette requête vérifie les éléments 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é.
• Indique si un point d'entrée pour les options de confidentialité est obligatoire. Certains messages de confidentialité exigent que les applications permettent aux utilisateurs de modifier leurs options de confidentialité à tout moment.

Java

// Requesting an update to consent information should be called on every app launch.
consentInformation.requestConsentInfoUpdate(
    activity,
    params,
    () -> // Called when consent information is successfully updated.
    requestConsentError -> // Called when there's an error updating consent information.
GoogleMobileAdsConsentManager.java

Kotlin

// Requesting an update to consent information should be called on every app launch.
consentInformation.requestConsentInfoUpdate(
  activity,
  params,
  {
    // Called when consent information is successfully updated.
  },
  { requestConsentError ->
    // Called when there's an error updating consent information.
  },
)
GoogleMobileAdsConsentManager.kt

Avertissement :L'utilisation d'autres méthodes pour vérifier l'état du consentement, telles que le cache de votre application ou une chaîne de consentement précédemment enregistrée, peut entraîner une erreur TCF 3.3 si le consentement a expiré.

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

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

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

Java

UserMessagingPlatform.loadAndShowConsentFormIfRequired(
    activity,
    formError -> {
      // Consent gathering process is complete.
    });
GoogleMobileAdsConsentManager.java

Kotlin

UserMessagingPlatform.loadAndShowConsentFormIfRequired(activity) { formError ->
  // Consent gathering process is complete.
}
GoogleMobileAdsConsentManager.kt

Options de confidentialité

Certains formulaires de message de confidentialité sont présentés à partir d'un point d'entrée des options de confidentialité généré 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 voient au point d'entrée des options de confidentialité, consultez la section 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.

Java

/** Helper variable to determine if the privacy options form is required. */
public boolean isPrivacyOptionsRequired() {
  return consentInformation.getPrivacyOptionsRequirementStatus()
      == PrivacyOptionsRequirementStatus.REQUIRED;
}
GoogleMobileAdsConsentManager.java

Kotlin

/** Helper variable to determine if the privacy options form is required. */
val isPrivacyOptionsRequired: Boolean
  get() =
    consentInformation.privacyOptionsRequirementStatus ==
      ConsentInformation.PrivacyOptionsRequirementStatus.REQUIRED
GoogleMobileAdsConsentManager.kt

Pour obtenir la liste complète des états des exigences concernant les options de confidentialité, consultez ConsentInformation.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é:

Java

UserMessagingPlatform.showPrivacyOptionsForm(activity, onConsentFormDismissedListener);
GoogleMobileAdsConsentManager.java

Kotlin

UserMessagingPlatform.showPrivacyOptionsForm(activity, onConsentFormDismissedListener)
GoogleMobileAdsConsentManager.kt

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:

Java

consentInformation.canRequestAds();

Kotlin

consentInformation.canRequestAds()

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

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

Important : canRequestAds() renvoie toujours false jusqu'à ce que vous appeliez 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 tâches redondantes liées aux demandes d'annonces

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 requêtes d'annonces redondantes qui pourraient entraîner le retour de true dans les deux vérifications. Par exemple, avec une variable booléenne.

Tests

Si vous souhaitez tester l'intégration dans votre application pendant le développement, suivez ces étapes pour enregistrer votre appareil de test par programmation. Veillez à supprimer le code qui définit ces ID d'appareil de test avant de publier votre application.

Remarque :À partir de la version 2.2.0, les émulateurs n'ont pas besoin d'être ajoutés à votre liste d'ID d'appareil, car ils sont des appareils de test par défaut.

1. Appelez requestConsentInfoUpdate().

2. Recherchez dans la sortie du journal un message semblable à l'exemple suivant, qui indique votre ID d'appareil et comment l'ajouter en tant qu'appareil de test:

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

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

4. Modifiez votre code pour appeler ConsentDebugSettings.Builder().TestDeviceHashedIds et transmettre une liste de vos ID d'appareils de test.

   Java

   ConsentDebugSettings debugSettings = new ConsentDebugSettings.Builder(this)
       .addTestDeviceHashedId("TEST-DEVICE-HASHED-ID")
       .build();
   
   ConsentRequestParameters params = new ConsentRequestParameters
       .Builder()
       .setConsentDebugSettings(debugSettings)
       .build();
   
   consentInformation = UserMessagingPlatform.getConsentInformation(this);
   // Include the ConsentRequestParameters in your consent request.
   consentInformation.requestConsentInfoUpdate(
       this,
       params,
       // ...
   );
   

   Kotlin

   val debugSettings = ConsentDebugSettings.Builder(this)
       .addTestDeviceHashedId("TEST-DEVICE-HASHED-ID")
       .build()
   
   val params = ConsentRequestParameters
       .Builder()
       .setConsentDebugSettings(debugSettings)
       .build()
   
   consentInformation = UserMessagingPlatform.getConsentInformation(this)
   // Include the ConsentRequestParameters in your consent request.
   consentInformation.requestConsentInfoUpdate(
       this,
       params,
       // ...
   )
   

Forcer une zone géographique

Le SDK UMP permet de tester le comportement de votre application comme si l'appareil était situé dans différentes régions, comme l'EEE ou le Royaume-Uni, à l'aide de DebugGeography. Notez que les paramètres de débogage ne fonctionnent que sur les appareils de test.

Java

ConsentDebugSettings debugSettings = new ConsentDebugSettings.Builder(this)
    .setDebugGeography(ConsentDebugSettings.DebugGeography.DEBUG_GEOGRAPHY_EEA)
    .addTestDeviceHashedId("TEST-DEVICE-HASHED-ID")
    .build();

ConsentRequestParameters params = new ConsentRequestParameters
    .Builder()
    .setConsentDebugSettings(debugSettings)
    .build();

consentInformation = UserMessagingPlatform.getConsentInformation(this);
// Include the ConsentRequestParameters in your consent request.
consentInformation.requestConsentInfoUpdate(
    this,
    params,
    ...
);

Kotlin

val debugSettings = ConsentDebugSettings.Builder(this)
    .setDebugGeography(ConsentDebugSettings.DebugGeography.DEBUG_GEOGRAPHY_EEA)
    .addTestDeviceHashedId("TEST-DEVICE-HASHED-ID")
    .build()

val params = ConsentRequestParameters
    .Builder()
    .setConsentDebugSettings(debugSettings)
    .build()

consentInformation = UserMessagingPlatform.getConsentInformation(this)
// Include the ConsentRequestParameters in your consent request.
consentInformation.requestConsentInfoUpdate(
    this,
    params,
    ...
)

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 pouvoir simuler la première expérience d'installation d'un utilisateur. Pour ce faire, le SDK fournit la méthode reset().

Java

consentInformation.reset();

Kotlin

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

Exemples sur GitHub

Pour voir un exemple complet de l'intégration du SDK UMP abordée sur cette page, consultez Exemple Java BannerExample et Exemple Kotlin BannerExample.