Recueillir les commentaires des testeurs

Ce guide explique comment activer les commentaires intégrés à l'application à l'aide du SDK Android facultatif Firebase App Distribution, 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 déjà fait, ajoutez Firebase à votre projet Android.

Étape 1 : Activer l'API Tester App Distribution

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

2. Sous l'API Firebase App Testers, cliquez sur Activer.

Étape 2 : Ajouter App Distribution à votre application

Le SDK Android App Distribution se compose de deux bibliothèques :

• firebase-appdistribution-api : bibliothèque réservée à l'API, que vous pouvez inclure dans toutes les variantes de build.
• firebase-appdistribution : implémentation complète du SDK (facultative).

La bibliothèque réservée à l'API 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 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 build, y compris les types de build ou les variantes de produit que vous distribuerez via App Distribution.

3. Déclarez la dépendance pour le App Distribution SDK Android dans votre fichier Gradle 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 préliminaires :

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

   Java

   dependencies {
       // ADD the API-only library to all variants
       implementation("com.google.firebase:firebase-appdistribution-api:16.0.0-beta17")
   
       // ADD the full SDK implementation to the "beta" variant only (example)
       betaImplementation("com.google.firebase:firebase-appdistribution:16.0.0-beta17")
   }

Étape 3 : Configurer les commentaires intégrés à 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 App Distribution SDK Android peut afficher une notification continue sur laquelle 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 fournissent 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 des 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.

3. Démarre une activité en plein écran qui permet au testeur de rédiger 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, sur laquelle il peut appuyer pour envoyer des commentaires. Lorsque vous configurez la notification, vous devez fournir du texte qui sera affiché au testeur avant qu'il n'envoie des commentaires, ainsi qu'un niveau d' interruption pour la notification (correspondant à l'importance du canal de notification importance). 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 un tel avis.

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.

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

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 des commentaires à l'aide du 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 permettre à vos testeurs de secouer leur appareil ou de prendre une capture d'écran. Lorsque vous déclenchez des commentaires, fournissez du texte qui sera affiché au testeur avant qu'il n'envoie des 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 fournir un tel avis.

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

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

Étape 4 : Créer et tester 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 les bibliothèques App Distribution complètes, et vérifiez que vous pouvez déclencher des commentaires à l'aide du mécanisme implémenté à l'étape 3 : Configurer les commentaires intégrés à l'application. Les commentaires ne sont pas envoyés en mode développeur.

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

   adb shell setprop debug.firebase.appdistro.devmode false

Test de bout en bout

Pour vérifier que votre application peut envoyer des commentaires, créez-la en tant que variante préliminaire incluant les bibliothèques complètes App Distribution, puis testez votre implémentation en procédant comme suit :

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

2. Distribuez la version de l'application à un compte auquel vous êtes autorisé à accéder.

3. Téléchargez l'application via l'application Web ou Android pour les testeurs de App Distribution.

4. Déclenchez des commentaires à l'aide du mécanisme implémenté en Étape 3 : Configurer les commentaires intégrés à l'application.

5. Assurez-vous d'être connecté au même compte que celui auquel vous avez distribué la version de l'application, puis envoyez des commentaires.

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

Pour savoir comment résoudre les problèmes courants, par exemple lorsque les testeurs ne peuvent pas démarrer de commentaires dans l'application, consultez la section 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 agir en conséquence :

• Firebase console

• Alertes par e-mail pour les nouveaux commentaires

• Outils tiers

Afficher et supprimer des commentaires dans la console Firebase

Vous pouvez examiner et supprimer les commentaires des utilisateurs, y compris les captures d'écran, en ouvrant l'onglet Commentaires des testeurs sous une version spécifique dans la Firebase console. 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 retiré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 du projet ou éditeur.

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 envoyé. Les membres du projet peuvent désactiver ces alertes individuellement.

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 for Firebase. Par exemple, vous pouvez écrire une fonction qui capture un événement d'alerte pour les nouveaux commentaires intégrés à l'application et publie les informations d'alerte sur un service tiers tel que Discord, Slack ou Jira.