Prácticas recomendadas

Sigue estas guías de diseño de complementos para mejorar la experiencia general de los usuarios.

Prácticas recomendadas generales

Te recomendamos que uses las siguientes prácticas recomendadas para todos los complementos que desarrolles.

Determina la propiedad del complemento antes de comenzar

Los complementos se definen mediante proyectos de Apps Script, que deben ser propiedad de una cuenta específica o colocarse en una unidad compartida. Antes de codificar un complemento, determina qué cuenta debe ser propietaria del proyecto y qué cuenta actúa como su publicador. También determina qué cuentas actuarán como colaboradores y asegúrate de que tengan acceso al proyecto de secuencia de comandos y a su proyecto de Google Cloud asociado.

Extiende Google Workspace, no lo repliques

Los complementos están diseñados para proporcionar nuevas capacidades a las aplicaciones de Google Workspace que extienden o para automatizar tareas complejas. Es probable que los complementos que solo replican la funcionalidad que ya está dentro de la aplicación o los que no realizan mejoras significativas en un flujo de trabajo no pasen la revisión de complementos para su publicación.

Mantén los alcances limitados

Cuando definas tus alcances de forma explícita, elige siempre el conjunto de alcances menos permisivo posible. Por ejemplo, no hagas que tu complemento solicite acceso completo al Calendario del usuario con el alcance https://www.googleapis.com/auth/calendar si solo necesita acceso de lectura. Para el acceso de solo lectura, usa el alcance https://www.googleapis.com/auth/calendar.readonly.

Evita depender demasiado de las bibliotecas

El uso de bibliotecas de Apps Script puede hacer que tu complemento se ejecute más lento que 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 reducciones de rendimiento si las usas. Evita incluir bibliotecas innecesarias en tu proyecto y considera formas de reducir la dependencia de tu complemento en ellas.

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 complementos del editor

Las siguientes prácticas recomendadas solo se aplican a los complementos del editor.

Coloca el HTML de la interfaz y el JavaScript del cliente en sus propios archivos de secuencia de comandos

Puedes crear varios archivos de secuencia de comandos en un proyecto de Apps Script. Es más fácil administrar un complemento complejo si colocas el HTML y JavaScript que definen las barras laterales y los diálogos del complemento en archivos de secuencia de comandos dedicados a ellos.

Realiza pruebas exhaustivas en diferentes modos de autorización

Cuando pruebes tu complemento, asegúrate de probar configuraciones que tengan diferentes archivos y diferentes estados de autorización.