Premiers pas

Le SDK Google User Messaging Platform (UMP) est un outil permettant vous aider à gérer les paramètres de confidentialité. Pour en savoir plus, consultez À propos de l'outil Confidentialité et messagerie.

Créer un type de message

Créez des messages destinés aux utilisateurs avec l'une des Types de messages disponibles pour les utilisateurs dans la section Confidentialité l'onglet "Messages" de votre AdMob de service. Le SDK UMP tente d'afficher un message sur la confidentialité créé à partir de AdMob l'identifiant de l'application dans votre projet.

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

Ajouter l'ID application

Vous trouverez l'ID de votre application dans le Interface utilisateur d'AdMob. Ajoutez la pièce d'identité à votre à l'aide de l'extrait de code suivant:

Demande d'informations sur le consentement

Vous devez demander la mise à jour des informations sur le consentement de l'utilisateur pour chaque application lancer, à l'aide de Update(). Cette demande vérifie les éléments suivants:

• Le consentement est-il requis ? Par exemple, le consentement est requis pour ou que la précédente décision de consentement a expiré.
• Indique si un point d'entrée pour les options de confidentialité est requis. Certains messages sur la confidentialité exiger que les applications autorisent les utilisateurs à modifier leurs options de confidentialité à tout moment.

Voici un exemple de vérification de l'état au démarrage de l'application:

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

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

void OnConsentInfoUpdated(FormError consentError)
{
    if (consentError != null)
    {
        // Handle the error.
        UnityEngine.Debug.LogError(consentError);
        return;
    }

    // If the error is null, the consent information state was updated.
    // You are now ready to check if a form is available.
}

Avertissement :En utilisant d'autres moyens de vérifier l'état du consentement, comme le cache de votre ou une chaîne de consentement précédemment enregistrée, peut entraîner une Erreur du TCF 3.3 si le consentement est est arrivé à expiration.

Charger et présenter un formulaire de message sur la confidentialité si nécessaire

Important :Les API suivantes sont compatibles avec le SDK UMP version 2.1.0 ou ultérieure.

Une fois que vous avez reçu les toutes dernières informations concernant l'état de votre consentement, appelez LoadAndShowConsentFormIfRequired() pour charger les formulaires nécessaires recueillir le consentement des utilisateurs. Une fois le chargement terminé, les formulaires s'affichent immédiatement.

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

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

void OnConsentInfoUpdated(FormError consentError)
{
    if (consentError != null)
    {
        // Handle the error.
        UnityEngine.Debug.LogError(consentError);
        return;
    }

    // If the error is null, the consent information state was updated.
    // You are now ready to check if a form is available.
    ConsentForm.LoadAndShowConsentFormIfRequired((FormError formError) =>
    {
        if (formError != null)
        {
            // Consent gathering failed.
            UnityEngine.Debug.LogError(consentError);
            return;
        }

        // Consent has been gathered.
    });
}

Important :Si aucun formulaire de message sur la confidentialité n'exige de recueillir le consentement des utilisateurs au préalable aux demandes d'annonces, le rappel est invoqué immédiatement.

Si vous devez effectuer des actions après que l'utilisateur a choisi ou ignoré dans le formulaire, placez cette logique dans Action<FormError> callback pour votre formulaire.

Options de confidentialité

Certains formulaires de message sur la confidentialité sont présentés à partir d'une interface qui permet aux utilisateurs de gérer leurs options de confidentialité à tout moment. Pour en savoir plus sur le message que voient vos utilisateurs dans les options de confidentialité point d'entrée, consultez Types de messages disponibles pour les utilisateurs

Pour implémenter un point d'entrée pour les options de confidentialité, procédez comme suit:

1. Vérifiez PrivacyOptionsRequirementStatus.
2. Si un point d'entrée des options de confidentialité est ajoutez un élément d'interface utilisateur visible et interactif à votre application.
3. Déclenchez le formulaire des options de confidentialité à l'aide de ShowPrivacyOptionsForm()

L'exemple de code suivant illustre ces étapes:

[SerializeField, Tooltip("Button to show the privacy options form.")]
private Button _privacyButton;

private void Start()
{
  // Enable the privacy settings button.
  if (_privacyButton != null)
  {
      _privacyButton.onClick.AddListener(UpdatePrivacyButton);
      // Disable the privacy settings button by default.
      _privacyButton.interactable = false;
  }
}

/// <summary>
/// Shows the privacy options form to the user.
/// </summary>
public void ShowPrivacyOptionsForm()
{
    Debug.Log("Showing privacy options form.");

    ConsentForm.ShowPrivacyOptionsForm((FormError showError) =>
    {
        if (showError != null)
        {
            Debug.LogError("Error showing privacy options form with error: " + showError.Message);
        }
        // Enable the privacy settings button.
        if (_privacyButton != null)
        {
            _privacyButton.interactable =
                ConsentInformation.PrivacyOptionsRequirementStatus ==
                PrivacyOptionsRequirementStatus.Required;
        }
    });
}

Demander des annonces

Avant de demander des annonces dans votre application, vérifiez si vous avez obtenu le consentement des utilisateurs de l'utilisateur via CanRequestAds(). Il y a deux endroits où vérifier le consentement des utilisateurs:

• Une fois que le consentement a été obtenu lors de la session en cours.
• Immédiatement après avoir appelé Update(). Il est possible que le consentement ait été obtenu lors de la session précédente. En tant que latence nous vous recommandons de ne pas attendre la fin du rappel commencer à charger des annonces dès que possible après le lancement de votre application.

Remarque: CanRequestAds() renvoie toujours false jusqu'à ce que vous ayez appelé Update()

Si une erreur se produit lors du processus de collecte du consentement, vous devez pour tenter de demander des annonces. Le SDK UMP utilise l'état de consentement de l'autorisation session.

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

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

void OnConsentInfoUpdated(FormError consentError)
{
    if (consentError != null)
    {
        // Handle the error.
        UnityEngine.Debug.LogError(consentError);
        return;
    }

    // If the error is null, the consent information state was updated.
    // You are now ready to check if a form is available.
    ConsentForm.LoadAndShowConsentFormIfRequired((FormError formError) =>
    {
        if (formError != null)
        {
            // Consent gathering failed.
            UnityEngine.Debug.LogError(consentError);
            return;
        }

        // Consent has been gathered.
        if (ConsentInformation.CanRequestAds())
        {
            MobileAds.Initialize((InitializationStatus initstatus) =>
            {
              // TODO: Request an ad.
            });
        }
    });
    
}

Tests

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

1. Appelez le Update().

2. Recherchez dans la sortie du journal un message semblable à l'exemple suivant, affiche l'ID de votre appareil et explique 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 votre presse-papiers.

4. Modifiez votre code pour appeler DebugGeography.TestDeviceHashedIds et transmettre la liste de vos ID d'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ées dans l'EEE ou au Royaume-Uni par le biais de the DebugGeography field on ConsentDebugSettings. 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 le l'état du SDK afin de simuler la première expérience d'installation d'un utilisateur. Pour ce faire, le SDK fournit la méthode Reset() .

ConsentInformation.Reset();

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

Exemples sur GitHub