In dieser Anleitung wird beschrieben, wie Sie mit dem optionalen Firebase App Distribution Android SDK In-App-Feedback aktivieren, damit Ihre Tester Feedback (einschließlich Screenshots) direkt in der App senden können.
Hinweis
Fügen Sie Ihrem Android-Projekt Firebase hinzu, falls noch nicht geschehen.
Schritt 1: App Distribution Tester API aktivieren
Öffnen Sie die Google Cloud Console und wählen Sie Ihr Firebase-Projekt aus.
Klicken Sie unter „Firebase App Testers API“ auf Aktivieren.
Schritt 2: App Distribution zur App hinzufügen
Das App Distribution Android SDK besteht aus zwei Bibliotheken:
firebase-appdistribution-api
: Die API-Bibliothek, die Sie in alle Buildvarianten aufnehmen können.firebase-appdistribution
: Die vollständige SDK-Implementierung (optional).
Mit der API-Bibliothek kann Ihr Code das SDK aufrufen. Die Aufrufe haben keine Auswirkungen, wenn die vollständige SDK-Implementierung nicht vorhanden ist.
Deklarieren Sie die Abhängigkeit für das App Distribution Android SDK in der Gradle-Datei des Moduls (auf App-Ebene) (in der Regel
<project>/<app-module>/build.gradle.kts
oder<project>/<app-module>/build.gradle
).Wenn Sie die Funktion zur automatischen Aktualisierung der vollständigen SDK-Implementierung nicht in Ihre Google Play-Builds aufnehmen möchten, müssen Sie die Buildvarianten angeben, einschließlich Buildtypen oder Produktvarianten, die Sie über App Distribution verteilen.
Deklarieren Sie die Abhängigkeit für das App Distribution Android SDK in Ihrer Gradle-Datei des Moduls (auf App-Ebene) (in der Regel
app/build.gradle
). Fügen Sie die vollständige SDK-Implementierung nur Varianten hinzu, die ausschließlich für Vorabtests vorgesehen sind:Kotlin
dependencies { // ADD the API-only library to all variants implementation("com.google.firebase:firebase-appdistribution-api-ktx:16.0.0-beta14") // ADD the full SDK implementation to the "beta" variant only (example) betaImplementation("com.google.firebase:firebase-appdistribution:16.0.0-beta14") }
Java
dependencies { // ADD the API-only library to all variants implementation("com.google.firebase:firebase-appdistribution-api:16.0.0-beta14") // ADD the full SDK implementation to the "beta" variant only (example) betaImplementation("com.google.firebase:firebase-appdistribution:16.0.0-beta14") }
Schritt 3: In-App-Feedback konfigurieren
Verwenden Sie einen der folgenden Trigger, um Feedback von Ihren Testern einzuholen:
Integrierter Benachrichtigungstrigger: Das App Distribution Android SDK kann eine laufende Benachrichtigung anzeigen, auf die Tester von überall in der App tippen können. Verwenden Sie diesen Trigger, wenn Sie schneller loslegen möchten und die Art und Weise, wie Ihre Tester Feedback geben, nicht anpassen müssen.
Benutzerdefinierter Trigger: Sie können einen eigenen Triggermechanismus angeben, z. B. das Tippen auf eine Schaltfläche oder einen Menüpunkt in Ihrer App oder das Schütteln des Geräts.
Wenn Sie einen dieser Trigger verwenden und der Tester Feedback gibt, führt das Android SDK die folgenden Aktionen aus:
Erfasst einen Screenshot der aktuellen Aktivitäten der App.
Es werden Prüfungen durchgeführt, um sicherzustellen, dass der Tester die Testfunktionen des SDKs aktiviert hat. Wenn die Testfunktionen nicht aktiviert sind, werden die Tester vom Android SDK aufgefordert, sich mit ihrem Google-Konto in App Distribution anzumelden.
Startet eine Vollbildaktivität, in der die Tester ihr Feedback eingeben und einreichen können.
Option 1: Benachrichtigungsauslöser
Mit showFeedbackNotification()
können Sie auf dem Gerät des Testers eine dauerhafte oder fortlaufende Benachrichtigung anzeigen lassen, auf die er tippen kann, um Feedback zu geben.
Wenn Sie die Benachrichtigung konfigurieren, müssen Sie einen Text angeben, der den Testern angezeigt wird, bevor sie Feedback geben. Außerdem müssen Sie die Unterbrechungsstufe für die Benachrichtigung festlegen, die der Wichtigkeit des Benachrichtigungskanals entspricht. Wenn Sie Ihre Tester über die Erhebung und Verarbeitung ihrer Feedbackdaten informieren möchten, können Sie diesen Text verwenden.
Wenn Sie showFeedbackNotification()
verwenden und die App in den Hintergrund wechselt, wird die Benachrichtigung ausgeblendet. Wenn Sie die Benachrichtigung explizit ausblenden möchten, verwenden Sie cancelFeedbackNotification()
. Wir empfehlen, showFeedbackNotification()
in die onCreate()
Ihrer Hauptaktivität einzufügen.
Kotlin
class MainActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
Firebase.appDistribution.showFeedbackNotification(
// Text providing notice to your testers about collection and
// processing of their feedback data
R.string.additionalFormText,
// The level of interruption for the notification
InterruptionLevel.HIGH)
}
}
Java
public class MainActivity extends AppCompatActivity {
FirebaseAppDistribution firebaseAppDistribution =
FirebaseAppDistribution.getInstance();
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
firebaseAppDistribution.showFeedbackNotification(
// Text providing notice to your testers about collection and
// processing of their feedback data
R.string.additionalFormText,
// The level of interruption for the notification
InterruptionLevel.HIGH);
}
}
Option 2: Benutzerdefinierter Trigger
Verwenden Sie die Methode startFeedback()
, um Feedback über einen Mechanismus Ihrer Wahl zu initiieren. Wenn Sie beispielsweise Feedback erhalten möchten, können Sie dem Aktionsmenü Ihrer App den Menüpunkt „Feedback geben“ hinzufügen oder Ihre Tester bitten, ihr Gerät zu schütteln oder einen Screenshot zu erstellen.
Wenn Sie Feedback auslösen, geben Sie einen Text an, der den Testern angezeigt wird, bevor sie Feedback geben. Wenn Sie Ihren Testern eine Mitteilung zur Erhebung und Verarbeitung ihrer Feedbackdaten senden möchten, können Sie diesen Text verwenden.
Kotlin
Firebase.appDistribution.startFeedback(R.string.feedbackMessage)
Java
FirebaseAppDistribution.getInstance().startFeedback(R.string.feedbackMessage);
Schritt 4: Implementierung erstellen und testen
Lokales Testen
So testen Sie Ihre Implementierung, ohne die App zuerst verteilen zu müssen:
Aktivieren Sie den Entwicklermodus auf Ihrem lokalen Gerät:
adb shell setprop debug.firebase.appdistro.devmode true
Erstellen Sie eine Vorabversion Ihrer App, die alle App Distribution-Bibliotheken enthält, und testen Sie, ob Sie Feedback mit dem in Schritt 3: In-App-Feedback konfigurieren implementierten Mechanismus auslösen können. Im Entwicklermodus wird kein Feedback gesendet.
Nach dem Testen können Sie den Entwicklermodus auf Ihrem Gerät deaktivieren:
adb shell setprop debug.firebase.appdistro.devmode false
End-to-End-Tests
Wenn Sie testen möchten, ob Ihre App Feedback senden kann, erstellen Sie eine Vorabversion Ihrer App, die die vollständigen App Distribution-Bibliotheken enthält. Führen Sie dann die folgenden Schritte aus, um Ihre Implementierung zu testen:
Laden Sie einen neuen App-Release auf App Distribution hoch.
Veröffentlichen Sie die App-Version in einem Konto, auf das Sie Zugriff haben.
Lade die App über die Website oder die Android-Tester-App von App Distribution herunter.
Lösen Sie Feedback mit dem Mechanismus aus, der in Schritt 3: In-App-Feedback konfigurieren implementiert wurde.
Melden Sie sich mit dem Konto an, über das Sie die App-Version veröffentlicht haben, und reichen Sie Feedback ein.
Sie können sich Ihr Feedback in der Karte des neuen Release in der Firebase Console ansehen.
Informationen zum Beheben häufiger Probleme, z. B. wenn Tester kein Feedback in der App geben können, finden Sie unter Testfunktionen mit dem SDK aktivieren.
Schritt 5: Feedback der Tester verwalten
Nachdem Sie Ihren Testern die Möglichkeit gegeben haben, Feedback zu senden, können Sie dieses Feedback mit den folgenden Tools prüfen und darauf reagieren:
Feedback in der Firebase-Konsole ansehen und löschen
Sie können Nutzerfeedback, einschließlich Screenshots, prüfen und löschen, indem Sie in der Firebase-Konsole unter einer bestimmten Version den Tab Testerfeedback öffnen. Nutzerfeedback ist nach Release sortiert, damit Sie die Version bestätigen können, auf die sich das Feedback bezieht.
Nachdem Sie das Nutzerfeedback geprüft haben, können Sie es löschen, indem Sie auf die Schaltfläche Feedback löschen klicken. Das gelöschte Feedback wird aus Ihrer Version entfernt.
E-Mail-Benachrichtigungen für neues Feedback erhalten
Wenn Sie proaktiv über neues Testerfeedback informiert werden möchten, können Sie E-Mail-Benachrichtigungen erhalten, wenn ein Tester Feedback einreicht. Die E-Mail-Benachrichtigung enthält das schriftliche Feedback Ihres Testers und einen Link zu allen eingereichten Screenshots.
Wenn Sie App Distribution-E-Mail-Benachrichtigungen über diesen Standardmechanismus erhalten möchten, benötigen Sie die Berechtigung firebase.projects.update
. Die folgenden Rollen umfassen diese erforderliche Berechtigung standardmäßig: Firebase-Administrator oder Inhaber oder Bearbeiter des Projekts.
Standardmäßig erhalten alle Projektmitglieder, die die erforderlichen Berechtigungen zum Empfangen von E-Mail-Benachrichtigungen haben, eine E-Mail, wenn ein neuer Feedbackbericht eingereicht wird. Projektmitglieder können diese Benachrichtigungen einzeln deaktivieren.
Informationen zum Deaktivieren von E-Mail-Benachrichtigungen finden Sie unter Firebase-Benachrichtigungen erhalten.
Neues Feedback an Tools von Drittanbietern senden
Sie können App Distribution-Benachrichtigungen auch über Cloud Functions for Firebase an den bevorzugten Benachrichtigungskanal Ihres Teams senden. Sie können beispielsweise eine Funktion schreiben, die ein Benachrichtigungsereignis für neues In-App-Feedback erfasst und die Benachrichtigungsinformationen in einem Drittanbieterdienst wie Discord, Slack oder Jira postet.
So richten Sie erweiterte Benachrichtigungsfunktionen mit Cloud Functions for Firebase ein:
Cloud Functions for Firebase einrichten, was die folgenden Aufgaben umfasst:
Laden Sie Node.js und npm herunter.
Installieren Sie die Firebase-Befehlszeile und melden Sie sich an.
Initialisieren Sie Cloud Functions for Firebase mit der Firebase-Befehlszeile.
Erstellen und bereitstellen einer Funktion, die ein In-App-Feedback-Benachrichtigungsereignis von App Distribution erfasst und die Ereignisnutzlast verarbeitet (z. B. die Benachrichtigungsinformationen in einer Nachricht auf Discord postet).
Eine Beispielfunktion, die zeigt, wie Sie neues Feedback an Jira senden, finden Sie hier.
Informationen zu allen Benachrichtigungsereignissen, die Sie erfassen können, finden Sie in der Referenzdokumentation für App Distribution-Benachrichtigungen.