Questa guida descrive come attivare il feedback in-app utilizzando l'SDK Android Firebase App Distribution facoltativo, in modo che i tester possano inviare feedback (inclusi screenshot) direttamente nell'app.
Prima di iniziare
Se non l'hai già fatto, aggiungi Firebase al tuo progetto Android.
Passaggio 1: attiva l'API App Distribution Tester
Apri la console Google Cloud e seleziona il tuo progetto Firebase.
Nella sezione API Firebase App Testers, fai clic su Abilita.
Passaggio 2: aggiungi App Distribution alla tua app
L'SDK Android App Distribution è costituito da due librerie:
firebase-appdistribution-api: la libreria solo API, che puoi includere in tutte le varianti di build.firebase-appdistribution: l'implementazione completa dell'SDK (facoltativo).
La libreria solo API consente al codice di effettuare chiamate all'SDK. Le chiamate non hanno alcun effetto se l'implementazione completa dell'SDK non è presente.
Dichiara la dipendenza per l'SDK Android App Distribution nel file Gradle del modulo (a livello di app) (solitamente
<project>/<app-module>/build.gradle.ktso<project>/<app-module>/build.gradle).Per evitare di includere la funzionalità di aggiornamento automatico dell'implementazione completa dell'SDK nelle build di Google Play, identifica le varianti di build, inclusi i tipi di build o i gusti del prodotto che distribuirai tramite App Distribution.
Dichiara la dipendenza per l'SDK Android App Distribution nel file Gradle (a livello di app) del modulo (solitamente
app/build.gradle). Aggiungi l'implementazione completa dell'SDK solo alle varianti destinate esclusivamente ai test pre-release: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") }
Passaggio 3: configura il feedback in-app
Per raccogliere i feedback dei tester, utilizza uno dei seguenti trigger per consentire ai tester di avviare il feedback:
Trigger di notifica integrato: l'SDK Android App Distribution può mostrare una notifica continua che il tester può toccare da qualsiasi punto dell'app. Utilizza questo trigger se vuoi iniziare più rapidamente e non hai bisogno di personalizzare il modo in cui i tester forniscono feedback.
Trigger personalizzato: puoi fornire il tuo meccanismo di trigger, ad esempio toccando un pulsante o una voce di menu nella tua app o scuotendo il dispositivo.
Quando utilizzi uno di questi trigger e il tester invia feedback, l'SDK Android esegue le seguenti azioni:
Acquisisce uno screenshot dell'attività corrente dell'app.
Esegue controlli per assicurarsi che il tester abbia abilitato le funzionalità di test dell'SDK. Se le funzionalità di test non sono attivate, l'SDK Android chiede al tester di accedere a App Distribution con il proprio Account Google.
Avvia un'attività a schermo intero che consente al tester di scrivere e inviare il proprio feedback.
Opzione 1: condizione di attivazione della notifica
Utilizza showFeedbackNotification() per visualizzare una notifica persistente o
in corso
sul dispositivo del tester, che può toccare per avviare il feedback.
Quando configuri la notifica, devi fornire un testo che verrà
mostrato al tester prima che invii il feedback e un livello di
interruzione per la notifica (corrispondente all'importanza del canale di notifica). Se vuoi
comunicare ai tester la raccolta e il trattamento dei dati
dei feedback, puoi utilizzare il testo per fornire questa comunicazione.
Quando utilizzi showFeedbackNotification() e l'app passa in background, la notifica viene nascosta. Se vuoi nascondere esplicitamente
la notifica, utilizza cancelFeedbackNotification(). Ti consigliamo di
inserire showFeedbackNotification() in onCreate() dell'attività principale.
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);
}
}
Opzione 2: trigger personalizzato
Utilizza il metodo startFeedback() per avviare il feedback utilizzando un meccanismo a tua
scelta. Ad esempio, per attivare il feedback potresti aggiungere una voce di menu "Invia feedback" al menu delle azioni dell'app o consentire ai tester di scuotere il dispositivo o acquisire uno screenshot.
Quando attivi il feedback, fornisci un testo che verrà mostrato al tester
prima che invii il feedback. Se vuoi fornire un avviso ai tuoi tester
in merito alla raccolta e al trattamento dei dati di feedback, puoi utilizzare questo testo
per fornire l'avviso.
Kotlin
Firebase.appDistribution.startFeedback(R.string.feedbackMessage)
Java
FirebaseAppDistribution.getInstance().startFeedback(R.string.feedbackMessage);
Passaggio 4: crea e testa l'implementazione
Test locale
Per testare l'implementazione senza dover prima distribuire l'app, segui questi passaggi:
Attiva la modalità sviluppatore sul tuo dispositivo locale:
adb shell setprop debug.firebase.appdistro.devmode true
Crea la tua app come variante di pre-release che includa le librerie App Distribution complete e verifica di poter attivare il feedback utilizzando il meccanismo implementato nel passaggio 3: configura il feedback in-app. Il feedback non viene inviato quando è attiva la modalità sviluppatore.
Dopo il test, puoi disattivare la modalità sviluppatore sul tuo dispositivo:
adb shell setprop debug.firebase.appdistro.devmode false
Test end-to-end
Per verificare che la tua app possa inviare feedback, crea la tua app come variante pre-release che includa le librerie App Distribution complete e testa l'implementazione seguendo questi passaggi:
Carica una nuova release dell'app su App Distribution.
Distribuisci la release dell'app a un account a cui hai l'autorizzazione di accedere.
Scarica l'app tramite il sito web o l'app di test per Android di App Distribution.
Attiva il feedback utilizzando il meccanismo implementato nel passaggio 3: configura il feedback in-app.
Assicurati di aver eseguito l'accesso con lo stesso account su cui hai distribuito la release dell'app e invia un feedback.
Visualizza il tuo feedback nella scheda della nuova release nella console Firebase.
Per scoprire come risolvere i problemi comuni, ad esempio l'impossibilità per i tester di avviare il feedback nell'app, consulta la sezione Attivare le funzionalità di test con l'SDK.
Passaggio 5: gestisci il feedback dei tester
Dopo aver consentito ai tester di inviare feedback, puoi utilizzare i seguenti strumenti per esaminare e gestire i feedback:
Visualizzare ed eliminare il feedback nella console Firebase
Puoi esaminare ed eliminare il feedback degli utenti, inclusi gli screenshot, aprendo la scheda Feedback dei tester in una release specifica nella console Firebase. Il feedback degli utenti è organizzato per release, in modo da poter confermare la versione a cui si applica il feedback.
Dopo aver esaminato il feedback degli utenti, puoi eliminarlo facendo clic sul pulsante Elimina feedback. Il feedback eliminato viene rimosso dalla tua release.
Ricevere avvisi via email per i nuovi feedback
Per conoscere in modo proattivo i nuovi feedback dei tester, puoi ricevere avvisi via email quando un tester invia un feedback. L'avviso via email include il feedback scritto fornito dal tester e un link agli eventuali screenshot inviati.
Per ricevere avvisi email di App Distribution tramite questo meccanismo predefinito, devi disporre dell'autorizzazione firebase.projects.update. I seguenti ruoli includono questa autorizzazione
obbligatoria per impostazione predefinita: Amministratore Firebase
o Proprietario o Editor del progetto.
Per impostazione predefinita, ogni membro del progetto che dispone delle autorizzazioni necessarie per ricevere avvisi via email riceverà un'email quando viene inviato un nuovo report di feedback. I membri del progetto possono disattivare individualmente questi avvisi.
Per disattivare gli avvisi via email, consulta Ricevere avvisi Firebase.
Inviare nuovi feedback a strumenti di terze parti
Puoi anche inviare avvisi di App Distribution al canale di notifica preferito del tuo team utilizzando Cloud Functions for Firebase. Ad esempio, puoi scrivere una funzione che acquisisce un evento di avviso per il nuovo feedback in-app e pubblica le informazioni sull'avviso in un servizio di terze parti come Discord, Slack o Jira.
Per configurare funzionalità di avviso avanzate utilizzando Cloud Functions for Firebase, segui questi passaggi:
Configura Cloud Functions for Firebase, che include le seguenti attività:
Scarica Node.js e npm.
Installa ed esegui l'accesso alla CLI Firebase.
Inizializza Cloud Functions for Firebase utilizzando la CLI Firebase.
Scrivi ed esegui il deployment di una funzione che acquisisce un evento di avviso di feedback in-app da App Distribution e gestisce il payload dell'evento (ad esempio, pubblica le informazioni sull'avviso in un messaggio su Discord).
Per visualizzare una funzione di esempio che mostra come inviare nuovi feedback a Jira, consulta questo esempio.
Per scoprire tutti gli eventi di avviso che puoi acquisire, consulta la documentazione di riferimento per gli avvisi App Distribution.