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. Puoi vedere un'implementazione IMA funzionante con l'SDK UMP nelle app di esempio UMP in Objective-C o Swift.
Creare 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 Ad Manager. L'SDK UMP tenta di mostrare un messaggio sulla privacy creato dall'ID applicazione Interactive Media Ads impostato nel progetto.
Per ulteriori dettagli, consulta Informazioni su privacy e messaggi.
Importa l'SDK
L'SDK UMP non è incluso come dipendenza dell'SDK IMA, quindi devi aggiungerlo esplicitamente.
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 mai utilizzato CocoaPods, consulta Utilizzare CocoaPods per informazioni dettagliate su come creare e utilizzare i file Pod.
Swift Package Manager
L'SDK UMP supporta anche Swift Package Manager. Segui questi passaggi per importare il pacchetto Swift.
In Xcode, installa il pacchetto Swift dell'SDK UMP andando a File > Aggiungi pacchetti.
Nel prompt visualizzato, cerca il repository GitHub del pacchetto Swift dell'SDK UMP:
https://github.com/googleads/swift-package-manager-google-user-messaging-platform.gitSeleziona la versione del pacchetto Swift dell'SDK UMP che vuoi utilizzare. Per i nuovi progetti, consigliamo di utilizzare l'opzione Fino alla versione principale successiva.
Xcode risolve quindi le dipendenze del pacchetto e le scarica in background. Per maggiori dettagli su come aggiungere le dipendenze del pacchetto, consulta l'articolo di Apple.
Aggiungi l'ID applicazione
Puoi trovare il tuo ID applicazione nell'interfaccia utente di Ad Manager.
Aggiungi l'ID a
Info.plist
con lo snippet di codice seguente:
<key>UMPApplicationIdentifier</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
requestConsentInfoUpdateWithParameters:completionHandler:. Questa richiesta verifica quanto segue:
- Se il consenso è obbligatorio. Ad esempio, il consenso è richiesto per la prima volta o la decisione di consenso precedente è scaduta.
- Se è richiesto un punto di accesso alle opzioni sulla privacy. Alcuni messaggi sulla privacy richiedono alle app di consentire agli utenti di modificare le proprie opzioni sulla privacy in qualsiasi momento.
Swift
// Requesting an update to consent information should be called on every app launch.
UMPConsentInformation.sharedInstance.requestConsentInfoUpdate(with: parameters) {
requestConsentError in
// ...
}
Objective-C
// Requesting an update to consent information should be called on every app launch.
[UMPConsentInformation.sharedInstance
requestConsentInfoUpdateWithParameters:parameters
completionHandler:^(NSError *_Nullable requestConsentError) {
// ...
}];
Carica e presenta il modulo del messaggio sulla privacy
Dopo aver ricevuto lo stato del consenso più aggiornato, chiama
loadAndPresentIfRequiredFromViewController:completionHandler: per caricare i moduli richiesti per raccogliere il consenso degli utenti. Dopo il caricamento, i moduli vengono visualizzati immediatamente.
Swift
try await UMPConsentForm.loadAndPresentIfRequired(from: viewController)
Objective-C
[UMPConsentForm
loadAndPresentIfRequiredFromViewController:viewController
completionHandler:^(NSError *_Nullable loadAndPresentError) {
// Consent gathering process is complete.
}];
Opzioni per la privacy
Alcuni moduli di messaggi sulla privacy vengono presentati da un punto di contatto per le opzioni di privacy visualizzato dal publisher, che consente agli utenti di gestire le proprie opzioni di privacy in qualsiasi momento. Per scoprire di più sul messaggio visualizzato dagli utenti nel punto di accesso alle opzioni della privacy, consulta Tipi di messaggi per gli utenti disponibili.
Verificare se è richiesto un punto di accesso alle opzioni sulla privacy
Dopo aver chiamato
requestConsentInfoUpdateWithParameters:completionHandler:, controlla
UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus per determinare se è necessario un punto di accesso alle opzioni sulla privacy per la tua app. Se è necessario un punto di accesso, aggiungi alla tua app un elemento dell'interfaccia utente visibile e interattivo che presenti il modulo delle opzioni sulla privacy. Se non è richiesto un punto di contatto per la privacy, configura l'elemento dell'interfaccia utente in modo che non sia visibile e interattivo.
Swift
var isPrivacyOptionsRequired: Bool {
return UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus == .required
}
Objective-C
- (BOOL)areGDPRConsentMessagesRequired {
return UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus ==
UMPPrivacyOptionsRequirementStatusRequired;
}
- (void)gatherConsentFromConsentPresentationViewController:(UIViewController *)viewController
consentGatheringComplete:
(void (^)(NSError *_Nullable))consentGatheringComplete {
UMPRequestParameters *parameters = [[UMPRequestParameters alloc] init];
// Set tag for under age of consent. Use NO constant to indicate that the user is not under age.
parameters.tagForUnderAgeOfConsent = NO;
UMPDebugSettings *debugSettings = [[UMPDebugSettings alloc] init];
// Uncomment the following line to simulate a consent request from users in the
// European Economic Area (EEA) for testing purposes.
// debugSettings.geography = UMPDebugGeographyEEA;
parameters.debugSettings = debugSettings;
// Requesting an update to consent information should be called on every app launch.
[UMPConsentInformation.sharedInstance
requestConsentInfoUpdateWithParameters:parameters
completionHandler:^(NSError *_Nullable requestConsentError) {
// ...
}];
}
- (void)loadAndPresentIfRequiredFromViewController:(UIViewController *)viewController
completionHandler:(void (^)(NSError *_Nullable))completionHandler {
[UMPConsentForm
loadAndPresentIfRequiredFromViewController:viewController
completionHandler:^(NSError *_Nullable loadAndPresentError) {
// Consent gathering process is complete.
}];
}
- (void)presentPrivacyOptionsFormFromViewController:(UIViewController *)viewController
completionHandler:
(void (^)(NSError *_Nullable))completionHandler {
[UMPConsentForm presentPrivacyOptionsFormFromViewController:viewController
completionHandler:completionHandler];
}
@end
Per l'elenco completo degli stati dei requisiti delle opzioni sulla privacy, consulta
UMPPrivacyOptionsRequirementStatus.
Presentare il modulo relativo alle opzioni per la privacy
Quando l'utente interagisce con il tuo elemento, presenta il modulo delle opzioni della privacy:
Swift
UMPConsentForm.presentPrivacyOptionsForm(
from: viewController, completionHandler: completionHandler)
Objective-C
[UMPConsentForm presentPrivacyOptionsFormFromViewController:viewController
completionHandler:completionHandler];
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:
Swift
UMPConsentInformation.sharedInstance.canRequestAds
Objective-C
UMPConsentInformation.sharedInstance.canRequestAds;
Di seguito sono elencati i luoghi in cui puoi 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
requestConsentInfoUpdateWithParameters:completionHandler:. 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, controlla se puoi richiedere gli annunci. L'SDK UMP utilizza lo stato del consenso della sessione dell'app precedente.
Evitare attività di richiesta di annunci ridondanti
Quando controlli
UMPConsentInformation.sharedInstance.canRequestAds dopo aver raccolto il consenso e dopo aver chiamato
requestConsentInfoUpdateWithParameters:completionHandler:, assicurati che la tua logica impedisca richieste di annunci ridondanti che
potrebbero comportare il ritorno di true in 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 il dispositivo di test in modo programmatico. Assicurati di rimuovere il codice che imposta questi ID dispositivo di test prima di rilasciare l'app.
- Chiama il numero
requestConsentInfoUpdateWithParameters:completionHandler:. Controlla l'output del log per verificare la presenza di 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]Copia l'ID del dispositivo di test negli appunti.
Modifica il codice in modo da chiamare
UMPDebugSettings().testDeviceIdentifierse passare un elenco di ID dei dispositivi di test.Swift
let parameters = UMPRequestParameters() let debugSettings = UMPDebugSettings() debugSettings.testDeviceIdentifiers = ["TEST-DEVICE-HASHED-ID"] parameters.debugSettings = debugSettings // Include the UMPRequestParameters in your consent request. UMPConsentInformation.sharedInstance.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à
L'SDK UMP fornisce un modo per testare il comportamento della tua app come se il dispositivo si trovasse in varie regioni, ad esempio nel SEE o nel Regno Unito, utilizzando UMPDebugGeography. Tieni presente che le impostazioni di debug funzionano solo sui dispositivi di test.
Swift
let parameters = UMPRequestParameters()
let debugSettings = UMPDebugSettings()
debugSettings.testDeviceIdentifiers = ["TEST-DEVICE-HASHED-ID"]
debugSettings.geography = .EEA
parameters.debugSettings = debugSettings
// Include the UMPRequestParameters in your consent request.
UMPConsentInformation.sharedInstance.requestConsentInfoUpdate(
with: parameters,
completionHandler: { error in
// ...
})
Objective-C
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 la tua app con l'SDK UMP, potresti trovare utile reimpostare lo stato dell'SDK in modo da poter simulare la prima esperienza di installazione di un utente.
L'SDK fornisce il metodo reset per farlo.
Swift
UMPConsentInformation.sharedInstance.reset()
Objective-C
[UMPConsentInformation.sharedInstance reset];
Esempi su GitHub
Consulta un esempio completo dell'integrazione dell'SDK UMP descritto in questa pagina in Swift UmpExample e Objective-C UmpExample.