Das Google User Messaging Platform (UMP) SDK ist ein Datenschutz- und Benachrichtigungstool, um Ihre Datenschutzeinstellungen zu verwalten. Weitere Informationen finden Sie unter Über Datenschutz und Nachrichtenfunktion. Eine funktionierende IMA-Implementierung mit dem UMP SDK ist entweder Ziel-C oder Swift UMP-Beispiel-Apps.
Mitteilungstyp erstellen
Erstellen Sie Nutzermitteilungen mit einer der Verfügbare Mitteilungstypen für Nutzer Datenschutz- und Messaging auf Ihrem Ad Manager Konto. Das UMP SDK versucht, eine Datenschutzmitteilung erstellt aus der Interactive Media Ads Anwendungs-ID die in Ihrem Projekt festgelegt sind.
Weitere Informationen finden Sie unter Datenschutz und Mitteilungen
SDK importieren
Das UMP SDK ist nicht als Abhängigkeit des IMA SDK enthalten. Daher müssen Sie explizit selbst hinzufügen.
CocoaPods (bevorzugt)
Am einfachsten können Sie das SDK mit der CocoaPods Öffnen Sie das Podfile und fügen Sie diese Zeile dem Ziel Ihrer Anwendung hinzu:
pod 'GoogleUserMessagingPlatform'
Führen Sie dann den folgenden Befehl aus:
pod install --repo-update
Wenn Sie mit CocoaPods noch nicht vertraut sind, lesen Sie unter Verwendung von CocoaPods Podfiles erstellen und verwenden.
Swift-Paketmanager
Das UMP SDK unterstützt auch Swift Package Manager. Führen Sie die folgenden Schritte aus, um das Swift-Paket importieren.
Installieren Sie in Xcode das UMP SDK Swift Package, indem Sie Datei > Pakete hinzufügen...
Suchen Sie in der angezeigten Eingabeaufforderung nach dem UMP SDK Swift Package GitHub Repository:
https://github.com/googleads/swift-package-manager-google-user-messaging-platform.git
Wählen Sie die Version des UMP SDK Swift Package aus, die Sie verwenden möchten. Für neue Projekten arbeiten, empfehlen wir die Verwendung von Bis zur nächsten Hauptversion.
Xcode löst dann Ihre Paketabhängigkeiten auf und lädt sie im Hintergrund. Weitere Informationen zum Hinzufügen von Paketabhängigkeiten finden Sie in der Apple-Dokumentation
Anwendungs-ID hinzufügen
Ihre Anwendungs-ID finden Sie in der
Ad Manager-Benutzeroberfläche:
Fügen Sie die ID Ihrem
Info.plist
.
mit dem folgenden Code-Snippet:
<key>UMPApplicationIdentifier</key>
<string>ca-app-pub-xxxxxxxxxxxxxxxx~yyyyyyyyyy</string>
Anfrage zur Einwilligungserklärung
Sie sollten bei jeder App eine Aktualisierung der Einwilligungsinformationen des Nutzers anfordern
mit requestConsentInfoUpdateWithParameters:completionHandler:
starten. In dieser Anfrage wird geprüft,
Folgendes:
- Ob eine Einwilligung erforderlich ist: Beispielsweise ist eine Einwilligung für die oder die vorherige Einwilligungsentscheidung ist abgelaufen.
- Ob ein Einstiegspunkt für Datenschutzoptionen erforderlich ist Einige Datenschutzmitteilungen Sie können festlegen, dass Apps Nutzern die Möglichkeit geben, ihre Datenschutzeinstellungen jederzeit zu ändern.
Hier ist ein Beispiel dafür, wie du den Status einer UIViewController
im
viewDidLoad()
-Methode.
Swift
override func viewDidLoad() {
super.viewDidLoad()
// Request an update for the consent information.
UMPConsentInformation.sharedInstance.requestConsentInfoUpdate(with: nil) {
[weak self] requestConsentError in
guard let self else { return }
if let consentError = requestConsentError {
// Consent gathering failed.
return print("Error: \(consentError.localizedDescription)")
}
// TODO: Load and present the privacy message form.
}
}
Objective-C
- (void)viewDidLoad {
[super viewDidLoad];
// Request an update for the consent information.
[UMPConsentInformation.sharedInstance
requestConsentInfoUpdateWithParameters:nil
completionHandler:^(NSError *_Nullable requestConsentError) {
if (requestConsentError) {
// Consent gathering failed.
NSLog(@"Error: %@", requestConsentError.localizedDescription);
return;
}
// TODO: Load and present the privacy message form.
}];
}
Formular für Datenschutzmitteilungen laden und bei Bedarf präsentieren
Nachdem Sie den aktuellen Einwilligungsstatus erhalten haben, rufen Sie
loadAndPresentIfRequiredFromViewController:completionHandler:
um alle Formulare zu laden, die für
die Einholung der Nutzereinwilligung. Nach dem Laden sind die Formulare sofort zu sehen.
Swift
override func viewDidLoad() {
super.viewDidLoad()
// Request an update for the consent information.
UMPConsentInformation.sharedInstance.requestConsentInfoUpdate(with: nil) {
[weak self] requestConsentError in
guard let self else { return }
if let consentError = requestConsentError {
// Consent gathering failed.
return print("Error: \(consentError.localizedDescription)")
}
UMPConsentForm.loadAndPresentIfRequired(from: self) {
[weak self] loadAndPresentError in
guard let self else { return }
if let consentError = loadAndPresentError {
// Consent gathering failed.
return print("Error: \(consentError.localizedDescription)")
}
// Consent has been gathered.
}
}
}
Objective-C
- (void)viewDidLoad {
[super viewDidLoad];
__weak __typeof__(self) weakSelf = self;
// Request an update for the consent information.
[UMPConsentInformation.sharedInstance
requestConsentInfoUpdateWithParameters:nil
completionHandler:^(NSError *_Nullable requestConsentError) {
if (requestConsentError) {
// Consent gathering failed.
NSLog(@"Error: %@", requestConsentError.localizedDescription);
return;
}
__strong __typeof__(self) strongSelf = weakSelf;
if (!strongSelf) {
return;
}
[UMPConsentForm loadAndPresentIfRequiredFromViewController:strongSelf
completionHandler:^(NSError *loadAndPresentError) {
if (loadAndPresentError) {
// Consent gathering failed.
NSLog(@"Error: %@", loadAndPresentError.localizedDescription);
return;
}
// Consent has been gathered.
}];
}];
}
Wenn du weitere Aktionen ausführen musst, nachdem der Nutzer eine Auswahl getroffen oder die Anzeige geschlossen hat platziere diese Logik in der completion handler für Ihr Formular.
Datenschutzoptionen
Einige Formulare für Datenschutzmitteilungen werden von einem vom Publisher gerenderten Datenschutz Optionen, mit denen Nutzer ihre Datenschutzeinstellungen jederzeit verwalten können. Weitere Informationen dazu, welche Mitteilung Ihre Nutzer in den Datenschutzoptionen sehen Einstiegspunkt erhalten, siehe Verfügbare Mitteilungstypen für Nutzer.
So implementieren Sie einen Einstiegspunkt für Datenschutzoptionen:
- Prüfen Sie
UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus
. - Wenn ein Einstiegspunkt für Datenschutzoptionen müssen Sie Ihrer App ein sichtbares und interaktives UI-Element hinzufügen.
- Lösen Sie das Formular für Datenschutzoptionen aus mit
presentPrivacyOptionsFormFromViewController:completionHandler:
Im folgenden Codebeispiel werden diese Schritte veranschaulicht:
Swift
@IBOutlet weak var privacySettingsButton: UIBarButtonItem!
var isPrivacyOptionsRequired: Bool {
return UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus == .required
}
override func viewDidLoad() {
// ...
// Request an update for the consent information.
UMPConsentInformation.sharedInstance.requestConsentInfoUpdate(with: parameters) {
// ...
UMPConsentForm.loadAndPresentIfRequired(from: self) {
//...
// Consent has been gathered.
// Show the button if privacy options are required.
self.privacySettingsButton.isEnabled = isPrivacyOptionsRequired
}
}
// ...
}
// Present the privacy options form when a user interacts with the
// privacy settings button.
@IBAction func privacySettingsTapped(_ sender: UIBarButtonItem) {
UMPConsentForm.presentPrivacyOptionsForm(from: self) {
[weak self] formError in
guard let self, let formError else { return }
// Handle the error.
}
}
Objective-C
@interface ViewController ()
@property(weak, nonatomic) IBOutlet UIBarButtonItem *privacySettingsButton;
@end
- (BOOL)isPrivacyOptionsRequired {
return UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus ==
UMPPrivacyOptionsRequirementStatusRequired;
}
- (void)viewDidLoad {
// ...
__weak __typeof__(self) weakSelf = self;
// Request an update for the consent information.
[UMPConsentInformation.sharedInstance
requestConsentInfoUpdateWithParameters:parameters
completionHandler:^(NSError *_Nullable requestConsentError) {
// ...
[UMPConsentForm loadAndPresentIfRequiredFromViewController:strongSelf
completionHandler:^(NSError *loadAndPresentError) {
// ...
// Consent has been gathered.
// Show the button if privacy options are required.
strongSelf.privacySettingsButton.enabled = isPrivacyOptionsRequired;
}];
}];
}
// Present the privacy options form when a user interacts with your
// privacy settings button.
- (IBAction)privacySettingsTapped:(UIBarButtonItem *)sender {
[UMPConsentForm presentPrivacyOptionsFormFromViewController:self
completionHandler:^(NSError *_Nullable formError) {
if (formError) {
// Handle the error.
}
}];
}
Anzeigenanfrage senden
Bevor Sie Anzeigen in Ihrer App anfordern, prüfen Sie, ob Sie die Einwilligung eingeholt haben
vom Nutzer mit UMPConsentInformation.sharedInstance.canRequestAds
. Es gibt zwei
Stellen, die beim Einholen der Einwilligung geprüft werden sollten:
- Nachdem in der aktuellen Sitzung die Einwilligung eingeholt wurde.
- Unmittelbar nach Ihrem Anruf bei
requestConsentInfoUpdateWithParameters:completionHandler:
Möglicherweise wurde die Einwilligung bereits in der vorherigen Sitzung erteilt. Als Latenz solltet ihr nicht auf den Abschluss des Callbacks warten, Anzeigen so bald wie möglich nach der Einführung Ihrer App zu laden.
Wenn beim Einholen der Einwilligung ein Fehler auftritt, sollten Sie trotzdem Anzeigen anzufordern. Für das UMP SDK wird der Einwilligungsstatus aus dem vorherigen Sitzung.
Swift
class ViewController: UIViewController {
override func viewDidLoad() {
super.viewDidLoad()
// Request an update for the consent information.
UMPConsentInformation.sharedInstance.requestConsentInfoUpdate(with: nil) {
[weak self] requestConsentError in
guard let self else { return }
if let consentError = requestConsentError {
// Consent gathering failed.
return print("Error: \(consentError.localizedDescription)")
}
UMPConsentForm.loadAndPresentIfRequired(from: self) {
[weak self] loadAndPresentError in
guard let self else { return }
if let consentError = loadAndPresentError {
// Consent gathering failed.
return print("Error: \(consentError.localizedDescription)")
}
// Consent has been gathered.
if UMPConsentInformation.sharedInstance.canRequestAds {
self.startImaSdk()
}
}
}
// Check if you can initialize the IMA SDK in parallel
// while checking for new consent information. Consent obtained in
// the previous session can be used to request ads.
if UMPConsentInformation.sharedInstance.canRequestAds {
startImaSdk()
}
}
private func startImaSdk() {
// Create an IMAAdsLoader instance.
adsLoader = IMAAdsLoader(settings: nil)
// TODO: Create an IMAAdDisplayContainer and IMAAdsRequest, then make
// a request for ads.
}
}
Objective-C
@implementation ViewController
- (void)viewDidLoad {
[super viewDidLoad];
__weak __typeof__(self) weakSelf = self;
// Request an update for the consent information.
[UMPConsentInformation.sharedInstance
requestConsentInfoUpdateWithParameters:nil
completionHandler:^(NSError *_Nullable requestConsentError) {
if (requestConsentError) {
// Consent gathering failed.
NSLog(@"Error: %@", requestConsentError.localizedDescription);
return;
}
__strong __typeof__(self) strongSelf = weakSelf;
if (!strongSelf) {
return;
}
[UMPConsentForm loadAndPresentIfRequiredFromViewController:strongSelf
completionHandler:^(NSError *loadAndPresentError) {
if (loadAndPresentError) {
// Consent gathering failed.
NSLog(@"Error: %@", loadAndPresentError.localizedDescription);
return;
}
// Consent has been gathered.
__strong __typeof__(self) strongSelf = weakSelf;
if (!strongSelf) {
return;
}
if (UMPConsentInformation.sharedInstance.canRequestAds) {
[strongSelf startImaSdk];
}
}];
}];
// Check if you can initialize the Google IMA SDK in parallel
// while checking for new consent information. Consent obtained in
// the previous session can be used to request ads.
if (UMPConsentInformation.sharedInstance.canRequestAds) {
[self startImaSdk];
}
}
- (void)startImaSdk {
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
// Create an IMAAdsLoader instance.
self.adsLoader = [[IMAAdsLoader alloc] init];
// TODO: Create an IMAAdDisplayContainer and IMAAdsRequest, then make
// a request for ads.
});
}
Test
Wenn Sie die Integration in Ihre App während der Entwicklung testen möchten, folgen Sie mit diesen Schritten können Sie Ihr Testgerät programmatisch registrieren. Achten Sie darauf, die Code, mit dem diese Testgeräte-IDs festgelegt werden, bevor Sie Ihre App veröffentlichen.
- Rufen Sie uns unter
requestConsentInfoUpdateWithParameters:completionHandler:
an. Suchen Sie in der Logausgabe nach einer Nachricht ähnlich dem folgenden Beispiel. 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]
Kopieren Sie die Testgeräte-ID in die Zwischenablage.
Ändern Sie Ihren Code, Anrufen
UMPDebugSettings().testDeviceIdentifiers
und übergeben Sie eine Liste Ihrer Testgeräte-IDs.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){ ... }];
Geografie erzwingen
Mit dem UMP SDK können Sie das Verhalten Ihrer App so testen, als wäre das Gerät
sich im EWR oder Vereinigten Königreich befinden, unter Verwendung von the debugGeography
property of type UMPDebugGeography
on UMPDebugSettings
. Beachten Sie, dass
Debug-Einstellungen funktionieren nur auf Testgeräten.
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){
...
}];
Einwilligungsstatus zurücksetzen
Wenn Sie Ihre App mit dem UMP SDK testen, kann es hilfreich sein, das
Status des SDK, um die erste Installation durch einen Nutzer zu simulieren.
Das SDK bietet dazu die Methode reset
.
Swift
UMPConsentInformation.sharedInstance.reset()
Objective-C
[UMPConsentInformation.sharedInstance reset];