In dieser Anleitung wird beschrieben, wie Sie In-App-Feedback mit dem optionalen Firebase App Distribution Android SDK 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 Konsole und wählen Sie Ihr Firebase-Projekt aus.
Klicken Sie unter der Firebase App Testers API auf Aktivieren.
Schritt 2: App Distribution Ihrer App hinzufügen
Das App Distribution Android SDK besteht aus zwei Bibliotheken:
firebase-appdistribution-api: Die reine API-Bibliothek, die Sie in alle Build-Varianten einbinden können.firebase-appdistribution: Die vollständige SDK-Implementierung (optional).
Mit der reinen API-Bibliothek kann Ihr Code Aufrufe an das SDK senden. 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 Anwendungsebene) (in der Regel
<project>/<app-module>/build.gradle.ktsoder<project>/<app-module>/build.gradle).Um die Selbstaktualisierungsfunktion der vollständigen SDK-Implementierung nicht in Ihre Google Play-Builds einzubinden, identifizieren Sie die Build-Varianten, einschließlich Build-Typen oder Produktvarianten , die Sie über App Distribution verteilen möchten.
Deklarieren Sie die Abhängigkeit für das App Distribution Android SDK in der Gradle-Datei des Moduls (auf Anwendungsebene) (in der Regel
app/build.gradle). Fügen Sie die vollständige SDK-Implementierung nur Varianten hinzu, die ausschließlich für Tests vor der Veröffentlichung vorgesehen sind:Kotlin
dependencies { // ADD the API-only library to all variants implementation("com.google.firebase:firebase-appdistribution-api-ktx:16.0.0-beta15") // ADD the full SDK implementation to the "beta" variant only (example) betaImplementation("com.google.firebase:firebase-appdistribution:16.0.0-beta18") }
Java
dependencies { // ADD the API-only library to all variants implementation("com.google.firebase:firebase-appdistribution-api:16.0.0-beta18") // ADD the full SDK implementation to the "beta" variant only (example) betaImplementation("com.google.firebase:firebase-appdistribution:16.0.0-beta18") }
Schritt 3: In-App-Feedback konfigurieren
Verwenden Sie einen der folgenden Trigger, um Feedback von Ihren Testern zu erhalten:
Integrierter Benachrichtigungstrigger: Das App Distribution Android SDK kann eine Benachrichtigung über laufende Aktivitäten anzeigen, auf die der Tester von überall in der App tippen kann. Verwenden Sie diesen Trigger, wenn Sie schnell loslegen möchten und nicht anpassen müssen, wie Ihre Tester Feedback geben.
Benutzerdefinierter Trigger: Sie können einen eigenen Trigger Mechanismus bereitstellen, z. B. durch Tippen auf eine Schaltfläche oder ein Menüelement in Ihrer App oder durch Schütteln des Geräts.
Wenn Sie einen dieser Trigger verwenden und der Tester Feedback sendet, führt das Android SDK die folgenden Aktionen aus:
Erstellt einen Screenshot der aktuellen Aktivität der App.
Führt Prüfungen durch, um sicherzustellen, dass der Tester die Testfunktionen des SDK aktiviert hat. Wenn die Testfunktionen nicht aktiviert sind, fordert das Android SDK den Tester auf, sich mit seinem Google-Konto bei App Distribution anzumelden.
Startet eine Vollbildaktivität, mit der der Tester sein Feedback schreiben und senden kann.
Option 1: Benachrichtigungstrigger
Verwenden Sie showFeedbackNotification(), um auf dem Gerät des Testers eine dauerhafte oder
laufende
Benachrichtigung anzuzeigen, auf die er tippen kann, um Feedback zu geben.
Wenn Sie die Benachrichtigung konfigurieren, müssen Sie einen Text angeben, der
dem Tester angezeigt wird, bevor er Feedback sendet, und eine Unterbrechungsstufe für die Benachrichtigung (entsprechend der Wichtigkeit des Benachrichtigungskanals). Wenn Sie Ihre Tester über die Erhebung und Verarbeitung ihrer Feedbackdaten informieren möchten, können Sie den Text verwenden, um eine solche Benachrichtigung bereitzustellen.
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()-Methode 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 mit einem Mechanismus Ihrer Wahl zu geben. Sie können beispielsweise ein
Menüelement „Feedback senden“ zum Aktionsmenü Ihrer App hinzufügen oder Ihre Tester
das Gerät schütteln
oder einen Screenshot erstellen lassen.
Wenn Sie Feedback geben, geben Sie einen Text an, der dem Tester angezeigt wird, bevor er Feedback sendet. Wenn Sie Ihre Tester über die Erhebung und Verarbeitung ihrer Feedbackdaten informieren möchten, können Sie diesen Text verwenden, um eine solche Benachrichtigung bereitzustellen.
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 Ihre App als Vorabversion, die die vollständigen App Distribution Bibliotheken enthält, und testen Sie, ob Sie Feedback mit dem in Schritt 3: In-App-Feedback konfigurierenimplementierten Mechanismus geben 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 Ihre App als Vorabversion , die die vollständigen App Distribution Bibliotheken enthält, und testen Sie Ihre Implementierung so:
Laden Sie einen neuen App-Release in App Distribution hoch.
Verteilen Sie den App-Release an ein Konto, auf das Sie Zugriff haben.
Laden Sie die App über die Web- oder Android-Tester-App von App Distribution's herunter.
Geben Sie Feedback mit dem in Schritt 3: In-App-Feedback konfigurieren implementierten Mechanismus.
Melden Sie sich mit demselben Konto an, an das Sie den App-Release verteilt haben, und senden Sie Feedback.
Sehen Sie sich Ihr Feedback auf der Karte des neuen Release in der Firebase Console an.
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: Tester-Feedback verwalten
Nachdem Sie Ihren Testern die Möglichkeit gegeben haben, Feedback zu senden, können Sie die folgenden Tools verwenden, um dieses Feedback zu prüfen und darauf zu reagieren:
Feedback in der Firebase Console ansehen und löschen
Sie können Nutzerfeedback, einschließlich Screenshots, prüfen und löschen, indem Sie in der Firebase Console unter einem bestimmten Release den Tab Tester-Feedback öffnen. Nutzerfeedback ist nach Release organisiert, sodass 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 Ihrem Release entfernt.
E-Mail-Benachrichtigungen für neues Feedback erhalten
Wenn Sie proaktiv über neues Tester-Feedback informiert werden möchten, können Sie E-Mail-Benachrichtigungen erhalten, wenn ein Tester Feedback sendet. Die E-Mail-Benachrichtigung enthält das schriftliche Feedback Ihres Testers und einen Link zu allen von ihm gesendeten Screenshots.
Wenn Sie App Distribution E-Mail-Benachrichtigungen über diesen Standardmechanismus erhalten möchten, benötigen Sie
die firebase.projects.update Berechtigung. Die folgenden Rollen enthalten diese
erforderliche Berechtigung standardmäßig: Firebase-Administrator
oder ProjektInhaber oder Bearbeiter.
Standardmäßig erhält jedes Projektmitglied mit den erforderlichen Berechtigungen zum Empfangen von E-Mail-Benachrichtigungen eine E-Mail, wenn ein neuer Feedbackbericht gesendet wird. Projektmitglieder können diese Benachrichtigungen einzeln deaktivieren.
Informationen zum Deaktivieren von E-Mail-Benachrichtigungen finden Sie unter Firebase-Benachrichtigungen erhalten.
Neues Feedback an Drittanbieter-Tools senden
Sie können auch App Distribution Benachrichtigungen mit 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 an einen Drittanbieterdienst wie Discord, Slack oder Jira sendet.
So richten Sie erweiterte Benachrichtigungsfunktionen mit Cloud Functions for Firebase, ein:
Richten Sie Cloud Functions for Firebase ein. Dazu gehören die folgenden Aufgaben:
Laden Sie Node.js und npm herunter.
Installieren Sie die Firebase CLI und melden Sie sich an.
Initialisieren Sie Cloud Functions for Firebase mit der Firebase CLI.
Schreiben und stellen Sie eine Funktion bereit, die ein In-App-Feedback-Benachrichtigungsereignis von App Distribution erfasst und die Ereignisnutzlast verarbeitet (z. B. die Benachrichtigungsinformationen in einer Nachricht auf Discord postet).
Ein Beispielfunktion, die zeigt, wie Sie neues Feedback an Jira senden, finden Sie in diesem Beispiel.
Informationen zu allen Benachrichtigungsereignissen, die Sie erfassen können, finden Sie in der Referenz dokumentation zu App Distribution Benachrichtigungen.