Comenzar

Selecciona la plataforma: Android iOS Unity Flutter

El SDK de Google User Messaging Platform (UMP) es una herramienta de privacidad y mensajería que te ayuda a administrar las opciones de privacidad. Para obtener más información, consulta Acerca de Privacidad y mensajería.

Requisitos previos

  • Nivel de API de Android 21 o posterior

Crea un tipo de mensaje

Crea mensajes para los usuarios con uno de los tipos de mensajes para los usuarios disponibles en la pestaña Privacidad y mensajería de tu cuenta de AdMob. El SDK de UMP intenta mostrar un mensaje de privacidad creado a partir del ID de aplicación de AdMob establecido en tu proyecto.

Para obtener más detalles, consulta Acerca de la privacidad y la mensajería.

Instalación con Gradle

Agrega la dependencia del SDK de Google User Messaging Platform al archivo Gradle a nivel de la app de tu módulo, que suele ser app/build.gradle:

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

Después de realizar los cambios en el archivo build.gradle de tu app, asegúrate de sincronizar tu proyecto con los archivos de Gradle.

Agrega el ID de aplicación

Puedes encontrar el ID de tu aplicación en la IU de AdMob. Agrega el ID a tu AndroidManifest.xml con el siguiente fragmento de código:

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

Para obtener la información de consentimiento del usuario, haz lo siguiente:

Declara una instancia de ConsentInformation:

Java

private final ConsentInformation consentInformation;

Kotlin

private lateinit val consentInformation: ConsentInformation

Inicializa la instancia de ConsentInformation:

Java

consentInformation = UserMessagingPlatform.getConsentInformation(context);

Kotlin

consentInformation = UserMessagingPlatform.getConsentInformation(context)

Debes solicitar una actualización de la información de consentimiento del usuario en cada inicio de la app con requestConsentInfoUpdate(). Esta solicitud verifica lo siguiente:

  • Indica si se requiere consentimiento. Por ejemplo, se requiere el consentimiento por primera vez o venció la decisión de consentimiento anterior.
  • Indica si se requiere un punto de entrada de opciones de privacidad. Algunos mensajes de privacidad requieren que las apps permitan a los usuarios modificar sus opciones de privacidad en cualquier momento.

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.

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

Carga y presenta el formulario de mensaje de privacidad

Después de recibir el estado de consentimiento más actualizado, llama a loadAndShowConsentFormIfRequired() para cargar los formularios necesarios para recopilar el consentimiento del usuario. Después de la carga, los formularios se muestran de inmediato.

Java


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

Kotlin


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

Opciones de privacidad

Algunos formularios de mensajes de privacidad se presentan desde un punto de entrada de opciones de privacidad renderizado por el publicador, lo que permite a los usuarios administrar sus opciones de privacidad en cualquier momento. Para obtener más información sobre qué mensaje ven los usuarios en el punto de entrada de las opciones de privacidad, consulta Tipos de mensajes disponibles para los usuarios.

Verifica si se requiere un punto de entrada de opciones de privacidad

Después de llamar a requestConsentInfoUpdate(), verifica getPrivacyOptionsRequirementStatus() para determinar si se requiere un punto de entrada de opciones de privacidad para tu app. Si se requiere un punto de entrada, agrega un elemento de la IU visible y con el que se pueda interactuar a tu app que presente el formulario de opciones de privacidad. Si no se requiere un punto de entrada de privacidad, configura el elemento de IU para que no sea visible ni interactivo.

Java


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

Kotlin


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

Para obtener la lista completa de los estados de requisitos de las opciones de privacidad, consulta ConsentInformation.PrivacyOptionsRequirementStatus.

Presenta el formulario de opciones de privacidad

Cuando el usuario interactúe con tu elemento, presenta el formulario de opciones de privacidad:

Java


UserMessagingPlatform.showPrivacyOptionsForm(activity, onConsentFormDismissedListener);

Kotlin


UserMessagingPlatform.showPrivacyOptionsForm(activity, onConsentFormDismissedListener)

Solicita anuncios con el consentimiento del usuario

Antes de solicitar anuncios, usa canRequestAds() para verificar si obtuviste el consentimiento del usuario:

Java

consentInformation.canRequestAds();

Kotlin

consentInformation.canRequestAds()

A continuación, se indican los lugares que debes consultar para saber si puedes solicitar anuncios mientras recopilas el consentimiento:

  • Después de que el SDK de UMP recopila el consentimiento en la sesión actual.
  • Inmediatamente después de que hayas llamado a requestConsentInfoUpdate(). Es posible que el SDK de UMP haya obtenido el consentimiento en la sesión anterior de la app.

Si se produce un error durante el proceso de recopilación del consentimiento, verifica si puedes solicitar anuncios. El SDK de UMP usa el estado de consentimiento de la sesión anterior de la app.

Evita el trabajo redundante de las solicitudes de anuncios

Cuando verifiques canRequestAds() después de obtener el consentimiento y después de llamar a requestConsentInfoUpdate(), asegúrate de que tu lógica evite solicitudes de anuncios redundantes que podrían hacer que ambas verificaciones devuelvan true. Por ejemplo, con una variable booleana.

Prueba

Si quieres probar la integración en tu app mientras la desarrollas, sigue estos pasos para registrar tu dispositivo de prueba de forma programática. Asegúrate de quitar el código que establece estos IDs de dispositivos de prueba antes de lanzar tu app.

  1. Llamar a requestConsentInfoUpdate()
  2. Verifica el resultado del registro para ver un mensaje similar al siguiente ejemplo, que muestra el ID de tu dispositivo y cómo agregarlo como dispositivo de prueba:

    Use new ConsentDebugSettings.Builder().addTestDeviceHashedId("33BE2250B43518CCDA7DE426D04EE231") to set this as a debug device.
    
  3. Copia el ID de tu dispositivo de prueba en el portapapeles.

  4. Modifica tu código para llamar a ConsentDebugSettings.Builder().TestDeviceHashedIds y pasar una lista de los IDs de tus dispositivos de prueba.

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

Forzar una ubicación geográfica

El SDK de UMP proporciona una forma de probar el comportamiento de tu app como si el dispositivo estuviera ubicado en varias regiones, como el EEE o el Reino Unido, con setDebugGeography(). Ten en cuenta que la configuración de depuración solo funciona en dispositivos de prueba.

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

Cuando pruebes tu app con el SDK de UMP, te resultará útil restablecer el estado del SDK para simular la experiencia de instalación inicial de un usuario. El SDK proporciona el método reset() para hacerlo.

Java

consentInformation.reset();

Kotlin

consentInformation.reset()

Ejemplos en GitHub

Consulta un ejemplo completo de la integración del SDK de UMP que se explica en esta página en Java BannerExample y Kotlin BannerExample.