Prácticas recomendadas

Mejora la experiencia de tus usuarios experiencia general siguiendo estas guías para Diseño de complementos de Google Meet

Versión preliminar para desarrolladores: Está disponible como parte del Programa de Versión preliminar para desarrolladores de Google Workspace, que otorga acceso anticipado a ciertas funciones.

Prácticas recomendadas para la autorización

Recomendamos que sigas estas prácticas recomendadas para cualquier Complementos de Google Meet que requieren autenticación o autorización

Usar Acceso con Google

Muchos usuarios de los complementos de Google Workspace ya habrán accedido a Google antes. uniéndote a la reunión. Por lo tanto, tener Acceso con Google que está disponible como opción puede ahorrarles a los usuarios varios clics al revisar flujo de acceso.

Abrir la página de acceso de terceros en una ventana nueva

Además del Acceso con Google, tu aplicación puede ofrecer funciones de acceso con mecanismos de control de acceso clave. Si es así, usa una ventana de diálogo en lugar de abrir una página de acceso en una pestaña nueva. De esta manera, el usuario aún puede ver y regresar a la de Google Meet, y recibirá menos clics en general.

Nota: Las páginas de acceso de terceros para los complementos de Google Meet no tienen la misma implementación requisitos como complementos de Google Workspace. Puedes abrir una ventana de acceso directamente desde tu iframed y mantener la integridad de su aplicación. Tampoco se admiten los complementos de Meet Acceso al complemento de Google Workspace tarjetas. Sin embargo, debes redireccionar a los usuarios para que completen la verificación de autenticación y autorización en tu infraestructura.

Solicita correctamente los alcances de las APIs de Google

Si tu complemento de Meet llama a las APIs de Google, entonces Debes proporcionar una lista completa de documentos permisos que requiere tu complemento. Esto se hace en la Página de configuración de apps de Google Workspace Marketplace Después de agregar estos permisos, se les mostrará un mensaje a tus usuarios cuando instalen tu Complemento de Meet que indica a los usuarios qué tipo de datos están lo que permite que acceda tu app.

Antes de publicar tu complemento, también debes configurar el consentimiento de OAuth, pantalla. Esto requiere agregar exactamente los mismos alcances de autorización de tu Configuración de las apps de Google Workspace Marketplace. Configura el OAuth la pantalla de consentimiento también requiere configurar la información de desarrollo de la marca, la política de privacidad y las Condiciones del Servicio, que se muestran cuando se solicitan alcances. Para publicar públicamente, toda esta información se debe enviar para verificación.

Nota: A diferencia de los complementos generales de Google Workspace, no es necesario Complementos de Meet para incluir oauthScopes en el manifiesto.

Cuando escribas código para llamar a las APIs de Google Workspace, sigue las instrucciones de JavaScript Guía de inicio rápido es la forma más fácil de comenzar. Este enfoque cumple con las prácticas recomendadas para con el Acceso con Google y ventanas de diálogo. Ten en cuenta que inicializar el token, cliente en JavaScript requiere solicitar por separado los alcances a los que la aplicación usa en el tiempo de ejecución. Para brindar la mejor experiencia del usuario, estos permisos solicitados deben coincidir con los de la configuración de apps de Google Workspace Marketplace . Esta redundancia proporciona un resguardo para manejar el caso en el que un usuario ha revocado permisos.

Prácticas recomendadas de mantenimiento

Las siguientes prácticas recomendadas son para escritura aplicaciones web, pero son particularmente importantes al escribir cualquier Complementos de Meet.

Usa la versión más reciente del SDK de complementos de Google Meet

El SDK de complementos de Meet se actualiza con regularidad. El SDK cumple con lo siguiente: control de versiones semántico. Para encontrar la versión más reciente, haz lo siguiente:

• Cuando se usa gstatic: la versión más reciente del SDK se encuentra en el SDK de gstatic. URL que se encuentra en las instrucciones para usar el SDK.
• Cuando uses npm: Ejecuta npm update @googleworkspace/meet-add-ons desde adentro el directorio que contiene los package.json para el sitio web que aloja el complemento de Meet.

Crear un proyecto de etapa de pruebas de Google Cloud

Una vez que el complemento de Google Meet esté publicado en la Google Workspace Marketplace, cualquier implementación nueva del complemento de Google Meet se actualiza disponibles para los usuarios de Meet. Los usuarios verán estas actualizaciones en cuanto vacían su caché o la caché vence. Por lo tanto, recomendamos no enviando los cambios al sitio de producción hasta que se prueben exhaustivamente

Importante: Es posible que los usuarios noten una demora en las actualizaciones de tu de Meet según las políticas de caché de tu y mantener la integridad de su aplicación. Establece el tiempo de caducidad de la caché en un valor adecuado para tu una aplicación (idealmente, no más de 24 horas) para garantizar las experiencias del usuario. Los usuarios también ven una versión nueva si vacían su caché. manualmente.

Para evitar la implementación directamente en producción, recomendamos crear un Proyecto de Google Cloud que se publica de forma privada a tu organización. Este proyecto de Cloud alojará los entornos de etapa de pruebas entornos de desarrollo para tu complemento de Meet. Acceso para este proyecto de Cloud deben limitarse a un equipo más pequeño directamente en el desarrollo del complemento.

Para crear estos entornos alternativos para tu complemento, sigue estos pasos: primero debes alojar entornos alternativos de la aplicación web que contiene tu complemento en un dominio que te pertenece. Luego, puedes crear entornos alternativos para tus complemento de Meet agregando más Deployment a tu proyecto de etapa de pruebas de Google Cloud. Estas nuevas implementaciones deberían tener que apuntan a entornos alternativos de tu aplicación web. Luego, recomendamos que instales cada complemento entorno de la siguiente manera:

• Staging: Publica la versión de la etapa de pruebas de forma privada. para que cualquier miembro de su organización pueda ayudar con las pruebas.
• Desarrollo: Haz clic en Instalar en la columna Acciones para instalar la Descubre la versión de desarrollo del complemento para tu cuenta.

Cómo escribir pruebas

Antes de implementar tu complemento de Meet en un entorno de desarrollo entorno, recomendamos escribir pruebas de unidades. Las pruebas de unidades deben incluir lo siguiente:

• Simulación del SDK de complementos de Meet y, luego, verificar que el El complemento de Meet llama a las funciones del SDK como se espera.
• Realiza pruebas de unidades de todas las funciones no relacionadas con el SDK de tu con tu framework de prueba web preferido.

Prácticas recomendadas para la experiencia del usuario

Las siguientes prácticas recomendadas ayudan a crear un complemento de Meet sean más intuitivas y refinadas.

Administra todo el estado inicial en el panel lateral

Te recomendamos que configures el complemento en función de lo siguiente: acciones que realizan los usuarios en el panel lateral. Para ello, se debe configurar el inicio de la colaboración estado en JavaScript: Todos los datos que se incluyen en la CollaborationStartingState el iniciador del complemento (en general, (el organizador de la reunión) en el panel lateral. Puedes pensar en la primera vista panel lateral como un formulario que controla la configuración de tu complemento.

Cierra el panel lateral cuando no lo uses

Después de iniciar la actividad llamando startCollaboration, solo debes mantener el panel lateral abierto si es una parte esencial de la experiencia del usuario para tu el complemento de Google Meet. Puedes cerrar el panel lateral una vez que la página principal se abre llamando a unloadSidePanel

Promociona tu complemento de Meet compartiendo pantalla

Los complementos de Meet ofrecen una experiencia más completa que compartir pantalla. Sin embargo, muchos usuarios están acostumbrados a usar la función de compartir pantalla . Si un usuario comparte una pestaña que muestra el sitio web que aloja tu complemento de Meet, se puede configurar para lo siguiente: mostrar un banner a todos los participantes de la llamada en el que se les indique que instalen o usen el el complemento de Meet correspondiente. Para obtener más información, consulta promoción de tu complemento en la pantalla uso compartido.