Services Google avancés

Les services avancés d'Apps Script permettent aux développeurs expérimentés de se connecter à certaines API Google publiques avec une configuration moins facile que via leurs interfaces HTTP. Les services avancés sont essentiellement des wrappers légers autour de ces API Google. Ils fonctionnent de la même manière que les services intégrés d'Apps Script : par exemple, ils proposent la saisie semi-automatique, et Apps Script gère automatiquement le flux d'autorisation. Toutefois, vous devez activer un service avancé avant de pouvoir l'utiliser dans un script.

Pour connaître les API Google 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é, connectez-vous simplement à celle-ci comme n'importe quelle 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 simplement en effectuant les requêtes API directement à l'aide de UrlFetch.

Si vous utilisez la méthode de service avancée, Apps Script gère le flux d'autorisation et propose une fonctionnalité de 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 considérez essentiellement l'API Google comme une API externe. Cette méthode permet d'utiliser tous les aspects de l'API. Cependant, vous devez gérer vous-même les autorisations 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 facile d'utiliser un service avancé lorsque cela est possible et de n'utiliser la méthode UrlFetch que lorsque le service avancé ne fournit pas les fonctionnalités dont vous avez besoin.

Conditions requises

Pour pouvoir utiliser un service avancé, vous devez remplir les conditions suivantes:

1. Vous devez activer le service avancé dans votre projet de script.

2. 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 cette date, l'API est activée automatiquement une fois que vous avez activé le service avancé et enregistré le projet de script. Si vous ne l'avez pas déjà fait, vous pouvez également être invité à 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. Vous devez être autorisé à modifier le projet GCP pour effectuer cette modification.

Pour en savoir plus, consultez la page Projets Cloud Platform.

Activer les services avancés

Pour utiliser un service Google avancé, procédez comme suit:

1. Ouvrez le projet Apps Script.
2. À gauche, cliquez sur Éditeur .
3. Sur la gauche, à côté de Services, cliquez sur Ajouter un service .
4. Sélectionnez un service Google avancé, puis cliquez sur Ajouter.

Remarque :Si vous utilisez un projet GCP standard (ou un ancien projet GCP par défaut créé avant le 8 avril 2019), vous devez également activer manuellement l'API correspondant au service avancé. Activez l'API en procédant comme suit :

1. Ouvrez le projet GCP associé à votre script dans la console Google Cloud.
2. En haut de la console, cliquez dans la barre de recherche et saisissez une partie du nom de l'API (par exemple, "Agenda"), puis cliquez sur le nom lorsque vous le voyez.
3. Sur l'écran suivant, cliquez sur Activer l'API.
4. Fermez la console Google Cloud et revenez à l'éditeur de script. Cliquez sur OK dans la boîte de dialogue.

Une fois que vous avez activé un service avancé, 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éthodes et paramètres que les API publiques correspondantes, bien que les signatures de méthodes 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 commencer, 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 de médias. 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:

1. Corps de la requête (généralement une ressource), en tant qu'objet JavaScript.
2. Chemin d'accès ou paramètres requis, en tant qu'arguments individuels.
3. Pièce jointe d'importation de contenu multimédia, en tant qu'argument Blob.
4. Paramètres facultatifs, en tant qu'objet JavaScript mappant des noms de paramètres à des valeurs.
5. les en-têtes de requêtes HTTP, sous la forme d'un objet JavaScript mappant les noms d'en-têtes avec les 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 l'importation d'un contenu multimédia, le paramètre uploadType est défini automatiquement.
• Les méthodes nommées delete dans l'API Google sont nommées remove dans Apps Script, car delete est un terme réservé en JavaScript.
• Si un service avancé est configuré pour accepter les en-têtes de requêtes HTTP et que vous définissez un objet JavaScript d'en-têtes de requête, vous devez également définir l'objet JavaScript des paramètres facultatifs (sur un objet vide si vous n'utilisez pas de paramètres facultatifs).

Assistance pour les services avancés

Les services avancés ne sont que des wrappers légers qui permettent d'utiliser des 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.

Si vous rencontrez un problème lors de l'utilisation d'un service avancé, vous devez le signaler en suivant les instructions d'assistance de l'API sous-jacente. Des liens vers ces instructions d'assistance sont fournis dans chaque guide de service avancé de la section Référence d'Apps Script.