Los gehts

Plattform auswählen: Android iOS

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. Eine funktionierende IMA-Implementierung mit dem UMP SDK finden Sie in der UMP-Beispiel App.

Vorbereitung

• Android API‑Level 21 oder höher

Mitteilungstyp erstellen

Erstellen Sie Nutzermitteilungen mit einem der verfügbaren Mitteilungstypen auf dem Tab Datenschutz und Mitteilungen in Ihrem Ad Manager -Konto. Das UMP SDK versucht, eine Datenschutzmitteilung anzuzeigen, die aus der in Ihrem Projekt festgelegten Interactive Media Ads-App-ID erstellt wurde.

Weitere Informationen finden Sie unter Datenschutz und Mitteilungen.

Mit Gradle installieren

Gradle

dependencies {
  implementation("com.google.android.ump:user-messaging-platform:4.0.0")
}

Nachdem Sie die Änderungen an der Datei build.gradle Ihrer App vorgenommen haben, müssen Sie Ihr Projekt mit den Gradle-Dateien synchronisieren.

App-ID hinzufügen

Ihre App-ID finden Sie in der Ad Manager-Benutzeroberfläche. Fügen Sie die ID zu Ihrem AndroidManifest.xml mit dem folgenden Code-Snippet hinzu:

<manifest>
  <application>
    <meta-data
        android:name="com.google.android.gms.ads.APPLICATION_ID"
        android:value="ca-app-pub-xxxxxxxxxxxxxxxx~yyyyyyyyyy"/>
  </application>
</manifest>

Einwilligungsinformationen des Nutzers abrufen

So rufen Sie die Einwilligungsinformationen des Nutzers ab:

Deklarieren Sie eine Instanz von ConsentInformation:

Java

private final ConsentInformation consentInformation;

Kotlin

private lateinit val consentInformation: ConsentInformation

Initialisieren Sie die Instanz ConsentInformation:

Java

consentInformation = UserMessagingPlatform.getConsentInformation(context);

Kotlin

consentInformation = UserMessagingPlatform.getConsentInformation(context)

Sie sollten bei jedem Start der App eine Aktualisierung der Einwilligungsinformationen des Nutzers mit requestConsentInfoUpdate()anfordern. 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 Datenschutzmitteilungen müssen Apps Nutzern die Möglichkeit geben, ihre Datenschutzeinstellungen jederzeit zu ändern.

Java

// Requesting an update to consent information should be called on every app launch.
consentInformation.requestConsentInfoUpdate(
    activity,
    params,
    () -> // Called when consent information is successfully updated.
    requestConsentError -> // Called when there's an error updating consent information.
ConsentManager.java

Kotlin

// Requesting an update to consent information should be called on every app launch.
consentInformation.requestConsentInfoUpdate(
  activity,
  params,
  {
    // Called when consent information is successfully updated.
  },
  { requestConsentError ->
    // Called when there's an error updating consent information.
  },
)

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

Formular für Datenschutzmitteilung laden und präsentieren

Nachdem Sie den aktuellen Einwilligungsstatus erhalten haben, rufen Sie loadAndShowConsentFormIfRequired() 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 Datenschutzmitteilungen die Einholung der Nutzereinwilligung vor dem Anfordern von Anzeigen erforderlich ist, wird der Callback sofort aufgerufen.

Java

UserMessagingPlatform.loadAndShowConsentFormIfRequired(
    activity,
    formError -> {
      // Consent gathering process is complete.
    });
ConsentManager.java

Kotlin

UserMessagingPlatform.loadAndShowConsentFormIfRequired(activity) { formError ->
  // Consent has been gathered.
}

Datenschutzoptionen

Einige Formulare für Datenschutzmitteilungen 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 Mitteilungstypen.

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

Nachdem Sie requestConsentInfoUpdate() aufgerufen haben, prüfen Sie mit getPrivacyOptionsRequirementStatus(), ob für Ihre App ein Einstiegspunkt für Datenschutzoptionen erforderlich ist. Wenn ein Einstiegspunkt 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 interaktiv ist.

Java

/** Helper function to determine if a privacy options entry point is required. */
public boolean isPrivacyOptionsRequired() {
  return consentInformation.getPrivacyOptionsRequirementStatus()
      == PrivacyOptionsRequirementStatus.REQUIRED;
}
ConsentManager.java

Kotlin

/** Helper variable to determine if the privacy options form is required. */
val isPrivacyOptionsRequired: Boolean
  get() =
    consentInformation.privacyOptionsRequirementStatus ==
      ConsentInformation.PrivacyOptionsRequirementStatus.REQUIRED

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

Formular für Datenschutzoptionen präsentieren

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

Java

UserMessagingPlatform.showPrivacyOptionsForm(activity, onConsentFormDismissedListener);
ConsentManager.java

Kotlin

UserMessagingPlatform.showPrivacyOptionsForm(activity, onConsentFormDismissedListener)

Anzeigen mit Nutzereinwilligung anfordern

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

Java

consentInformation.canRequestAds();

Kotlin

consentInformation.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 die Einwilligung in der aktuellen Sitzung eingeholt hat.
• Unmittelbar nach dem Aufruf von requestConsentInfoUpdate(). Das UMP SDK hat möglicherweise in der vorherigen App-Sitzung die Einwilligung eingeholt.

Wichtig: canRequestAds() gibt immer false zurück, bis Sie requestConsentInfoUpdate()

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 canRequestAds() nach dem Einholen der Einwilligung und nach dem Aufruf von requestConsentInfoUpdate() prüfen, müssen Sie mit Ihrer Logik doppelte Anzeigenanfragen verhindern, die dazu führen könnten, dass beide Prüfungen true zurückgeben. Verwenden Sie dazu beispielsweise eine boolesche Variable.

Test

Wenn Sie die Integration während der Entwicklung in Ihrer App testen möchten, folgen Sie dieser Anleitung, 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: Ab Version 2.2.0 müssen Emulatoren nicht mehr der Liste der Geräte-IDs hinzugefügt werden, da sie standardmäßig als Testgeräte gelten.

1. Rufen Sie requestConsentInfoUpdate() 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:

   Use new ConsentDebugSettings.Builder().addTestDeviceHashedId("33BE2250B43518CCDA7DE426D04EE231") to set this as a debug device.
   

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

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

   Java

   ConsentDebugSettings debugSettings = new ConsentDebugSettings.Builder(this)
       .addTestDeviceHashedId("TEST-DEVICE-HASHED-ID")
       .build();
   
   ConsentRequestParameters params = new ConsentRequestParameters
       .Builder()
       .setConsentDebugSettings(debugSettings)
       .build();
   
   consentInformation = UserMessagingPlatform.getConsentInformation(this);
   // Include the ConsentRequestParameters in your consent request.
   consentInformation.requestConsentInfoUpdate(
       this,
       params,
       // ...
   );
   

   Kotlin

   val debugSettings = ConsentDebugSettings.Builder(this)
       .addTestDeviceHashedId("TEST-DEVICE-HASHED-ID")
       .build()
   
   val params = ConsentRequestParameters
       .Builder()
       .setConsentDebugSettings(debugSettings)
       .build()
   
   consentInformation = UserMessagingPlatform.getConsentInformation(this)
   // Include the ConsentRequestParameters in your consent request.
   consentInformation.requestConsentInfoUpdate(
       this,
       params,
       // ...
   )
   

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 (UK) und in der Schweiz, indem Sie DebugGeography verwenden. Debug-Einstellungen funktionieren nur auf Testgeräten.

Java

ConsentDebugSettings debugSettings = new ConsentDebugSettings.Builder(this)
    .setDebugGeography(ConsentDebugSettings.DebugGeography.DEBUG_GEOGRAPHY_EEA)
    .addTestDeviceHashedId("TEST-DEVICE-HASHED-ID")
    .build();

ConsentRequestParameters params = new ConsentRequestParameters
    .Builder()
    .setConsentDebugSettings(debugSettings)
    .build();

consentInformation = UserMessagingPlatform.getConsentInformation(this);
// Include the ConsentRequestParameters in your consent request.
consentInformation.requestConsentInfoUpdate(
    this,
    params,
    ...
);

Kotlin

val debugSettings = ConsentDebugSettings.Builder(this)
    .setDebugGeography(ConsentDebugSettings.DebugGeography.DEBUG_GEOGRAPHY_EEA)
    .addTestDeviceHashedId("TEST-DEVICE-HASHED-ID")
    .build()

val params = ConsentRequestParameters
    .Builder()
    .setConsentDebugSettings(debugSettings)
    .build()

consentInformation = UserMessagingPlatform.getConsentInformation(this)
// Include the ConsentRequestParameters in your consent request.
consentInformation.requestConsentInfoUpdate(
    this,
    params,
    ...
)

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

Java

consentInformation.reset();

Kotlin

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