Gérer des projets

Cette section présente les méthodes de l'API Apps Script que vous pouvez utiliser pour créer, lire, modifier et surveiller vos projets Apps Script. La page d'exemples Gestion de projet présente des exemples de requêtes de gestion d'API. La documentation de référence pour chaque méthode fournit des informations sur l'implémentation.

Présentation des méthodes d'API
Créer des projets

projects.create

Résultats : créez un projet de base vide, sans fichier de projet et avec un fichier manifeste de projet par défaut.

Options : vous pouvez fournir un titre de projet. Vous pouvez également créer un script lié en fournissant l'ID Google Drive d'un fichier Google Docs, Google Sheets, Google Forms ou Slides qui servira de parent au script.

Lire les métadonnées du projet

projects.get

Résultats : récupère un objet Project, qui représente les métadonnées du projet. Ces données incluent le titre du projet, l'ID du script, l'utilisateur créateur, l'heure de création et d'autres informations.

Lire le contenu du projet

projects.getContent

Résultats : renvoie un tableau d'objets File, un pour chaque fichier de code et HTML du projet. La liste inclut également le manifeste du projet sous forme de fichier JSON. Les objets File contiennent le contenu source du fichier (File.source) et d'autres métadonnées, comme une liste de fonctions dans le fichier (File.functionSet).

Options : vous pouvez spécifier la version du contenu à récupérer avec un paramètre de requête.

Modifier le contenu d'un projet

projects.updateContent

Résultats : modifie le contenu du fichier dans un projet de script. Vous fournissez le nouveau contenu sous la forme d'un tableau d'objets File. L'un de ces objets File doit avoir un type JSON et représenter le nouveau fichier manifeste du projet de script. Le nouveau contenu est stocké en tant que version HEAD du projet. Il est utilisé lorsque le script s'exécute en tant que déclencheur, dans l'éditeur de script, en mode Aperçu du module complémentaire ou en tant qu'application Web ou API Apps Script en mode Développement.

Remarque : Lorsque vous mettez à jour le contenu d'un projet de script, la pratique courante consiste à envoyer d'abord une requête projects.getContent pour récupérer un tableau des File existants, apporter les modifications souhaitées à ces objets, puis utiliser les File comme entrée pour une requête projects.updateContent.

Avertissement : Le nouveau contenu remplace tous les fichiers existants dans le projet de script. Les fichiers non mis à jour par la demande sont supprimés.

Lire les métriques du projet

projects.getMetrics

Résultats : lire certaines métriques sur un projet. Ces métriques incluent le nombre d'utilisateurs, le nombre total d'exécutions, le nombre total d'erreurs d'exécution et d'autres détails. Utilisez un MetricType pour spécifier les informations que vous demandez.

Options : limitez les résultats à des déploiements ou des fonctions de script spécifiques à l'aide d'un MetricsFilter. Vous pouvez également définir un intervalle de métrique spécifique à l'aide d'une MetricsIntervalConfig.