Mejora la experiencia de tus usuarios experiencia general siguiendo estas guías sobre el diseño de tu producto.
Prácticas recomendadas generales
Te sugerimos que sigas las siguientes prácticas recomendadas para todos los complementos que a desarrollar código.
Determinar la propiedad de los complementos antes de comenzar
los complementos se definen por proyectos de Apps Script, que deben ser propiedad de una persona o colocarlos en una unidad compartida. Antes de programar un complemento, determina qué cuenta debe ser propietaria del proyecto. qué cuenta actúa como su publicador. Determina también qué cuentas deben tomarse. como colaboradores y asegurarse de que esas cuentas tengan acceso a la secuencia de comandos el proyecto y su conjunto de datos Proyecto de Cloud Platform.
Extiende Google Workspace, no lo repliques
los complementos están destinados a proporcionar nuevas capacidades al las aplicaciones de Google Workspace que extienden automatizar tareas complejas. que simplemente replican la funcionalidad aplicación o aquellas que no replican mejoras significativas en un flujo de trabajo no superen la revisión de complementos de publicación.
Asegúrate de que los permisos sean limitados
Cuando definas tus alcances explícitamente,
elegir el conjunto de alcances
menos permisivo posible. Por ejemplo, no
hacer que su complemento solicite acceso completo al Calendario del usuario con el
Permiso https://www.googleapis.com/auth/calendar si solo necesita lectura
el acceso a los datos. Para el acceso de solo lectura, usa el
Permiso de https://www.googleapis.com/auth/calendar.readonly.
Evita depender demasiado de las bibliotecas
El uso de las bibliotecas de Apps Script puede hacer que las complemento para ejecutarse más lentamente si todo el código de Apps Script estuviera contenido en un solo proyecto de secuencia de comandos. Aunque las bibliotecas de Apps Script funcionan en complementos, es posible que experimentes rendimiento reducciones si las usas. Evita incluir bibliotecas innecesarias en tu y analizar formas de reducir la dependencia de tu complemento en ellos.
La latencia descrita anteriormente solo se aplica a los proyectos de Apps Script que se usan como bibliotecas del servidor. Puedes usar bibliotecas de JavaScript del cliente, como jQuery libremente sin encontrar esta latencia.
Prácticas recomendadas para el complemento de Google Workspace
Las siguientes prácticas recomendadas solo se aplican a de los complementos de Google Workspace y su uso del Servicio de tarjetas.
Usa solo unas pocas tarjetas
Si el complemento usa demasiadas tarjetas, la configuración de navegación se vuelve complejo y difícil de administrar.
Evita el impulso de crear más tarjetas de las necesarias.
Usa las funciones de creación de widgets
Cuando escribes código que crea Card
o algún otro objeto complejo de IU, considera colocar ese código en su propia función.
Esta función de creación solo debe compilar el objeto y mostrarlo. Esto permite
volverás a generar rápidamente ese objeto cada vez que se deba actualizar la IU. Recuerda
para llamar a build() después de usar las clases de compilador en la
Servicio de tarjetas
Usa tarjetas simples
Si una tarjeta determinada tiene demasiados widgets, puede llenar demasiado de la pantalla y se vuelven menos útiles. Mientras que las secciones grandes de las tarjetas se renderizan como elementos de IU que se pueden contraer, Esto oculta información al usuario. Intenta optimizar el complemento exactamente qué necesita el usuario y no más.
Cómo usar tarjetas de error
Crea tarjetas para las condiciones de error. Si tu complemento produce un error, debería mostrar una tarjeta con la información del error y las instrucciones para corregirlo si es posible. Por ejemplo, si tu complemento no se puede conectar a una cuenta que no es de Google servicio debido a que la autorización falló, muestra una tarjeta que indique esto y pregunta al usuario para verificar la información de la cuenta que se está usando.
Cómo escribir pruebas y mensajes de prueba
Deberías probar minuciosamente todos los complementos que crees. Compila funciones de prueba que crear tarjetas y widgets usando datos de prueba y, luego, verificar que los objetos estén crearse como se esperaba.
Cuando uses funciones de devolución de llamada de acción, por lo general, debes construir un objeto de respuesta. Puedes usar sentencias como lo siguiente para verificar que las respuestas se construyen de forma correcta:
Logger.log(response.printJson());
Ejecutar las funciones de prueba que crees directamente desde Apps Script con el menú Run. Cuando tengas un complemento viable que funcione, Asegúrate de instalar la versión no publicada. para que puedas probarlo.
Usa datos de prueba apropiados para cada aplicación host que extienda el complemento. Para Por ejemplo, si el complemento extiende Gmail, es probable que necesites algunos correos electrónicos de prueba. y sus IDs de mensaje, de modo que puedas asegurarte de que el complemento funcione como cuando se les entrega un contenido diferente. Puedes obtener el ID de mensaje de un mensaje proporcionado con una lista de los mensajes Users.messages.list de la API de Gmail o si usas la secuencia de comandos Servicio de Gmail.
Prácticas recomendadas para las reuniones de Calendario
Si tu complemento integra herramientas reunión de calendario del Calendario de Google, sigue estas prácticas recomendadas adicionales:
Mantén tu onCreateFunction liviana
Cada onCreateFunction
que defines en tu manifiesto se llama de forma síncrona cuando un usuario intenta
crear una solución de conferencia de ese tipo. Asegúrate de que estas funciones solo hagan lo siguiente:
y la cantidad mínima de trabajo
necesaria para crear la conferencia. Hacer demasiado en estas
funciones pueden causar una experiencia del usuario lenta para tu complemento.
Usa los campos ConferenceData adecuados para los datos de conferencias.
Cuando compilas
ConferenceData
objetos, puedes completarlos con detalles sobre la conferencia (acceso
códigos, números de teléfono, PINs, URIs, etcétera). Asegúrate de usar los
Campo EntryPoint
para esta información. No coloques estos detalles en el archivo ConferenceData.
en el campo de notas.
No agregar detalles de la reunión al evento de Calendario de Google
El complemento no necesita agregar información sobre aplicaciones de terceros conferencias a la descripción del evento de Calendario de Google. El Calendario de Google esto automáticamente cuando sea necesario.