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 i messaggi che ti aiuta a gestire le scelte relative alla privacy. Per saperne di più, consulta la pagina Informazioni su Privacy e messaggi.

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 maggiori dettagli, consulta la pagina Informazioni su privacy e messaggi.

Importare l'SDK

CocoaPods (opzione preferita)

Il modo più semplice per importare l'SDK in un progetto iOS è utilizzare CocoaPods. Apri il Podfile del progetto e aggiungi questa riga al target dell'app:

pod 'GoogleUserMessagingPlatform'

Quindi, esegui il comando seguente:

pod install --repo-update

Se non hai familiarità con CocoaPods, consulta la pagina Utilizzare CocoaPods per informazioni dettagliate su come creare e utilizzare i Podfile.

Swift Package Manager

L'SDK UMP supporta anche Swift Package Manager. Segui questi passaggi per importare il pacchetto Swift.

1. In Xcode, installa il pacchetto Swift dell'SDK UMP andando a File > Add Packages... (File > Aggiungi pacchetti).

2. Nel prompt visualizzato, cerca il repository GitHub del pacchetto Swift dell'SDK UMP:

   https://github.com/googleads/swift-package-manager-google-user-messaging-platform.git
   

3. Seleziona la versione del pacchetto Swift dell'SDK UMP che vuoi utilizzare. Per i nuovi progetti, ti consigliamo di utilizzare Up to Next Major Version (Fino alla prossima versione principale).

Xcode risolve le dipendenze del pacchetto e le scarica in background. Per maggiori dettagli su come aggiungere le dipendenze del pacchetto, consulta l'articolo di Apple.

Download manuale

L'altro modo per importare l'SDK è farlo manualmente.

Scarica l'SDK

Quindi, trascina il framework nel progetto Xcode, assicurandoti di selezionare Copy items if needed (Copia gli elementi se necessario).

Puoi quindi includere il framework in qualsiasi file necessario utilizzando:

import UserMessagingPlatform

#include <UserMessagingPlatform/UserMessagingPlatform.h>

Aggiungere l'ID applicazione

Puoi trovare l'ID applicazione nell' interfaccia utente di AdMob. Aggiungi l'ID al tuo Info.plist con il seguente snippet di codice:

<key>GADApplicationIdentifier</key>
<string>ca-app-pub-xxxxxxxxxxxxxxxx~yyyyyyyyyy</string>

Ottenere le informazioni sul consenso dell'utente

Devi richiedere un aggiornamento delle informazioni sul consenso dell'utente a ogni avvio dell'app utilizzando requestConsentInfoUpdate(with:completionHandler:). 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.

// Requesting an update to consent information should be called on every app launch.
ConsentInformation.shared.requestConsentInfoUpdate(with: parameters) {
  requestConsentError in
  // ...
}
GoogleMobileAdsConsentManager.swift

// Requesting an update to consent information should be called on every app launch.
ConsentInformation.shared.requestConsentInfoUpdate(with: parameters) {
  requestConsentError in
  // ...
}
GoogleMobileAdsConsentManager.swift

// Requesting an update to consent information should be called on every app launch.
[UMPConsentInformation.sharedInstance
    requestConsentInfoUpdateWithParameters:parameters
                         completionHandler:^(NSError *_Nullable requestConsentError) {
                           // ...
                         }];
GoogleMobileAdsConsentManager.m

Caricare e presentare il modulo del messaggio sulla privacy

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

try await ConsentForm.loadAndPresentIfRequired(from: viewController)
GoogleMobileAdsConsentManager.swift

try await ConsentForm.loadAndPresentIfRequired(from: nil)
GoogleMobileAdsConsentManager.swift

[UMPConsentForm
    loadAndPresentIfRequiredFromViewController:viewController
                             completionHandler:^(NSError *_Nullable loadAndPresentError) {
                                 // Consent gathering process is complete.
                                }];
GoogleMobileAdsConsentManager.m

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 pagina Tipi di messaggi per gli utenti disponibili.

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

Dopo aver chiamato requestConsentInfoUpdate(with:completionHandler:), controlla UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus 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 all'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.

var isPrivacyOptionsRequired: Bool {
  return ConsentInformation.shared.privacyOptionsRequirementStatus == .required
}
GoogleMobileAdsConsentManager.swift

- (BOOL)isPrivacyOptionsRequired {
  return UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus ==
         UMPPrivacyOptionsRequirementStatusRequired;
}
GoogleMobileAdsConsentManager.m

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

Presentare il modulo delle opzioni sulla privacy

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

try await ConsentForm.presentPrivacyOptionsForm(from: viewController)
GoogleMobileAdsConsentManager.swift

try await ConsentForm.presentPrivacyOptionsForm(from: nil)
GoogleMobileAdsConsentManager.swift

[UMPConsentForm presentPrivacyOptionsFormFromViewController:viewController
                                          completionHandler:completionHandler];
GoogleMobileAdsConsentManager.m

Richiedere annunci con il consenso dell'utente

Prima di richiedere gli annunci, utilizza UMPConsentInformation.sharedInstance.canRequestAds per verificare se hai ottenuto il consenso dell'utente:

ConsentInformation.shared.canRequestAds

UMPConsentInformation.sharedInstance.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 ha raccolto il consenso nella sessione corrente.
• Subito dopo aver chiamato requestConsentInfoUpdate(with:completionHandler:). L'SDK UMP potrebbe aver ottenuto il consenso nella sessione dell'app precedente.

Se si verifica un errore durante il processo di raccolta del consenso, controlla 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 UMPConsentInformation.sharedInstance.canRequestAds dopo aver raccolto il consenso e dopo aver chiamato requestConsentInfoUpdate(with:completionHandler:), 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(with:completionHandler:).

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:

   <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 UMPDebugSettings().testDeviceIdentifiers e trasmettere un elenco degli ID dispositivo di test.

   Swift

   let parameters = RequestParameters()
   let debugSettings = DebugSettings()
   
   debugSettings.testDeviceIdentifiers = ["TEST-DEVICE-HASHED-ID"]
   parameters.debugSettings = debugSettings
   
   // Include the UMPRequestParameters in your consent request.
   ConsentInformation.shared.requestConsentInfoUpdate(
       with: parameters,
       completionHandler: { error in
         // ...
       })
   

   Objective-C

   UMPRequestParameters *parameters = [[UMPRequestParameters alloc] init];
   UMPDebugSettings *debugSettings = [[UMPDebugSettings alloc] init];
   
   debugSettings.testDeviceIdentifiers = @[ @"TEST-DEVICE-HASHED-ID" ];
   parameters.debugSettings = debugSettings;
   
   // Include the UMPRequestParameters in your consent request.
   [UMPConsentInformation.sharedInstance
       requestConsentInfoUpdateWithParameters:parameters
                           completionHandler:^(NSError *_Nullable error){
                             // ...
   }];
   

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

let parameters = RequestParameters()
let debugSettings = DebugSettings()

debugSettings.testDeviceIdentifiers = ["TEST-DEVICE-HASHED-ID"]
debugSettings.geography = .EEA
parameters.debugSettings = debugSettings

// Include the UMPRequestParameters in your consent request.
ConsentInformation.shared.requestConsentInfoUpdate(
    with: parameters,
    completionHandler: { error in
      // ...
    })

UMPRequestParameters *parameters = [[UMPRequestParameters alloc] init];
UMPDebugSettings *debugSettings = [[UMPDebugSettings alloc] init];

debugSettings.testDeviceIdentifiers = @[ @"TEST-DEVICE-HASHED-ID" ];
debugSettings.geography = UMPDebugGeographyEEA;
parameters.debugSettings = debugSettings;

// Include the UMPRequestParameters in your consent request.
[UMPConsentInformation.sharedInstance
    requestConsentInfoUpdateWithParameters:parameters
                         completionHandler:^(NSError *_Nullable error){
                           // ...
}];

Reimpostare lo stato del consenso

Quando testi l'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.shared.reset()

[UMPConsentInformation.sharedInstance reset];

Esempi su GitHub

Consulta un esempio completo dell'integrazione dell'SDK UMP trattata in questa pagina in

• Swift BannerExample
• SwiftUIDemo
• Objective-C BannerExample