Cette section explique comment une application Google Chat peut appeler l'API Chat, ce qui permet aux applications Chat de créer un espace, d'y ajouter des personnes et de publier un message sans être invitée par un événement d'interaction avec l'application Chat.
Authentification
L'appel asynchrone de l'API Chat nécessite une authentification. Chaque méthode de l'API Chat nécessite soit l'authentification de l'utilisateur (pour effectuer des actions ou l'accès aux données au nom d'un utilisateur), soit l'authentification de l'application (pour effectuer des actions ou accéder aux données en tant qu'application Chat). Certaines méthodes prennent en charge à la fois l'authentification des utilisateurs et l'authentification des applications.
Pour en savoir plus sur l'authentification dans Chat, consultez la section Présentation de l'authentification.
Ressources et méthodes de l'API
Les ressources et les méthodes REST accordent un accès asynchrone aux espaces Chat, aux membres des espaces, aux messages, aux réactions aux messages et aux pièces jointes.
- Espaces
Les espaces sont des endroits où les utilisateurs et les applications peuvent discuter et partager des fichiers. Il existe plusieurs types d'espaces. Les messages privés (MP) sont des conversations individuelles entre deux utilisateurs ou un utilisateur et une application Chat. Les chats de groupe sont des conversations entre trois utilisateurs ou plus d'applications Chat. Les espaces nommés sont des espaces persistants où les utilisateurs envoient des messages, partagent des fichiers et collaborent.
La ressource
spacesreprésente un espace.Les espaces acceptent les méthodes suivantes:
- Créez un espace, c'est-à-dire un espace où les utilisateurs et les applications peuvent discuter et partager des fichiers.
- Configurez un espace pour créer l'espace, puis ajoutez-y des personnes et des applications Chat.
- Obtenez un espace pour en afficher les détails.
- Répertoriez les espaces pour afficher une liste paginée et filtrable d'espaces.
- Mettez à jour un espace pour en modifier les attributs, tels que son nom à afficher visible par l'utilisateur, sa description et ses consignes.
- Supprimez un espace lorsqu'il n'est plus nécessaire.
- Recherchez un message privé pour renvoyer un message privé entre deux utilisateurs, ou un message privé entre un utilisateur et les applications Chat appelantes.
- Membres
Les membres sont les utilisateurs et les applications Chat qui ont rejoint un espace ou qui y ont été invités.
La ressource
spaces.membersreprésente un membre.Les membres acceptent les méthodes suivantes:
- Créez un abonnement pour ajouter un utilisateur ou une application à un espace.
- Souscrivez un abonnement pour en afficher les détails.
- Lister les membres pour afficher une liste paginée et filtrable des membres d'un espace.
- Modifier un abonnement pour modifier les attributs d'un membre, par exemple attribuer le rôle de gestionnaire à un membre de l'espace ou de gestionnaire de l'espace à celui de membre de l'espace.
- Supprimer un abonnement pour exclure un utilisateur ou une application d'un espace
- Messages
Les messages incluent les communications de texte et de cartes publiées dans les espaces. Les messages peuvent être associés à des fichiers. Les utilisateurs peuvent réagir aux messages en y ajoutant des emoji.
La ressource
spaces.messagesreprésente un message.Les messages sont compatibles avec les méthodes suivantes:
- Créez un message pour publier un message texte ou carte. Vous pouvez également démarrer un fil de discussion ou y répondre.
- Recevoir un message pour obtenir des informations sur un message, comme sa date d'envoi ou ce qu'il dit.
- Répertoriez les messages pour afficher une liste paginée et filtrable des messages d'un espace.
- Mettez à jour un message pour modifier ses attributs, par exemple ce qu'il dit. Vous pouvez également ajouter une carte à un message de carte ou à un message texte.
- Supprimez un message lorsqu'il n'est plus nécessaire.
- Réactions
Les réactions représentent les emoji que les gens utilisent pour réagir à un message, par exemple 👍, Appointment et shutdown.
La ressource
spaces.messages.reactionsreprésente une réaction.Les réactions sont compatibles avec les méthodes suivantes:
- Créez une réaction pour ajouter un emoji à un message.
- Répertoriez les réactions pour afficher une liste paginée et filtrable des réactions à un message.
- Supprimez une réaction pour supprimer un emoji du message.
- Contenus multimédias et pièces jointes
Multimédia représente un fichier importé dans Google Chat, comme des images, des vidéos et des documents.
La ressource
mediareprésente les contenus multimédias associés aux messages.Les pièces jointes sont des instances de contenus multimédias (fichiers) joints à des messages.
La ressource
spaces.messages.attachmentsreprésente un rattachement. Une pièce jointe inclut le contenu multimédia et les métadonnées associées joints à un message.Les fichiers multimédias et les pièces jointes sont compatibles avec les méthodes suivantes:
- Importez des contenus multimédias en tant que pièces jointes pour importer des contenus multimédias dans Google Chat, puis joignez-les à un message.
- Télécharger des contenus multimédias en pièce jointe pour télécharger des contenus multimédias depuis Google Chat sous forme de fichier binaire.
- Obtenez une pièce jointe pour récupérer les métadonnées concernant une pièce jointe à un message.
- Événements de l'espace
Les événements d'espace représentent les modifications apportées à un espace ou à ses ressources enfants, y compris ses membres, ses messages et ses réactions.
La ressource
spaces.spaceEventreprésente un événement d'espace.Les événements d'espace sont compatibles avec les méthodes suivantes:
- Obtenez un événement d'espace pour renvoyer les détails d'un événement qui s'est produit dans un espace.
- Répertoriez les événements de l'espace pour obtenir la liste des événements qui se sont produits dans un espace.
- États de lecture par l'utilisateur
Les états de lecture par l'utilisateur sont des ressources singleton qui représentent les détails du dernier message lu par un utilisateur spécifié dans un espace Google Chat ou un fil de discussion.
La ressource
users.spacesreprésente l'état de lecture d'un utilisateur dans un espace.La ressource
users.spaces.threadsreprésente l'état de lecture d'un utilisateur dans un fil de discussion.Les états de lecture de l'utilisateur sont compatibles avec les méthodes suivantes:
- Obtenir l'état de lecture de l'espace pour renvoyer des détails sur l'état de lecture d'un utilisateur dans un espace.
- Mettre à jour l'état de lecture d'un espace pour mettre à jour l'état de lecture d'un utilisateur dans un espace.
- Obtenir l'état de lecture du thread pour renvoyer des détails sur l'état de lecture d'un utilisateur dans un thread.