Améliorez l'expérience globale de vos utilisateurs en suivant ces guides de conception de modules complémentaires.
Bonnes pratiques générales
Nous vous encourageons à suivre les bonnes pratiques ci-dessous pour tous les modules complémentaires que vous développez.
Déterminer la propriété du module complémentaire avant de commencer
Les modules complémentaires sont définis par des projets Apps Script, qui doivent appartenir à un compte spécifique ou être placés dans un Drive partagé. Avant de coder un module complémentaire, déterminez le compte qui doit être propriétaire du projet et celui qui doit agir en tant qu'éditeur. Déterminez également les comptes qui doivent agir en tant que collaborateurs et assurez-vous qu'ils ont accès au projet de script et au projet Google Cloud associé .
Étendre Google Workspace, ne pas le répliquer
Les modules complémentaires sont conçus pour fournir de nouvelles fonctionnalités aux applications Google Workspace qu'ils étendent ou pour automatiser des tâches complexes. Les modules complémentaires qui ne font que répliquer des fonctionnalités déjà présentes dans l' application ou qui n'apportent pas d'améliorations significatives à un workflow ne sont pas susceptibles d'être approuvés lors de l'examen des modules complémentaires pour publication.
Limiter les champs d'application
Lorsque vous définissez explicitement vos champs d'application, choisissez toujours l'ensemble de champs d'application le
moins permissif possible. Par exemple, ne demandez pas à votre module complémentaire d'accéder en lecture/écriture au calendrier de l'utilisateur avec le champ d'application https://www.googleapis.com/auth/calendar s'il n'a besoin que d'un accès en lecture seule. Pour un accès en lecture seule, utilisez le champ d'application https://www.googleapis.com/auth/calendar.readonly.
Éviter de trop dépendre des bibliothèques
L'utilisation de bibliothèques Apps Script peut ralentir l'exécution de votre module complémentaire par rapport à si tout le code Apps Script était contenu dans un seul projet de script. Bien que les bibliothèques Apps Script fonctionnent dans les modules complémentaires, vous risquez de constater une baisse des performances si vous les utilisez. Évitez d'inclure des bibliothèques inutiles dans votre projet et réfléchissez à des moyens de réduire la dépendance de votre module complémentaire à leur égard.
La latence décrite ci-dessus ne s'applique qu'aux projets Apps Script utilisés comme bibliothèques côté serveur. Vous pouvez utiliser librement des bibliothèques JavaScript côté client comme jQuery sans rencontrer cette latence.
Bonnes pratiques concernant les modules complémentaires de l'éditeur
Les bonnes pratiques suivantes ne s'appliquent qu'aux modules complémentaires de l'éditeur.
Placer le code HTML de l'interface et le code JavaScript côté client dans leurs propres fichiers de script
Vous pouvez créer plusieurs fichiers de script dans un projet Apps Script. Il est plus facile de gérer un module complémentaire complexe si vous placez le code HTML et le code JavaScript qui définissent les barres latérales et les boîtes de dialogue du module complémentaire dans des fichiers de script dédiés.
Tester minutieusement dans différents modes d'autorisation
Lorsque vous testez votre module complémentaire, veillez à essayer des configurations avec différents fichiers et différents états d'autorisation.