Erste Schritte mit Firebase Cloud Messaging in Android-Apps

Plattform auswählen: iOS+ Android Web Flutter Unity C++


In diesem Leitfaden wird beschrieben, wie Sie Firebase Cloud Messaging in Ihren Android-Client-Apps einrichten, damit Sie Nachrichten zuverlässig senden können.

Für FCM-Clients sind Geräte mit Android 6.0 oder höher erforderlich, auf denen auch die Google Play Store App installiert ist, oder ein Emulator mit Android 6.0 mit Google APIs. Sie können Ihre Android-Apps auch über andere Stores als den Google Play Store bereitstellen.

SDK einrichten

Falls noch nicht geschehen, fügen Sie Ihrem Android-Projekt Firebase hinzu.

Für eine optimale Nutzung von FCM empfehlen wir dringend, Google Analytics in Ihrem Projekt zu aktivieren. Google Analytics ist eine Voraussetzung für Berichte zur Nachrichtenzustellung für FCM.

App-Manifest bearbeiten

Fügen Sie dem Manifest Ihrer App Folgendes hinzu:

  • Ein Dienst, der FirebaseMessagingService erweitert. Dies ist erforderlich, wenn Sie Nachrichten über das Empfangen von Benachrichtigungen in Apps im Hintergrund hinaus verarbeiten möchten. Wenn Sie Benachrichtigungen in Apps im Vordergrund und Daten-Payloads erhalten möchten, müssen Sie diesen Dienst erweitern.
    • <service
    android:name=".java.MyFirebaseMessagingService"
    android:exported="false">
    <intent-filter>
        <action android:name="com.google.firebase.MESSAGING_EVENT" />
    </intent-filter>
</service>
  • (Optional) Metadatenelemente innerhalb der Anwendungskomponente, mit denen ein Standardbenachrichtigungssymbol und eine Standardbenachrichtigungsfarbe festgelegt werden können. Android verwendet diese Werte, wenn für eingehende Nachrichten nicht explizit ein Symbol oder eine Farbe festgelegt ist.
    • <!-- Set custom default icon. This is used when no icon is set for incoming notification messages.
     See README(https://goo.gl/l4GJaQ) for more. -->
<meta-data
    android:name="com.google.firebase.messaging.default_notification_icon"
    android:resource="@drawable/ic_stat_ic_notification" />
<!-- Set color used with incoming notification messages. This is used when no color is set for the incoming
     notification message. See README(https://goo.gl/6BKBk7) for more. -->
<meta-data
    android:name="com.google.firebase.messaging.default_notification_color"
    android:resource="@color/colorAccent" />
  • (Optional) Ab Android 8.0 (API-Ebene 26) werden Benachrichtigungskanäle unterstützt und empfohlen. FCM bietet einen Standardbenachrichtigungskanal mit grundlegenden Einstellungen. Wenn Sie lieber einen eigenen Standardkanal erstellen und verwenden möchten, legen Sie default_notification_channel_id auf die ID Ihres Benachrichtigungskanalobjekts fest, wie gezeigt. FCM verwendet diesen Wert immer dann, wenn in eingehenden Nachrichten kein Benachrichtigungskanal explizit festgelegt ist. Weitere Informationen finden Sie unter Benachrichtigungskanäle verwalten. 
    • <meta-data
    android:name="com.google.firebase.messaging.default_notification_channel_id"
    android:value="@string/default_notification_channel_id" />

Laufzeitberechtigung zum Senden von Benachrichtigungen unter Android 13 und höher anfordern

In Android 13 wird eine neue Laufzeitberechtigung zum Anzeigen von Benachrichtigungen eingeführt. Dies betrifft alle Apps unter Android 13 oder höher, die FCM-Benachrichtigungen verwenden.

Standardmäßig enthält das FCM SDK (Version 23.0.6 oder höher) die im Manifest definierte Berechtigung POST_NOTIFICATIONS. Ihre App muss jedoch auch die Laufzeitversion dieser Berechtigung mit der Konstanten android.permission.POST_NOTIFICATIONS anfordern. Ihre App darf erst dann Benachrichtigungen anzeigen, wenn der Nutzer diese Berechtigung erteilt hat.

So fordern Sie die neue Laufzeitberechtigung an:

Kotlin

// Declare the launcher at the top of your Activity/Fragment:
private val requestPermissionLauncher = registerForActivityResult(
    ActivityResultContracts.RequestPermission(),
) { isGranted: Boolean ->
    if (isGranted) {
        // FCM SDK (and your app) can post notifications.
    } else {
        // TODO: Inform user that that your app will not show notifications.
    }
}

private fun askNotificationPermission() {
    // This is only necessary for API level >= 33 (TIRAMISU)
    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
        if (ContextCompat.checkSelfPermission(this, Manifest.permission.POST_NOTIFICATIONS) ==
            PackageManager.PERMISSION_GRANTED
        ) {
            // FCM SDK (and your app) can post notifications.
        } else if (shouldShowRequestPermissionRationale(Manifest.permission.POST_NOTIFICATIONS)) {
            // TODO: display an educational UI explaining to the user the features that will be enabled
            //       by them granting the POST_NOTIFICATION permission. This UI should provide the user
            //       "OK" and "No thanks" buttons. If the user selects "OK," directly request the permission.
            //       If the user selects "No thanks," allow the user to continue without notifications.
        } else {
            // Directly ask for the permission
            requestPermissionLauncher.launch(Manifest.permission.POST_NOTIFICATIONS)
        }
    }
}

Java

// Declare the launcher at the top of your Activity/Fragment:
private final ActivityResultLauncher<String> requestPermissionLauncher =
        registerForActivityResult(new ActivityResultContracts.RequestPermission(), isGranted -> {
            if (isGranted) {
                // FCM SDK (and your app) can post notifications.
            } else {
                // TODO: Inform user that that your app will not show notifications.
            }
        });

private void askNotificationPermission() {
    // This is only necessary for API level >= 33 (TIRAMISU)
    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
        if (ContextCompat.checkSelfPermission(this, Manifest.permission.POST_NOTIFICATIONS) ==
                PackageManager.PERMISSION_GRANTED) {
            // FCM SDK (and your app) can post notifications.
        } else if (shouldShowRequestPermissionRationale(Manifest.permission.POST_NOTIFICATIONS)) {
            // TODO: display an educational UI explaining to the user the features that will be enabled
            //       by them granting the POST_NOTIFICATION permission. This UI should provide the user
            //       "OK" and "No thanks" buttons. If the user selects "OK," directly request the permission.
            //       If the user selects "No thanks," allow the user to continue without notifications.
        } else {
            // Directly ask for the permission
            requestPermissionLauncher.launch(Manifest.permission.POST_NOTIFICATIONS);
        }
    }
}

Im Allgemeinen sollten Sie eine Benutzeroberfläche anzeigen, auf der dem Nutzer die Funktionen erläutert werden, die aktiviert werden, wenn er der App die Berechtigung zum Senden von Benachrichtigungen erteilt. In dieser Benutzeroberfläche sollten Nutzer die Möglichkeit haben, zuzustimmen oder abzulehnen, z. B. über die Schaltflächen OK und Nein, danke. Wenn der Nutzer OK auswählt, fordern Sie die Berechtigung direkt an. Wenn der Nutzer Nein, danke auswählt, lassen Sie ihn ohne Benachrichtigungen fortfahren.

Weitere Best Practices dazu, wann Ihre App die Berechtigung POST_NOTIFICATIONS vom Nutzer anfordern sollte, finden Sie unter Laufzeitberechtigung für Benachrichtigungen.

Benachrichtigungsberechtigungen für Apps, die auf Android 12L (API-Level 32) oder niedriger ausgerichtet sind

Android fragt den Nutzer automatisch um die Berechtigung, wenn Ihre App zum ersten Mal einen Benachrichtigungskanal erstellt, sofern sich die App im Vordergrund befindet. Es gibt jedoch wichtige Einschränkungen hinsichtlich des Zeitpunkts der Kanalerstellung und der Berechtigungsanfragen:

  • Wenn Ihre App ihren ersten Benachrichtigungskanal erstellt, während sie im Hintergrund ausgeführt wird (was das FCM SDK beim Empfang einer FCM-Benachrichtigung tut), lässt Android nicht zu, dass die Benachrichtigung angezeigt wird, und fordert den Nutzer erst beim nächsten Öffnen Ihrer App zur Erteilung der Berechtigung zum Senden von Benachrichtigungen auf. Das bedeutet, dass alle Benachrichtigungen, die vor dem Öffnen Ihrer App und der Einwilligung des Nutzers in die Berechtigung empfangen werden, verloren gehen.
  • Wir empfehlen dringend, Ihre App so zu aktualisieren, dass sie auf Android 13 oder höher ausgerichtet ist, damit Sie die APIs der Plattform zum Anfordern von Berechtigungen nutzen können. Wenn das nicht möglich ist, sollte Ihre App Benachrichtigungskanäle erstellen, bevor Sie Benachrichtigungen an die App senden, um den Dialog zur Berechtigung zum Senden von Benachrichtigungen auszulösen und dafür zu sorgen, dass keine Benachrichtigungen verloren gehen. Weitere Informationen finden Sie unter Best Practices für Benachrichtigungsberechtigungen.

Optional: Berechtigung für POST_NOTIFICATIONS entfernen

Standardmäßig ist im FCM SDK die Berechtigung POST_NOTIFICATIONS enthalten. Wenn Ihre App keine Benachrichtigungen verwendet (weder über FCM-Benachrichtigungen noch über ein anderes SDK oder direkt von Ihrer App gesendet) und Sie nicht möchten, dass Ihre App die Berechtigung enthält, können Sie sie mit dem remove-Marker des Manifest-Mergers entfernen. Wenn Sie diese Berechtigung entfernen, werden alle Benachrichtigungen deaktiviert, nicht nur FCM-Benachrichtigungen. Fügen Sie der Manifestdatei Ihrer App Folgendes hinzu:

<uses-permission android:name="android.permission.POST_NOTIFICATIONS" tools:node="remove"/>

Auf die Firebase-Installations-ID zugreifen

Beim ersten Start Ihrer App registriert das FCM SDK die App-Instanz bei FCM und gibt eine Kennung für die App-Instanz zurück. Wenn Sie einzelne App-Instanzen ansprechen möchten, müssen Sie auf diese Kennung zugreifen, indem Sie FirebaseMessagingService erweitern und onRegistered() überschreiben. Es empfiehlt sich, die zuletzt aktualisierte Kennung abzurufen, da sich die Kennung nach dem ersten Start ändern kann.

Registrierung über die Firebase-Installations-ID aktivieren

Wenn Sie die Registrierung Ihrer App-Instanz bei FCM über die Firebase-Installations-ID (FID) aktivieren möchten, fügen Sie der Datei AndroidManifest.xml das folgende Metadaten-Flag hinzu: 
<meta-data
    android:name="firebase_messaging_installation_id_enabled"
    android:value="true" />

onRegistered()-Callback implementieren

App-Instanzen werden über die Firebase-Installations-ID (FID) angesprochen, sobald sie bei FCM registriert sind. Um die FID bei der Registrierung abzurufen, implementieren Sie den Callback onRegistered(). Sobald eine App-Instanz registriert ist, überwacht das FCM SDK automatisch FID-Änderungen und ruft den Callback auf, wenn eine Änderung erkannt wird. Wenn die automatische Initialisierung aktiviert ist, wird das FCM SDK automatisch mit dem FCM-Backend synchronisiert, um die Registrierung auf dem neuesten Stand zu halten. Außerdem wird der Callback aufgerufen, damit Ihr App-Server die aktuelle Kennung hat. Um FID-Verlust oder veraltete FIDs zu vermeiden, sollten Sie die FID an Ihren App-Server senden, wenn dieser Callback ausgelöst wird.

Kotlin

  /**
   * There are three scenarios when `onRegistered` is called:
   * 1) Every time a manual `register()` call finishes successfully
   * 2) Whenever the FID is changed and the app is re-registered with FCM via the new FID.
   * 3) Automatically on app startup or routine sync when auto-initialization is enabled.
   * Under #2, there are three scenarios when the existing FID is changed:
   * A) App is restored to a new device
   * B) User uninstalls/reinstalls the app
   * C) User clears app data
   */
  override fun onRegistered(installationId: String) {
      Log.d(TAG, "Registered installation ID: $installationId")

      // Send the Firebase Installation ID to your app server.
      sendRegistrationToServer(installationId)
  }

Java

  /**
   * There are three scenarios when `onRegistered` is called:
   * 1) Every time a manual `register()` call finishes successfully
   * 2) Whenever the FID is changed and the app is re-registered with FCM via the new FID
   * 3) Automatically on app startup or routine sync when auto-initialization is enabled.
   * Under #2, there are three scenarios when the existing FID is changed:
   * A) App is restored to a new device
   * B) User uninstalls/reinstalls the app
   * C) User clears app data
   */
  @Override
  public void onRegistered(@NonNull String installationId) {
      Log.d(TAG, "Registered installation ID: " + installationId);

      // Send the Firebase Installation ID to your app server.
      sendRegistrationToServer(installationId);
  }

Manuelle Registrierung, wenn die automatische Initialisierung deaktiviert ist

Wenn Sie die automatische Initialisierung deaktivieren müssen, wird das FCM SDK beim Start nicht automatisch synchronisiert oder der onRegistered()-Callback ausgelöst. Es wird dringend empfohlen, die automatische Initialisierung wieder zu aktivieren, nachdem die Berechtigungen für Benachrichtigungen erteilt wurden. Weitere Informationen finden Sie unter Automatische Initialisierung wieder aktivieren.

Wenn die automatische Initialisierung deaktiviert bleiben muss, rufen Sie beim Starten der App FirebaseMessaging.getInstance().register() auf, um die Registrierung und die FID-Übermittlung über den Callback onRegistered() auszulösen. Sie können diesen Aufruf in der Methode onCreate() Ihrer Haupt-Activity ausführen.

Kotlin

  // Trigger manual registration if auto-initialization is turned off.
  // Consider calling this every time the app starts to guarantee sync status.
  FirebaseMessaging.getInstance().register()
      .addOnCompleteListener(this) { task ->
        if (!task.isSuccessful()) {
          // Registration failed. Consider retrying the registration with exponential backoff.
          Log.w(TAG, "Failed to register with Firebase Cloud Messaging", task.exception)
        }
        // Success! The Firebase Installation ID can be used to target messages to this app
        // instance and will be delivered asynchronously to your `onRegistered()` callback.
      }

Java

  // Trigger manual registration if auto-initialization is turned off.
  // Consider calling this every time the app starts to guarantee sync status.
  FirebaseMessaging.getInstance().register()
      .addOnCompleteListener(task -> {
        if (!task.isSuccessful()) {
          // Registration failed. Consider retrying the registration with exponential backoff.
          Log.w(TAG, "Failed to register with Firebase Cloud Messaging", task.exception)
        }
        // Success! The Firebase Installation ID can be used to target messages to this app
        // instance and will be delivered asynchronously to your `onRegistered()` callback.
      });

Auf das Registrierungstoken für FCM zugreifen (eingestellt)

Beim ersten Start Ihrer App generiert das FCM SDK ein Registrierungstoken für die Client-App-Instanz. Wenn Sie einzelne App-Instanzen ausrichten oder Gerätegruppen erstellen möchten, müssen Sie auf dieses Token zugreifen, indem Sie FirebaseMessagingService erweitern und onNewToken überschreiben. Da das Token nach dem ersten Start rotiert werden kann, wird dringend empfohlen, das zuletzt aktualisierte Registrierungstoken abzurufen.

Das Registrierungstoken kann sich ändern, wenn:

  • Die App wird auf einem neuen Gerät wiederhergestellt
  • Der Nutzer deinstalliert/installiert die App neu
  • Der Nutzer löscht App-Daten.

Aktuelles Registrierungstoken abrufen

Wenn Sie das aktuelle Token abrufen müssen, rufen Sie FirebaseMessaging.getInstance().getToken() auf:

Kotlin

FirebaseMessaging.getInstance().token.addOnCompleteListener(OnCompleteListener { task ->
    if (!task.isSuccessful) {
        Log.w(TAG, "Fetching FCM registration token failed", task.exception)
        return@OnCompleteListener
    }

    // Get new FCM registration token
    val token = task.result

    // Log and toast
    val msg = getString(R.string.msg_token_fmt, token)
    Log.d(TAG, msg)
    Toast.makeText(baseContext, msg, Toast.LENGTH_SHORT).show()
})

Java

FirebaseMessaging.getInstance().getToken()
    .addOnCompleteListener(new OnCompleteListener<String>() {
        @Override
        public void onComplete(@NonNull Task<String> task) {
          if (!task.isSuccessful()) {
            Log.w(TAG, "Fetching FCM registration token failed", task.getException());
            return;
          }

          // Get new FCM registration token
          String token = task.getResult();

          // Log and toast
          String msg = getString(R.string.msg_token_fmt, token);
          Log.d(TAG, msg);
          Toast.makeText(MainActivity.this, msg, Toast.LENGTH_SHORT).show();
        }
    });

Tokenerstellung überwachen

Der onNewToken-Callback wird immer dann ausgelöst, wenn ein neues Token generiert wird.

Kotlin

/**
 * Called if the FCM registration token is updated. This may occur if the security of
 * the previous token had been compromised. Note that this is called when the
 * FCM registration token is initially generated so this is where you would retrieve the token.
 */
override fun onNewToken(token: String) {
    Log.d(TAG, "Refreshed token: $token")

    // If you want to send messages to this application instance or
    // manage this apps subscriptions on the server side, send the
    // FCM registration token to your app server.
    sendRegistrationToServer(token)
}

Java

/**
 * There are two scenarios when onNewToken is called:
 * 1) When a new token is generated on initial app startup
 * 2) Whenever an existing token is changed
 * Under #2, there are three scenarios when the existing token is changed:
 * A) App is restored to a new device
 * B) User uninstalls/reinstalls the app
 * C) User clears app data
 */
@Override
public void onNewToken(@NonNull String token) {
    Log.d(TAG, "Refreshed token: " + token);

    // If you want to send messages to this application instance or
    // manage this apps subscriptions on the server side, send the
    // FCM registration token to your app server.
    sendRegistrationToServer(token);
}

Nachdem Sie das Token erhalten haben, können Sie es an Ihren App-Server senden und mit der gewünschten Methode speichern.

Prüfen, ob die Google Play-Dienste installiert sind

Apps, die auf dem Play Services SDK basieren, sollten immer prüfen, ob auf dem Gerät ein kompatibles APK für die Google Play-Dienste vorhanden ist, bevor sie auf Funktionen der Google Play-Dienste zugreifen. Weitere Informationen finden Sie unter Google Play-Dienste einrichten. Es wird empfohlen, dies an zwei Stellen zu tun: in der onCreate()-Methode der Hauptaktivität und in der zugehörigen onResume()-Methode. Die Prüfung in onCreate() sorgt dafür, dass die App nicht ohne erfolgreiche Prüfung verwendet werden kann. Die Prüfung in onResume() sorgt dafür, dass die Prüfung auch dann durchgeführt wird, wenn der Nutzer auf andere Weise zur laufenden App zurückkehrt, z. B. über den Button „Zurück“.

Wenn auf dem Gerät keine kompatible Version der Google Play-Dienste installiert ist, kann Ihre App GoogleApiAvailability.makeGooglePlayServicesAvailable() aufrufen, damit Nutzer die Google Play-Dienste aus dem Play Store herunterladen können.

Automatische Initialisierung verhindern

Wenn eine FCM-Registrierung generiert wird, lädt die Bibliothek die Kennung und die Konfigurationsdaten in Firebase hoch. Wenn Sie die automatische Registrierung verhindern möchten, deaktivieren Sie die Analytics-Erhebung und die automatische FCM-Initialisierung (Sie müssen beide deaktivieren), indem Sie diese Metadatenwerte zu Ihrem AndroidManifest.xml hinzufügen:

<meta-data
    android:name="firebase_messaging_auto_init_enabled"
    android:value="false" />
<meta-data
    android:name="firebase_analytics_collection_enabled"
    android:value="false" />

Automatische Initialisierung wieder aktivieren

Wenn Sie die automatische FCM-Initialisierung wieder aktivieren möchten, führen Sie einen Laufzeitaufruf aus:

Kotlin

Firebase.messaging.isAutoInitEnabled = true

Java

FirebaseMessaging.getInstance().setAutoInitEnabled(true);

Wenn Sie die Analytics-Erfassung wieder aktivieren möchten, rufen Sie die Methode setAnalyticsCollectionEnabled() der Klasse FirebaseAnalytics auf. Beispiel:

setAnalyticsCollectionEnabled(true);

Diese Werte bleiben nach dem Festlegen auch nach einem Neustart der App erhalten.

Benachrichtigung senden

So können Sie prüfen, ob Ihr Android-Client richtig eingerichtet ist:

  1. Installieren Sie die App auf dem Zielgerät und führen Sie sie aus.

  2. Die App muss auf dem Gerät im Hintergrund ausgeführt werden.

  3. Rufen Sie in der Firebase Console DevOps & Engagement > Messaging auf.

  4. Erstellen Sie eine Kampagne.

    • Wenn dies Ihre erste Nachricht ist:

      1. Wählen Sie Erste Kampagne erstellen aus.

      2. Wählen Sie Firebase-Benachrichtigungen und dann Erstellen aus.

    • Wenn Sie bereits Kampagnen erstellt haben:

      1. Wählen Sie auf dem Tab Kampagnen die Option Neue Kampagne aus.

      2. Klicke auf Benachrichtigungen.

  5. Geben Sie den Nachrichtentext ein. Alle anderen sind optional.

  6. Wählen Sie im rechten Bereich Testnachricht senden aus.

  7. Geben Sie in das Feld mit dem Label FCM-Registrierungstoken hinzufügen das Registrierungstoken ein, das Sie in einem vorherigen Abschnitt dieses Leitfadens erhalten haben.

  8. Wählen Sie Testen aus.

Das Zielclientgerät mit der App im Hintergrund sollte die Benachrichtigung empfangen.

Wenn Sie Informationen zur Zustellung von Nachrichten an Ihre App erhalten möchten, rufen Sie in der Firebase-Konsole das Dashboard „Berichte“ unter DevOps & Engagement > Messaging auf. In diesem Dashboard wird die Anzahl der auf Apple- und Android-Geräten gesendeten und geöffneten Nachrichten erfasst. Außerdem sind Daten zu „Impressionen“ (von Nutzern gesehene Benachrichtigungen) für Android-Apps enthalten.

Nächste Schritte

Nachdem Sie die Einrichtungsschritte abgeschlossen haben, haben Sie folgende Möglichkeiten, mit FCM für Android fortzufahren: