Configurer le SDK User Messaging Platform

Sélectionnez une plate-forme : Android

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

Créer un type de message

Créez des messages destinés aux utilisateurs à l'aide de l'un des types de messages utilisateur disponibles sous 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 À propos de Confidentialité et messages.

Obtenir les informations de 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 Update(). 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.

void Start()
{
    // Create a ConsentRequestParameters object.
    ConsentRequestParameters requestParameters = new ConsentRequestParameters();

    // Request an update of the user's consent information.
    ConsentInformation.Update(requestParameters, OnConsentInfoUpdated);
}UMPSnippets.cs

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

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

ConsentForm.LoadAndShowConsentFormIfRequired((FormError formError) =>
{
    if (formError != null)
    {
        // Consent gathering failed.
        Debug.LogError("Error loading/showing consent form: " + formError.Message);
    }

    // ...
});UMPSnippets.cs

Options de confidentialité

Certains formulaires de message de confidentialité sont présentés à partir d'un point d'entrée pour les 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 voient 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é Update(), vérifiez PrivacyOptionsRequirementStatus 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 des options de confidentialité. Si un point d'entrée pour les options de confidentialité n'est pas requis, configurez votre élément d'interface utilisateur pour qu'il ne soit pas visible et interactif.

void UpdatePrivacyButton()
{
    if (_privacyButton != null)
    {
        // Enable the button only if a privacy options entry point is required.
        _privacyButton.interactable =
            ConsentInformation.PrivacyOptionsRequirementStatus == PrivacyOptionsRequirementStatus.Required;
    }
}UMPSnippets.cs

Pour obtenir la liste complète des états requis pour les options de confidentialité, consultez ConsentInformation.PrivacyOptionsRequirementStatus.

Présenter le formulaire des options de confidentialité

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

public void ShowPrivacyOptionsForm()
{
    ConsentForm.ShowPrivacyOptionsForm((FormError showError) =>
    {
        if (showError != null)
        {
            Debug.LogError("Error showing privacy options form: " + showError.Message);
        }
    });
}UMPSnippets.cs

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 :

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 lors de la session en cours.
Immédiatement après avoir appelé Update(). Le SDK UMP peut avoir obtenu le consentement lors de la session d'application précédente.

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é Update(), 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 son développement, suivez ces étapes pour enregistrer votre appareil de test par programmation. Veillez à supprimer le code qui définit ces ID d'appareils de test avant de publier votre application.

Appelez Update().

Dans la sortie du journal, recherchez un message semblable à l'exemple suivant, qui 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]

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

Modifiez votre code pour appeler DebugGeography.TestDeviceHashedIds et transmettez la liste des ID de vos appareils de test.

void Start()
{
    var debugSettings = new ConsentDebugSettings
    {
        TestDeviceHashedIds =
        new List<string>
        {
            "TEST-DEVICE-HASHED-ID"
        }
    };

    // Create a ConsentRequestParameters object.
    ConsentRequestParameters request = new ConsentRequestParameters
    {
        ConsentDebugSettings = debugSettings,
    };

    // Check the current consent information status.
    ConsentInformation.Update(request, OnConsentInfoUpdated);
}

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

void Start()
{
    var debugSettings = new ConsentDebugSettings
    {
        // Geography appears as in EEA for debug devices.
        DebugGeography = DebugGeography.EEA,
        TestDeviceHashedIds = new List<string>
        {
            "TEST-DEVICE-HASHED-ID"
        }
    };

    // Create a ConsentRequestParameters object.
    ConsentRequestParameters request = new ConsentRequestParameters
    {
        ConsentDebugSettings = debugSettings,
    };

    // Check the current consent information status.
    ConsentInformation.Update(request, OnConsentInfoUpdated);
}

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 par un utilisateur. Le SDK fournit la méthode Reset() pour ce faire.

ConsentInformation.Reset();

Exemples sur GitHub

Consultez un exemple complet de l'intégration du SDK UMP abordée sur cette page dans HelloWorld.