Package google.chat.v1

Index

ChatService

Permet aux développeurs de créer des applications et des intégrations Chat sur la plate-forme Google Chat.

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

Finalise le processus d'importation pour l'espace spécifié et le rend visible pour les utilisateurs.

Nécessite l'authentification de l'utilisateur et la délégation au niveau du domaine avec le champ d'application de l'autorisation :

  • https://www.googleapis.com/auth/chat.import

Pour en savoir plus, consultez Autoriser les applications Google Chat à importer des données.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/chat.import

Pour en savoir plus, consultez le guide d'autorisation.
CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

Crée un emoji personnalisé.

Les emoji personnalisés ne sont disponibles que pour les comptes Google Workspace. L'administrateur doit les activer pour l'organisation. Pour en savoir plus, consultez À propos des emoji personnalisés dans Google Chat et Gérer les autorisations pour les emoji personnalisés.

Nécessite une authentification de l'utilisateur avec le champ d'application de l'autorisation :

  • https://www.googleapis.com/auth/chat.customemojis
Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/chat.customemojis

Pour en savoir plus, consultez le guide d'autorisation.
CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Crée un abonnement pour l'application Chat pour les appels, un utilisateur ou un groupe Google. Il n'est pas possible de créer des abonnements pour d'autres applications de chat. Lorsque vous créez un abonnement, si le membre spécifié a désactivé sa règle d'acceptation automatique, il est invité et doit accepter l'invitation à rejoindre l'espace avant de pouvoir le faire. Sinon, la création d'un abonnement ajoute directement le membre à l'espace spécifié.

Compatible avec les types d'authentification suivants :

  • Authentification de l'application avec approbation de l'administrateur et champ d'application de l'autorisation :

    • https://www.googleapis.com/auth/chat.app.memberships

  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (pour ajouter l'application d'appel à l'espace)
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)
    • L'authentification de l'utilisateur accorde des droits d'administrateur lorsqu'un compte administrateur s'authentifie, use_admin_access est true et que le champ d'application d'autorisation suivant est utilisé :
      • https://www.googleapis.com/auth/chat.admin.memberships

L'authentification des applications n'est pas compatible avec les cas d'utilisation suivants :

  • Inviter des utilisateurs externes à l'organisation Workspace propriétaire de l'espace
  • Ajouter un groupe Google à un espace
  • Ajout d'une application Chat à un espace

Pour obtenir un exemple d'utilisation, consultez :

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

Pour en savoir plus, consultez le guide d'autorisation.
CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

crée un message dans un espace Google Chat ; Pour obtenir un exemple, consultez Envoyer un message.

Compatible avec les types d'authentification suivants :

  • Authentification de l'application avec le champ d'application de l'autorisation :
    • https://www.googleapis.com/auth/chat.bot
  • Authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)

Chat attribue l'expéditeur du message différemment selon le type d'authentification que vous utilisez dans votre requête.

L'image suivante montre comment Chat attribue un message lorsque vous utilisez l'authentification de l'application. Chat affiche l'application Chat comme expéditeur du message. Le contenu du message peut contenir du texte (text), des cartes (cardsV2) et des widgets accessoires (accessoryWidgets).

Message envoyé avec l'authentification de l'application

L'image suivante montre comment Chat attribue un message lorsque vous utilisez l'authentification des utilisateurs. Chat affiche l'utilisateur comme expéditeur du message et attribue l'application Chat au message en affichant son nom. Le contenu du message ne peut contenir que du texte (text).

Message envoyé avec authentification de l'utilisateur

La taille maximale d'un message, y compris son contenu, est de 32 000 octets.

Pour les requêtes webhook, la réponse ne contient pas le message complet. La réponse ne renseigne que les champs name et thread.name, en plus des informations contenues dans la requête.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

Pour en savoir plus, consultez le guide d'autorisation.
CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

Crée une réaction et l'ajoute à un message. Pour obtenir un exemple, consultez Ajouter une réaction à un message.

Nécessite une authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :

  • https://www.googleapis.com/auth/chat.messages.reactions.create
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)
Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

Pour en savoir plus, consultez le guide d'autorisation.
CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

Crée un espace. Permet de créer un espace nommé ou un chat de groupe dans Import mode. Pour obtenir un exemple, consultez Créer un espace.

Compatible avec les types d'authentification suivants :

  • Authentification de l'application avec approbation de l'administrateur et l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.app.spaces.create
    • https://www.googleapis.com/auth/chat.app.spaces

  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.spaces.create
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)

Lors de l'authentification en tant qu'application, le champ space.customer doit être défini dans la requête.

Lorsque vous vous authentifiez en tant qu'application, l'application Chat est ajoutée en tant que membre de l'espace. Toutefois, contrairement à l'authentification humaine, l'application Chat n'est pas ajoutée en tant que gestionnaire de l'espace. Par défaut, tous les membres de l'espace peuvent supprimer l'application Chat de l'espace. Pour autoriser uniquement les gestionnaires d'espace à supprimer l'application d'un espace, définissez space.permission_settings.manage_apps sur managers_allowed.

L'adhésion à un espace lors de sa création dépend de l'endroit où il est créé dans Import mode :

  • Mode Importation : aucun membre n'est créé.
  • Tous les autres modes : l'utilisateur qui appelle est ajouté en tant que membre. Il s'agit :
    • L'application elle-même lors de l'utilisation de l'authentification par application.
    • Utilisateur humain lors de l'utilisation de l'authentification de l'utilisateur.

Si le message d'erreur ALREADY_EXISTS s'affiche lorsque vous créez un espace, essayez un autre displayName. Il est possible qu'un espace existant dans l'organisation Google Workspace utilise déjà ce nom à afficher.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.app.spaces.create
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

Pour en savoir plus, consultez le guide d'autorisation.
DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

Supprime un emoji personnalisé. Par défaut, les utilisateurs ne peuvent supprimer que les emoji personnalisés qu'ils ont créés. Les gestionnaires d'emoji désignés par l'administrateur peuvent supprimer n'importe quel emoji personnalisé de l'organisation. Consultez À propos des emoji personnalisés dans Google Chat.

Les emoji personnalisés ne sont disponibles que pour les comptes Google Workspace. L'administrateur doit les activer pour l'organisation. Pour en savoir plus, consultez À propos des emoji personnalisés dans Google Chat et Gérer les autorisations pour les emoji personnalisés.

Nécessite une authentification de l'utilisateur avec le champ d'application de l'autorisation :

  • https://www.googleapis.com/auth/chat.customemojis
Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/chat.customemojis

Pour en savoir plus, consultez le guide d'autorisation.
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

Supprime un abonnement. Pour obtenir un exemple, consultez Supprimer un utilisateur ou une application Google Chat d'un espace.

Compatible avec les types d'authentification suivants :

  • Authentification de l'application avec approbation de l'administrateur et champ d'application de l'autorisation :

    • https://www.googleapis.com/auth/chat.app.memberships

  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (pour supprimer l'application d'appel de l'espace)
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)
    • L'authentification de l'utilisateur accorde des droits d'administrateur lorsqu'un compte administrateur s'authentifie, use_admin_access est true et que le champ d'application d'autorisation suivant est utilisé :
      • https://www.googleapis.com/auth/chat.admin.memberships

L'authentification des applications n'est pas compatible avec les cas d'utilisation suivants :

  • Supprimer un groupe Google d'un espace
  • Supprimer une application Chat d'un espace

Pour supprimer des membres d'un espace, le demandeur doit être gestionnaire de l'espace. Si vous utilisez l'authentification par application, l'application Chat doit être le créateur de l'espace.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

Pour en savoir plus, consultez le guide d'autorisation.
DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

Supprime un message. Pour obtenir un exemple, consultez Supprimer un message.

Compatible avec les types d'authentification suivants :

  • Authentification par l'application avec le champ d'application de l'autorisation :

    • https://www.googleapis.com/auth/chat.bot

  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)

Lorsque vous utilisez l'authentification d'application, les requêtes ne peuvent supprimer que les messages créés par l'application Chat appelante.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

Pour en savoir plus, consultez le guide d'autorisation.
DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

Supprime une réaction à un message. Pour obtenir un exemple, consultez Supprimer une réaction.

Nécessite une authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :

  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)
Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions

Pour en savoir plus, consultez le guide d'autorisation.
DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

Supprime un espace nommé. Effectue toujours une suppression en cascade, ce qui signifie que les ressources enfants de l'espace (comme les messages publiés dans l'espace et les membres de l'espace) sont également supprimées. Pour obtenir un exemple, consultez Supprimer un espace.

Compatible avec les types d'authentification suivants :

  • Authentification de l'application avec approbation de l'administrateur et champ d'application de l'autorisation :

    • https://www.googleapis.com/auth/chat.app.delete (uniquement dans les espaces créés par l'application)

  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.delete
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)
    • L'authentification de l'utilisateur accorde des droits d'administrateur lorsqu'un compte administrateur s'authentifie, use_admin_access est true et que le champ d'application d'autorisation suivant est utilisé :
      • https://www.googleapis.com/auth/chat.admin.delete
Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.app.delete
  • https://www.googleapis.com/auth/chat.admin.delete
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.delete

Pour en savoir plus, consultez le guide d'autorisation.
FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

Renvoie le message privé existant avec l'utilisateur spécifié. Si aucun espace de message privé n'est trouvé, une erreur 404 NOT_FOUND est renvoyée. Pour obtenir un exemple, consultez Rechercher un message privé.

Avec l'authentification de l'application, renvoie l'espace de message privé entre l'utilisateur spécifié et l'application Chat appelante.

Avec l'authentification de l'utilisateur, renvoie l'espace de messages privés entre l'utilisateur spécifié et l'utilisateur authentifié.

Compatible avec les types d'authentification suivants :

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

Pour en savoir plus, consultez le guide d'autorisation.
GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

Obtient les métadonnées d'une pièce jointe d'un message. Les données des pièces jointes sont récupérées à l'aide de l'API Media. Pour obtenir un exemple, consultez Obtenir des métadonnées sur une pièce jointe d'un message.

Nécessite une authentification de l'application avec le champ d'application de l'autorisation :

  • https://www.googleapis.com/auth/chat.bot
Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/chat.bot

Pour en savoir plus, consultez le guide d'autorisation.
GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

Renvoie des informations sur un emoji personnalisé.

Les emoji personnalisés ne sont disponibles que pour les comptes Google Workspace. L'administrateur doit les activer pour l'organisation. Pour en savoir plus, consultez À propos des emoji personnalisés dans Google Chat et Gérer les autorisations pour les emoji personnalisés.

Nécessite une authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis
Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

Pour en savoir plus, consultez le guide d'autorisation.
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

Renvoie des informations sur une appartenance. Pour obtenir un exemple, consultez Obtenir des informations sur l'appartenance d'un utilisateur ou d'une application Google Chat.

Compatible avec les types d'authentification suivants :

  • Authentification de l'application avec l'un des niveaux d'autorisation suivants :

  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • L'authentification des utilisateurs accorde des droits d'administrateur lorsqu'un compte administrateur s'authentifie, use_admin_access est true et que l'un des niveaux d'autorisation suivants est utilisé :
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Pour en savoir plus, consultez le guide d'autorisation.
GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

Renvoie des informations sur un message. Pour obtenir un exemple, consultez Obtenir des informations sur un message.

Compatible avec les types d'authentification suivants :

  • Authentification de l'application avec l'un des niveaux d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.bot : lorsque vous utilisez ce champ d'application d'autorisation, cette méthode renvoie des informations sur un message auquel l'application Chat a accès, comme les messages privés et les commandes à barre oblique qui appellent l'application Chat.
    • https://www.googleapis.com/auth/chat.app.messages.readonly avec approbation de l'administrateur (disponible en Preview développeur). Lorsque vous utilisez ce champ d'application d'authentification, cette méthode renvoie des informations sur un message public dans un espace.

  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages

Remarque : Il est possible qu'un message provenant d'un membre ou d'un espace bloqué soit renvoyé.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly

Pour en savoir plus, consultez le guide d'autorisation.
GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

Renvoie des informations sur un espace. Pour obtenir un exemple, consultez Obtenir des informations sur un espace.

Compatible avec les types d'authentification suivants :

  • Authentification de l'application avec l'un des niveaux d'autorisation suivants :

  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • L'authentification des utilisateurs accorde des droits d'administrateur lorsqu'un compte administrateur s'authentifie, use_admin_access est true et que l'un des niveaux d'autorisation suivants est utilisé :
      • https://www.googleapis.com/auth/chat.admin.spaces.readonly
      • https://www.googleapis.com/auth/chat.admin.spaces

L'authentification des applications présente les limites suivantes :

  • space.access_settings n'est renseigné que lorsque la portée chat.app.spaces est utilisée.
  • space.predefind_permission_settings et space.permission_settings ne sont renseignés que lorsque vous utilisez le champ d'application chat.app.spaces, et uniquement pour les espaces créés par l'application.
Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.app.spaces

Pour en savoir plus, consultez le guide d'autorisation.
GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

Renvoie un événement d'un espace Google Chat. La charge utile de l'événement contient la version la plus récente de la ressource qui a été modifiée. Par exemple, si vous demandez un événement concernant un nouveau message, mais que le message a été modifié par la suite, le serveur renvoie la ressource Message mise à jour dans la charge utile de l'événement.

Remarque : Le champ permissionSettings n'est pas renvoyé dans l'objet Space des données d'événement Space pour cette requête.

Les types d'authentification suivants sont acceptés avec un champ d'application de l'autorisation approprié pour lire les données demandées :

  • Authentification de l'application avec approbation de l'administrateur dans la version Preview développeur avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.app.spaces
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.memberships

  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.messages.reactions.readonly
    • https://www.googleapis.com/auth/chat.messages.reactions
    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships

Pour obtenir un événement, l'appelant authentifié doit être membre de l'espace.

Pour obtenir un exemple, consultez Obtenir des informations sur un événement à partir d'un espace Google Chat.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Pour en savoir plus, consultez le guide d'autorisation.
GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Récupère le paramètre de notification de l'espace. Pour obtenir un exemple, consultez Obtenir le paramètre de notification de l'espace de l'appelant.

Nécessite une authentification de l'utilisateur avec le champ d'application de l'autorisation :

  • https://www.googleapis.com/auth/chat.users.spacesettings
Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/chat.users.spacesettings

Pour en savoir plus, consultez le guide d'autorisation.
GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

Renvoie des informations sur l'état de lecture d'un utilisateur dans un espace, utilisé pour identifier les messages lus et non lus. Pour obtenir un exemple, consultez Obtenir des informations sur l'état de lecture d'un espace par un utilisateur.

Nécessite une authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

Pour en savoir plus, consultez le guide d'autorisation.
GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

Renvoie des informations sur l'état de lecture d'un utilisateur dans un thread, utilisé pour identifier les messages lus et non lus. Pour obtenir un exemple, consultez Obtenir des informations sur l'état de lecture des fils de discussion d'un utilisateur.

Nécessite une authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

Pour en savoir plus, consultez le guide d'autorisation.
ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

Liste les emoji personnalisés visibles par l'utilisateur authentifié.

Les emoji personnalisés ne sont disponibles que pour les comptes Google Workspace. L'administrateur doit les activer pour l'organisation. Pour en savoir plus, consultez À propos des emoji personnalisés dans Google Chat et Gérer les autorisations pour les emoji personnalisés.

Nécessite une authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis
Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

Pour en savoir plus, consultez le guide d'autorisation.
ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

Répertorie les membres d'un espace. Pour obtenir un exemple, consultez Lister les utilisateurs et les applications Google Chat dans un espace. La liste des abonnements avec authentification de l'application répertorie les abonnements aux espaces auxquels l'application Chat a accès, mais exclut les abonnements à l'application Chat, y compris les siens. La liste des abonnements avec l'authentification des utilisateurs répertorie les abonnements aux espaces auxquels l'utilisateur authentifié a accès.

Compatible avec les types d'authentification suivants :

  • Authentification de l'application avec l'un des niveaux d'autorisation suivants :

  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)
    • L'authentification des utilisateurs accorde des droits d'administrateur lorsqu'un compte administrateur s'authentifie, use_admin_access est true et que l'un des niveaux d'autorisation suivants est utilisé :
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Pour en savoir plus, consultez le guide d'autorisation.
ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Liste les messages d'un espace dont l'appelant est membre, y compris les messages des membres et espaces bloqués. Les messages système, comme ceux annonçant l'arrivée de nouveaux membres dans un espace, ne sont pas inclus. Si vous listez les messages d'un espace sans message, la réponse est un objet vide. Lorsque vous utilisez une interface REST/HTTP, la réponse contient un objet JSON vide, {}. Pour obtenir un exemple, consultez Lister les messages.

Compatible avec les types d'authentification suivants :

  • Authentification de l'application avec approbation de l'administrateur dans la version Preview pour les développeurs avec le champ d'application de l'autorisation :

    • https://www.googleapis.com/auth/chat.app.messages.readonly. Lorsque vous utilisez ce champ d'application d'authentification, cette méthode ne renvoie que les messages publics d'un espace. Les messages privés ne sont pas inclus.

  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)
Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly

Pour en savoir plus, consultez le guide d'autorisation.
ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

Liste les réactions à un message. Pour obtenir un exemple, consultez Lister les réactions à un message.

Nécessite une authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :

  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Pour en savoir plus, consultez le guide d'autorisation.
ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

Liste les événements d'un espace Google Chat. Pour chaque événement, la charge utile contient la version la plus récente de la ressource Chat. Par exemple, si vous listez des événements concernant de nouveaux membres d'un espace, le serveur renvoie des ressources Membership contenant les dernières informations sur les membres. Si de nouveaux membres ont été supprimés au cours de la période demandée, la charge utile de l'événement contient une ressource Membership vide.

Les types d'authentification suivants sont acceptés avec un champ d'application de l'autorisation approprié pour lire les données demandées :

  • Authentification de l'application avec approbation de l'administrateur dans la version Preview développeur avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.app.spaces
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.memberships

  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.messages.reactions.readonly
    • https://www.googleapis.com/auth/chat.messages.reactions
    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships

Pour lister les événements, l'appelant authentifié doit être membre de l'espace.

Pour obtenir un exemple, consultez Lister les événements d'un espace Google Chat.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Pour en savoir plus, consultez le guide d'autorisation.
ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

Liste les espaces dont l'appelant est membre. Les discussions de groupe et les messages privés ne sont listés qu'une fois le premier message envoyé. Pour obtenir un exemple, consultez Lister les espaces.

Compatible avec les types d'authentification suivants :

Pour lister tous les espaces nommés par organisation Google Workspace, utilisez plutôt la méthode spaces.search() avec les droits d'administrateur Workspace.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

Pour en savoir plus, consultez le guide d'autorisation.
SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

Renvoie la liste des espaces d'une organisation Google Workspace en fonction de la recherche d'un administrateur. Dans la requête, définissez use_admin_access sur true. Pour obtenir un exemple, consultez Rechercher et gérer des espaces.

Nécessite une authentification utilisateur avec droits d'administrateur et l'un des champs d'application d'autorisation suivants :

  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.admin.spaces
Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

Pour en savoir plus, consultez le guide d'autorisation.
SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

Crée un espace et y ajoute les utilisateurs spécifiés. L'utilisateur appelant est automatiquement ajouté à l'espace et ne doit pas être spécifié en tant que membre dans la requête. Pour obtenir un exemple, consultez Configurer un espace avec des membres initiaux.

Pour spécifier les membres humains à ajouter, ajoutez des appartenances avec le membership.member.name approprié. Pour ajouter un utilisateur humain, utilisez users/{user}, où {user} peut être l'adresse e-mail de l'utilisateur. Pour les utilisateurs de la même organisation Workspace, {user} peut également être le id de la personne dans l'API People ou le id de l'utilisateur dans l'API Directory. Par exemple, si l'ID de profil de personne de l'API People pour [email protected] est 123456789, vous pouvez ajouter l'utilisateur à l'espace en définissant membership.member.name sur users/[email protected] ou users/123456789.

Pour spécifier les groupes Google à ajouter, ajoutez des abonnements avec le membership.group_member.name approprié. Pour ajouter ou inviter un groupe Google, utilisez groups/{group}, où {group} correspond à l'id du groupe à partir de l'API Cloud Identity Groups. Par exemple, vous pouvez utiliser l'API Cloud Identity Groups Lookup pour récupérer l'ID 123456789 pour l'adresse e-mail du groupe [email protected], puis ajouter le groupe à l'espace en définissant membership.group_member.name sur groups/123456789. Les adresses e-mail de groupe ne sont pas acceptées. Les groupes Google ne peuvent être ajoutés en tant que membres que dans les espaces nommés.

Pour un espace nommé ou une discussion de groupe, si l'appelant bloque certains membres ou est bloqué par certains d'entre eux, ou s'il n'est pas autorisé à ajouter certains membres, ces membres ne sont pas ajoutés à l'espace créé.

Pour créer un message privé (MP) entre l'utilisateur qui appelle et un autre utilisateur humain, spécifiez exactement une appartenance pour représenter l'utilisateur humain. Si un utilisateur bloque l'autre, la demande échoue et le message privé n'est pas créé.

Pour créer un MP entre l'utilisateur appelant et l'application appelante, définissez Space.singleUserBotDm sur true et ne spécifiez aucune appartenance. Vous ne pouvez utiliser cette méthode que pour configurer un message privé avec l'application d'appel. Pour ajouter l'application d'appel en tant que membre d'un espace ou d'un message privé existant entre deux utilisateurs humains, consultez Inviter ou ajouter un utilisateur ou une application à un espace.

Si un message privé existe déjà entre deux utilisateurs, même si l'un d'eux bloque l'autre au moment où la demande est effectuée, le message privé existant est renvoyé.

Les espaces avec réponses groupées ne sont pas acceptés. Si le message d'erreur ALREADY_EXISTS s'affiche lorsque vous configurez un espace, essayez un autre displayName. Il est possible qu'un espace existant dans l'organisation Google Workspace utilise déjà ce nom à afficher.

Nécessite une authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :

  • https://www.googleapis.com/auth/chat.spaces.create
  • https://www.googleapis.com/auth/chat.spaces
Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

Pour en savoir plus, consultez le guide d'autorisation.
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

Met à jour une appartenance. Pour consulter un exemple, reportez-vous à la section Modifier l'appartenance d'un utilisateur à un espace.

Compatible avec les types d'authentification suivants :

  • Authentification de l'application avec approbation de l'administrateur et champ d'application de l'autorisation :

    • https://www.googleapis.com/auth/chat.app.memberships (uniquement dans les espaces créés par l'application)

  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)
    • L'authentification de l'utilisateur accorde des droits d'administrateur lorsqu'un compte administrateur s'authentifie, use_admin_access est true et que le champ d'application d'autorisation suivant est utilisé :
      • https://www.googleapis.com/auth/chat.admin.memberships
Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships

Pour en savoir plus, consultez le guide d'autorisation.
UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

Met à jour un message. Il existe une différence entre les méthodes patch et update. La méthode patch utilise une requête patch, tandis que la méthode update utilise une requête put. Nous vous recommandons d'utiliser la méthode patch. Pour obtenir un exemple, consultez Mettre à jour un message.

Compatible avec les types d'authentification suivants :

  • Authentification par l'application avec le champ d'application de l'autorisation :

    • https://www.googleapis.com/auth/chat.bot

  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)

Lorsque vous utilisez l'authentification d'application, les requêtes ne peuvent mettre à jour que les messages créés par l'application Chat appelante.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

Pour en savoir plus, consultez le guide d'autorisation.
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

Met à jour un espace. Pour obtenir un exemple, consultez Mettre à jour un espace.

Si vous mettez à jour le champ displayName et que le message d'erreur ALREADY_EXISTS s'affiche, essayez un autre nom à afficher. Il est possible qu'un espace existant dans l'organisation Google Workspace utilise déjà ce nom à afficher.

Compatible avec les types d'authentification suivants :

  • Authentification de l'application avec approbation de l'administrateur et l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.app.spaces

  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)
    • L'authentification des utilisateurs accorde des droits d'administrateur lorsqu'un compte administrateur s'authentifie, use_admin_access est défini sur true et les niveaux d'accès suivants sont utilisés :
      • https://www.googleapis.com/auth/chat.admin.spaces

L'authentification des applications présente les limites suivantes :

  • Pour mettre à jour space.predefined_permission_settings ou space.permission_settings, l'application doit être celle qui a créé l'espace.
  • La mise à jour de space.access_settings.audience n'est pas acceptée pour l'authentification des applications.
Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

Pour en savoir plus, consultez le guide d'autorisation.
UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Met à jour le paramètre de notification de l'espace. Pour obtenir un exemple, consultez Mettre à jour le paramètre de notification de l'espace de l'appelant.

Nécessite une authentification de l'utilisateur avec le champ d'application de l'autorisation :

  • https://www.googleapis.com/auth/chat.users.spacesettings
Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/chat.users.spacesettings

Pour en savoir plus, consultez le guide d'autorisation.
UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

Met à jour l'état de lecture d'un utilisateur dans un espace. Cette méthode permet d'identifier les messages lus et non lus. Pour obtenir un exemple, consultez Mettre à jour l'état de lecture d'un espace pour un utilisateur.

Nécessite une authentification de l'utilisateur avec le champ d'application de l'autorisation :

  • https://www.googleapis.com/auth/chat.users.readstate
Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/chat.users.readstate

Pour en savoir plus, consultez le guide d'autorisation.

AccessoryWidget

Un ou plusieurs widgets interactifs qui s'affichent en bas d'un message. Pour en savoir plus, consultez Ajouter des widgets interactifs au bas d'un message.

Champs
Champ d'union action. Type d'action. action ne peut être qu'un des éléments suivants :
button_list

ButtonList

Liste de boutons.

ActionResponse

Paramètres qu'une application Chat peut utiliser pour configurer la façon dont sa réponse est publiée.

Champs
type

ResponseType

Uniquement en entrée. Type de réponse de l'application Chat.
url

string

Uniquement en entrée. URL permettant aux utilisateurs de s'authentifier ou de configurer le service. (Uniquement pour les types de réponse REQUEST_CONFIG.)
dialog_action

DialogAction

Uniquement en entrée. Réponse à un événement d'interaction lié à une boîte de dialogue. Doit être accompagné de ResponseType.Dialog.
updated_widget

UpdatedWidget

Uniquement en entrée. Réponse du widget mis à jour.

ResponseType

Type de réponse de l'application Chat.

Enums
TYPE_UNSPECIFIED Type par défaut géré en tant que NEW_MESSAGE.
NEW_MESSAGE Publier un nouveau message dans le sujet
UPDATE_MESSAGE Modifiez le message de l'application Chat. Cela n'est autorisé que pour un événement CARD_CLICKED dont le type d'expéditeur du message est BOT.
UPDATE_USER_MESSAGE_CARDS Mettez à jour les fiches du message d'un utilisateur. Cela n'est autorisé qu'en réponse à un événement MESSAGE avec une URL correspondante ou à un événement CARD_CLICKED dont le type d'expéditeur du message est HUMAN. Le texte est ignoré.
REQUEST_CONFIG Demandez à l'utilisateur de manière privée de fournir une authentification ou une configuration supplémentaire.
DIALOG Présente une boîte de dialogue.
UPDATE_WIDGET Requête des options de saisie semi-automatique du texte du widget.

SelectionItems

Liste des résultats de saisie semi-automatique du widget.

Champs
items[]

SelectionItem

Tableau des objets SelectionItem.

UpdatedWidget

Pour les widgets selectionInput, renvoie des suggestions de saisie semi-automatique pour un menu à sélection multiple.

Champs
widget

string

ID du widget mis à jour. L'ID doit correspondre à celui du widget qui a déclenché la demande de mise à jour.
Champ d'union updated_widget. Le widget a été mis à jour en réponse à une action de l'utilisateur. updated_widget ne peut être qu'un des éléments suivants :
suggestions

SelectionItems

Liste des résultats de saisie semi-automatique du widget

ActionStatus

Représente l'état d'une requête visant à appeler ou à envoyer un dialogue.

Champs
status_code

Code

Code d'état.
user_facing_message

string

Message à envoyer aux utilisateurs concernant l'état de leur demande. Si cette valeur n'est pas définie, un message générique basé sur status_code est envoyé.

Annotation

Uniquement en sortie. Les annotations peuvent être associées au corps en texte brut du message ou à des chips qui renvoient vers des ressources Google Workspace telles que Google Docs ou Sheets avec start_index et length définis sur 0. Pour ajouter une mise en forme de base à un message, consultez Mettre en forme les messages.

Exemple de corps de message en texte brut :

Hello @FooBot how are you!"

Métadonnées des annotations correspondantes :

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
Champs
type

AnnotationType

Type de cette annotation.
length

int32

Longueur de la sous-chaîne dans le corps du message en texte brut à laquelle correspond cette annotation. Si elle n'est pas présente, cela indique une longueur de 0.
start_index

int32

Index de début (inclus, basé sur 0) dans le corps du message en texte brut auquel correspond cette annotation.
Champ d'union metadata. Métadonnées supplémentaires sur l'annotation. metadata ne peut être qu'un des éléments suivants :
user_mention

UserMentionMetadata

Métadonnées de la mention de l'utilisateur.
slash_command

SlashCommandMetadata

Métadonnées d'une commande à barre oblique.
custom_emoji_metadata

CustomEmojiMetadata

Métadonnées d'un emoji personnalisé.

AnnotationType

Type de l'annotation.

Enums
ANNOTATION_TYPE_UNSPECIFIED Valeur par défaut de l'énumération. Ne pas utiliser.
USER_MENTION Un utilisateur est mentionné.
SLASH_COMMAND Une commande à barre oblique est appelée.
CUSTOM_EMOJI Annotation d'emoji personnalisé.

AppCommandMetadata

Métadonnées concernant une commande d'application Chat.

Champs
app_command_id

int32

ID de la commande spécifiée dans la configuration de l'API Chat.
app_command_type

AppCommandType

Type de commande de l'application Chat.

AppCommandType

Type de commande de l'application Chat. Pour en savoir plus, consultez Types de commandes d'applications Chat.

Enums
APP_COMMAND_TYPE_UNSPECIFIED Valeur par défaut. Non spécifié.
SLASH_COMMAND Une commande à barre oblique. L'utilisateur envoie la commande dans un message Chat.
QUICK_COMMAND Une commande rapide. L'utilisateur sélectionne la commande dans le menu Chat de la zone de réponse au message.

AttachedGif

Image GIF spécifiée par une URL.

Champs
uri

string

Uniquement en sortie. URL qui héberge l'image GIF.

Pièce jointe

Pièce jointe dans Google Chat.

Champs
name

string

Facultatif. Nom de ressource de la pièce jointe, au format spaces/{space}/messages/{message}/attachments/{attachment}.
content_name

string

Uniquement en sortie. Nom de fichier d'origine du contenu, et non le chemin d'accès complet.
content_type

string

Uniquement en sortie. Type de contenu (type MIME) du fichier.
thumbnail_uri

string

Uniquement en sortie. URL de la miniature à utiliser pour prévisualiser la pièce jointe pour un utilisateur humain. Les applications de chat ne doivent pas utiliser cette URL pour télécharger le contenu des pièces jointes.
download_uri

string

Uniquement en sortie. URL de téléchargement à utiliser pour permettre à un utilisateur humain de télécharger la pièce jointe. Les applications de chat ne doivent pas utiliser cette URL pour télécharger le contenu des pièces jointes.
source

Source

Uniquement en sortie. Source de la pièce jointe.
Champ d'union data_ref. Référence aux données de la pièce jointe. data_ref ne peut être qu'un des éléments suivants :
attachment_data_ref

AttachmentDataRef

Facultatif. Référence aux données de la pièce jointe. Ce champ permet de créer ou de mettre à jour des messages avec des pièces jointes, ou avec l'API Media pour télécharger les données des pièces jointes.
drive_data_ref

DriveDataRef

Uniquement en sortie. Référence à la pièce jointe Google Drive. Ce champ est utilisé avec l'API Google Drive.

Source

Source de la pièce jointe.

Enums
SOURCE_UNSPECIFIED Réservé.
DRIVE_FILE Le fichier est un fichier Google Drive.
UPLOADED_CONTENT Le fichier est importé dans Chat.

AttachmentDataRef

Référence aux données de la pièce jointe.

Champs
resource_name

string

Facultatif. Nom de ressource des données de la pièce jointe. Ce champ est utilisé avec l'API Media pour télécharger les données des pièces jointes.
attachment_upload_token

string

Facultatif. Jeton opaque contenant une référence à une pièce jointe importée. Chaîne opaque traitée par les clients et utilisée pour créer ou modifier des messages de chat avec des pièces jointes.

CalendarEventLinkData

Données pour les liens vers des événements Agenda.

Champs
calendar_id

string

Identifiant de l'agenda associé.
event_id

string

L'identifiant de l'événement de l'événement Agenda associé.

CardWithId

Une fiche dans un message Google Chat.

Seules les applications Chat peuvent créer des fiches. Si votre application Chat s'authentifie en tant qu'utilisateur, le message ne peut pas contenir de cartes.

Concevez et prévisualisez des cartes avec le générateur de cartes.

Ouvrir le générateur de cartes

Champs
card_id

string

Obligatoire si le message contient plusieurs cartes. Identifiant unique d'une fiche dans un message.
card

Card

Une fiche La taille maximale est de 32 Ko.

ChatSpaceLinkData

Données pour les liens vers les espaces Chat.

Champs
space

string

Espace de la ressource d'espace Chat associée.

Format : spaces/{space}
thread

string

Fil de discussion de la ressource d'espace Chat associée.

Format : spaces/{space}/threads/{thread}
message

string

Message de la ressource d'espace Chat associée.

Format : spaces/{space}/messages/{message}

CompleteImportSpaceRequest

Message de requête pour terminer le processus d'importation d'un espace.

Champs
name

string

Obligatoire. Nom de ressource de l'espace en mode importation.

Format : spaces/{space}

CompleteImportSpaceResponse

Message de réponse pour la finalisation du processus d'importation d'un espace.

Champs
space

Space

Espace en mode importation.

ContextualAddOnMarkup

Ce type ne comporte aucun champ.

Balisage permettant aux développeurs de spécifier le contenu d'un module complémentaire contextuel.

Fiche

Une fiche est un élément d'interface utilisateur qui peut contenir des widgets d'interface utilisateur tels que du texte et des images.

Champs
header

CardHeader

En-tête de la fiche. Un en-tête contient généralement un titre et une image.
sections[]

Section

Les sections sont séparées par une ligne.
card_actions[]

CardAction

Actions de cette carte.
name

string

Nom de la carte.

CardAction

Une action de fiche est l'action associée à la fiche. Pour une fiche de facture, une action typique consiste à supprimer la facture, à l'envoyer par e-mail ou à l'ouvrir dans un navigateur.

Non disponible pour les applications Google Chat.

Champs
action_label

string

Libellé qui était affiché dans l'élément de menu d'action.
on_click

OnClick

Action onclick pour cet élément d'action.

CardHeader

Champs
title

string

Vous devez indiquer le titre. L'en-tête a une hauteur fixe : si un titre et un sous-titre sont spécifiés, chacun occupe une ligne. Si seul le titre est spécifié, il occupe les deux lignes.
subtitle

string

Sous-titre de l'en-tête de la fiche.
image_style

ImageStyle

Type de l'image (par exemple, bordure carrée ou circulaire).
image_url

string

URL de l'image dans l'en-tête de la carte.

ImageStyle

Enums
IMAGE_STYLE_UNSPECIFIED
IMAGE Bordure carrée.
AVATAR Bordure circulaire.

Section

Une section contient un ensemble de widgets qui sont affichés (verticalement) dans l'ordre dans lequel ils sont spécifiés. Sur toutes les plates-formes, les cartes ont une largeur fixe étroite. Il n'est donc pas nécessaire d'utiliser des propriétés de mise en page (par exemple, float).

Champs
header

string

En-tête de la section. Le texte mis en forme est accepté. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme du texte dans les applications Google Chat et Mettre en forme du texte dans les modules complémentaires Google Workspace.
widgets[]

WidgetMarkup

Une section doit contenir au moins un widget.

CreateCustomEmojiRequest

Requête permettant de créer un emoji personnalisé.

Champs
custom_emoji

CustomEmoji

Obligatoire. Emoji personnalisé à créer.

CreateMembershipRequest

Message de requête pour créer un abonnement.

Champs
parent

string

Obligatoire. Nom de ressource de l'espace pour lequel créer l'abonnement.

Format : spaces/{space}
membership

Membership

Obligatoire. Relation d'appartenance à créer.

Le champ memberType doit contenir un utilisateur dont les champs user.name et user.type sont renseignés. Le serveur attribuera un nom de ressource et écrasera tout ce qui a été spécifié.

Lorsqu'une application Chat crée une relation de membre pour un utilisateur humain, elle doit utiliser certains niveaux d'autorisation et définir des valeurs spécifiques pour certains champs :

  • Lors de l'authentification en tant qu'utilisateur, le champ d'application de l'autorisation chat.memberships est requis.

  • Lorsque vous vous authentifiez en tant qu'application, le champ d'application d'autorisation chat.app.memberships est requis.

  • Définissez user.type sur HUMAN et user.name au format users/{user}, où {user} peut être l'adresse e-mail de l'utilisateur. Pour les utilisateurs de la même organisation Workspace, {user} peut également être le id de la personne de l'API People ou le id de l'utilisateur dans l'API Directory. Par exemple, si l'ID de profil de personne de l'API People pour [email protected] est 123456789, vous pouvez ajouter l'utilisateur à l'espace en définissant membership.member.name sur users/[email protected] ou users/123456789.

Pour inviter des utilisateurs externes à l'organisation Workspace propriétaire de l'espace, vous devez authentifier les utilisateurs.

Lorsqu'une application Chat crée une relation d'appartenance pour elle-même, elle doit s'authentifier en tant qu'utilisateur et utiliser le champ d'application chat.memberships.app, définir user.type sur BOT et user.name sur users/app.
use_admin_access

bool

Facultatif. Lorsque la valeur est true, la méthode s'exécute avec les droits d'administrateur Google Workspace de l'utilisateur.

L'utilisateur qui appelle doit être un administrateur Google Workspace disposant du droit "Gérer les conversations Chat et Espaces".

Nécessite le champ d'application OAuth 2.0 chat.admin.memberships.

La création d'abonnements à des applications ou pour des utilisateurs en dehors de l'organisation Google Workspace de l'administrateur n'est pas possible avec l'accès administrateur.

CreateMessageRequest

Crée un message.

Champs
parent

string

Obligatoire. Nom de ressource de l'espace dans lequel créer un message.

Format : spaces/{space}
message

Message

Obligatoire. Corps du message.
thread_key
(deprecated)

string

Facultatif. Obsolète : utilisez plutôt thread.thread_key. ID du fil de discussion. Elle peut contenir jusqu'à 4 000 caractères. Pour démarrer un fil de discussion ou y ajouter un message, créez un message et spécifiez un threadKey ou un thread.name. Pour obtenir des exemples d'utilisation, consultez Démarrer un fil de discussion ou y répondre.
request_id

string

Facultatif. ID de requête unique pour ce message. Si vous spécifiez un ID de demande existant, le message créé avec cet ID est renvoyé au lieu d'en créer un.
message_reply_option

MessageReplyOption

Facultatif. Indique si un message démarre un fil de discussion ou y répond. Compatible uniquement avec les espaces nommés.

Ce champ est ignoré lorsque vous répondez aux interactions utilisateur. Pour les interactions dans un fil de discussion, la réponse est créée dans le même fil. Sinon, la réponse est créée sous forme de nouveau fil de discussion.
message_id

string

Facultatif. ID personnalisé d'un message. Permet aux applications Chat d'obtenir, de mettre à jour ou de supprimer un message sans avoir à stocker l'ID attribué par le système dans le nom de ressource du message (représenté dans le champ name du message).

La valeur de ce champ doit répondre aux exigences suivantes :

  • Commence par client-. Par exemple, client-custom-name est un ID personnalisé valide, mais custom-name ne l'est pas.
  • Contenir jusqu'à 63 caractères, et uniquement des lettres minuscules, des chiffres et des traits d'union.
  • Il est unique dans un espace. Une application Chat ne peut pas utiliser le même ID personnalisé pour différents messages.

Pour en savoir plus, consultez Nommer un message.

MessageReplyOption

Spécifie comment répondre à un message. D'autres États pourront être ajoutés à l'avenir.

Enums
MESSAGE_REPLY_OPTION_UNSPECIFIED Par défaut. Démarre un nouveau thread. Si vous choisissez cette option, les thread ID ou thread_key inclus seront ignorés.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Crée le message en réponse au fil de discussion spécifié par thread ID ou thread_key. Si l'opération échoue, le message lance un nouveau fil de discussion.
REPLY_MESSAGE_OR_FAIL Crée le message en réponse au fil de discussion spécifié par thread ID ou thread_key. Si un nouveau thread_key est utilisé, un nouveau fil de discussion est créé. Si la création du message échoue, une erreur NOT_FOUND est renvoyée.

CreateReactionRequest

Crée une réaction à un message.

Champs
parent

string

Obligatoire. Message sur lequel la réaction est créée.

Format : spaces/{space}/messages/{message}
reaction

Reaction

Obligatoire. Réaction à créer.

CreateSpaceRequest

Demande de création d'un espace nommé sans membres.

Champs
space

Space

Obligatoire. Les champs displayName et spaceType doivent être renseignés. Seuls SpaceType.SPACE et SpaceType.GROUP_CHAT sont acceptés. SpaceType.GROUP_CHAT ne peut être utilisé que si importMode est défini sur "true".

Si le message d'erreur ALREADY_EXISTS s'affiche, essayez un autre displayName. Il est possible qu'un espace existant dans l'organisation Google Workspace utilise déjà ce nom à afficher.

L'espace name est attribué sur le serveur. Par conséquent, tout ce qui est spécifié dans ce champ sera ignoré.
request_id

string

Facultatif. Identifiant unique de cette demande. Nous vous recommandons d'utiliser un UUID aléatoire. Si vous spécifiez un ID de demande existant, l'espace créé avec cet ID est renvoyé au lieu d'un nouvel espace. Si vous spécifiez un ID de demande existant provenant de la même application Chat avec un utilisateur authentifié différent, une erreur est renvoyée.

CustomEmoji

Représente un emoji personnalisé.

Champs
name

string

Identifiant. Nom de ressource de l'emoji personnalisé, attribué par le serveur.

Format : customEmojis/{customEmoji}
uid

string

Uniquement en sortie. Clé unique de la ressource d'emoji personnalisé.
emoji_name

string

Facultatif. Immuable. Nom fourni par l'utilisateur pour l'emoji personnalisé, qui est unique au sein de l'organisation.

Obligatoire lors de la création de l'emoji personnalisé, en sortie uniquement dans le cas contraire.

Les noms d'emojis doivent commencer et se terminer par un deux-points, être en minuscules et ne contenir que des caractères alphanumériques, des traits d'union et des traits de soulignement. Les traits d'union et les traits de soulignement servent à séparer les mots et ne peuvent pas être utilisés de manière consécutive.

Exemple : :valid-emoji-name:
temporary_image_uri

string

Uniquement en sortie. URL temporaire de l'image pour l'emoji personnalisé, valide pendant au moins 10 minutes. Notez que cette valeur n'est pas renseignée dans la réponse lorsque l'emoji personnalisé est créé.
payload

CustomEmojiPayload

Facultatif. Uniquement en entrée. Données de charge utile. Obligatoire lors de la création de l'emoji personnalisé.

CustomEmojiPayload

Données de charge utile pour l'emoji personnalisé.

Champs
file_content

bytes

Obligatoire. Uniquement en entrée. Image utilisée pour l'emoji personnalisé.

La charge utile doit être inférieure à 256 ko, et l'image doit être carrée et mesurer entre 64 et 500 pixels. Ces restrictions sont susceptibles d'être modifiées.
filename

string

Obligatoire. Uniquement en entrée. Nom du fichier image.

Extensions de fichier acceptées : .png, .jpg, .gif.

CustomEmojiMetadata

Métadonnées d'annotation pour les emoji personnalisés.

Champs
custom_emoji

CustomEmoji

Emoji personnalisé.

DeleteCustomEmojiRequest

Demande de suppression d'un emoji personnalisé.

Champs
name

string

Obligatoire. Nom de ressource de l'emoji personnalisé à supprimer.

Format : customEmojis/{customEmoji}

Vous pouvez utiliser le nom de l'emoji comme alias pour {customEmoji}. Par exemple, customEmojis/:example-emoji: où :example-emoji: est le nom d'un emoji personnalisé.

DeleteMembershipRequest

Demande de suppression d'un membre dans un espace.

Champs
name

string

Obligatoire. Nom de ressource de la souscription à supprimer. Les applications de chat peuvent supprimer les abonnements des utilisateurs humains ou les leurs. Les applications de chat ne peuvent pas supprimer les abonnements d'autres applications.

Lorsque vous supprimez un membre humain, vous devez utiliser le champ d'application chat.memberships avec l'authentification de l'utilisateur ou le champ d'application chat.memberships.app avec l'authentification de l'application et le format spaces/{space}/members/{member}. Vous pouvez utiliser l'adresse e-mail comme alias pour {member}. Par exemple, spaces/{space}/members/[email protected] où [email protected] est l'adresse e-mail de l'utilisateur Google Chat.

Lors de la suppression d'une appartenance à une application, les formats chat.memberships.app et spaces/{space}/members/app sont requis.

Format : spaces/{space}/members/{member} ou spaces/{space}/members/app.
use_admin_access

bool

Facultatif. Lorsque la valeur est true, la méthode s'exécute avec les droits d'administrateur Google Workspace de l'utilisateur.

L'utilisateur qui appelle doit être un administrateur Google Workspace disposant du droit "Gérer les conversations Chat et Espaces".

Nécessite le champ d'application OAuth 2.0 chat.admin.memberships.

Il n'est pas possible de supprimer les abonnements aux applications dans un espace avec un accès administrateur.

DeleteMessageRequest

Demande de suppression d'un message.

Champs
name

string

Obligatoire. Nom de ressource du message.

Format : spaces/{space}/messages/{message}

Si vous avez défini un ID personnalisé pour votre message, vous pouvez utiliser la valeur du champ clientAssignedMessageId pour {message}. Pour en savoir plus, consultez Nommer un message.
force

bool

Facultatif. Lorsque true, la suppression d'un message entraîne également la suppression des réponses associées. Lorsque false, si un message comporte des réponses groupées, la suppression échoue.

Ne s'applique que lors de l'authentification en tant qu'utilisateur. N'a aucun effet lors de l'authentification en tant qu'application Chat.

DeleteReactionRequest

Supprime une réaction à un message.

Champs
name

string

Obligatoire. Nom de la réaction à supprimer.

Format : spaces/{space}/messages/{message}/reactions/{reaction}

DeleteSpaceRequest

Demande de suppression d'un espace.

Champs
name

string

Obligatoire. Nom de ressource de l'espace à supprimer.

Format : spaces/{space}
use_admin_access

bool

Facultatif. Lorsque la valeur est true, la méthode s'exécute avec les droits d'administrateur Google Workspace de l'utilisateur.

L'utilisateur qui appelle doit être un administrateur Google Workspace disposant du droit "Gérer les conversations Chat et Espaces".

Nécessite le champ d'application OAuth 2.0 chat.admin.delete.

DeletionMetadata

Informations sur un message supprimé. Un message est supprimé lorsque delete_time est défini.

Champs
deletion_type

DeletionType

Indique qui a supprimé le message.

DeletionType

Qui a supprimé le message et comment il a été supprimé D'autres valeurs pourront être ajoutées à l'avenir. Pour savoir quand les messages peuvent être supprimés, consultez Modifier ou supprimer un message dans Google Chat.

Enums
DELETION_TYPE_UNSPECIFIED Cette valeur n'est pas utilisée.
CREATOR L'utilisateur a supprimé son propre message.
SPACE_OWNER Un gestionnaire de l'espace a supprimé le message.
ADMIN Un administrateur Google Workspace a supprimé le message. Les administrateurs peuvent supprimer n'importe quel message de l'espace, y compris ceux envoyés par un membre de l'espace ou par l'application Chat.
APP_MESSAGE_EXPIRY Une application Chat a supprimé son propre message à son expiration.
CREATOR_VIA_APP Une application Chat a supprimé le message au nom de son créateur (à l'aide de l'authentification de l'utilisateur).
SPACE_OWNER_VIA_APP Une application Chat a supprimé le message au nom d'un gestionnaire d'espace (à l'aide de l'authentification de l'utilisateur).
SPACE_MEMBER Un membre de l'espace a supprimé le message. Les utilisateurs peuvent supprimer les messages envoyés par les applications.

Dialog

Wrapper autour du corps de la fiche de la boîte de dialogue.

Champs
body

Card

Uniquement en entrée. Corps de la boîte de dialogue, affiché dans un modal. Les applications Google Chat ne sont pas compatibles avec les entités de carte suivantes : DateTimePicker, OnChangeAction.

DialogAction

Contient un dialog et un code d'état de la requête.

Champs
action_status

ActionStatus

Uniquement en entrée. État d'une requête permettant d'appeler ou d'envoyer un dialogue. Affiche un état et un message aux utilisateurs, si nécessaire. Par exemple, en cas d'erreur ou de réussite.
Champ d'union action. Action à effectuer. action ne peut être qu'un des éléments suivants :
dialog

Dialog

Uniquement en entrée. Boîte de dialogue pour la requête.

DriveDataRef

Référence aux données d'une pièce jointe Drive.

Champs
drive_file_id

string

ID du fichier Drive. Utilisez-le avec l'API Drive.

DriveLinkData

Données pour les liens Google Drive.

Champs
drive_data_ref

DriveDataRef

Un DriveDataRef qui fait référence à un fichier Google Drive.
mime_type

string

Type MIME de la ressource Google Drive associée.

Emoji

Emoji utilisé comme réaction à un message.

Champs
Champ d'union content. Obligatoire. Contenu de l'emoji. content ne peut être qu'un des éléments suivants :
unicode

string

Facultatif. Emoji de base représenté par une chaîne Unicode.
custom_emoji

CustomEmoji

Un emoji personnalisé.

EmojiReactionSummary

Nombre de personnes ayant réagi à un message avec un emoji spécifique.

Champs
emoji

Emoji

Uniquement en sortie. Emoji associé aux réactions.
reaction_count

int32

Uniquement en sortie. Nombre total de réactions utilisant l'emoji associé.

FindDirectMessageRequest

Requête permettant d'obtenir un espace de messages privés en fonction de la ressource utilisateur.

Champs
name

string

Obligatoire. Nom de ressource de l'utilisateur avec lequel trouver un message privé.

Format : users/{user}, où {user} correspond au id de la personne dans l'API People ou au id de l'utilisateur dans l'API Directory. Par exemple, si l'ID de profil de l'API People est 123456789, vous pouvez trouver un message privé avec cette personne en utilisant users/123456789 comme name. Lorsque vous êtes authentifié en tant qu'utilisateur, vous pouvez utiliser l'adresse e-mail comme alias pour {user}. Par exemple, users/