Les services avancés d'Apps Script permettent aux développeurs expérimentés de se connecter à certaines API Google publiques avec moins de configuration que via leurs interfaces HTTP. Les services avancés sont essentiellement des wrappers légers pour ces API Google. Ils fonctionnent comme les services intégrés d'Apps Script. Par exemple, ils proposent une saisie semi-automatique, et Apps Script gère automatiquement le flux d'autorisation. Toutefois, vous devez activer un service avancé pour pouvoir l'utiliser dans un script.
Pour savoir quelles API Google sont disponibles en tant que services avancés, consultez la section Services avancés Google dans la documentation de référence. Si vous souhaitez utiliser une API Google qui n'est pas disponible en tant que service avancé, il vous suffit de vous y connecter comme à toute autre API externe.
Services avancés ou HTTP ?
Chacun des services Google avancés est associé à une API Google publique.
Dans Apps Script, vous pouvez accéder à ces API via des services avancés ou en effectuant simplement les requêtes API directement à l'aide de UrlFetch.
Si vous utilisez la méthode de service avancé, Apps Script gère le flux d'autorisation et propose la saisie semi-automatique. Toutefois, vous devez activer le service avancé avant de pouvoir l'utiliser. En outre, certains services avancés ne fournissent qu'un sous-ensemble des fonctionnalités disponibles dans l'API.
Si vous utilisez la méthode UrlFetch pour accéder directement à l'API, vous traitez essentiellement l'API Google comme une API externe. Avec cette méthode, tous les aspects de l'API peuvent être utilisés. Toutefois, vous devez gérer vous-même l'autorisation de l'API. Vous devez également créer les en-têtes nécessaires et analyser les réponses de l'API.
En général, il est plus simple d'utiliser un service avancé dans la mesure du possible et de n'utiliser la méthode UrlFetch que lorsque le service avancé ne fournit pas la fonctionnalité dont vous avez besoin.
Conditions requises
Avant de pouvoir utiliser un service avancé, vous devez remplir les conditions suivantes:
- Vous devez activer le service avancé dans votre projet de script.
Vous devez vous assurer que l'API correspondant au service avancé est activée dans le projet Cloud Platform (GCP) utilisé par votre script.
Si votre projet de script utilise un projet GCP par défaut créé le 8 avril 2019 ou après, l'API est activée automatiquement après avoir activé le service avancé et enregistré le projet de script. Si vous ne l'avez pas déjà fait, vous devrez peut-être également accepter les conditions d'utilisation de Google Cloud et des API Google.
Si votre projet de script utilise un projet GCP standard ou un projet GCP par défaut plus ancien, vous devez activer manuellement l'API correspondante du service avancé dans le projet GCP. Pour effectuer cette modification, vous devez disposer des droits de modification sur le projet GCP.
Pour en savoir plus, consultez la section Projets Cloud Platform.
Activer les services avancés
Pour utiliser un service Google avancé, procédez comme suit:
- Ouvrez le projet Apps Script.
- Sur la gauche, cliquez sur Montage .
- Sur la gauche, à côté de Services, cliquez sur Ajouter un service .
- Sélectionnez un service Google avancé, puis cliquez sur Ajouter.
Une fois qu'un service avancé est activé, il est disponible dans la saisie semi-automatique.
Comment les signatures de méthode sont-elles déterminées ?
Les services avancés utilisent généralement les mêmes objets, noms de méthode et paramètres que les API publiques correspondantes, bien que les signatures de méthode soient traduites pour être utilisées dans Apps Script. La fonction de saisie semi-automatique de l'éditeur de script fournit généralement suffisamment d'informations pour vous lancer, mais les règles ci-dessous expliquent comment Apps Script génère une signature de méthode à partir d'une API Google publique.
Les requêtes envoyées aux API Google peuvent accepter différents types de données, y compris des paramètres de chemin d'accès, des paramètres de requête, un corps de requête et/ou une pièce jointe d'importation multimédia. Certains services avancés peuvent également accepter des en-têtes de requête HTTP spécifiques (par exemple, le service avancé Agenda).
La signature de méthode correspondante dans Google Apps Script comporte les arguments suivants:
- Le corps de la requête (généralement une ressource), en tant qu'objet JavaScript
- Chemin d'accès ou paramètres requis, sous forme d'arguments individuels.
- Pièce jointe d'importation de fichiers multimédias, en tant qu'argument
Blob. - Paramètres facultatifs, en tant qu'objet JavaScript mappant les noms de paramètres à des valeurs.
- En-têtes de requête HTTP, en tant qu'objet JavaScript mappant les noms d'en-tête aux valeurs d'en-tête.
Si la méthode ne comporte aucun élément dans une catégorie donnée, cette partie de la signature est omise.
Il existe quelques exceptions spéciales à prendre en compte:
- Pour les méthodes qui acceptent une importation de contenu multimédia, le paramètre
uploadTypeest défini automatiquement. - Les méthodes nommées
deletedans l'API Google sont nomméesremovedans Apps Script, cardeleteest un mot réservé en JavaScript. - Si un service avancé est configuré pour accepter les en-têtes de requête HTTP et que vous définissez un objet JavaScript d'en-têtes de requête, vous devez également définir l'objet JavaScript de paramètres facultatifs (sur un objet vide si vous n'utilisez pas de paramètres facultatifs).
Compatibilité avec les services avancés
Les services avancés ne sont que des wrappers légers qui permettent d'utiliser une API Google dans Apps Script. Par conséquent, tout problème rencontré lors de leur utilisation est généralement lié à l'API sous-jacente, et non à Apps Script lui-même.
Si vous rencontrez un problème lors de l'utilisation d'un service avancé, vous devez le signaler à l'aide des instructions d'assistance de l'API sous-jacente. Vous trouverez des liens vers ces instructions d'assistance dans le guide de chaque service avancé de la section Documentation de référence sur Apps Script.