Configura l'SDK UMP

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

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

Creare un tipo di messaggio per gli utenti

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

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

Ottenere le informazioni sul consenso dell'utente

Dovresti 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 sul consenso precedente è scaduta.
• Se è richiesto un punto di accesso alle opzioni sulla privacy. Alcuni messaggi sulla privacy richiedono che le app consentano agli utenti di modificare le proprie opzioni sulla privacy in qualsiasi momento.

@override
void initState() {
  super.initState();

  // Create a ConsentRequestParameters object.
  final params = ConsentRequestParameters();

  // Request an update to consent information on every app launch.
  ConsentInformation.instance.requestConsentInfoUpdate(
    params,
    () async {
      // Called when consent information is successfully updated.
    },
    (FormError error) {
      // Called when there's an error updating consent information.
    },
  );
}

Avviso: l'utilizzo di altri modi per controllare lo stato del consenso, ad esempio la cache dell'app o una stringa di consenso salvata in precedenza, può causare un errore TCF 3.3 se il consenso è scaduto.

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.

Punto chiave: se nessun modulo di messaggi sulla privacy richiede la raccolta del consenso dell'utente prima di richiedere gli annunci, il callback viene richiamato immediatamente.

@override
void initState() {
  super.initState();

  // Create a ConsentRequestParameters object.
  final params = ConsentRequestParameters();

  // Request an update to consent information on every app launch.
  ConsentInformation.instance.requestConsentInfoUpdate(
    params,
    () async {
      ConsentForm.loadAndShowConsentFormIfRequired((loadAndShowError) {
        if (loadAndShowError != null) {
          // Consent gathering failed.
        }

        // Consent has been gathered.
      });
    },
    (FormError error) {
      // Handle the error.
    },
  );
}

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 visualizzato dagli utenti nel punto di accesso alle opzioni sulla privacy, consulta la sezione Tipi di messaggi per gli utenti disponibili.

Verificare se è richiesto un punto di accesso alle 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 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.

/// Helper variable to determine if the privacy options entry point is required.
Future<bool> isPrivacyOptionsRequired() async {
  return await ConsentInformation.instance
      .getPrivacyOptionsRequirementStatus() ==
      PrivacyOptionsRequirementStatus.required;
}

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

Presentare il modulo delle opzioni sulla privacy

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

ConsentForm.showPrivacyOptionsForm((formError) {
  if (formError != null) {
    debugPrint("${formError.errorCode}: ${formError.message}");
  }
});

Richiedere annunci con il consenso dell'utente

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

await ConsentInformation.instance.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.

Importante: canRequestAds() restituisce sempre false finché non hai chiamato requestConsentInfoUpdate()

Se si verifica un errore durante il processo 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 ridondante di richiesta di annunci

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:

   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. Copia l'ID dispositivo di test negli appunti.

4. Modifica il codice per chiamare ConsentDebugSettings.testIdentifiers e trasmettere un elenco degli ID dispositivo di test.

   ConsentDebugSettings debugSettings = ConsentDebugSettings(
     testIdentifiers: ["TEST-DEVICE-HASHED-ID"],
   );
   
   ConsentRequestParameters params =
       ConsentRequestParameters(consentDebugSettings: debugSettings);
   
   ConsentInformation.instance.requestConsentInfoUpdate(params, () async {
     // ...
   };
   

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 debugGeography. Tieni presente che le impostazioni di debug funzionano solo sui dispositivi di test.

ConsentDebugSettings debugSettings = ConsentDebugSettings(
  debugGeography: DebugGeography.debugGeographyEea,
  testIdentifiers: ["TEST-DEVICE-HASHED-ID"],
);

ConsentRequestParameters params =
    ConsentRequestParameters(consentDebugSettings: debugSettings);

ConsentInformation.instance.requestConsentInfoUpdate(params, () async {
  // ...
};

Reimpostare lo stato del consenso

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.

ConsentInformation.instance.reset();

Attenzione: questo metodo è destinato all'uso solo a scopo di test. Non devi chiamare reset() nel codice di produzione.

Esempi su GitHub

Consulta un esempio completo dell'integrazione dell'SDK UMP trattata in questa pagina in i nostri esempi di Flutter.