Ce guide décrit comment activer les commentaires dans l'application à l'aide du SDK Android Firebase App Distribution en option, afin que vos testeurs puissent soumettre des commentaires (y compris des captures d'écran) directement dans l'application.
Avant que tu commences
Si vous ne l'avez pas déjà fait, ajoutez Firebase à votre projet Android .
Étape 1 : Activer l'API App Distribution Tester
Ouvrez la console Google Cloud et sélectionnez votre projet Firebase.
Sous l'API Firebase App Testers, cliquez sur Activer .
Étape 2 : Ajoutez App Distribution à votre application
Le SDK Android App Distribution se compose de deux bibliothèques :
-
firebase-appdistribution-api: la bibliothèque API uniquement, que vous pouvez inclure dans toutes les variantes de build . -
firebase-appdistribution: L'implémentation complète du SDK (facultatif).
La bibliothèque API uniquement permet à votre code d'appeler le SDK. Les appels n’ont aucun effet si l’implémentation complète du SDK n’est pas présente.
Déclarez la dépendance du SDK Android App Distribution dans le fichier Gradle de votre module (au niveau de l'application) (généralement
<project>/<app-module>/build.gradle.ktsou<project>/<app-module>/build.gradle).Pour éviter d'inclure la fonctionnalité de mise à jour automatique de l'implémentation complète du SDK dans vos builds Google Play, identifiez les variantes de build, y compris les types de build ou les versions de produits que vous distribuerez via App Distribution.
Déclarez la dépendance du SDK Android App Distribution dans le fichier Gradle de votre module (au niveau de l'application) (généralement
app/build.gradle). Ajoutez uniquement l'implémentation complète du SDK aux variantes destinées exclusivement aux tests préliminaires :Kotlin+KTX
dependencies { // ADD the API-only library to all variants implementation("com.google.firebase:firebase-appdistribution-api-ktx:16.0.0-beta12") // ADD the full SDK implementation to the "beta" variant only (example) betaImplementation("com.google.firebase:firebase-appdistribution:16.0.0-beta12") }Java
dependencies { // ADD the API-only library to all variants implementation("com.google.firebase:firebase-appdistribution-api:16.0.0-beta12") // ADD the full SDK implementation to the "beta" variant only (example) betaImplementation("com.google.firebase:firebase-appdistribution:16.0.0-beta12") }
Étape 3 : Configurer les commentaires dans l'application
Pour recueillir les commentaires de vos testeurs, utilisez l'un des déclencheurs suivants pour permettre aux testeurs de lancer des commentaires :
Déclencheur de notification intégré : le SDK Android App Distribution peut afficher une notification continue sur laquelle le testeur peut appuyer depuis n'importe où dans l'application. Utilisez ce déclencheur si vous souhaitez démarrer plus rapidement et que vous n'avez pas besoin de personnaliser la façon dont vos testeurs fournissent des commentaires.
Déclencheur personnalisé : vous pouvez fournir votre propre mécanisme de déclenchement, comme appuyer sur un bouton ou un élément de menu dans votre application ou secouer l'appareil.
Lorsque vous utilisez l'un de ces déclencheurs et que le testeur envoie des commentaires, le SDK Android effectue les actions suivantes :
Capture une capture d'écran de l'activité actuelle de l'application.
Exécute des vérifications pour garantir que le testeur a activé les fonctionnalités de test du SDK. Si les fonctionnalités de test ne sont pas activées, le SDK Android invite le testeur à se connecter à App Distribution avec son compte Google.
Démarre une activité en plein écran qui permet au testeur d'écrire et de soumettre ses commentaires.
Option 1 : Déclencheur de notification
Utilisez showFeedbackNotification() pour afficher une notification persistante ou en cours sur l'appareil du testeur sur laquelle il peut appuyer pour lancer des commentaires. Lorsque vous configurez la notification, vous devez fournir un texte qui sera affiché au testeur avant qu'il soumette ses commentaires, ainsi qu'un niveau d'interruption pour la notification (correspondant à l' importance du canal de notification). Si vous souhaitez informer vos testeurs de la collecte et du traitement de leurs données de commentaires, vous pouvez utiliser le texte pour fournir une telle notification.
Lorsque vous utilisez showFeedbackNotification() et que l'application passe en arrière-plan, la notification est masquée. Si vous souhaitez masquer explicitement la notification, utilisez cancelFeedbackNotification() . Nous vous recommandons de mettre showFeedbackNotification() dans onCreate() de votre activité principale.
Kotlin+KTX
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 : Déclencheur personnalisé
Utilisez la méthode startFeedback() pour lancer un feedback à l'aide d'un mécanisme de votre choix. Par exemple, pour déclencher des commentaires, vous souhaiterez peut-être ajouter un élément de menu « Envoyer des commentaires » au menu d'action de votre application, ou laisser vos testeurs secouer leur appareil ou prendre une capture d'écran . Lorsque vous déclenchez des commentaires, fournissez un texte qui sera présenté au testeur avant qu'il ne soumette ses commentaires. Si vous souhaitez informer vos testeurs concernant la collecte et le traitement de leurs données de commentaires, vous pouvez utiliser ce texte pour fournir un tel avis.
Kotlin+KTX
Firebase.appDistribution.startFeedback(R.string.feedbackMessage)
Java
FirebaseAppDistribution.getInstance().startFeedback(R.string.feedbackMessage);
Étape 4 : Créez et testez votre implémentation
Tests locaux
Pour tester votre implémentation sans avoir à distribuer l'application au préalable, procédez comme suit :
Activez le mode développement sur votre appareil local :
adb shell setprop debug.firebase.appdistro.devmode true
Créez votre application en tant que variante préliminaire incluant les bibliothèques complètes d'App Distribution et testez que vous pouvez déclencher des commentaires à l'aide du mécanisme implémenté à l'Étape 3 : Configurer les commentaires dans l'application . Les commentaires ne sont pas soumis en mode développement.
Après le test, vous pouvez désactiver le mode développement sur votre appareil :
adb shell setprop debug.firebase.appdistro.devmode false
Tests de bout en bout
Pour tester que votre application peut envoyer des commentaires, créez votre application en tant que variante préliminaire incluant les bibliothèques complètes d'App Distribution et testez votre implémentation en suivant ces étapes :
Téléchargez une nouvelle version de l'application sur App Distribution.
Distribuez la version de l'application sur un compte auquel vous êtes autorisé à accéder.
Téléchargez l'application via l'application de test Web ou Android d'App Distribution.
Déclenchez des commentaires à l'aide du mécanisme implémenté à l'étape 3 : Configurer les commentaires dans l'application .
Assurez-vous que vous êtes connecté avec le même compte sur lequel vous avez distribué la version de l'application et envoyez vos commentaires.
Consultez vos commentaires sur la fiche de la nouvelle version dans la console Firebase .
Pour savoir comment résoudre les problèmes courants, tels que l'incapacité des testeurs à lancer des commentaires dans l'application, consultez Activation des fonctionnalités de test avec le SDK .
Étape 5 : Gérer les commentaires des testeurs
Après avoir autorisé vos testeurs à envoyer des commentaires, vous pouvez utiliser les outils suivants pour examiner ces commentaires et agir en conséquence :
Afficher et supprimer des commentaires dans la console Firebase
Vous pouvez consulter et supprimer les commentaires des utilisateurs, y compris les captures d'écran, en ouvrant l'onglet Commentaires du testeur sous une version spécifique dans la console Firebase. Les commentaires des utilisateurs sont organisés par version afin que vous puissiez confirmer la version à laquelle les commentaires s'appliquent.
Après avoir examiné les commentaires des utilisateurs, vous pouvez supprimer ces commentaires en cliquant sur le bouton Supprimer les commentaires . Les commentaires supprimés sont supprimés de votre version.
Recevez des alertes par e-mail pour de nouveaux commentaires
Pour connaître de manière proactive les commentaires des nouveaux testeurs, vous pouvez recevoir des alertes par e-mail lorsqu'un testeur soumet des commentaires. L'alerte par e-mail comprend les commentaires écrits fournis par votre testeur et un lien vers les captures d'écran qu'il a soumises.
Pour recevoir des alertes par e-mail App Distribution via ce mécanisme par défaut, vous devez disposer de l'autorisation firebase.projects.update . Les rôles suivants incluent cette autorisation requise par défaut : Administrateur Firebase ou Propriétaire ou Éditeur du projet.
Par défaut, chaque membre du projet disposant des autorisations requises pour recevoir des alertes par e-mail recevra un e-mail lorsqu'un nouveau rapport de commentaires sera soumis. Les membres du projet peuvent individuellement se désinscrire de ces alertes.
Pour désactiver les alertes par e-mail, consultez Recevoir des alertes Firebase .
Envoyer de nouveaux commentaires à des outils tiers
Vous pouvez également envoyer des alertes App Distribution au canal de notification préféré de votre équipe à l'aide de Cloud Functions pour Firebase. Par exemple, vous pouvez écrire une fonction qui capture un événement d'alerte pour les nouveaux commentaires dans l'application et publie les informations d'alerte sur un service tiers comme Discord, Slack ou Jira.
Pour configurer des fonctionnalités d'alerte avancées à l'aide de Cloud Functions pour Firebase, procédez comme suit :
Configurez Cloud Functions pour Firebase , qui comprend les tâches suivantes :
Téléchargez Node.js et npm.
Installez et connectez-vous à la CLI Firebase.
Initialisez Cloud Functions pour Firebase à l'aide de la CLI Firebase.
Écrivez et déployez une fonction qui capture un événement d'alerte de commentaires dans l'application à partir d'App Distribution et gère la charge utile de l'événement (par exemple, publie les informations d'alerte dans un message sur Discord).
Pour voir un exemple de fonction qui vous montre comment envoyer de nouveaux commentaires à Jira, reportez-vous à cet exemple .
Pour en savoir plus sur tous les événements d’alerte que vous pouvez capturer, consultez la documentation de référence pour les alertes App Distribution .