Per iniziare

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

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 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.

Importa 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 questo comando:

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.

  1. In Xcode, installa il pacchetto Swift dell'SDK UMP andando a 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, consigliamo di utilizzare l'opzione Fino alla versione principale successiva.

Xcode risolve le dipendenze dei pacchetti e le scarica in background. Per maggiori dettagli su come aggiungere dipendenze dei pacchetti, 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 Copia elementi se necessario.

Puoi quindi includere il framework in qualsiasi file ti serve utilizzando:

Swift

import UserMessagingPlatform

Objective-C

#include <UserMessagingPlatform/UserMessagingPlatform.h>

Aggiungi l'ID applicazione

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

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

Per raccogliere il consenso, completa i seguenti passaggi:

  1. Richiedi le informazioni più recenti sul consenso degli utenti.
  2. Carica e presenta un modulo di consenso, se necessario.

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 il consenso è obbligatorio. Ad esempio, il consenso è richiesto la prima volta o la decisione precedente sul consenso è 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.

Carica e presenta un modulo per il messaggio sulla privacy, se necessario

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

Il seguente codice mostra come richiedere le informazioni più recenti sul consenso dell'utente. Se necessario, il codice viene caricato e presenta un modulo di messaggio sulla privacy:

Swift


// Requesting an update to consent information should be called on every app launch.
UMPConsentInformation.sharedInstance.requestConsentInfoUpdate(with: parameters) {
  requestConsentError in
  guard requestConsentError == nil else {
    return consentGatheringComplete(requestConsentError)
  }

  Task { @MainActor in
    do {
      try await UMPConsentForm.loadAndPresentIfRequired(from: viewController)
      // Consent has been gathered.
      consentGatheringComplete(nil)
    } catch {
      consentGatheringComplete(error)
    }
  }
}

Objective-C


// Requesting an update to consent information should be called on every app launch.
[UMPConsentInformation.sharedInstance
    requestConsentInfoUpdateWithParameters:parameters
                         completionHandler:^(NSError *_Nullable requestConsentError) {
                           if (requestConsentError) {
                             consentGatheringComplete(requestConsentError);
                           } else {
                             [UMPConsentForm
                                 loadAndPresentIfRequiredFromViewController:viewController
                                                          completionHandler:^(
                                                              NSError
                                                                  *_Nullable loadAndPresentError) {
                                                            // Consent has been gathered.
                                                            consentGatheringComplete(
                                                                loadAndPresentError);
                                                          }];
                           }
                         }];

Opzioni per la privacy

Alcuni moduli di messaggi sulla privacy vengono presentati da un punto di accesso alle opzioni di privacy visualizzate dall'editore, 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 immissione delle opzioni sulla privacy, consulta Tipi di messaggi per gli utenti disponibili.

Verificare se è richiesto un punto di accesso alle opzioni sulla privacy

Dopo aver chiamato requestConsentInfoUpdate(with:completionHandler:), controlla UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus per determinare se è necessario un punto di accesso per le opzioni di privacy per la tua app:

Swift


var isPrivacyOptionsRequired: Bool {
  return UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus == .required
}

Objective-C


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

Aggiungere un elemento visibile all'app

Se è necessario un punto di ingresso per la privacy, aggiungi alla tua app un elemento di interfaccia utente visibile e interattivo, che presenti il modulo per le opzioni di privacy. Se non è richiesto un punto di ingresso per la privacy, configura l'elemento UI in modo che non sia visibile e non possa essere interagito.

Swift


self.privacySettingsButton.isEnabled =
  GoogleMobileAdsConsentManager.shared.isPrivacyOptionsRequired

Objective-C


strongSelf.privacySettingsButton.enabled =
    GoogleMobileAdsConsentManager.sharedInstance
        .isPrivacyOptionsRequired;

Presentare il modulo per le opzioni di privacy

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

Swift


try await UMPConsentForm.presentPrivacyOptionsForm(from: viewController)

Objective-C


[UMPConsentForm presentPrivacyOptionsFormFromViewController:viewController
                                          completionHandler:completionHandler];

Richiedi annunci

Prima di richiedere gli annunci nella tua app, controlla se hai ottenuto il consenso dell'utente utilizzando UMPConsentInformation.sharedInstance.canRequestAds. Ci sono due punti da controllare durante la raccolta del consenso:

  • Dopo aver raccolto il consenso nella sessione corrente.
  • Subito dopo che avrai chiamato requestConsentInfoUpdate(with:completionHandler:). È possibile che il consenso sia stato ottenuto nella sessione precedente. Come best practice sulla latenza, ti consigliamo di non attendere il completamento del callback per poter iniziare a caricare gli annunci il prima possibile dopo il lancio dell'app.

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

Il seguente codice controlla se puoi richiedere annunci durante la procedura di raccolta del consenso:

Swift


GoogleMobileAdsConsentManager.shared.gatherConsent(from: self) { [weak self] consentError in
  guard let self else { return }

  if let consentError {
    // Consent gathering failed.
    print("Error: \(consentError.localizedDescription)")
  }

  if GoogleMobileAdsConsentManager.shared.canRequestAds {
    self.startGoogleMobileAdsSDK()
  }
  // ...
}

// This sample attempts to load ads using consent obtained in the previous session.
if GoogleMobileAdsConsentManager.shared.canRequestAds {
  startGoogleMobileAdsSDK()
}

Objective-C


[GoogleMobileAdsConsentManager.sharedInstance
    gatherConsentFromConsentPresentationViewController:self
                              consentGatheringComplete:^(NSError *_Nullable consentError) {
                                if (consentError) {
                                  // Consent gathering failed.
                                  NSLog(@"Error: %@", consentError.localizedDescription);
                                }

                                __strong __typeof__(self) strongSelf = weakSelf;
                                if (!strongSelf) {
                                  return;
                                }

                                if (GoogleMobileAdsConsentManager.sharedInstance.canRequestAds) {
                                  [strongSelf startGoogleMobileAdsSDK];
                                }
                                // ...
                              }];

// This sample attempts to load ads using consent obtained in the previous session.
if (GoogleMobileAdsConsentManager.sharedInstance.canRequestAds) {
  [self startGoogleMobileAdsSDK];
}

Il seguente codice configura l'SDK Google Mobile Ads dopo la raccolta del consenso dell'utente:

Swift


private func startGoogleMobileAdsSDK() {
  DispatchQueue.main.async {
    guard !self.isMobileAdsStartCalled else { return }

    self.isMobileAdsStartCalled = true

    // Initialize the Google Mobile Ads SDK.
    GADMobileAds.sharedInstance().start()

    if self.isViewDidAppearCalled {
      self.loadBannerAd()
    }
  }
}

Objective-C


- (void)startGoogleMobileAdsSDK {
  static dispatch_once_t onceToken;
  dispatch_once(&onceToken, ^{
    // Initialize the Google Mobile Ads SDK.
    [GADMobileAds.sharedInstance startWithCompletionHandler:nil];
    [self loadBannerAd];
  });
}

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.

  1. Chiama il numero requestConsentInfoUpdate(with:completionHandler:).
  2. 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]
    
  3. Copia l'ID del dispositivo di test negli appunti.

  4. Modifica il codice per chiamare UMPDebugSettings().testDeviceIdentifiers e passare in un elenco di ID dispositivo 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 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 SEE o Regno Unito, utilizzando geography. 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){
                           // ...
}];

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

Swift

UMPConsentInformation.sharedInstance.reset()

Objective-C

[UMPConsentInformation.sharedInstance reset];

Esempi su GitHub

Per un esempio completo dell'integrazione dell'SDK UMP trattata in questa pagina, consulta gli articoli Swift BannerExample e Objective-C BannerExample.