UMP SDK einrichten

Plattform auswählen: Android (Beta) Android iOS Unity Flutter

Wichtiger Hinweis: Das Consent SDK wurde eingestellt. Es wird durch das User Messaging Platform (UMP) SDK ersetzt.

Das Google User Messaging Platform (UMP) SDK ist ein Tool für Datenschutz und Mitteilungen, mit dem Sie Datenschutzeinstellungen verwalten können. Weitere Informationen finden Sie unter Datenschutz und Mitteilungen.

Mitteilungstyp erstellen

Erstellen Sie Nutzermitteilungen mit einem der verfügbaren Nutzermitteilungstypen auf dem Tab Datenschutz und Mitteilungen in Ihrem AdMob -Konto. Das UMP SDK versucht, eine Datenschutzerklärung anzuzeigen, die aus der in Ihrem Projekt festgelegten AdMob-App-ID erstellt wurde.

Weitere Informationen finden Sie unter Datenschutz und Mitteilungen.

SDK importieren

CocoaPods (empfohlen)

Das SDK lässt sich am einfachsten mit CocoaPods in ein iOS-Projekt importieren. Öffnen Sie die Podfile-Datei Ihres Projekts und fügen Sie die folgende Zeile dem Ziel Ihrer App hinzu:

pod 'GoogleUserMessagingPlatform'

Führen Sie dann den folgenden Befehl aus:

pod install --repo-update

Wenn Sie CocoaPods noch nicht kennen, finden Sie unter CocoaPods verwenden weitere Informationen zum Erstellen und Verwenden von Podfiles.

Swift Package Manager

Das UMP SDK unterstützt auch den Swift Package Manager. Führen Sie die folgenden Schritte aus, um das Swift-Paket zu importieren.

1. Installieren Sie in Xcode das UMP SDK Swift Package, indem Sie zu File > Add Packages... (Datei > Pakete hinzufügen...) gehen.

2. Suchen Sie in der Eingabeaufforderung nach dem GitHub-Repository des UMP SDK Swift Package:

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

3. Wählen Sie die Version des UMP SDK Swift Package aus, die Sie verwenden möchten. Für neue Projekte empfehlen wir die Option Up to Next Major Version (Bis zur nächsten Hauptversion).

Xcode löst dann die Paketabhängigkeiten auf und lädt sie im Hintergrund herunter. Weitere Informationen zum Hinzufügen von Paketabhängigkeiten finden Sie im Artikel von Apple.

Manueller Download

Das SDK kann auch manuell importiert werden.

SDK herunterladen

Ziehen Sie das Framework dann in Ihr Xcode-Projekt und wählen Sie Copy items if needed (Elemente bei Bedarf kopieren) aus.

Anschließend können Sie das Framework mit dem folgenden Code in jede gewünschte Datei einfügen:

Swift

import UserMessagingPlatform

Objective-C

#include <UserMessagingPlatform/UserMessagingPlatform.h>

App-ID hinzufügen

Ihre App-ID finden Sie in der AdMob-Benutzeroberfläche. Fügen Sie die ID zu Ihrer Info.plist mit dem folgenden Code-Snippet hinzu:

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

Einwilligungsinformationen des Nutzers abrufen

Sie sollten bei jedem Start der App eine Aktualisierung der Einwilligungsinformationen des Nutzers anfordern. Verwenden Sie dazu requestConsentInfoUpdate(with:completionHandler:). Bei dieser Anfrage wird Folgendes geprüft:

• Ist eine Einwilligung erforderlich? Eine Einwilligung ist beispielsweise erforderlich, wenn der Nutzer die App zum ersten Mal verwendet oder die vorherige Einwilligung abgelaufen ist.
• Ist ein Einstiegspunkt für Datenschutzoptionen erforderlich? Bei einigen Datenschutzerklärungen müssen Apps Nutzern die Möglichkeit bieten, ihre Datenschutzeinstellungen jederzeit zu ändern.

Swift

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

SwiftUI

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

Objective-C

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

Warnung: Wenn Sie den Einwilligungsstatus auf andere Weise prüfen, z. B. über den Cache Ihrer App oder einen zuvor gespeicherten Einwilligungsstring, kann dies zu einem TCF 3.3-Fehler führen, wenn die Einwilligung abgelaufen ist.

Formular für Datenschutzerklärung laden und präsentieren

Nachdem Sie den aktuellen Einwilligungsstatus erhalten haben, rufen Sie loadAndPresentIfRequired(from:) auf, um alle Formulare zu laden, die zum Einholen der Nutzereinwilligung erforderlich sind. Nach dem Laden werden die Formulare sofort präsentiert.

Wichtiger Hinweis:Wenn für keine Formulare für Datenschutzerklärungen die Nutzereinwilligung eingeholt werden muss, bevor Anzeigen angefordert werden, wird der Callback sofort aufgerufen.

Swift

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

SwiftUI

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

Objective-C

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

Datenschutzoptionen

Einige Formulare für Datenschutzerklärungen werden über einen vom Publisher gerenderten Einstiegspunkt für Datenschutzoptionen präsentiert, sodass Nutzer ihre Datenschutzeinstellungen jederzeit verwalten können. Weitere Informationen dazu, welche Mitteilung Ihre Nutzer am Einstiegspunkt für Datenschutzoptionen sehen, finden Sie unter Verfügbare Nutzermitteilungstypen.

Prüfen, ob ein Einstiegspunkt für Datenschutzoptionen erforderlich ist

Nachdem Sie requestConsentInfoUpdate(with:completionHandler:) aufgerufen haben, prüfen Sie UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus, um festzustellen, ob für Ihre App ein Einstiegspunkt für Datenschutzoptionen erforderlich ist. Wenn ein Einstieg punkt erforderlich ist, fügen Sie Ihrer App ein sichtbares und interaktives UI-Element hinzu, über das das Formular für Datenschutzoptionen präsentiert wird. Wenn kein Einstiegspunkt für Datenschutzoptionen erforderlich ist, konfigurieren Sie das UI-Element so, dass es nicht sichtbar und nicht interaktiv ist.

Swift

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

Objective-C

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

Die vollständige Liste der Status für die Anforderungen an Datenschutzoptionen finden Sie unter UMPPrivacyOptionsRequirementStatus.

Formular für Datenschutzoptionen präsentieren

Wenn der Nutzer mit Ihrem Element interagiert, präsentieren Sie das Formular für Datenschutzoptionen:

Swift

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

SwiftUI

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

Objective-C

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

Anzeigen mit Nutzereinwilligung anfordern

Prüfen Sie vor dem Anfordern von Anzeigen mit UMPConsentInformation.sharedInstance.canRequestAds, ob Sie die Einwilligung des Nutzers eingeholt haben:

Swift

ConsentInformation.shared.canRequestAds

Objective-C

UMPConsentInformation.sharedInstance.canRequestAds;

An den folgenden Stellen können Sie prüfen, ob Sie Anzeigen anfordern können, während Sie die Einwilligung einholen:

• Nachdem das UMP SDK in der aktuellen Sitzung die Einwilligung eingeholt hat.
• Unmittelbar nachdem Sie requestConsentInfoUpdate(with:completionHandler:) aufgerufen haben. Das UMP SDK hat möglicherweise in der vorherigen App-Sitzung die Einwilligung eingeholt.

Wichtig: UMPConsentInformation.sharedInstance.canRequestAds gibt immer false zurück, bis Sie requestConsentInfoUpdate(with:completionHandler:)

aufgerufen haben.

Wenn beim Einholen der Einwilligung ein Fehler auftritt, prüfen Sie, ob Sie Anzeigen anfordern können. Das UMP SDK verwendet den Einwilligungsstatus aus der vorherigen App-Sitzung.

Doppelte Anzeigenanfragen vermeiden

Da Sie UMPConsentInformation.sharedInstance.canRequestAds nach dem Einholen der Einwilligung und nach dem Aufrufen von requestConsentInfoUpdate(with:completionHandler:) prüfen, müssen Sie mit Ihrer Logik doppelte Anzeigenanfragen vermeiden, die dazu führen könnten, dass beide Prüfungen true zurückgeben. Sie können beispielsweise eine boolesche Variable verwenden.

Test

Wenn Sie die Integration während der Entwicklung in Ihrer App testen möchten, führen Sie die folgenden Schritte aus, um Ihr Testgerät programmatisch zu registrieren. Entfernen Sie den Code, mit dem diese Testgeräte-IDs festgelegt werden, bevor Sie Ihre App veröffentlichen.

Hinweis: Simulatoren müssen nicht der Liste der Geräte-IDs hinzugefügt werden, da sie standardmäßig Test geräte sind.

1. Rufen Sie requestConsentInfoUpdate(with:completionHandler:) auf.

2. Suchen Sie in der Logausgabe nach einer Mitteilung, die dem folgenden Beispiel ähnelt. Dort sehen Sie Ihre Geräte-ID und wie Sie sie als Testgerät hinzufügen:

   <UMP SDK>To enable debug mode for this device, set: UMPDebugSettings.testDeviceIdentifiers = @[2077ef9a63d2b398840261c8221a0c9b]
   

3. Kopieren Sie die ID Ihres Testgeräts in die Zwischenablage.

4. Ändern Sie Ihren Code so, dass UMPDebugSettings().testDeviceIdentifiers aufgerufen wird, und übergeben Sie eine Liste Ihrer Testgeräte-IDs.

   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){
                             // ...
   }];
   

Region erzwingen

Mit dem UMP SDK können Sie testen, wie sich Ihre App verhält, wenn sich das Gerät in verschiedenen Regionen befindet, z. B. im Europäischen Wirtschaftsraum (EWR), im Vereinigten Königreich und in der Schweiz, indem Sie geography verwenden. Debug-Einstellungen funktionieren nur auf Testgeräten.

Swift

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

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){
                           // ...
}];

Einwilligungsstatus zurücksetzen

Wenn Sie Ihre App mit dem UMP SDK testen, kann es hilfreich sein, den Status des SDK zurückzusetzen, damit Sie die erste Installation durch einen Nutzer simulieren können. Das SDK bietet dafür die Methode reset.

Swift

ConsentInformation.shared.reset()

Objective-C

[UMPConsentInformation.sharedInstance reset];

Achtung: Diese Methode ist nur für Testzwecke vorgesehen. Sie sollten reset nicht im Produktionscode aufrufen.

Beispiele auf GitHub

Ein vollständiges Beispiel für die UMP SDK-Integration, die auf dieser Seite behandelt wird, finden Sie unter

• Swift BannerExample
• SwiftUIDemo
• Objective-C BannerExample