Recopila comentarios de los verificadores

En esta guía, se describe cómo habilitar los comentarios directos desde la app con el SDK de Android para Firebase App Distribution, que es opcional. Con esto, los verificadores pueden enviar comentarios (incluidas capturas de pantalla) directamente desde la app.

Antes de comenzar

Si aún no lo has hecho, agrega Firebase a tu proyecto de Android.

Paso 1: Habilita la API de App Distribution Tester

  1. Abre la Consola de Google Cloud y selecciona tu proyecto de Firebase.

  2. En la API de Firebase App Testers, haz clic en Habilitar.

Paso 2: Agrega App Distribution a tu app

El SDK de Android de App Distribution se compone de las siguientes dos bibliotecas:

  • firebase-appdistribution-api es la biblioteca única de API, que puedes incluir en todas las variantes de compilación.
  • firebase-appdistribution es la implementación del SDK completa (opcional).

La biblioteca única de API permite que el código haga llamadas al SDK. Las llamadas no tendrán efecto si la implementación completa del SDK no está presente.

  1. Declara la dependencia del SDK de Android de App Distribution en tu Archivo Gradle (generalmente <project>/<app-module>/build.gradle.kts o <project>/<app-module>/build.gradle) de tu módulo (nivel de app) .

  2. Para evitar incluir la funcionalidad completa de actualización automática del SDK en tus compilaciones de Google Play, identifica las variantes de compilación, incluidos los tipos de compilación o las variantes de productos que distribuirás a través de App Distribution.

  3. Declara la dependencia del SDK de Android de App Distribution en el archivo Gradle (generalmente app/build.gradle) de tu módulo (nivel de app). Solo agrega la implementación completa del SDK a las variantes destinadas exclusivamente a pruebas previas al lanzamiento:

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

Paso 3: Configura los comentarios directos desde la app

Para recopilar comentarios de los verificadores, usa uno de los siguientes activadores para permitir que los verificadores inicien los comentarios:

  • Activador de notificación integrado: El SDK de Android de App Distribution puede mostrar una notificación continua que el verificador puede presionar desde cualquier lugar de la app. Usa este activador si quieres comenzar más rápido y no necesitas personalizar la forma en que los verificadores proporcionan comentarios.

  • Activador personalizado: Puedes proporcionar tu propio mecanismo de activación, como presionar un botón o un elemento de menú en la app, o agitar el dispositivo.

Cuando usas cualquiera de estos activadores y el verificador envía comentarios, el SDK de Android realiza las siguientes acciones:

  1. Toma una captura de pantalla de la actividad actual de la app.

  2. Ejecuta verificaciones para garantizar que el verificador haya habilitado las funciones de prueba del SDK. Si las funciones de prueba no están habilitadas, el SDK de Android le solicita al verificador que acceda a App Distribution con su Cuenta de Google.

  3. Inicia una actividad en pantalla completa que le permite al verificador escribir y enviar sus comentarios.

Opción 1: Activador de notificaciones

Usa showFeedbackNotification() para mostrar una notificación persistente o permanente en el dispositivo del verificador, que puede presionar para comenzar a entregar comentarios. Cuando configures la notificación, deberás proporcionar el texto que se le mostrará al verificador antes de que envíe los comentarios, así como un nivel de interrupción (correspondiente a la importancia del canal de notificaciones). Si quieres notificar a los verificadores sobre la recopilación y el procesamiento de sus datos de comentarios, puedes usar el texto para hacerlo.

Cuando usas showFeedbackNotification() y la app pasa a segundo plano, se oculta la notificación. Si quieres ocultar de forma explícita la notificación, usa cancelFeedbackNotification(). Te recomendamos que coloques showFeedbackNotification() en el método onCreate() de tu actividad principal.

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

Opción 2: Activador personalizado

Usa el método startFeedback() para iniciar los comentarios mediante el mecanismo que elijas. Por ejemplo, para activar los comentarios, puedes agregar el elemento de menú “Enviar comentarios” al menú de acciones de la app o permitir que los verificadores agiten su dispositivo o tomen una captura de pantalla. Cuando actives los comentarios, proporciona texto para que se le muestre al verificador antes de que envíe los comentarios. Si quieres notificar a los verificadores sobre la recopilación y el procesamiento de sus datos de comentarios, puedes usar este texto para hacerlo.

Kotlin+KTX 

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

Java 

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

Paso 4: Compila y prueba tu implementación

Pruebas locales

Para probar tu implementación sin tener que distribuir la app primero, sigue estos pasos:

  1. Habilita el modo de desarrollador en tu dispositivo local:

    adb shell setprop debug.firebase.appdistro.devmode true

  2. Compila tu app como una variante previa al lanzamiento que incluya las bibliotecas completas de App Distribution y prueba que puedes activar los comentarios con el mecanismo implementado en el apartado Paso 3: Configura los comentarios directos desde la app. Los comentarios no se envían en el modo de desarrollador.

  3. Después de realizar las pruebas, puedes inhabilitar el modo de desarrollador en tu dispositivo:

    adb shell setprop debug.firebase.appdistro.devmode false

Pruebas de extremo a extremo

Para probar que la app puede enviar comentarios, compílala como una variante previa al lanzamiento que incluya las bibliotecas completas de App Distribution. Sigue estos pasos para probar la implementación:

  1. Sube una nueva versión de la app a App Distribution.

  2. Distribuye la versión de la app a una cuenta a la que tengas permiso para acceder.

  3. Descarga la app usando la app web o de verificadores de Android de App Distribution.

  4. Activa los comentarios con el mecanismo que implementaste en el Paso 3: Configura los comentarios directos desde la app.

  5. Asegúrate de haber accedido con la misma cuenta a la que distribuiste la versión de la app y envía comentarios.

  6. Consulta tus comentarios en la tarjeta del nuevo lanzamiento en Firebase console.

Para obtener información sobre cómo resolver problemas habituales, como que los verificadores no puedan hacer comentarios en la app, consulta Cómo habilitar funciones de prueba con el SDK.

Paso 5: Administra los comentarios de los verificadores

Después de permitir que los verificadores envíen comentarios, puedes usar las siguientes herramientas para revisar esos comentarios y tomar medidas al respecto:

Consulta y borra los comentarios en Firebase console

Para revisar y borrar los comentarios de los usuarios, incluidas las capturas de pantalla, abre la pestaña Comentarios de verificadores de una versión específica en Firebase console. Los comentarios de los usuarios se organizan por versión para que puedas confirmar a cuál se aplican.

Para borrar los comentarios de los usuarios después de revisarlos, puedes hacer clic en el botón Borrar comentarios. Los comentarios que borres se quitarán de la versión.

Recibe alertas por correo electrónico sobre nuevos comentarios

Para obtener información de forma proactiva sobre los comentarios nuevos de los verificadores, puedes recibir alertas por correo electrónico cuando los envíen. Estas alertas incluyen los comentarios escritos que proporcionó el verificador y un vínculo a las capturas de pantalla que envió.

Para recibir alertas por correo electrónico de App Distribution a través de este mecanismo predeterminado, debes tener el permiso firebase.projects.update. Los siguientes roles incluyen este permiso obligatorio de forma predeterminada: Administrador de Firebase, o propietario o editor del proyecto.

De forma predeterminada, cada miembro del proyecto que tenga los permisos necesarios para recibir alertas por correo electrónico recibirá un correo cuando se envíe un nuevo informe de comentarios. Los miembros del proyecto pueden inhabilitar estas alertas de manera individual.

Para inhabilitar las alertas por correo electrónico, consulta Recibe alertas de Firebase.

Envía comentarios nuevos a herramientas de terceros

También puedes enviar alertas de App Distribution al canal de notificaciones preferido de tu equipo usando Cloud Functions for Firebase. Por ejemplo, puedes escribir una función que capture un evento de alerta para los comentarios nuevos desde la app y publique la información de la alerta en un servicio de terceros, como Discord, Slack o Jira.

Para configurar las funciones avanzadas de alertas con Cloud Functions for Firebase, sigue estos pasos:

  1. Configura Cloud Functions for Firebase, lo que incluye las siguientes tareas:

    1. Descarga Node.js y npm.

    2. Instala Firebase CLI y accede a ella.

    3. Inicializa Cloud Functions for Firebase con Firebase CLI.

  2. Escribe y, luego, implementa una función que capture un evento de alerta de comentarios desde la app de App Distribution y maneje la carga útil del evento (por ejemplo, que publique la información de alerta en un mensaje en Discord).

Para ver una función de ejemplo que te muestre cómo enviar comentarios nuevos a Jira, consulta esta muestra.

Para obtener información sobre todos los eventos de alerta que puedes capturar, consulta la documentación de referencia sobre las alertas de App Distribution.