Recueillir les commentaires des testeurs

Le SDK Android Firebase App Distribution est une version bêta. Cela signifie que la fonctionnalité peut faire l'objet de modifications susceptibles d'affecter la rétrocompatibilité. Une version bêta n'est sujette à aucun contrat de niveau de service ni aucun règlement d'obsolescence. Elle peut ne bénéficier d'une assistance limitée ou inexistante.

Ce guide explique comment activer les commentaires dans l'application à l'aide du SDK Android Firebase App Distribution facultatif, afin que vos testeurs puissent envoyer des commentaires (y compris des captures d'écran) directement dans l'application.

Avant de commencer

Si ce n'est pas encore fait, ajoutez Firebase à votre projet Android.

Remarque : Si votre projet Firebase contient plusieurs applications, assurez-vous que l'application que vous souhaitez distribuer avec App Distribution dispose de son propre fichier de configuration google-services.json. Pour en savoir plus, consultez la section Prendre en charge plusieurs environnements.

Étape 1: Activez l'API App Distribution Tester

1. Ouvrez la console Google Cloud, puis sélectionnez votre projet Firebase.

2. 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: bibliothèque API uniquement, que vous pouvez inclure dans toutes les variantes de compilation.
• firebase-appdistribution: implémentation complète du SDK (facultatif).

Attention : Pour prendre en charge des fonctionnalités telles que la notification des testeurs de nouveaux builds, l'implémentation complète du SDK Android App Distribution contient une fonctionnalité d'auto-mise à jour qui peut être considérée comme une violation du Règlement Google Play, même si ce code n'est pas exécuté au moment de l'exécution. Si vous envoyez votre application sur Google Play sans supprimer l'implémentation complète du SDK, elle risque d'être supprimée de Google Play.

La bibliothèque API uniquement permet à votre code d'effectuer des appels au SDK. Les appels n'ont aucun effet si l'implémentation complète du SDK n'est pas présente.

1. Déclarez la dépendance pour le SDK Android App Distribution dans le fichier Gradle de votre module (au niveau de l'application) (généralement <project>/<app-module>/build.gradle.kts ou <project>/<app-module>/build.gradle).

2. 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 compilation, y compris les types de compilation ou les types de produit que vous distribuerez via App Distribution.

3. Déclarez la dépendance pour le SDK Android App Distribution dans votre fichier Gradle de module (au niveau de l'application) (généralement app/build.gradle). N'ajoutez l'implémentation complète du SDK qu'aux variantes destinées exclusivement aux tests en version préliminaire:

   Kotlin+KTX

   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")
   }

Étape 3: Configurez les commentaires dans l'application

Pour recueillir les commentaires de vos testeurs, utilisez l'un des déclencheurs suivants pour leur permettre de les envoyer:

• Déclencheur de notification intégré: le SDK Android App Distribution peut afficher une notification en cours que le testeur peut appuyer n'importe où dans l'application. Utilisez ce déclencheur si vous souhaitez commencer plus rapidement et que vous n'avez pas besoin de personnaliser la façon dont vos testeurs envoient des commentaires.

• Déclencheur personnalisé: vous pouvez fournir votre propre mécanisme de déclenchement, par exemple en appuyant sur un bouton ou un élément de menu dans votre application ou en secouant l'appareil.

Lorsque vous utilisez l'un de ces déclencheurs et que le testeur envoie ses commentaires, le SDK Android effectue les actions suivantes:

1. Capture une capture d'écran de l'activité actuelle de l'application.

2. Exécute des vérifications pour s'assurer 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.

   Remarque : L'activation des fonctionnalités de test est un processus ponctuel sur l'appareil de test et persiste lors des mises à jour de votre application. Les fonctionnalités de test restent activées sur l'appareil de test jusqu'à ce que le testeur désinstalle l'application ou que l'application appelle la méthode signOutTester.

3. Démarre une activité en plein écran qui permet au testeur d'écrire et d'envoyer ses commentaires.

Option 1: Déclencheur de notification

Utilisez showFeedbackNotification() pour afficher une notification persistante ou continue sur l'appareil du testeur. Il peut appuyer dessus pour envoyer des commentaires. Lorsque vous configurez la notification, vous devez fournir du texte qui sera affiché au testeur avant d'envoyer 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 ce texte pour le faire.

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 placer showFeedbackNotification() dans le 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);
    }
}

Remarque : Sur Android 13 et versions ultérieures, cette méthode nécessite l'autorisation d'exécution pour l'envoi de notifications : POST_NOTIFICATIONS. Si votre application cible Android 13 (niveau d'API 33) ou version ultérieure, vous devez déclarer l'autorisation, puis la demander au moment de l'exécution.

Option 2 : Déclencheur personnalisé

Utilisez la méthode startFeedback() pour lancer des commentaires à l'aide d'un mécanisme de votre choix. Par exemple, pour déclencher des commentaires, vous pouvez 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 du texte qui sera présenté au testeur avant qu'il n'envoie ses commentaires. Si vous souhaitez informer vos testeurs de la collecte et du traitement de leurs données de commentaires, vous pouvez utiliser ce texte pour le faire.

Kotlin+KTX

Firebase.appDistribution.startFeedback(R.string.feedbackMessage)

Java

FirebaseAppDistribution.getInstance().startFeedback(R.string.feedbackMessage);

Étape 4: Créez et testez votre implémentation

Test local

Pour tester votre implémentation sans avoir à distribuer l'application au préalable, procédez comme suit:

1. Activez le mode développeur sur votre appareil local:

   adb shell setprop debug.firebase.appdistro.devmode true

2. Créez votre application en tant que variante préliminaire incluant l'intégralité des bibliothèques App Distribution, puis vérifiez que vous pouvez déclencher des commentaires à l'aide du mécanisme implémenté à l'Étape 3: Configurez les commentaires dans l'application. Les commentaires ne sont pas envoyés en mode développeur.

3. Après les tests, vous pouvez désactiver le mode développeur sur votre appareil:

   adb shell setprop debug.firebase.appdistro.devmode false

Test de bout en bout

Remarque : Par défaut, les nouveaux commentaires déclenchent des alertes par e-mail et dans la console pour tous les propriétaires et éditeurs de projets Firebase.

Pour vérifier que votre application peut envoyer des commentaires, créez-la en tant que variante en version préliminaire qui inclut l'ensemble des bibliothèques App Distribution, puis testez votre implémentation en procédant comme suit:

1. Importez une nouvelle version de l'application sur App Distribution.

2. Distribuez la version de l'application à un compte auquel vous avez accès.

3. Téléchargez l'application via le site Web ou l'application de test Android de App Distribution.

4. Déclenchez les commentaires à l'aide du mécanisme implémenté à l'étape 3 : "Configurer les commentaires dans l'application".

5. Assurez-vous d'être connecté avec le même compte que celui avec lequel vous avez distribué la version de l'application, puis envoyez vos commentaires.

6. Consultez vos commentaires dans la fiche de la nouvelle version dans la console Firebase.

Attention :Avant de publier votre application sur le Google Play Store, assurez-vous de la tester pour vérifier que vous n'incluez que la dépendance de bibliothèque API uniquement et que votre mécanisme de commentaires n'est pas inclus dans votre variante de version. Pour en savoir plus, consultez Étape 2: Ajouter App Distribution à votre application.

Pour savoir comment résoudre les problèmes courants, tels que l'incapacité des testeurs à envoyer des commentaires dans l'application, consultez Activer les fonctionnalités de test avec le SDK.

Étape 5: Gérer les commentaires des testeurs

Une fois que vous avez autorisé vos testeurs à envoyer des commentaires, vous pouvez utiliser les outils suivants pour les examiner et les prendre en compte:

• Console Firebase

• Alertes par e-mail pour les nouveaux commentaires

• Outils tiers

Afficher et supprimer des commentaires dans la console Firebase

Vous pouvez consulter et supprimer les commentaires des utilisateurs, y compris des captures d'écran, en ouvrant l'onglet Tester feedback (Commentaires du testeur) sous une version spécifique de la console Firebase. Les commentaires des utilisateurs sont organisés par version afin que vous puissiez confirmer la version à laquelle ils s'appliquent.

Après avoir examiné les commentaires des utilisateurs, vous pouvez les supprimer en cliquant sur le bouton Supprimer les commentaires. Les commentaires supprimés sont supprimés de votre version.

Recevoir des alertes par e-mail pour les nouveaux commentaires

Pour être informé de manière proactive des nouveaux commentaires des testeurs, vous pouvez recevoir des alertes par e-mail lorsqu'un testeur envoie des commentaires. L'alerte par e-mail inclut les commentaires écrits fournis par votre testeur et un lien vers les captures d'écran qu'il a envoyées.

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, tous les membres du projet disposant des autorisations requises pour recevoir des alertes par e-mail reçoivent un e-mail lorsqu'un nouveau rapport d'avis est envoyé. Les membres du projet peuvent désactiver individuellement 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 sur le canal de notification préféré de votre équipe à l'aide de Cloud Functions for 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 tel que Discord, Slack ou Jira.

Remarque :Pour utiliser les fonctionnalités avancées d'alerte, votre projet Firebase doit utiliser le forfait Blaze.

Pour configurer les fonctionnalités d'alerte avancées à l'aide de Cloud Functions for Firebase, procédez comme suit:

1. Configurez Cloud Functions for Firebase, ce qui comprend les tâches suivantes :

   1. Téléchargez Node.js et npm.

   2. Installez et connectez-vous à la CLI Firebase.

   3. Initialisez Cloud Functions for Firebase à l'aide de la CLI Firebase.

2. Écrivez et déployez une fonction qui capture un événement d'alerte de commentaires dans l'application à partir de 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 consulter un exemple de fonction vous montrant 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 sur les alertes App Distribution.