Le service Advanced Chat vous permet d'utiliser l'API Google Chat dans Apps Script. Cette API permet aux scripts de rechercher, créer et modifier des espaces Chat, d'ajouter des membres à des espaces ou d'en supprimer, et de lire ou publier des messages avec du texte, des cartes, des pièces jointes et des réactions.
Prérequis
- Une application Google Chat Apps Script configurée sur la page de configuration de l'API Chat dans la console Google Cloud. Le projet Apps Script de l'application doit utiliser un projet Google Cloud standard au lieu de celui par défaut créé automatiquement pour les projets Apps Script. Pour créer une application Google Chat compatible, consultez Créer une application Google Chat avec Apps Script.
- Authentification configurée pour l'application Chat. Effectuer une action au nom d'un utilisateur nécessite son authentification. L'exécution d'une action telle que l'application Chat nécessite l'authentification de l'application avec un compte de service. Pour vérifier le type d'authentification compatible avec une méthode de l'API Chat, consultez la section Types d'authentification requis pour les appels d'API Google Chat.
Reference
Pour plus d'informations sur ce service, consultez la documentation de référence de l'API Chat. Comme tous les services avancés d'Apps Script, le service Chat utilise les mêmes objets, méthodes et paramètres que l'API publique.
Exemple de code
Ces exemples vous montrent comment effectuer des actions courantes de l'API Google Chat à l'aide du service avancé.
Publier un message contenant des identifiants utilisateur
L'exemple suivant montre comment publier un message dans un espace Chat au nom de l'utilisateur.
Ajoutez le champ d'application des autorisations
chat.messages.create
au fichierappsscript.json
du projet Apps Script:"oauthScopes": [ "https://www.googleapis.com/auth/chat.messages.create" ]
Ajoutez une fonction comme celle-ci au code du projet Apps Script:
Publier un message contenant les identifiants de l'application
L'exemple suivant montre comment publier un message dans un espace Chat pour le compte de l'application. L'utilisation du service Chat avancé avec un compte de service ne vous oblige pas à spécifier des champs d'application d'autorisation dans appsscript.json
. Pour en savoir plus sur l'authentification avec des comptes de service, consultez S'authentifier en tant qu'application Google Chat.
Obtenir un espace
L'exemple suivant montre comment obtenir des informations sur un espace Chat.
Ajoutez le champ d'application des autorisations
chat.spaces.readonly
au fichierappsscript.json
du projet Apps Script:"oauthScopes": [ "https://www.googleapis.com/auth/chat.spaces.readonly" ]
Ajoutez une fonction comme celle-ci au code du projet Apps Script:
Créer un espace
L'exemple suivant montre comment créer un espace Chat.
Ajoutez le champ d'application des autorisations
chat.spaces.create
au fichierappsscript.json
du projet Apps Script:"oauthScopes": [ "https://www.googleapis.com/auth/chat.spaces.create" ]
Ajoutez une fonction comme celle-ci au code du projet Apps Script:
Répertorier les adhésions
L'exemple suivant montre comment répertorier tous les membres d'un espace Chat.
Ajoutez le champ d'application des autorisations
chat.memberships.readonly
au fichierappsscript.json
du projet Apps Script:"oauthScopes": [ "https://www.googleapis.com/auth/chat.memberships.readonly" ]
Ajoutez une fonction comme celle-ci au code du projet Apps Script:
Dépannage
Si Error 400: invalid_scope
s'affiche avec le message d'erreur Some requested scopes cannot be shown
, cela signifie que vous n'avez spécifié aucun champ d'application d'autorisation dans le fichier appsscript.json
du projet Apps Script. Dans la plupart des cas, Apps Script détermine automatiquement les champs d'application dont un script a besoin. Toutefois, lorsque vous utilisez le service avancé Chat, vous devez ajouter manuellement les champs d'application des autorisations utilisés par votre script au fichier manifeste de votre projet Apps Script. Consultez la section Définir des champs d'application explicites.
Pour résoudre l'erreur, ajoutez les champs d'application d'autorisation appropriés au fichier appsscript.json
du projet Apps Script dans le tableau oauthScopes
. Par exemple, pour appeler la méthode spaces.messages.create
, ajoutez les éléments suivants:
"oauthScopes": [
"https://www.googleapis.com/auth/chat.messages.create"
]
Limites et considérations
Le service de chat avancé n'est pas compatible avec:
- La méthode
media.download
de l'API Chat. - Méthodes de l'API Chat disponibles dans la Preview développeur
Pour télécharger une pièce jointe de message ou appeler une méthode d'aperçu pour les développeurs, utilisez plutôt UrlFetchApp
.