Best practice

Migliora le informazioni in generale seguendo queste guide la progettazione del componente aggiuntivo Google Meet.

Best practice per l'autorizzazione

Ti invitiamo a utilizzare le seguenti best practice per qualsiasi Componenti aggiuntivi di Google Meet che richiedono l'autenticazione o l'autorizzazione.

Utilizzare Accedi con Google

Molti utenti dei componenti aggiuntivi di Google Workspace avranno già eseguito l'accesso a Google in precedenza partecipare alla riunione. Pertanto, la funzionalità Accedi con Google disponibile come opzione consente di far risparmiare agli utenti diversi clic durante la flusso di accesso.

Apri la pagina di accesso di terze parti in una nuova finestra

Oltre al servizio Accedi con Google, la tua applicazione potrebbe offrire un accesso aggiuntivo i meccanismi della ricerca di informazioni. In questo caso, utilizza una finestra di dialogo anziché aprire una pagina di accesso in un nuova scheda. In questo modo, l'utente può comunque visualizzare e tornare Meet, quindi riceverà meno clic complessivi.

Ambiti di richiesta corretti per le API di Google

Se il componente aggiuntivo Meet chiama le API di Google: è necessario fornire un elenco completo di ambiti richiesto dal componente aggiuntivo. Questa operazione viene eseguita pagina di configurazione dell'app di Google Workspace Marketplace. Dopo l'aggiunta ambiti, agli utenti viene mostrata una richiesta quando installano il componente aggiuntivo Meet, che comunica agli utenti il tipo di dati che stanno consentendo l'accesso alla tua app.

Prima di pubblicare il componente aggiuntivo, devi anche configurare la funzione Consenso OAuth schermo. Devi aggiungere esattamente gli stessi ambiti di autorizzazione dal tuo Configurazione app di Google Workspace Marketplace. Configurazione del protocollo OAuth schermata per il consenso richiede anche l'impostazione delle informazioni di branding, e i termini di servizio, che verranno visualizzati quando vengono richiesti gli ambiti. Per pubblicare pubblicamente, tutte queste informazioni devono essere inviate verifica.

Quando scrivi il codice per chiamare le API Google Workspace, segui le istruzioni del codice JavaScript Guida rapida è il modo più facile per iniziare. Questo approccio è conforme alle best practice per utilizzando Accedi con Google e le finestre di dialogo. Tieni presente che l'inizializzazione del token cliente in JavaScript richiede separatamente la richiesta degli ambiti in cui l'applicazione effettivamente utilizzato in fase di esecuzione. Per una migliore esperienza utente, questi ambiti richiesti devono corrispondere a quelli presenti nella configurazione app di Google Workspace Marketplace . Questa ridondanza fornisce un fallback per gestire il caso in cui un utente ha revocato ambiti.

Best practice di manutenzione

Le seguenti best practice riguardano la scrittura di elementi applicazioni web, ma sono particolarmente importanti quando si scrive Componenti aggiuntivi di Meet.

Utilizzare la versione più recente dell'SDK dei componenti aggiuntivi di Google Meet

L'SDK dei componenti aggiuntivi di Meet viene aggiornato regolarmente. L'SDK rispetta controllo delle versioni semantico. Per trovare la versione più recente:

  • Quando utilizzi gstatic: l'ultima versione dell'SDK è contenuta nel file gstatic. URL presente nelle istruzioni per l'utilizzo dell'SDK.
  • Quando utilizzi npm: esegui npm update @googleworkspace/meet-add-ons dall'interno la directory contenente package.json per il sito web che ospita il componente aggiuntivo di Meet.

Creare un progetto Google Cloud temporaneo

Una volta che il componente aggiuntivo di Google Meet è pubblicato nella Google Workspace Marketplace tutti i nuovi deployment del tuo componente aggiuntivo Google Meet vengono immediatamente disponibili per gli utenti di Meet. Gli utenti vedranno questi aggiornamenti non appena svuota la cache o la cache scade. Pertanto, consigliamo di non trasferire le modifiche al sito di produzione finché non vengono testate accuratamente.

Per evitare il deployment diretto in produzione, consigliamo di creare un'istanza progetto Google Cloud pubblicato privatamente per la tua organizzazione. Questo progetto Cloud ospiterà sia la gestione temporanea ambienti di sviluppo per il tuo componente aggiuntivo Meet. Accesso per questo progetto Cloud dovrebbero essere limitati a un team più piccolo lavorando direttamente allo sviluppo del componente aggiuntivo.

Per creare questi ambienti alternativi per il tuo componente aggiuntivo, devi prima ospitare ambienti alternativi della tua applicazione web, contiene il tuo componente aggiuntivo, su un dominio di tua proprietà. Poi, puoi creare ambienti alternativi per i tuoi il componente aggiuntivo Meet aggiungendo deployment al tuo progetto Google Cloud temporaneo. Questi nuovi deployment dovrebbero avere manifest che puntano ad ambienti alternativi della tua applicazione web. Successivamente, ti consigliamo di installare ogni componente aggiuntivo dell'ambiente di rete come segue:

  • Staging: pubblica privatamente la versione temporanea in modo che chiunque nella tua organizzazione possa aiutarti con i test.
  • Sviluppo: fai clic su Installa nella colonna Azioni per installare la versione di sviluppo dei componenti aggiuntivi Meet solo per il tuo account.

Scrivere test

Prima di eseguire il deployment del componente aggiuntivo Meet in un ambiente di sviluppo consigliamo di scrivere i test delle unità. I test delle unità devono includere:

  • Simulazione dell'SDK dei componenti aggiuntivi di Meet, quindi verifica che il parametro Il componente aggiuntivo Meet chiama le funzioni dell'SDK come previsto.
  • Test delle unità di tutte le funzionalità non correlate all'SDK del tuo con il framework di test web che preferisci.

Best practice per l'esperienza utente

Le seguenti best practice aiutano a creare un componente aggiuntivo di Meet più intuitivi e perfezionati.

Gestisci tutto lo stato iniziale nel riquadro laterale

Ti consigliamo vivamente di configurare il componente aggiuntivo in base Azioni utente eseguite nel riquadro laterale. Per farlo, imposta la collaborazione in JavaScript. Tutti i dati inseriti nel CollaborationStartingState deve essere impostato dall'iniziatore del componente aggiuntivo (solitamente l'organizzatore della riunione) nel riquadro laterale. Puoi pensare alla prima veduta riquadro laterale per controllare l'impostazione come componente aggiuntivo.

Chiudi il riquadro laterale quando non in uso

Dopo aver avviato l'attività chiamando startCollaboration, devi tenere solo il riquadro laterale aprire se è una parte essenziale dell'esperienza utente per il tuo Componente aggiuntivo Google Meet. Puoi chiudere il riquadro laterale una volta che la finestra principale sia aperto chiamando unloadSidePanel

Promuovi il tuo componente aggiuntivo di Meet tramite la condivisione schermo

I componenti aggiuntivi di Meet offrono un'esperienza più ricca rispetto alla condivisione dello schermo. Tuttavia, molti utenti sono abituati a usare la condivisione schermo di Meet funzionalità. Se un utente condivide una scheda che mostra il sito web che ospita Meet, può essere configurato per mostrare un banner a tutti i partecipanti alla chiamata invitandoli a installare o utilizzare componente aggiuntivo di Meet corrispondente. Per ulteriori informazioni, vedi promuovere il componente aggiuntivo tramite lo schermo condivisione.