Configura l'SDK UMP

Seleziona la piattaforma: Android (beta) Nuovo Android iOS Unity Flutter

L'SDK Google User Messaging Platform (UMP) è uno strumento per la privacy e i messaggi che ti aiuta a gestire le scelte relative alla privacy. Per ulteriori informazioni, consulta la pagina Informazioni su Privacy e messaggi.

Prerequisiti

  • Livello API Android 21 o versioni successive

Creare un tipo di messaggio

Crea messaggi per gli utenti con uno dei tipi di messaggi disponibili nella scheda Privacy e messaggi del tuo account AdMob. L'SDK UMP tenta di visualizzare un messaggio sulla privacy creato dall'ID applicazione AdMob impostato nel tuo progetto.

Per ulteriori dettagli, consulta la pagina Informazioni su privacy e messaggi.

Installare con Gradle

Aggiungi la dipendenza per l'SDK Google User Messaging Platform al file Gradle Gradle del tuo modulo, in genere app/build.gradle:

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

Dopo aver apportato le modifiche a build.gradle della tua app, assicurati di sincronizzare il progetto con i file Gradle.

Aggiungere l'ID applicazione

Puoi trovare l'ID applicazione nell' interfaccia utente di AdMob. Aggiungi l'ID a AndroidManifest.xml con il seguente snippet di codice:

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

Per ottenere le informazioni sul consenso dell'utente:

Dichiara un'istanza di ConsentInformation:

Java

private final ConsentInformation consentInformation;

Kotlin

private lateinit val consentInformation: ConsentInformation

Inizializza l'istanza ConsentInformation:

Java

consentInformation = UserMessagingPlatform.getConsentInformation(context);

Kotlin

consentInformation = UserMessagingPlatform.getConsentInformation(context)

Devi richiedere un aggiornamento delle informazioni sul consenso dell'utente a ogni avvio dell'app utilizzando requestConsentInfoUpdate(). Questa richiesta controlla quanto segue:

  • Se è richiesto il consenso. Ad esempio, il consenso è richiesto per la prima volta o la decisione di consenso precedente è scaduta.
  • Se è richiesto un punto di contatto per le opzioni sulla privacy. Alcuni messaggi sulla privacy richiedono che le app consentano agli utenti di modificare le proprie opzioni sulla privacy in qualsiasi 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.
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

Caricare e presentare il modulo del messaggio sulla privacy

Dopo aver ricevuto lo stato del consenso più aggiornato, chiama loadAndShowConsentFormIfRequired() per caricare tutti i moduli necessari per raccogliere il consenso dell'utente. Dopo il caricamento, i moduli vengono presentati immediatamente.

Java


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

Kotlin


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

Opzioni sulla privacy

Alcuni moduli di messaggi sulla privacy vengono presentati da un punto di accesso alle opzioni sulla privacy sottoposto a rendering dal publisher, consentendo agli utenti di gestire le proprie opzioni sulla privacy in qualsiasi momento. Per scoprire di più su quale messaggio viene mostrato agli utenti nel punto di accesso alle opzioni sulla privacy, consulta Tipi di messaggi per gli utenti disponibili.

Verificare se è richiesto un punto di contatto per le opzioni sulla privacy

Dopo aver chiamato requestConsentInfoUpdate(), controlla getPrivacyOptionsRequirementStatus() per determinare se è richiesto un punto di accesso alle opzioni sulla privacy per la tua app. Se è richiesto un punto di accesso, aggiungi un elemento UI visibile e interattivo alla tua app che presenta il modulo delle opzioni sulla privacy. Se non è richiesto un punto di accesso alla privacy, configura l'elemento UI in modo che non sia visibile e interattivo.

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

Per l'elenco completo degli stati dei requisiti delle opzioni sulla privacy, consulta ConsentInformation.PrivacyOptionsRequirementStatus.

Presentare il modulo delle opzioni sulla privacy

Quando l'utente interagisce con l'elemento, presenta il modulo delle opzioni sulla privacy:

Java


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

Kotlin


UserMessagingPlatform.showPrivacyOptionsForm(activity, onConsentFormDismissedListener)
GoogleMobileAdsConsentManager.kt

Richiedere annunci con il consenso dell'utente

Prima di richiedere gli annunci, utilizza canRequestAds() per verificare se hai ottenuto il consenso dell'utente:

Java

consentInformation.canRequestAds();

Kotlin

consentInformation.canRequestAds()

Di seguito sono riportati i luoghi in cui puoi verificare se puoi richiedere gli annunci durante la raccolta del consenso:

  • Dopo che l'SDK UMP raccoglie il consenso nella sessione corrente.
  • Subito dopo aver chiamato requestConsentInfoUpdate(). L'SDK UMP potrebbe aver ottenuto il consenso nella sessione dell'app precedente.

Se si verifica un errore durante la procedura di raccolta del consenso, verifica se puoi richiedere gli annunci. L'SDK UMP utilizza lo stato del consenso della sessione dell'app precedente.

Evitare il lavoro di richiesta di annunci ridondante

Quando controlli canRequestAds() dopo aver raccolto il consenso e dopo aver chiamato requestConsentInfoUpdate(), assicurati che la tua logica impedisca richieste di annunci ridondanti che potrebbero comportare la restituzione di true da entrambi i controlli. Ad esempio, con una variabile booleana.

Test

Se vuoi testare l'integrazione nella tua app durante lo sviluppo, segui questi passaggi per registrare in modo programmatico il tuo dispositivo di test. Assicurati di rimuovere il codice che imposta questi ID dispositivo di test prima di rilasciare l'app.

  1. Chiama requestConsentInfoUpdate().

  2. Controlla l'output del log per un messaggio simile all'esempio seguente, che mostra l'ID dispositivo e come aggiungerlo come dispositivo di test:

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

  3. Copia l'ID dispositivo di test negli appunti.

  4. Modifica il codice per chiamare ConsentDebugSettings.Builder().TestDeviceHashedIds e passa un elenco degli ID dispositivo di 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,
    // ...
)

Forzare una località geografica

L'SDK UMP offre un modo per testare il comportamento della tua app come se il dispositivo si trovasse in varie regioni, come lo Spazio Economico Europeo (SEE), il Regno Unito e la Svizzera, utilizzando setDebugGeography(). Tieni presente che le impostazioni di debug funzionano solo sui dispositivi di 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,
    ...
)

Quando testi la tua app con l'SDK UMP, potrebbe essere utile reimpostare lo stato dell'SDK in modo da poter simulare l'esperienza di prima installazione di un utente. L'SDK fornisce il metodo reset() per farlo.

Java

consentInformation.reset();

Kotlin

consentInformation.reset()

Esempi su GitHub

Consulta un esempio completo dell'integrazione dell'SDK UMP trattata in questa pagina in Java BannerExample e Kotlin BannerExample.