Configura l'SDK UMP

Seleziona la piattaforma: Android iOS Unity Flutter Android (legacy)

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 saperne di più, consulta Informazioni su Privacy e messaggi.

Crea un tipo di messaggio

Crea messaggi per gli utenti con uno dei tipi di messaggi per gli utenti 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 progetto.

Per maggiori dettagli, consulta Informazioni su Privacy e messaggi.

Aggiungi l'ID applicazione

Puoi trovare l'ID applicazione nell'interfaccia utente di AdMob. Aggiungi l'ID al tuo 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, segui questi passaggi:

Dichiara un'istanza di ConsentInformation:

Java

private final ConsentInformation consentInformation;

Kotlin

private lateinit var 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 il consenso è obbligatorio. Ad esempio, il consenso è richiesto per la prima volta o la decisione di consenso precedente è scaduta.
  • Se è necessario un punto di accesso alle opzioni sulla privacy. Alcuni messaggi sulla privacy richiedono che le app consentano agli utenti di modificare le proprie opzioni relative alla 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.

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

Carica e presenta il modulo del messaggio sulla privacy

Dopo aver ricevuto lo stato del consenso più aggiornato, chiama loadAndShowConsentFormIfRequired() per caricare i moduli necessari per raccogliere il consenso degli utenti. Dopo il caricamento, i moduli vengono visualizzati immediatamente.

Java


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

Kotlin


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

Opzioni per la privacy

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

Verifica se è necessario un punto di accesso alle opzioni sulla privacy

Dopo aver chiamato requestConsentInfoUpdate(), controlla getPrivacyOptionsRequirementStatus() per determinare se per la tua app è richiesto un punto di accesso alle opzioni sulla privacy. Se è richiesto un punto di accesso, aggiungi alla tua app un elemento UI visibile e interattivo che presenti 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;
}

Kotlin


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

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

Presentare il modulo delle opzioni sulla privacy

Quando l'utente interagisce con l'elemento, mostra il modulo delle opzioni per la privacy:

Java


UserMessagingPlatform.showPrivacyOptionsForm(activity, onConsentFormDismissedListener);

Kotlin


UserMessagingPlatform.showPrivacyOptionsForm(activity, onConsentFormDismissedListener)

Richiedi annunci con il consenso degli utenti

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 elencati i punti da controllare per verificare se puoi richiedere annunci durante la raccolta del consenso:

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

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

Evita operazioni ridondanti per le richieste di annunci

Quando controlli canRequestAds() dopo aver raccolto il consenso e dopo aver chiamato requestConsentInfoUpdate(), assicurati che la logica impedisca richieste di annunci ridondanti che potrebbero comportare la restituzione di true da parte di 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 il numero requestConsentInfoUpdate().

  2. Controlla l'output del log per un messaggio simile al seguente esempio, 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 del dispositivo di test negli appunti.

  4. Modifica il codice per chiamare ConsentDebugSettings.Builder().TestDeviceHashedIds e trasmetti un elenco degli ID dei tuoi dispositivi 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,
    // ...
)

Forza un'area geografica

L'SDK UMP consente di testare il comportamento della tua app come se il dispositivo si trovasse in varie regioni, ad esempio lo Spazio economico europeo (SEE), il Regno Unito (UK) 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,
    ...
)

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

Java

consentInformation.reset();

Kotlin

consentInformation.reset()