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 y être invité par un événement d'interaction avec l'application Chat.
Ratio d'économie d'énergie (EER)
L'appel asynchrone de l'API Chat nécessite une authentification. Chaque méthode de l'API Chat nécessite l'authentification de l'utilisateur (pour effectuer des actions ou accéder aux données au nom d'un utilisateur) ou l'authentification de l'application (pour effectuer des actions ou accéder aux données en tant qu'application Chat). Certaines méthodes sont compatibles à la fois avec 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 méthodes REST accordent un accès asynchrone aux espaces Chat et aux membres d'un espace, ainsi qu'aux messages, aux réactions aux messages et aux pièces jointes aux messages.
- Espaces
Les espaces sont des endroits où les personnes et les applications peuvent discuter et partager des fichiers. Il existe plusieurs types d'espaces. Les messages privés (MP) sont des conversations 1:1 entre deux utilisateurs, ou un utilisateur, et une application Chat. Les chats de groupe sont des conversations entre trois utilisateurs ou plus et des applications Chat. Les espaces nommés sont des espaces persistants où les utilisateurs envoient des messages, partagent des fichiers et collaborent.
La ressource
spaces
représente un espace.Les espaces sont compatibles avec les méthodes suivantes:
- Créez un espace, où des personnes et des applications peuvent discuter et partager des fichiers.
- Configurez un espace pour y ajouter 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 modifier les attributs qui lui sont associés, tels que son nom à afficher, sa description et ses consignes visibles par l'utilisateur.
- Supprimez un espace lorsqu'il n'est plus nécessaire.
- Recherchez un message privé (MP) pour renvoyer un MP entre deux utilisateurs, ou un MP entre un utilisateur et les applications Chat appelantes.
- Membres
Les membres sont des utilisateurs et des applications Chat qui ont rejoint un espace ou y sont invités.
La ressource
spaces.members
repré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.
- Répertoriez les adhésions pour afficher une liste paginée et filtrable des adhésions dans un espace.
- Mettre à jour un abonnement pour modifier les attributs d'un espace (par exemple, pour renommer un membre de l'espace ou le remplacer par un gestionnaire d'espace).
- Supprimez un abonnement pour supprimer un utilisateur ou une application d'un espace.
- Messages
Les messages incluent des communications textuelles et par cartes publiées dans les espaces. Les messages peuvent être joints à des fichiers. Les utilisateurs peuvent réagir aux messages en y ajoutant des emoji.
La ressource
spaces.messages
repré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 détails sur un message, comme sa date d'envoi ou son contenu
- Répertoriez les messages pour afficher une liste paginée et filtrable de messages dans un espace.
- Mettez à jour un message pour modifier les attributs du message, tels que son contenu. Vous pouvez également ajouter du texte à un message sous forme de fiche, ou une fiche à un message texte.
- Supprimez un message lorsqu'il n'est plus nécessaire.
- Réactions
Les réactions représentent les emoji utilisés par les internautes pour réagir à un message, par exemple 👍, 💌 et 😂.
La ressource
spaces.messages.reactions
repré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.
- Listez les réactions pour afficher une liste paginée et filtrable des réactions à un message.
- Supprimer une réaction pour supprimer un emoji du message.
- Contenus multimédias et pièces jointes
Le terme contenu multimédia désigne un fichier importé dans Google Chat, par exemple des images, des vidéos et des documents.
La ressource
media
représente le contenu multimédia joint aux messages.Les pièces jointes sont des instances de contenus multimédias (fichiers) joints à des messages.
La ressource
spaces.messages.attachments
représente un rattachement. Une pièce jointe inclut le contenu multimédia et les métadonnées associées associées à un message.Les éléments multimédias et les pièces jointes sont compatibles avec les méthodes suivantes:
- Importez des fichiers multimédias en tant que pièce jointe pour importer des contenus multimédias dans Google Chat et les joindre à un message.
- Téléchargez des contenus multimédias en pièce jointe pour télécharger des contenus multimédias depuis Google Chat sous forme de fichier binaire.
- Récupérez une pièce jointe pour récupérer les métadonnées concernant la pièce jointe d'un message.
- Événements d'espaces
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.spaceEvent
repré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épertorier les événements d'un espace pour obtenir la liste des événements qui se sont produits dans un espace
- États de lecture des utilisateurs
Les états de lecture de l'utilisateur sont des ressources singleton qui représentent des détails sur le dernier message lu d'un utilisateur spécifié dans un espace Google Chat ou un fil de discussion.
La ressource
users.spaces
représente l'état de lecture d'un utilisateur dans un espace.La ressource
users.spaces.threads
représente l'état de lecture d'un utilisateur dans un fil de discussion.Les états de lecture utilisateur sont compatibles avec les méthodes suivantes:
- Obtenez l'état de lecture de l'espace pour renvoyer les détails de l'état de lecture d'un utilisateur dans un espace.
- Mettez à jour l'état de lecture d'un espace pour mettre à jour l'état de lecture d'un utilisateur dans un espace.
- Obtenez l'état de lecture d'un thread pour renvoyer des détails sur l'état de lecture d'un utilisateur dans un thread.