Package google.chat.v1

Index

• ChatService (interface)
• AccessoryWidget (message)
• ActionResponse (message)
• ActionResponse.ResponseType (enum)
• ActionResponse.SelectionItems (message)
• ActionResponse.UpdatedWidget (message)
• ActionStatus (message)
• Annotation (message)
• AnnotationType (enum)
• AttachedGif (message)
• Attachment (message)
• Attachment.Source (enum)
• AttachmentDataRef (message)
• CardWithId (message)
• ChatSpaceLinkData (message)
• CompleteImportSpaceRequest (message)
• CompleteImportSpaceResponse (message)
• ContextualAddOnMarkup (message)
• ContextualAddOnMarkup.Card (message)
• ContextualAddOnMarkup.Card.CardAction (message)
• ContextualAddOnMarkup.Card.CardHeader (message)
• ContextualAddOnMarkup.Card.CardHeader.ImageStyle (enum)
• ContextualAddOnMarkup.Card.Section (message)
• CreateCustomEmojiRequest (message)
• CreateMembershipRequest (message)
• CreateMessageRequest (message)
• CreateMessageRequest.MessageReplyOption (enum)
• CreateReactionRequest (message)
• CreateSpaceRequest (message)
• CustomEmoji (message)
• CustomEmoji.CustomEmojiPayload (message)
• DeleteCustomEmojiRequest (message)
• DeleteMembershipRequest (message)
• DeleteMessageRequest (message)
• DeleteReactionRequest (message)
• DeleteSpaceRequest (message)
• DeletionMetadata (message)
• DeletionMetadata.DeletionType (enum)
• Dialog (message)
• DialogAction (message)
• DriveDataRef (message)
• DriveLinkData (message)
• Emoji (message)
• EmojiReactionSummary (message)
• FindDirectMessageRequest (message)
• GetAttachmentRequest (message)
• GetCustomEmojiRequest (message)
• GetMembershipRequest (message)
• GetMessageRequest (message)
• GetSpaceEventRequest (message)
• GetSpaceNotificationSettingRequest (message)
• GetSpaceReadStateRequest (message)
• GetSpaceRequest (message)
• GetThreadReadStateRequest (message)
• Group (message)
• HistoryState (enum)
• ListCustomEmojisRequest (message)
• ListCustomEmojisResponse (message)
• ListMembershipsRequest (message)
• ListMembershipsResponse (message)
• ListMessagesRequest (message)
• ListMessagesResponse (message)
• ListReactionsRequest (message)
• ListReactionsResponse (message)
• ListSpaceEventsRequest (message)
• ListSpaceEventsResponse (message)
• ListSpacesRequest (message)
• ListSpacesResponse (message)
• MatchedUrl (message)
• Membership (message)
• Membership.MembershipRole (enum)
• Membership.MembershipState (enum)
• MembershipBatchCreatedEventData (message)
• MembershipBatchDeletedEventData (message)
• MembershipBatchUpdatedEventData (message)
• MembershipCreatedEventData (message)
• MembershipDeletedEventData (message)
• MembershipUpdatedEventData (message)
• Message (message)
• MessageBatchCreatedEventData (message)
• MessageBatchDeletedEventData (message)
• MessageBatchUpdatedEventData (message)
• MessageCreatedEventData (message)
• MessageDeletedEventData (message)
• MessageUpdatedEventData (message)
• QuotedMessageMetadata (message)
• Reaction (message)
• ReactionBatchCreatedEventData (message)
• ReactionBatchDeletedEventData (message)
• ReactionCreatedEventData (message)
• ReactionDeletedEventData (message)
• RichLinkMetadata (message)
• RichLinkMetadata.RichLinkType (enum)
• SearchSpacesRequest (message)
• SearchSpacesResponse (message)
• SetUpSpaceRequest (message)
• SlashCommand (message)
• SlashCommandMetadata (message)
• SlashCommandMetadata.Type (enum)
• Space (message)
• Space.AccessSettings (message)
• Space.AccessSettings.AccessState (enum)
• Space.MembershipCount (message)
• Space.PermissionSetting (message)
• Space.PermissionSettings (message)
• Space.PredefinedPermissionSettings (enum)
• Space.SpaceDetails (message)
• Space.SpaceThreadingState (enum)
• Space.SpaceType (enum)
• Space.Type (enum)
• SpaceBatchUpdatedEventData (message)
• SpaceEvent (message)
• SpaceReadState (message)
• SpaceUpdatedEventData (message)
• Thread (message)
• ThreadReadState (message)
• UpdateMembershipRequest (message)
• UpdateMessageRequest (message)
• UpdateSpaceReadStateRequest (message)
• UpdateSpaceRequest (message)
• User (message)
• User.Type (enum)
• UserMentionMetadata (message)
• UserMentionMetadata.Type (enum)
• WidgetMarkup (message)
• WidgetMarkup.Button (message)
• WidgetMarkup.FormAction (message)
• WidgetMarkup.FormAction.ActionParameter (message)
• WidgetMarkup.Icon (enum)
• WidgetMarkup.Image (message)
• WidgetMarkup.ImageButton (message)
• WidgetMarkup.KeyValue (message)
• WidgetMarkup.OnClick (message)
• WidgetMarkup.OpenLink (message)
• WidgetMarkup.TextButton (message)
• WidgetMarkup.TextParagraph (message)

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) Termine le processus d'importation pour l'espace spécifié et le rend visible pour les utilisateurs. Nécessite l'authentification des applications et la délégation au niveau du domaine. 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) Preview développeur : disponible dans le cadre du programme Preview développeur Google Workspace, qui permet d'accéder en avant-première à certaines fonctionnalités. Crée un emoji personnalisé. Authentification des utilisateurs requise. 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 relatif aux autorisations.

CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership) Crée un abonnement pour l'application Chat appelante, un utilisateur ou un groupe Google. Il n'est pas possible de créer des souscriptions pour d'autres applications Chat. Lorsque vous créez un accès, si la règle d'acceptation automatique du membre spécifié est désactivée, il est invité et doit accepter l'invitation à l'espace avant de le rejoindre. Sinon, la création d'un accès ajoute le membre directement à l'espace spécifié. Compatible avec les types d'authentification suivants : Authentification des applications avec approbation de l'administrateur dans la Preview développeur Authentification de l'utilisateur : vous pouvez authentifier et autoriser cette méthode avec des droits d'administrateur en définissant le champ use_admin_access dans la requête. Pour voir un exemple d'utilisation, consultez les articles suivants : Inviter ou ajouter un utilisateur à un espace Inviter ou ajouter un groupe Google à un espace Ajoutez l'application Chat à un 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.

CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message) Crée un message dans un espace Google Chat. Pour obtenir un exemple, consultez Envoyer un message. La méthode create() nécessite une authentification de l'utilisateur ou une authentification de l'application. Chat attribue l'expéditeur du message différemment en fonction du 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 en tant qu'expéditeur du message. Le contenu du message peut inclure du texte (text), des fiches (cardsV2) et des widgets accessoires (accessoryWidgets). L'image suivante montre comment Chat attribue un message lorsque vous utilisez l'authentification utilisateur. Chat présente l'utilisateur en tant qu'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). La taille maximale du message, contenu inclus, est de 32 000 octets. 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 relatif aux autorisations.

CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction) Crée une réaction et l'ajoute à un message. Seuls les emoji Unicode sont acceptés. Pour obtenir un exemple, consultez Ajouter une réaction à un message. Nécessite une authentification de l'utilisateur. 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 relatif aux autorisations.

CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space) Crée un espace sans membres. Peut être utilisé pour créer un espace nommé. Les espaces regroupés par sujets ne sont pas acceptés. Pour obtenir un exemple, consultez la section Créer un espace. Si le message d'erreur ALREADY_EXISTS s'affiche lorsque vous créez un espace, essayez avec un autre displayName. Un espace existant dans l'organisation Google Workspace utilise peut-être déjà ce nom à afficher. Si vous êtes membre du programme Preview développeur, vous pouvez créer une discussion de groupe en mode importation à l'aide de spaceType.GROUP_CHAT. Accepte les types d'authentification suivants: Authentification de l'application avec approbation de l'administrateur dans la version Preview développeur Authentification des utilisateurs Lors de l'authentification en tant qu'application, le champ space.customer doit être défini 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.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 relatif aux autorisations.

DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty) Preview développeur:disponible dans le cadre du programme Preview développeur Google Workspace, qui accorde un accès anticipé à certaines fonctionnalités. Supprime un emoji personnalisé. Authentification des utilisateurs requise. 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 relatif aux autorisations.

DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership) Supprime un abonnement. Pour en savoir plus, consultez Supprimer un utilisateur ou une application Google Chat d'un espace. Accepte les types d'authentification suivants: Authentification de l'application avec approbation de l'administrateur dans la version Preview développeur Authentification de l'utilisateur : vous pouvez authentifier et autoriser cette méthode avec des droits d'administrateur en définissant le champ use_admin_access 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.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 relatif aux autorisations.

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 des applications Authentification des utilisateurs Lorsque vous utilisez l'authentification des applications, les requêtes ne peuvent supprimer que les messages créés par l'application Chat qui est à l'origine de l'appel. 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. Seuls les emoji Unicode sont acceptés. Vous trouverez un exemple dans la section Supprimer une réaction. Nécessite une authentification de l'utilisateur. 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 adhésions à 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 dans la version Preview développeur Authentification de l'utilisateur : vous pouvez authentifier et autoriser cette méthode avec des droits d'administrateur en définissant le champ use_admin_access 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.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 relatif aux autorisations.

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 messages privés 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é. // Accepte les types d'authentification suivants: Authentification des applications Authentification des utilisateurs 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 relatif aux autorisations.

GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment) Récupère les métadonnées d'une pièce jointe. Les données de l'attachement sont récupérées à l'aide de l'API multimédia. Pour obtenir un exemple, consultez la section Obtenir les métadonnées d'une pièce jointe de message. Authentification de l'application requise. 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) Preview développeur : disponible dans le cadre du programme Preview développeur Google Workspace, qui permet d'accéder en avant-première à certaines fonctionnalités. Renvoie des informations sur un emoji personnalisé. Authentification des utilisateurs requise. 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 relatif aux autorisations.

GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership) Renvoie les détails d'une appartenance. Pour obtenir un exemple, consultez Obtenir des informations sur l'adhésion d'un utilisateur ou d'une application Google Chat. Accepte les types d'authentification suivants: Authentification des applications Authentification de l'utilisateur : vous pouvez authentifier et autoriser cette méthode avec des droits d'administrateur en définissant le champ use_admin_access 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.admin.memberships https://www.googleapis.com/auth/chat.admin.memberships.readonly 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 relatif aux autorisations.

GetMessage

rpc GetMessage(GetMessageRequest) returns (Message) Renvoie des informations sur un message. Pour obtenir un exemple, consultez Obtenir des informations sur un message. Accepte les types d'authentification suivants: Authentification des applications Authentification des utilisateurs Remarque: il est possible que vous receviez un message d'un membre ou d'un espace bloqué. 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 Pour en savoir plus, consultez le guide d'autorisation.

GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space) Affiche les détails d'un espace. Pour en savoir plus, consultez la section Obtenir des informations sur un espace. Accepte les types d'authentification suivants: Authentification de l'application Authentification de l'utilisateur : vous pouvez authentifier et autoriser cette méthode avec des droits d'administrateur en définissant le champ use_admin_access 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.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 relatif aux autorisations.

GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent) Affiche 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é mis à jour ultérieurement, 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. Nécessite une authentification de l'utilisateur. Pour obtenir un événement, l'utilisateur authentifié doit être membre de l'espace. Pour obtenir un exemple, consultez Obtenir des informations sur un événement dans 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.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.

GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState) Affiche des informations sur l'état de lecture d'un utilisateur dans un espace, qui permettent d'identifier les messages lus et non lus. Pour obtenir un exemple, consultez Obtenir des informations sur l'état de lecture d'un espace utilisateur. Authentification des utilisateurs requise. 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 relatif aux autorisations.

GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState) Renvoie des informations sur l'état de lecture d'un utilisateur dans un fil de discussion, qui permettent d'identifier les messages lus et non lus. Pour obtenir un exemple, consultez Obtenir des informations sur l'état de lecture des fils d'un utilisateur. Nécessite une authentification de l'utilisateur. 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) Preview développeur : disponible dans le cadre du programme Preview développeur Google Workspace, qui permet d'accéder en avant-première à certaines fonctionnalités. Répertorie les emoji personnalisés visibles par l'utilisateur authentifié. Authentification des utilisateurs requise. 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.

ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse) Répertorie les appartenances à un espace. Pour obtenir un exemple, consultez Répertorier les utilisateurs et les applications Google Chat d'un espace. L'affichage des appartenances avec l'authentification de l'application liste les appartenances aux espaces auxquels l'application Chat a accès, mais exclut les appartenances à l'application Chat, y compris la sienne. Si vous répertoriez les adhésions avec l'authentification des utilisateurs, elles sont également répertoriées dans les espaces auxquels l'utilisateur authentifié a accès. Accepte les types d'authentification suivants: Authentification des applications Authentification de l'utilisateur : vous pouvez authentifier et autoriser cette méthode avec des droits d'administrateur en définissant le champ use_admin_access 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.admin.memberships https://www.googleapis.com/auth/chat.admin.memberships.readonly https://www.googleapis.com/auth/chat.import 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.

ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse) Liste les messages d'un espace dont l'appelant est membre, y compris les messages de membres et d'espaces bloqués. Si vous listez des messages d'un espace qui n'en contient pas, 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 la section Répertorier les messages. Authentification des utilisateurs requise. 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 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 Répertorier les réactions à un message. Nécessite une authentification de l'utilisateur. 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 répertoriez des événements concernant les nouveaux membres d'un espace, le serveur renvoie les ressources Membership contenant les informations d'adhésion les plus récentes. Si de nouveaux membres ont été supprimés pendant la période demandée, la charge utile de l'événement contient une ressource Membership vide. Authentification des utilisateurs requise. Pour lister les événements, l'utilisateur authentifié doit être membre de l'espace. Pour en savoir plus, 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.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) Répertorie les espaces dont l'appelant est membre. Les chats de groupe et les MP ne sont pas listés tant que le premier message n'a pas été envoyé. Pour obtenir un exemple, consultez Répertorier les espaces. Compatible avec les types d'authentification suivants : Authentification de l'application Authentification des utilisateurs Pour répertorier tous les espaces nommés par organisation Google Workspace, utilisez plutôt la méthode spaces.search() avec des 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. Nécessite l'authentification des utilisateurs avec des droits d'administrateur. Dans la requête, définissez use_admin_access sur true. 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é comme membre dans la demande. 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, 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 l'id de la personne de l'API People ou l'id de l'utilisateur dans l'API Directory. Par exemple, si l'ID de profil de personne de l'API People pour [e-mail] est 123456789, vous pouvez ajouter l'utilisateur à l'espace en définissant membership.member.name sur users/[e-mail] ou users/123456789. Pour spécifier les groupes Google à ajouter, ajoutez des appartenances avec l'membership.group_member.name appropriée. Pour ajouter ou inviter un groupe Google, utilisez groups/{group}, où {group} est l'id du groupe de l'API Cloud Identity Groups. Par exemple, vous pouvez utiliser l'API de recherche Cloud Identity Groups pour récupérer l'ID 123456789 de l'adresse e-mail de groupe [e-mail], puis ajouter le groupe à l'espace en définissant membership.group_member.name sur groups/123456789. L'adresse e-mail de groupe n'est pas acceptée, et les groupes Google ne peuvent être ajoutés qu'en tant que membres d'espaces nommés. Pour un espace nommé ou un chat de groupe, si l'appelant bloque, est bloqué par certains membres ou n'est pas autorisé à ajouter des membres, ceux-ci ne sont pas ajoutés à l'espace créé. Pour créer un message privé (MP) entre l'utilisateur appelant et un autre utilisateur humain, spécifiez exactement un seul abonnement pour représenter l'utilisateur humain. Si l'un des utilisateurs bloque l'autre, la requête échoue et la MP n'est pas créée. Pour créer un MP entre l'utilisateur appelant et l'application appelante, définissez Space.singleUserBotDm sur true et n'indiquez aucune adhésion. Vous ne pouvez utiliser cette méthode que pour configurer un MP avec l'application appelante. Pour ajouter l'application appelante en tant que membre d'un espace ou d'un MP 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 de la demande, le message privé existant est renvoyé. Les espaces avec des réponses organisées en fils de discussion ne sont pas acceptées. Si le message d'erreur ALREADY_EXISTS s'affiche lorsque vous configurez un espace, essayez avec un autre displayName. Il est possible qu'un espace existant de l'organisation Google Workspace utilise déjà ce nom à afficher. Nécessite une authentification de l'utilisateur. 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 un abonnement. Pour obtenir un exemple, consultez Modifier l'appartenance d'un utilisateur à un espace. Compatible avec les types d'authentification suivants : Authentification de l'application avec approbation de l'administrateur dans la version Preview développeur Authentification de l'utilisateur : vous pouvez authentifier et autoriser cette méthode avec des droits d'administrateur en définissant le champ use_admin_access 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.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 la section Modifier un message. Compatible avec les types d'authentification suivants : Authentification de l'application Authentification des utilisateurs Lorsque vous utilisez l'authentification de l'application, les requêtes ne peuvent modifier 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 de l'organisation Google Workspace utilise déjà ce nom à afficher. Compatible avec les types d'authentification suivants : Authentification des applications avec approbation de l'administrateur dans la Preview développeur Authentification de l'utilisateur : vous pouvez authentifier et autoriser cette méthode avec des droits d'administrateur en définissant le champ use_admin_access 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.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.

UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState) Met à jour l'état de lecture d'un utilisateur dans un espace, utilisé pour identifier les messages lus et non lus. Pour obtenir un exemple, consultez Modifier l'état de lecture d'un espace utilisateur. Nécessite une authentification de l'utilisateur. 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 au 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 des boutons.

ActionResponse

Paramètres qu'une application de chat peut utiliser pour configurer la publication de sa réponse.

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. (Uniquement pour les types de réponses 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	Publiez un nouveau message dans le sujet.
UPDATE_MESSAGE	modifier le message de l'application Chat ; Cette opération n'est autorisée que pour un événement CARD_CLICKED où le type d'expéditeur de message est BOT.
UPDATE_USER_MESSAGE_CARDS	Mettre à jour les fiches dans le message d'un utilisateur Cette opération n'est autorisée que comme réponse à un événement MESSAGE avec une URL correspondante ou à un événement CARD_CLICKED où le type d'expéditeur de message est HUMAN. Le texte est ignoré.
REQUEST_CONFIG	Demander à l'utilisateur de fournir une authentification ou une configuration supplémentaires en privé
DIALOG	Présente une boîte de dialogue.
UPDATE_WIDGET	Requête sur les options de saisie semi-automatique du texte du widget.

SelectionItems

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

Champs
items[]	SelectionItem Tableau d'objets SelectionItem.

UpdatedWidget

Réponse du widget mis à jour. Permet de fournir des options de saisie semi-automatique pour un widget.

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. Widget 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 la saisie semi-automatique du widget

ActionStatus

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

Champs
status_code	Code Code d'état.
user_facing_message	string Message à envoyer aux utilisateurs concernant l'état de leur demande. Si cette règle n'est pas configurée, un message générique basé sur status_code est envoyé.

Annotation

Uniquement en sortie. Annotations associées au corps en texte brut du message. Pour ajouter une mise en forme de base à un message, consultez Mettre en forme des 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 cette annotation correspond.
start_index	int32 Index de départ (basé sur 0, inclus) dans le corps du message en texte brut auquel cette annotation correspond.
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 d'un utilisateur.
slash_command	SlashCommandMetadata Métadonnées d'une commande à barre oblique.
rich_link_metadata	RichLinkMetadata Métadonnées d'un lien interactif.

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.
RICH_LINK	Annotation de lien enrichi.

AttachedGif

Une image GIF spécifiée par une URL.

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

Pièce jointe

Une pièce jointe dans Google Chat

Champs
name	string Nom de ressource du rattachement, au format spaces/{space}/messages/{message}/attachments/{attachment}.
content_name	string Uniquement en sortie. Nom de fichier d'origine du contenu, et non 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 vignette à utiliser pour prévisualiser la pièce jointe et la montrer à 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 d'une pièce jointe.
source	Source Uniquement en sortie. Source de la pièce jointe.
Champ d'union data_ref. Référence des données à la pièce jointe. data_ref ne peut être qu'un des éléments suivants :
attachment_data_ref	AttachmentDataRef Référence aux données de l'attachement. Ce champ est utilisé avec l'API multimédia pour télécharger les données de l'attachement.
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 du rattachement.

Enums
SOURCE_UNSPECIFIED	Réservé.
DRIVE_FILE	Il s'agit d'un fichier Google Drive.
UPLOADED_CONTENT	Le fichier est importé dans Chat.

AttachmentDataRef

Référence aux données de l'attachement.

Champs
resource_name	string Nom de ressource des données de rattachement. Ce champ est utilisé avec l'API Media pour télécharger les données des pièces jointes.
attachment_upload_token	string Jeton opaque contenant une référence à une pièce jointe importée. Traité par les clients comme une chaîne opaque et utilisé pour créer ou mettre à jour des messages Chat avec des pièces jointes.

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 fiche.

Créez et prévisualisez des fiches avec Card Builder.

Ouvrir Card Builder

Champs
card_id	string Obligatoire si le message contient plusieurs fiches. Identifiant unique d'une carte dans un message.
card	Card Une fiche La taille maximale est de 32 Ko.

ChatSpaceLinkData

Données pour les liens vers des 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 la ressource de l'espace en mode importation. Format : spaces/{space}

CompleteImportSpaceResponse

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

Champs
space	Space Espace en mode d'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 carte 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 de séparation.
card_actions[]	CardAction Actions de cette fiche.
name	string Nom de la fiche.

CardAction

Une action est associée à la fiche. Pour une fiche de facture, les actions courantes sont les suivantes : supprimer la facture, l'envoyer par e-mail ou l'ouvrir dans le navigateur.

Non compatible avec les applications Google Chat.

Champs
action_label	string Le libellé s'affichait dans l'élément de menu d'action.
on_click	OnClick L'action "onclick" pour cet élément d'action.

CardHeader

Champs
title	string Vous devez indiquer le titre. La hauteur de l'en-tête est 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 d'image (par exemple, bordure carrée ou bordure circulaire)
image_url	string URL de l'image dans l'en-tête de la fiche.

ImageStyle

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

Section

Une section contient un ensemble de widgets 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 formaté est accepté. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme le texte dans les applications Google Chat et Mettre en forme le texte dans les modules complémentaires Google Workspace.
widgets[]	WidgetMarkup Une section doit contenir au moins un widget.

CreateCustomEmojiRequest

Requête de création d'un emoji personnalisé.

Preview développeur : disponible dans le cadre du programme Preview développeur Google Workspace, qui permet d'accéder en avant-première à certaines fonctionnalités.

Champs
custom_emoji	CustomEmoji Obligatoire. L'emoji personnalisé à créer.

CreateMembershipRequest

Message de requête pour la création d'un abonnement.

Champs
parent	string Obligatoire. Nom de la ressource de l'espace pour lequel créer l'abonnement. Format: espaces/{espace}
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 attribue un nom de ressource et écrase tous les éléments spécifiés. Lorsqu'une application Chat crée une relation d'appartenance pour un utilisateur humain, elle doit utiliser certains champs 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. Lors de l'authentification en tant qu'application, le champ d'application chat.app.memberships est obligatoire. L'authentification en tant qu'application est disponible dans Preview développeur : disponible dans le cadre du programme Preview développeur Google Workspace, qui permet d'accéder en avant-première à certaines fonctionnalités. Définissez user.type sur HUMAN et user.name avec le format users/{user}, où {user} peut être l'adresse e-mail de l'utilisateur. Pour les utilisateurs d'une même organisation Workspace, {user} peut également correspondre 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 Person de l'API People pour [e-mail] est 123456789, vous pouvez ajouter l'utilisateur à l'espace en définissant membership.member.name sur users/[e-mail] ou users/123456789. 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 Lorsque la valeur est true, la méthode s'exécute à l'aide des droits d'administrateur Google Workspace de l'utilisateur. L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit de gérer les conversations Chat et Espaces. Requiert le champ d'application OAuth 2.0 chat.admin.memberships. Il n'est pas possible de créer des adhésions à des applications ni pour des utilisateurs externes à l'organisation Google Workspace de l'administrateur.

CreateMessageRequest

Crée un message.

Champs
parent	string Obligatoire. Nom de la ressource de l'espace dans lequel créer un message. Format : spaces/{space}
message	Message Obligatoire. Corps du message.
thread_key (deprecated)	string Cet élément est obsolète. Facultatif. Obsolète : utilisez thread.thread_key à la place. ID du thread. Il peut comporter jusqu'à 4 000 caractères. Pour démarrer un fil de discussion ou en ajouter un, créez un message et spécifiez un threadKey ou le thread.name. Pour obtenir un exemple d'utilisation, consultez Démarrer ou répondre à un fil de discussion.
request_id	string Facultatif. ID de requête unique pour ce message. Spécifier un ID de requête existant renvoie le message créé avec cet ID au lieu d'en créer un autre.
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.
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. Contient jusqu'à 63 caractères, et uniquement des lettres minuscules, des chiffres et des traits d'union. 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 pourraient être ajoutés à l'avenir.

Enums
MESSAGE_REPLY_OPTION_UNSPECIFIED	Par défaut. Démarre un nouveau thread. Cette option ignore tous les thread ID ou thread_key inclus.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD	Crée le message en tant que réponse au fil de discussion spécifié par thread ID ou thread_key. Si l'opération échoue, le message lance un nouveau thread à la place.
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 à la place.

CreateReactionRequest

Crée une réaction à un message.

Champs
parent	string Obligatoire. Le message dans lequel la réaction est créée. Format : spaces/{space}/messages/{message}
reaction	Reaction Obligatoire. Réaction à créer.

CreateSpaceRequest

Requête de création d'un espace nommé sans membres.

Champs
space	Space Obligatoire. Les champs displayName et spaceType doivent être renseignés. Seule l'option SpaceType.SPACE est acceptée. Si le message d'erreur ALREADY_EXISTS s'affiche, essayez avec un autre displayName. Un espace existant dans l'organisation Google Workspace utilise peut-être déjà ce nom à afficher. Si vous participez au programme Preview développeur, vous pouvez utiliser SpaceType.GROUP_CHAT si importMode est défini sur "true". L'espace name est attribué sur le serveur. Tout élément spécifié dans ce champ sera donc ignoré.
request_id	string Facultatif. Identifiant unique de cette requête. Nous vous recommandons d'utiliser un UUID aléatoire. Si vous spécifiez un ID de requête existant, l'espace créé avec cet ID est renvoyé au lieu d'en créer un autre. Spécifier un ID de requête existant de la même application Chat avec un autre utilisateur authentifié génère une erreur.

CustomEmoji

Représente un emoji personnalisé.

Champs
name	string Identifiant. Nom de ressource de l'emoji personnalisé, attribué par le serveur. Format : customEmojis/{customEmoji} Preview développeur : disponible dans le cadre du programme Preview développeur Google Workspace, qui permet d'accéder en avant-première à certaines fonctionnalités.
uid	string Uniquement en sortie. Clé unique de la ressource d'emoji personnalisés.
emoji_name	string Immuable. Nom fourni par l'utilisateur pour l'emoji personnalisé, qui est unique dans l'organisation. Obligatoire lorsque l'emoji personnalisé est créé (uniquement dans le cas contraire). Les noms des emoji doivent commencer et se terminer par des 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 doivent être utilisés pour séparer les mots et ne peuvent pas être utilisés de manière consécutive. Exemple : :valid-emoji-name: Preview développeur : disponible dans le cadre du programme Preview développeur Google Workspace, qui permet d'accéder en avant-première à certaines fonctionnalités.
temporary_image_uri	string Uniquement en sortie. URL de l'image de l'emoji personnalisé, valide pendant au moins 10 minutes. Notez que ce champ n'est pas renseigné dans la réponse lorsque l'emoji personnalisé est créé. Preview développeur : disponible dans le cadre du programme Preview développeur Google Workspace, qui permet d'accéder en avant-première à certaines fonctionnalités.
payload	CustomEmojiPayload Uniquement en entrée. Données de charge utile. Preview développeur:disponible dans le cadre du programme Preview développeur Google Workspace, qui accorde un accès anticipé à certaines fonctionnalités.

CustomEmojiPayload

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

Preview développeur : disponible dans le cadre du programme Preview développeur Google Workspace, qui permet d'accéder en avant-première à certaines fonctionnalités.

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 la dimension de l'image doit être comprise 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 compatibles: .png, .jpg, .gif.

DeleteCustomEmojiRequest

Demande de suppression d'un emoji personnalisé.

Preview développeur:disponible dans le cadre du programme Preview développeur Google Workspace, qui accorde un accès anticipé à certaines fonctionnalités.

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 de membres d'un espace.

Champs
name	string Obligatoire. Nom de ressource de l'abonnement à supprimer. Les applications de chat peuvent supprimer les adhésions d'utilisateurs ou les leurs. Les applications de chat ne peuvent pas supprimer d'autres applications les adhésions. Lorsque vous supprimez une appartenance à un utilisateur, vous devez spécifier la portée chat.memberships et le format spaces/{space}/members/{member}. Vous pouvez utiliser l'adresse e-mail comme alias pour {member}. Par exemple, spaces/{space}/members/[e-mail], où [e-mail] est l'adresse e-mail de l'utilisateur Google Chat. Lorsque vous supprimez une appartenance à une application, vous devez utiliser le champ d'application chat.memberships.app et le format spaces/{space}/members/app. Format: spaces/{space}/members/{member} ou spaces/{space}/members/app.
use_admin_access	bool Lorsque la valeur est true, la méthode s'exécute à l'aide des droits d'administrateur Google Workspace de l'utilisateur. L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit de 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 des abonnements à des applications d'un espace à l'aide d'un accès administrateur.

DeleteMessageRequest

Requête 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 Attribuer un nom à un message.
force	bool Lorsqu'un message est true, la suppression d'un message entraîne également la suppression de ses réponses organisées en fils de discussion. Lorsque la valeur est false, si un message comporte des réponses organisées en fils de discussion, la suppression échoue. S'applique uniquement lors de l'authentification en tant qu'utilisateur. Cela n'a aucun effet en cas d'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

Requête de suppression d'un espace.

Champs
name	string Obligatoire. Nom de la ressource de l'espace à supprimer. Format : spaces/{space}
use_admin_access	bool Lorsque la valeur est true, la méthode s'exécute avec les droits d'administrateur Google Workspace de l'utilisateur. L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit Gérer les conversations Chat et Espaces. Requiert 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 D'autres valeurs pourront être ajoutées ultérieurement.

Enums
DELETION_TYPE_UNSPECIFIED	Cette valeur n'est pas utilisée.
CREATOR	L'utilisateur a supprimé son propre message.
SPACE_OWNER	Le propriétaire de l'espace a supprimé le message.
ADMIN	Un administrateur Google Workspace a supprimé le message.
APP_MESSAGE_EXPIRY	Une application Chat a supprimé son propre message lorsqu'il a expiré.
CREATOR_VIA_APP	Une application Chat a supprimé le message au nom de l'utilisateur.
SPACE_OWNER_VIA_APP	Une application Chat a supprimé le message au nom du propriétaire de l'espace.

Dialog

Enveloppe 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é sous forme de modale. Les applications Google Chat ne prennent pas en charge les entités de cartes suivantes: DateTimePicker et OnChangeAction.

DialogAction

Contient une boîte de dialogue et un code d'état de la requête.

Champs
action_status	ActionStatus Uniquement en entrée. État d'une requête d'appel ou d'envoi d'une boîte de 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. Dialog (Boîte de dialogue) pour la requête.

DriveDataRef

Référence aux données d'un rattachement de disque.

Champs
drive_file_id	string ID du fichier Drive. Utilisez-la avec l'API Drive.

DriveLinkData

Données pour les liens Google Drive.

Champs
drive_data_ref	DriveDataRef Élément DriveDataRef qui 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. Contenu de l'emoji. content ne peut être qu'un des éléments suivants :
unicode	string Emoji de base représenté par une chaîne Unicode.
custom_emoji	CustomEmoji Uniquement en sortie. Un emoji personnalisé.

EmojiReactionSummary

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

Champs
emoji	Emoji Emoji associés aux réactions.
reaction_count	int32 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 la ressource de l'utilisateur avec lequel envoyer un message privé. Format: users/{user}, où {user} est soit le id pour la personne de l'API People, soit le id pour l'utilisateur dans l'API Directory. Par exemple, si l'ID de profil de l'API People est 123456789, vous pouvez rechercher 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/[e-mail], où [e-mail] est l'adresse e-mail de l'utilisateur Google Chat.

GetAttachmentRequest

Requête d'obtention d'une pièce jointe.

Champs
name	string Obligatoire. Nom de ressource du rattachement, au format spaces/{space}/messages/{message}/attachments/{attachment}.

GetCustomEmojiRequest

Requête permettant de renvoyer un seul emoji personnalisé.

Preview développeur:disponible dans le cadre du programme Preview développeur Google Workspace, qui accorde un accès anticipé à certaines fonctionnalités.

Champs
name	string Obligatoire. Nom de ressource de l'emoji personnalisé. Format : customEmojis/{customEmoji} Vous pouvez utiliser le nom de l'emoji comme alias pour {customEmoji}. Par exemple, customEmojis/:example-emoji:, où :example-emoji: correspond au nom de l'emoji personnalisé.

GetMembershipRequest

Requête d'obtention d'une adhésion à un espace.

Champs
name	string Obligatoire. Nom de ressource de l'abonnement à récupérer. Pour obtenir l'appartenance de l'application à l'aide de l'authentification utilisateur, vous pouvez utiliser spaces/{space}/members/app. Format: spaces/{space}/members/{member} ou spaces/{space}/members/app Vous pouvez utiliser l'adresse e-mail de l'utilisateur comme alias pour {member}. Par exemple, spaces/{space}/members/[e-mail], où [e-mail] correspond à l'adresse e-mail de l'utilisateur Google Chat.
use_admin_access	bool Lorsque la valeur est true, la méthode s'exécute avec les droits d'administrateur Google Workspace de l'utilisateur. L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit Gérer les conversations Chat et Espaces. Requiert les champs d'application OAuth 2.0 chat.admin.memberships ou chat.admin.memberships.readonly. Il n'est pas possible d'obtenir les adhésions à une application dans un espace lorsque vous utilisez un accès administrateur.

GetMessageRequest

Requête d'obtention 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.

GetSpaceEventRequest

Message de requête pour obtenir un événement dans un espace.

Champs
name	string Obligatoire. Nom de la ressource de l'événement de l'espace. Format : spaces/{space}/spaceEvents/{spaceEvent}

GetSpaceReadStateRequest

Message de requête pour l'API GetSpaceReadState.

Champs

name

string Obligatoire. Nom de la ressource de l'état de lecture de l'espace à récupérer. Prend uniquement en charge l'obtention de l'état de lecture pour l'utilisateur appelant. Pour faire référence à l'utilisateur appelant, définissez l'une des options suivantes: Alias me. Exemple :users/me/spaces/{space}/spaceReadState son adresse e-mail Workspace ; Par exemple, users/[e-mail]/spaces/{space}/spaceReadState. son ID utilisateur ; Par exemple, users/123456789/spaces/{space}/spaceReadState. Format : users/{user}/spaces/{space}/spaceReadState

GetSpaceRequest

Requête visant à renvoyer un seul espace.

Champs
name	string Obligatoire. Nom de ressource de l'espace, au format spaces/{space}. Format : spaces/{space}
use_admin_access	bool Lorsque la valeur est true, la méthode s'exécute à l'aide des droits d'administrateur Google Workspace de l'utilisateur. L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit Gérer les conversations Chat et Espaces. Requiert les champs d'application OAuth 2.0 chat.admin.spaces ou chat.admin.spaces.readonly.

GetThreadReadStateRequest

Message de requête pour l'API GetThreadReadStateRequest.

Champs

name

string Obligatoire. Nom de ressource de l'état de lecture du thread à récupérer. Permet uniquement d'obtenir l'état de lecture de l'utilisateur appelant. Pour faire référence à l'utilisateur appelant, définissez l'une des options suivantes: Alias me. Exemple :users/me/spaces/{space}/threads/{thread}/threadReadState Son adresse e-mail Workspace Par exemple, users/[e-mail]/spaces/{space}/threads/{thread}/threadReadState. Son ID utilisateur Par exemple, users/123456789/spaces/{space}/threads/{thread}/threadReadState. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState

Groupe

Groupe Google dans Google Chat

Champs
name	string Nom de ressource d'un groupe Google. Représente un groupe dans l'API Cloud Identity Groups. Format: groups/{group}

HistoryState

État de l'historique des messages et des espaces. Indique la durée de conservation des messages et des fils de conversation après leur création.

Enums
HISTORY_STATE_UNSPECIFIED	Valeur par défaut. Ne pas utiliser.
HISTORY_OFF	Historique désactivé. Les messages et les fils de discussion sont conservés pendant 24 heures.
HISTORY_ON	Historique activé. Les règles de conservation Vault de l'organisation spécifient la durée de conservation des messages et des fils de discussion.

ListCustomEmojisRequest

Requête pour renvoyer une liste d'emoji personnalisés.

Preview développeur:disponible dans le cadre du programme Preview développeur Google Workspace, qui accorde un accès anticipé à certaines fonctionnalités.

Champs
page_size	int32 Facultatif. Nombre maximal d'emoji personnalisés renvoyés. Le service peut renvoyer un nombre inférieur à cette valeur. Si elle n'est pas spécifiée, la valeur par défaut est 25. La valeur maximale est 200. les valeurs supérieures à 200 sont remplacées par 200.
page_token	string Facultatif. (si vous reprenez à partir d'une requête précédente). Jeton de page reçu lors d'un appel d'emoji personnalisés de liste précédent. Fournissez-le pour récupérer la page suivante. Lors de la pagination, la valeur du filtre doit correspondre à l'appel ayant fourni le jeton de page. Transmettre une valeur différente peut entraîner des résultats inattendus.
filter	string Facultatif. Filtre de requête Prend en charge le filtrage par créateur. Pour filtrer par créateur, vous devez spécifier une valeur valide. Actuellement, seuls creator("users/me") et NOT creator("users/me") sont acceptés pour filtrer les emoji personnalisés selon qu'ils ont été créés par l'utilisateur appelant ou non. Par exemple, la requête suivante renvoie les emoji personnalisés créés par l'appelant: creator("users/me") Les requêtes non valides sont rejetées par le serveur avec une erreur INVALID_ARGUMENT.

ListCustomEmojisResponse

Réponse à une liste d'emoji personnalisés.

Preview développeur : disponible dans le cadre du programme Preview développeur Google Workspace, qui permet d'accéder en avant-première à certaines fonctionnalités.

Champs
custom_emojis[]	CustomEmoji Liste non ordonnée. Liste des emoji personnalisés sur la page demandée (ou première).
next_page_token	string Jeton que vous pouvez envoyer en tant que pageToken pour récupérer la page de résultats suivante. Si ce champ est vide, aucune page suivante n'existe.

ListMembershipsRequest

Message de requête pour la liste des adhésions.

Champs
parent	string Obligatoire. Nom de ressource de l'espace pour lequel récupérer une liste de membres. Format : spaces/{space}
page_size	int32 Facultatif. Nombre maximal d'adhésions à renvoyer. Le service peut renvoyer moins que cette valeur. Si aucune valeur n'est spécifiée, 100 adhésions au maximum sont renvoyées. La valeur maximale est 1 000. Si vous utilisez une valeur supérieure à 1 000, elle est automatiquement remplacée par 1 000. Les valeurs négatives renvoient une erreur INVALID_ARGUMENT.
page_token	string Facultatif. Jeton de page reçu d'un appel précédent pour lister les adhésions. Fournissez ce paramètre pour récupérer la page suivante. Lors de la pagination, tous les autres paramètres fournis doivent correspondre à l'appel qui a fourni le jeton de page. Transmettre des valeurs différentes aux autres paramètres peut entraîner des résultats inattendus.
filter	string Facultatif. Un filtre de requête. Vous pouvez filtrer les adhésions par rôle (role) et type (member.type). Pour filtrer par rôle, définissez role sur ROLE_MEMBER ou ROLE_MANAGER. Pour filtrer par type, définissez member.type sur HUMAN ou BOT. Vous pouvez également filtrer pour member.type à l'aide de l'opérateur !=. Pour filtrer à la fois par rôle et par type, utilisez l'opérateur AND. Pour filtrer par rôle ou par type, utilisez l'opérateur OR. member.type = "HUMAN" ou member.type != "BOT" est obligatoire lorsque use_admin_access est défini sur "true". Les autres filtres de type de membre seront refusés. Par exemple, les requêtes suivantes sont valides: role = "ROLE_MANAGER" OR role = "ROLE_MEMBER" member.type = "HUMAN" AND role = "ROLE_MANAGER" member.type != "BOT" Les requêtes suivantes ne sont pas valides : member.type = "HUMAN" AND member.type = "BOT" role = "ROLE_MANAGER" AND role = "ROLE_MEMBER" Les requêtes non valides sont rejetées par le serveur avec une erreur INVALID_ARGUMENT.
show_groups	bool Facultatif. Lorsque la valeur est true, renvoie également les souscriptions associées à un Google Group, en plus des autres types de souscriptions. Si un filter est défini, les adhésions Google Group qui ne correspondent pas aux critères de filtrage ne sont pas renvoyées.
show_invited	bool Facultatif. Lorsque la valeur est true, renvoie également les souscriptions associées aux membres invited, en plus des autres types de souscriptions. Si un filtre est défini, les appartenances invited qui ne correspondent pas aux critères de filtre ne sont pas renvoyées. Cette fonctionnalité nécessite actuellement une authentification de l'utilisateur.
use_admin_access	bool Lorsque la valeur est true, la méthode s'exécute à l'aide des droits d'administrateur Google Workspace de l'utilisateur. L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit de gérer les conversations Chat et Espaces. Nécessite le champ d'application OAuth 2.0 chat.admin.memberships.readonly ou chat.admin.memberships. Il n'est pas possible de lister les appartenances à des applications dans un espace lorsque vous utilisez un accès administrateur.

ListMembershipsResponse

Réponse à la liste des membres de l'espace.

Champs
memberships[]	Membership Liste à puces. Liste des adhésions sur la page demandée (ou la première page).
next_page_token	string Jeton que vous pouvez envoyer en tant que pageToken pour récupérer la page de résultats suivante. Si ce champ est vide, aucune page suivante n'existe.

ListMessagesRequest

Liste les messages de l'espace spécifié dont l'utilisateur est membre.

Champs
parent	string Obligatoire. Nom de la ressource de l'espace à partir duquel lister les messages. Format : spaces/{space}
page_size	int32 Nombre maximal de messages renvoyés. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, 25 éléments sont renvoyés au maximum. La valeur maximale est 1 000. Si vous utilisez une valeur supérieure à 1 000, elle est automatiquement remplacée par 1 000. Les valeurs négatives renvoient une erreur INVALID_ARGUMENT.
page_token	string Facultatif, si vous reprenez à partir d'une requête précédente. Jeton de page reçu d'un précédent appel de liste de messages. Fournissez ce paramètre pour récupérer la page suivante. Lors de la pagination, tous les autres paramètres fournis doivent correspondre à l'appel qui a fourni le jeton de page. La transmission de valeurs différentes aux autres paramètres peut entraîner des résultats inattendus.
filter	string Un filtre de requête. Vous pouvez filtrer les messages par date (create_time) et par fil de discussion (thread.name). Pour filtrer les messages en fonction de leur date de création, spécifiez create_time avec un code temporel au format RFC-3339 et des guillemets doubles. Par exemple, "2023-04-21T11:30:00-04:00". Vous pouvez utiliser l'opérateur supérieur à > pour répertorier les messages créés après un horodatage, ou l'opérateur inférieur à < pour répertorier les messages créés avant un horodatage. Pour filtrer les messages dans un intervalle de temps, utilisez l'opérateur AND entre deux codes temporels. Pour filtrer par thread, spécifiez le thread.name, au format spaces/{space}/threads/{thread}. Vous ne pouvez spécifier qu'un seul élément thread.name par requête. Pour filtrer à la fois par fil de discussion et par date, utilisez l'opérateur AND dans votre requête. Par exemple, les requêtes suivantes sont valides: create_time > "2012-04-21T11:30:00-04:00" create_time > "2012-04-21T11:30:00-04:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 create_time > "2012-04-21T11:30:00+00:00" AND create_time < "2013-01-01T00:00:00+00:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 thread.name = spaces/AAAAAAAAAAA/threads/123 Les requêtes non valides sont rejetées par le serveur avec une erreur INVALID_ARGUMENT.
order_by	string Facultatif, si vous reprenez à partir d'une requête précédente. Façon dont la liste des messages est organisée. Spécifiez une valeur à trier par le biais d'une opération de tri. Les valeurs d'opération de tri valides sont les suivantes : ASC pour l'ordre croissant. DESC pour l'ordre décroissant. L'ordre par défaut est create_time ASC.
show_deleted	bool Indique si les messages supprimés doivent être inclus. Les messages supprimés incluent l'heure et les métadonnées concernant leur suppression, mais leur contenu n'est pas disponible.

ListMessagesResponse

Message de réponse pour la liste des messages.

Champs
messages[]	Message Liste des messages.
next_page_token	string Vous pouvez envoyer un jeton en tant que pageToken pour récupérer la page de résultats suivante. Si ce champ est vide, aucune page suivante n'existe.

ListReactionsRequest

Liste les réactions à un message.

Champs
parent	string Obligatoire. Message auquel les utilisateurs ont réagi. Format : spaces/{space}/messages/{message}
page_size	int32 Facultatif. Nombre maximal de réactions renvoyées. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, la valeur par défaut est 25. La valeur maximale est 200. Les valeurs supérieures à 200 sont remplacées par 200.
page_token	string Facultatif. (si vous reprenez à partir d'une requête précédente). Jeton de page reçu d'un précédent appel de réactions à une liste. Fournissez-le pour récupérer la page suivante. Lors de la pagination, la valeur du filtre doit correspondre à l'appel ayant fourni le jeton de page. Transmettre une valeur différente peut entraîner des résultats inattendus.
filter	string Facultatif. Un filtre de requête. Vous pouvez filtrer les réactions par emoji (emoji.unicode ou emoji.custom_emoji.uid) et utilisateur (user.name). Pour filtrer les réactions pour plusieurs emoji ou utilisateurs, joignez des champs similaires à l'aide de l'opérateur OR, comme emoji.unicode = "🙂" OR emoji.unicode = "👍" et user.name = "users/AAAAAA" OR user.name = "users/BBBBBB". Pour filtrer les réactions par emoji et par utilisateur, utilisez l'opérateur AND, par exemple emoji.unicode = "🙂" AND user.name = "users/AAAAAA". Si votre requête utilise à la fois AND et OR, regroupez-les à l'aide de parenthèses. Par exemple, les requêtes suivantes sont valides : user.name = "users/{user}" emoji.unicode = "🙂" emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" OR emoji.unicode = "👍" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" AND user.name = "users/{user}" (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}") AND user.name = "users/{user}" Les requêtes suivantes ne sont pas valides : emoji.unicode = "🙂" AND emoji.unicode = "👍" emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" OR user.name = "users/{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR user.name = "users/{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" AND user.name = "users/{user}" Les requêtes non valides sont rejetées par le serveur avec une erreur INVALID_ARGUMENT.

ListReactionsResponse

Réponse à une requête de liste des réactions.

Champs
reactions[]	Reaction Liste des réactions sur la page demandée (ou la première page).
next_page_token	string Jeton de continuité pour récupérer la page de résultats suivante. Il est vide pour la dernière page de résultats.

ListSpaceEventsRequest

Message de requête pour les événements de la fiche d'un espace

Champs
parent	string Obligatoire. Nom de la ressource de l'espace Google Chat dans lequel les événements se sont produits. Format : spaces/{space}.
page_size	int32 Facultatif. Nombre maximal d'événements d'espace renvoyés. Le service peut renvoyer un nombre inférieur à cette valeur. Les valeurs négatives renvoient une erreur INVALID_ARGUMENT.
page_token	string Jeton de page reçu d'un appel d'événement de liste précédent. Fournissez-le pour récupérer la page suivante. Lors de la pagination, tous les autres paramètres fournis pour lister les événements d'espace doivent correspondre à l'appel qui a fourni le jeton de page. Transmettre des valeurs différentes aux autres paramètres peut entraîner des résultats inattendus.
filter	string Obligatoire. Filtre de requête Vous devez spécifier au moins un type d'événement (event_type) à l'aide de l'opérateur comporte :. Pour filtrer selon plusieurs types d'événements, utilisez l'opérateur OR. Omettez les types d'événements par lot dans votre filtre. La requête renvoie automatiquement tous les événements de lot associés. Par exemple, si vous filtrez par nouvelles réactions (google.workspace.chat.reaction.v1.created), le serveur renvoie également des événements de nouvelles réactions par lot (google.workspace.chat.reaction.v1.batchCreated). Pour obtenir la liste des types d'événements compatibles, consultez la documentation de référence sur SpaceEvents. Vous pouvez également filtrer par heure de début (start_time) et heure de fin (end_time): start_time : code temporel exclusif à partir duquel commencer à lister les événements de l'espace. Vous pouvez répertorier les événements survenus il y a jusqu'à 28 jours. Si ce paramètre n'est pas spécifié, la liste des événements de l'espace au cours des 28 derniers jours s'affiche. end_time : code temporel inclusif jusqu'auquel les événements de l'espace sont listés. Si ce paramètre n'est pas spécifié, les événements sont listés jusqu'à l'heure de la requête. Pour spécifier une heure de début ou de fin, utilisez l'opérateur "est égal(e) à =" en respectant le format RFC-3339. Pour filtrer à la fois par start_time et end_time, utilisez l'opérateur AND. Par exemple, les requêtes suivantes sont valides : start_time="2023-08-23T19:20:33+00:00" AND end_time="2023-08-23T19:21:54+00:00" start_time="2023-08-23T19:20:33+00:00" AND (event_types:"google.workspace.chat.space.v1.updated" OR event_types:"google.workspace.chat.message.v1.created") Les requêtes suivantes ne sont pas valides : start_time="2023-08-23T19:20:33+00:00" OR end_time="2023-08-23T19:21:54+00:00" event_types:"google.workspace.chat.space.v1.updated" AND event_types:"google.workspace.chat.message.v1.created" Les requêtes non valides sont rejetées par le serveur avec une erreur INVALID_ARGUMENT.

ListSpaceEventsResponse

Message de réponse pour la liste des événements de l'espace.

Champs
space_events[]	SpaceEvent Les résultats sont renvoyés dans l'ordre chronologique (les événements les plus anciens en premier). Remarque : Le champ permissionSettings n'est pas renvoyé dans l'objet Space pour les requêtes de liste.
next_page_token	string Jeton de continuation utilisé pour extraire d'autres événements. Si ce champ est omis, il n'y a pas d'autres pages.

ListSpacesRequest

Requête permettant de lister les espaces dont l'appelant est membre.

Champs
page_size	int32 Facultatif. Nombre maximal d'espaces à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, 100 espaces au maximum sont renvoyés. La valeur maximale est 1 000. Si vous utilisez une valeur supérieure à 1 000, elle est automatiquement remplacée par 1 000. Les valeurs négatives renvoient une erreur INVALID_ARGUMENT.
page_token	string Facultatif. Jeton de page, reçu d'un appel de liste précédent d'espaces. Fournissez ce paramètre pour récupérer la page suivante. Lors de la pagination, la valeur du filtre doit correspondre à l'appel ayant fourni le jeton de page. Transmettre une valeur différente peut entraîner des résultats inattendus.
filter	string Facultatif. Un filtre de requête. Vous pouvez filtrer les espaces par type (space_type). Pour filtrer par type d'espace, vous devez spécifier une valeur d'énumération valide, telle que SPACE ou GROUP_CHAT (space_type ne peut pas être SPACE_TYPE_UNSPECIFIED). Pour effectuer une requête pour plusieurs types d'espaces, utilisez l'opérateur OR. Par exemple, les requêtes suivantes sont valides: space_type = "SPACE" spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE" Les requêtes non valides sont rejetées par le serveur avec une erreur INVALID_ARGUMENT.

ListSpacesResponse

Réponse à une requête de liste d'espaces.

Champs
spaces[]	Space Liste des espaces sur la page demandée (ou la première page). Remarque : Le champ permissionSettings n'est pas renvoyé dans l'objet Space pour les requêtes de liste.
next_page_token	string Vous pouvez envoyer un jeton en tant que pageToken pour récupérer la page de résultats suivante. Si ce champ est vide, aucune page suivante n'existe.

MatchedUrl

URL correspondante dans un message Chat. Les applications Chat peuvent prévisualiser les URL correspondantes. Pour en savoir plus, consultez Prévisualiser les liens.

Champs
url	string Uniquement en sortie. URL correspondante.

Abonnement

Représente une relation d'appartenance dans Google Chat (par exemple, un utilisateur ou une application Chat est invité, fait partie ou absent d'un espace).

Champs
name	string Nom de la ressource de l'abonnement, attribué par le serveur. Format : spaces/{space}/members/{member}
state	MembershipState Uniquement en sortie. État de l'appartenance.
role	MembershipRole Facultatif. Rôle de l'utilisateur dans un espace Chat, qui détermine les actions autorisées dans l'espace. Ce champ ne peut être utilisé que comme entrée dans UpdateMembership.
create_time	Timestamp Facultatif. Immuable. Date de création de l'appartenance, par exemple lorsque le membre a rejoint ou a été invité à rejoindre un espace. Ce champ est à usage exclusif en sortie, sauf lorsqu'il est utilisé pour importer des adhésions historiques dans des espaces en mode importation.
delete_time	Timestamp Facultatif. Immuable. Heure de suppression de l'abonnement, par exemple le moment où un membre a quitté un espace ou en a été exclu. Ce champ ne sert que de sortie, sauf s'il est utilisé pour importer des adhésions historiques dans des espaces en mode importation.
Champ d'union memberType. Membre associé à cet abonnement. D'autres types de membres pourraient être acceptés à l'avenir. memberType ne peut être qu'un des éléments suivants :
member	User Application ou utilisateur Google Chat auquel l'abonnement correspond. Si votre application Chat s'authentifie en tant qu'utilisateur, la sortie renseigne les champs user name et type.
group_member	Group Groupe Google auquel l'appartenance correspond. La lecture ou la modification des adhésions à Google Groupes nécessite l'authentification des utilisateurs.

MembershipRole

Représente les actions autorisées d'un utilisateur dans un espace Chat. D'autres valeurs d'énumération pourront être ajoutées à l'avenir.

Enums
MEMBERSHIP_ROLE_UNSPECIFIED	Valeur par défaut. Pour users: cette personne ne fait pas partie de l'espace, mais peut être invitée. Pour Google Groups: ce rôle leur est toujours attribué (d'autres valeurs d'énumération pourront être utilisées à l'avenir).
ROLE_MEMBER	un membre de l'espace ; L'utilisateur dispose d'autorisations de base, comme l'envoi de messages dans l'espace. Dans les conversations privées et de groupe sans nom, tous les participants ont ce rôle.
ROLE_MANAGER	un gestionnaire d'espace ; L'utilisateur dispose de toutes les autorisations de base, ainsi que d'autorisations administratives qui lui permettent de gérer l'espace, par exemple en ajoutant ou en supprimant des membres. Compatible uniquement avec SpaceType.SPACE.

MembershipState

Indique la relation du membre avec un espace. D'autres états d'adhésion pourraient être acceptés à l'avenir.

Enums
MEMBERSHIP_STATE_UNSPECIFIED	Valeur par défaut. Ne pas utiliser.
JOINED	L'utilisateur est ajouté à l'espace et peut y participer.
INVITED	L'utilisateur est invité à rejoindre l'espace, mais ne l'a pas encore fait.
NOT_A_MEMBER	L'utilisateur n'appartient pas à l'espace et n'a pas d'invitation en attente pour le rejoindre.

MembershipBatchCreatedEventData

Charge utile de l'événement pour plusieurs nouvelles adhésions.

Type d'événement: google.workspace.chat.membership.v1.batchCreated

Champs
memberships[]	MembershipCreatedEventData Liste des nouveaux abonnements.

MembershipBatchDeletedEventData

Charge utile de l'événement pour plusieurs abonnements supprimés.

Type d'événement : google.workspace.chat.membership.v1.batchDeleted

Champs
memberships[]	MembershipDeletedEventData Liste des abonnements supprimés.

MembershipBatchUpdatedEventData

Charge utile de l'événement pour plusieurs abonnements mis à jour.

Type d'événement : google.workspace.chat.membership.v1.batchUpdated

Champs
memberships[]	MembershipUpdatedEventData Liste des adhésions mises à jour.

MembershipCreatedEventData

Charge utile de l'événement pour une nouvelle adhésion.

Type d'événement: google.workspace.chat.membership.v1.created.

Champs
membership	Membership Le nouvel abonnement.

MembershipDeletedEventData

Charge utile de l'événement pour un abonnement supprimé.

Type d'événement: google.workspace.chat.membership.v1.deleted

Champs
membership	Membership L'abonnement supprimé. Seuls les champs name et state sont renseignés.

MembershipUpdatedEventData

Charge utile de l'événement pour un abonnement mis à jour.

Type d'événement : google.workspace.chat.membership.v1.updated

Champs
membership	Membership L'appartenance mise à jour.

Message

Un message dans un espace Google Chat

Champs
name	string Nom de ressource du message. Format : spaces/{space}/messages/{message} Où {space} est l'ID de l'espace dans lequel le message est publié et {message} est un ID attribué par le système pour le message. Par exemple, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB. Si vous définissez un ID personnalisé lorsque vous créez un message, vous pouvez l'utiliser pour spécifier le message dans une requête en remplaçant {message} par la valeur du champ clientAssignedMessageId. Par exemple, spaces/AAAAAAAAAAA/messages/client-custom-name. Pour en savoir plus, consultez Attribuer un nom à un message.
sender	User Uniquement en sortie. Utilisateur qui a créé le message. Si votre application Chat s'authentifie en tant qu'utilisateur, la sortie renseigne les utilisateurs name et type.
create_time	Timestamp Facultatif. Immuable. Pour les espaces créés dans Chat, heure à laquelle le message a été créé. Ce champ sert uniquement de sortie, sauf lorsqu'il est utilisé dans des espaces en mode importation. Pour les espaces en mode importation, définissez ce champ sur l'horodatage historique au moment de la création du message dans la source afin de conserver l'heure de création d'origine.
last_update_time	Timestamp Uniquement en sortie. Heure à laquelle le message a été modifié pour la dernière fois par un utilisateur. Si le message n'a jamais été modifié, ce champ est vide.
delete_time	Timestamp Uniquement en sortie. Heure à laquelle le message a été supprimé dans Google Chat. Si le message n'est jamais supprimé, ce champ est vide.
text	string Corps du message en texte brut. Le premier lien vers une image, une vidéo ou une page Web génère un chip d'aperçu. Vous pouvez également mentionner un utilisateur Google Chat ou tous les membres de l'espace. Pour savoir comment créer des messages, consultez Envoyer un message.
formatted_text	string Uniquement en sortie. Contient le message text avec des balisages ajoutés pour indiquer la mise en forme. Il est possible que ce champ ne reflète pas toute la mise en forme visible dans l'interface utilisateur, mais inclut les éléments suivants: Syntaxe de balisage pour les caractères gras, italique, barré, à chasse fixe, à chasse fixe et à puces. Mentions de l'utilisateur au format <users/{user}>. Liens hypertexte personnalisés au format <{url}|{rendered_text}>, où la première chaîne correspond à l'URL et la seconde au texte affiché (par exemple, <http://example.com|custom text>). Emoji personnalisés au format :{emoji_name}: (par exemple, :smile:). Cela ne s'applique pas aux emoji Unicode, comme U+1F600 pour les emoji représentant un visage souriant. Pour en savoir plus, consultez Afficher le formatage du texte envoyé dans un message.
cards[] (deprecated)	Card Cet élément est obsolète. Obsolète : utilisez cards_v2 à la place. Fiches enrichies, mises en forme et interactives, que vous pouvez utiliser pour afficher des éléments d'interface utilisateur tels que des textes mis en forme, des boutons et des images cliquables. Les fiches sont généralement affichées sous le corps du message en texte brut. cards et cards_v2 peuvent avoir une taille maximale de 32 Ko.
cards_v2[]	CardWithId Tableau de fiches. Seules les applications Chat peuvent créer des fiches. Si votre application Chat s'authentifie en tant qu'utilisateur, les messages ne peuvent pas contenir de cartes. Pour savoir comment créer un message contenant des fiches, consultez Envoyer un message. Concevez et prévisualisez des fiches à l'aide de l'outil de création de fiches. Ouvrir l'outil de création de cartes
annotations[]	Annotation Uniquement en sortie. Annotations associées à text dans ce message.
thread	Thread Fil de discussion auquel le message appartient. Pour obtenir des exemples d'utilisation, consultez Démarrer un fil de discussion ou y répondre.
space	Space Si votre application Chat s'authentifie en tant qu'utilisateur, le résultat renseigne l'espace name.
fallback_text	string Description au format texte brut des fiches du message, utilisée lorsque les fiches réelles ne peuvent pas être affichées (par exemple, les notifications mobiles).
action_response	ActionResponse Uniquement en entrée. Paramètres qu'une application de chat peut utiliser pour configurer la publication de sa réponse.
argument_text	string Uniquement en sortie. Corps du message en texte brut, sans mention de l'application Chat.
slash_command	SlashCommand Uniquement en sortie. Les informations sur la commande à barre oblique, le cas échéant.
attachment[]	Attachment Pièce jointe importée par l'utilisateur.
matched_url	MatchedUrl Uniquement en sortie. URL dans spaces.messages.text correspondant à un format d'aperçu de lien. Pour en savoir plus, consultez la section Liens d'aperçu.
thread_reply	bool Uniquement en sortie. Lorsque la valeur est true, le message est une réponse dans un fil de discussion de réponse. Lorsque la valeur est false, le message est visible dans la conversation racine de l'espace en tant que premier message d'un fil de discussion ou en tant que message sans fil de discussion. Si l'espace n'est pas compatible avec les réponses dans les fils de discussion, ce champ est toujours false.
client_assigned_message_id	string Facultatif. ID personnalisé du message. Vous pouvez utiliser ce champ pour identifier un message, ou pour l'obtenir, le supprimer ou le mettre à jour. Pour définir un ID personnalisé, spécifiez le champ messageId lorsque vous créez le message. Pour en savoir plus, consultez Nommer un message.
emoji_reaction_summaries[]	EmojiReactionSummary Uniquement en sortie. Liste des résumés des réactions emoji sur le message.
private_message_viewer	User Immuable. Entrée pour créer un message, sinon sortie uniquement. Utilisateur autorisé à voir le message. Lorsque ce paramètre est défini, le message est privé et uniquement visible par l'utilisateur spécifié et l'application Chat. Pour inclure ce champ dans votre requête, vous devez appeler l'API Chat à l'aide de l'authentification d'application et omettre les éléments suivants: Rattachements Widgets d'accessoires Pour en savoir plus, consultez Envoyer un message en mode privé.
deletion_metadata	DeletionMetadata Uniquement en sortie. Informations sur un message supprimé. Un message est supprimé lorsque delete_time est défini.
quoted_message_metadata	QuotedMessageMetadata Uniquement en sortie. Informations sur un message cité par un utilisateur Google Chat dans un espace. Les utilisateurs de Google Chat peuvent citer un message pour y répondre.
attached_gifs[]	AttachedGif Uniquement en sortie. Images GIF jointes au message
accessory_widgets[]	AccessoryWidget Un ou plusieurs widgets interactifs qui s'affichent en bas d'un message. Vous pouvez ajouter des widgets accessoires aux messages qui contiennent du texte, des cartes ou les deux. Non compatible avec les messages contenant des boîtes de dialogue. Pour en savoir plus, consultez Ajouter des widgets interactifs au bas d'un message. La création d'un message avec des widgets accessoires nécessite l'authentification de l'application.

MessageBatchCreatedEventData

Charge utile de l'événement pour plusieurs nouveaux messages.

Type d'événement: google.workspace.chat.message.v1.batchCreated

Champs
messages[]	MessageCreatedEventData Liste des nouveaux messages.

MessageBatchDeletedEventData

Charge utile d'événement pour plusieurs messages supprimés.

Type d'événement : google.workspace.chat.message.v1.batchDeleted

Champs
messages[]	MessageDeletedEventData Liste des messages supprimés.

MessageBatchUpdatedEventData

Charge utile d'événement pour plusieurs messages mis à jour.

Type d'événement: google.workspace.chat.message.v1.batchUpdated

Champs
messages[]	MessageUpdatedEventData Liste des messages mis à jour.

MessageCreatedEventData

Charge utile d'événement pour un nouveau message.

Type d'événement: google.workspace.chat.message.v1.created

Champs
message	Message Nouveau message.

MessageDeletedEventData

Charge utile d'événement pour un message supprimé.

Type d'événement : google.workspace.chat.message.v1.deleted

Champs
message	Message Message supprimé. Seuls les champs name, createTime, deleteTime et deletionMetadata sont renseignés.

MessageUpdatedEventData

Charge utile de l'événement pour un message mis à jour.

Type d'événement : google.workspace.chat.message.v1.updated

Champs
message	Message Message mis à jour.

QuotedMessageMetadata

Informations sur un message cité.

Champs
name	string Uniquement en sortie. Nom de ressource du message cité. Format : spaces/{space}/messages/{message}
last_update_time	Timestamp Uniquement en sortie. Horodatage de la création ou de la dernière mise à jour du message cité.

Réaction

Réaction à un message.

Champs
name	string Nom de ressource de la réaction. Format : spaces/{space}/messages/{message}/reactions/{reaction}
user	User Uniquement en sortie. Utilisateur ayant créé la réaction.
emoji	Emoji Emoji utilisé dans la réaction.

ReactionBatchCreatedEventData

Charge utile de l'événement pour plusieurs nouvelles réactions.

Type d'événement : google.workspace.chat.reaction.v1.batchCreated

Champs
reactions[]	ReactionCreatedEventData Liste des nouvelles réactions.

ReactionBatchDeletedEventData

Charge utile de l'événement pour plusieurs réactions supprimées.

Type d'événement: google.workspace.chat.reaction.v1.batchDeleted

Champs
reactions[]	ReactionDeletedEventData Liste des réactions supprimées.

ReactionCreatedEventData

Charge utile de l'événement pour une nouvelle réaction.

Type d'événement: google.workspace.chat.reaction.v1.created

Champs
reaction	Reaction La nouvelle réaction.

ReactionDeletedEventData

Charge utile de l'événement pour une réaction supprimée.

Type : google.workspace.chat.reaction.v1.deleted

Champs
reaction	Reaction Réaction supprimée.

RichLinkMetadata

Lien enrichi vers une ressource.

Champs
uri	string URI de ce lien.
rich_link_type	RichLinkType Type de lien enrichi.
Champ d'union data. Données de la ressource associée. data ne peut être qu'un des éléments suivants :
drive_link_data	DriveLinkData Données d'un lien Drive.
chat_space_link_data	ChatSpaceLinkData Données pour un lien vers un espace Chat.

RichLinkType

Type de lien enrichi. D'autres types pourront être ajoutés à l'avenir.

Enums
RICH_LINK_TYPE_UNSPECIFIED	Valeur par défaut de l'énumération. Ne pas utiliser.
DRIVE_FILE	Type de lien Google Drive enrichi.
CHAT_SPACE	Lien enrichi d'un espace Chat. (par exemple, un chip d'espace intelligent).

SearchSpacesRequest

Requête permettant de rechercher une liste d'espaces en fonction d'une requête.

Champs
use_admin_access	bool Lorsque la valeur est true, la méthode s'exécute avec les droits d'administrateur Google Workspace de l'utilisateur. L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit de gérer les conversations Chat et Espaces. Nécessite le champ d'application OAuth 2.0 chat.admin.spaces.readonly ou chat.admin.spaces. Cette méthode n'est actuellement compatible qu'avec l'accès administrateur. Par conséquent, seul true est accepté pour ce champ.
page_size	int32 Nombre maximal d'espaces à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, 100 espaces au maximum sont renvoyés. La valeur maximale est 1 000. Si vous utilisez une valeur supérieure à 1 000, elle est automatiquement remplacée par 1 000.
page_token	string Jeton reçu lors de l'appel d'espaces de recherche précédent. Indiquez ce paramètre pour récupérer la page suivante. Lors de la pagination, tous les autres paramètres fournis doivent correspondre à l'appel qui a fourni le jeton de page. Transmettre des valeurs différentes aux autres paramètres peut entraîner des résultats inattendus.
query	string Obligatoire. Une requête de recherche Vous pouvez effectuer une recherche à l'aide des paramètres suivants : create_time customer display_name external_user_allowed last_active_time space_history_state space_type create_time et last_active_time acceptent un code temporel au format RFC-3339. Les opérateurs de comparaison compatibles sont: =, <, >, <=, >=. customer est obligatoire et permet d'indiquer le client à partir duquel extraire les espaces. customers/my_customer est la seule valeur acceptée. display_name n'accepte que l'opérateur HAS (:). Le texte à faire correspondre est d'abord tokenisé en jetons, et chaque jeton est mis en correspondance avec un préfixe, sans distinction de casse et de manière indépendante, en tant que sous-chaîne n'importe où dans l'display_name de l'espace. Par exemple, Fun Eve correspond à Fun event ou The evening was fun, mais pas à notFun event ou even. external_user_allowed accepte true ou false. space_history_state n'accepte que les valeurs du champ historyState d'une ressource space. space_type est obligatoire. La seule valeur valide est SPACE. Dans les différents champs, seuls les opérateurs AND sont acceptés. space_type = "SPACE" AND display_name:"Hello" est un exemple valide. space_type = "SPACE" OR display_name:"Hello" est un exemple non valide. Parmi le même champ, space_type n'est pas compatible avec les opérateurs AND ou OR. display_name, "space_history_state" et "external_user_allowed" n'acceptent que les opérateurs OR. last_active_time et create_time sont compatibles avec les opérateurs AND et OR. AND ne peut être utilisé que pour représenter un intervalle, par exemple last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00". Les exemples de requêtes suivants sont valides : customer = "customers/my_customer" AND space_type = "SPACE" customer = "customers/my_customer" AND space_type = "SPACE" AND display_name:"Hello World" customer = "customers/my_customer" AND space_type = "SPACE" AND (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time > "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Fun event") AND (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time < "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (create_time > "2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
order_by	string Facultatif. Ordre de la liste des espaces. Les attributs acceptés pour la commande sont les suivants : membership_count.joined_direct_human_user_count : indique le nombre d'utilisateurs humains ayant rejoint directement un espace. last_active_time : indique l'heure à laquelle le dernier élément éligible a été ajouté à un sujet de cet espace. create_time : indique l'heure de création de l'espace. Les valeurs d'opération d'ordonnancement valides sont les suivantes : ASC pour l'ordre croissant. Valeur par défaut. DESC pour l'ordre décroissant. La syntaxe acceptée est la suivante: membership_count.joined_direct_human_user_count DESC membership_count.joined_direct_human_user_count ASC last_active_time DESC last_active_time ASC create_time DESC create_time ASC

SearchSpacesResponse

Réponse avec une liste d'espaces correspondant à la requête d'espaces de recherche.

Champs
spaces[]	Space Page des espaces demandés.
next_page_token	string Jeton permettant de récupérer la page suivante. Si ce champ est vide, il n'y a pas de pages suivantes.
total_size	int32 Nombre total d'espaces correspondant à la requête, sur toutes les pages. Si le résultat est supérieur à 10 000 espaces, cette valeur est une estimation.

SetUpSpaceRequest

Demande de création d'un espace et d'ajout des utilisateurs spécifiés à celui-ci.

Champs
space	Space Obligatoire. Le champ Space.spaceType est obligatoire. Pour créer un espace, définissez Space.spaceType sur SPACE et Space.displayName. Si le message d'erreur ALREADY_EXISTS s'affiche lorsque vous configurez un espace, essayez un autre displayName. Un espace existant dans l'organisation Google Workspace utilise peut-être déjà ce nom à afficher. Pour créer un chat de groupe, définissez Space.spaceType sur GROUP_CHAT. Ne définissez pas Space.displayName. Pour créer une conversation 1:1 entre des réviseurs humains, définissez Space.spaceType sur DIRECT_MESSAGE et Space.singleUserBotDm sur false. Ne définissez pas Space.displayName ni Space.spaceDetails. Pour créer une conversation privée entre un humain et l'application Chat appelante, définissez Space.spaceType sur DIRECT_MESSAGE et Space.singleUserBotDm sur true. Ne définissez pas Space.displayName ni Space.spaceDetails. Si un espace DIRECT_MESSAGE existe déjà, il est renvoyé au lieu d'en créer un.
request_id	string Facultatif. Identifiant unique de cette requête. Nous vous recommandons d'utiliser un UUID aléatoire. Si vous spécifiez un ID de requête existant, l'espace créé avec cet ID est renvoyé au lieu d'en créer un autre. Spécifier un ID de requête existant de la même application Chat avec un autre utilisateur authentifié génère une erreur.
memberships[]	Membership Facultatif. Utilisateurs ou groupes Google Chat à inviter à rejoindre l'espace. Omettre l'utilisateur appelant, car il est ajouté automatiquement. L'ensemble autorise actuellement jusqu'à 20 adhésions (en plus de l'appelant). Pour l'appartenance à un groupe d'utilisateurs, le champ Membership.member doit contenir un user avec name renseigné (format : users/{user}) et type défini sur User.Type.HUMAN. Vous ne pouvez ajouter que des utilisateurs humains lorsque vous configurez un espace (l'ajout d'applications Chat n'est accepté que pour la configuration de messages privés avec l'application d'appel). Vous pouvez également ajouter des membres en utilisant l'adresse e-mail de l'utilisateur comme alias pour {user}. Par exemple, user.name peut être users/[e-mail]. Pour inviter des utilisateurs Gmail ou des utilisateurs de domaines Google Workspace externes, vous devez utiliser leur adresse e-mail pour {user}. Pour l'appartenance à un groupe Google, le champ Membership.group_member doit contenir un group avec name renseigné (format groups/{group}). Vous ne pouvez ajouter des groupes Google que lorsque vous définissez Space.spaceType sur SPACE. Facultatif lorsque vous définissez Space.spaceType sur SPACE. Obligatoire lorsque vous définissez Space.spaceType sur GROUP_CHAT, ainsi que pour au moins deux adhésions. Obligatoire lorsque vous définissez Space.spaceType sur DIRECT_MESSAGE avec un utilisateur humain, avec un seul membre. Doit être vide lorsque vous créez une conversation privée entre un humain et l'application Chat appelante (lorsque vous définissez Space.spaceType sur DIRECT_MESSAGE et Space.singleUserBotDm sur true).

SlashCommand

Commande à barre oblique dans Google Chat

Champs
command_id	int64 ID de la commande à barre oblique appelée.

SlashCommandMetadata

Métadonnées d'annotation pour les commandes à barre oblique (/).

Champs
bot	User Application Chat dont la commande a été appelée.
type	Type Type de commande à barre oblique.
command_name	string Nom de la commande à barre oblique appelée.
command_id	int64 ID de la commande à barre oblique appelée.
triggers_dialog	bool Indique si la commande à barre oblique est destinée à une boîte de dialogue.

Type

Enums
TYPE_UNSPECIFIED	Valeur par défaut de l'énumération. Ne pas utiliser.
ADD	Ajoutez l'application Chat à l'espace.
INVOKE	Appeler une commande à barre oblique dans un espace

Espace

Espace dans Google Chat Les espaces sont des conversations entre deux utilisateurs ou plus, ou des messages privés entre un utilisateur et une application Chat.

Champs
name	string Nom de ressource de l'espace. Format : spaces/{space} Où {space} représente l'ID attribué par le système pour l'espace. Vous pouvez obtenir l'ID de l'espace en appelant la méthode spaces.list() ou à partir de l'URL de l'espace. Par exemple, si l'URL de l'espace est https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, l'ID de l'espace est AAAAAAAAA.
type (deprecated)	Type Cet élément est obsolète. Uniquement en sortie. Obsolète : utilisez space_type à la place. Type d'espace.
space_type	SpaceType Type d'espace. Obligatoire lors de la création d'un espace ou de la modification de son type. Sortie uniquement pour une autre utilisation.
single_user_bot_dm	bool Facultatif. Indique si l'espace est un message privé entre une application Chat et une personne.
threaded (deprecated)	bool Cet élément est obsolète. Uniquement en sortie. Obsolète: utilisez plutôt spaceThreadingState. Indique si les messages sont organisés en fils de discussion dans cet espace.
display_name	string Nom à afficher de l'espace. Obligatoire lorsque vous créez un espace avec un spaceType défini sur SPACE. Si le message d'erreur ALREADY_EXISTS s'affiche lorsque vous créez un espace ou modifiez le displayName, essayez avec un autre displayName. Il est possible qu'un espace existant de l'organisation Google Workspace utilise déjà ce nom à afficher. Pour les messages privés, ce champ peut être vide. Peut contenir jusqu'à 128 caractères.
external_user_allowed	bool Immuable. Indique si cet espace autorise tout utilisateur Google Chat à en être membre. Saisie lors de la création d'un espace dans une organisation Google Workspace. Omettez ce champ lorsque vous créez des espaces dans les conditions suivantes: L'utilisateur authentifié utilise un compte personnel (compte utilisateur non géré). Par défaut, un espace créé par un compte personnel autorise tous les utilisateurs de Google Chat. Pour les espaces existants, ce champ n'est fourni qu'en sortie.
space_threading_state	SpaceThreadingState Uniquement en sortie. État des fils de discussion dans l'espace Chat.
space_details	SpaceDetails Informations sur l'espace, y compris sa description et ses règles
space_history_state	HistoryState État de l'historique des messages et des fils de discussion de cet espace.
import_mode	bool Facultatif. Indique si cet espace est créé dans Import Mode lors d'une migration de données vers Google Workspace. Pendant l'importation des espaces, les utilisateurs ne peuvent pas les voir tant que l'importation n'est pas terminée. Pour créer un espace dans Import Mode, vous devez vous authentifier auprès de l'utilisateur.
create_time	Timestamp Facultatif. Immuable. Pour les espaces créés dans Chat, date et heure de création de l'espace. Ce champ sert uniquement de sortie, sauf lorsqu'il est utilisé dans des espaces en mode importation. Pour les espaces en mode importation, définissez ce champ sur l'horodatage historique de la création de l'espace dans la source, afin de conserver l'heure de création d'origine. N'est renseigné que dans la sortie lorsque spaceType est défini sur GROUP_CHAT ou SPACE.
last_active_time	Timestamp Uniquement en sortie. Code temporel du dernier message dans l'espace. Preview développeur:disponible dans le cadre du programme Preview développeur Google Workspace, qui accorde un accès anticipé à certaines fonctionnalités.
admin_installed	bool Uniquement en sortie. Pour les espaces de messages privés (MP) avec une application Chat, indique si l'espace a été créé par un administrateur Google Workspace. Les administrateurs peuvent installer et configurer un message privé avec une application Chat au nom des utilisateurs de leur organisation. Pour être compatible avec l'installation par administrateur, votre application Chat doit proposer les messages privés.
membership_count	MembershipCount Uniquement en sortie. Nombre d'adhésions membres, regroupées par type de membre. Renseigné lorsque space_type est défini sur SPACE, DIRECT_MESSAGE ou GROUP_CHAT. Preview développeur : disponible dans le cadre du programme Preview développeur Google Workspace, qui permet d'accéder en avant-première à certaines fonctionnalités.
access_settings	AccessSettings Facultatif. Spécifie le paramètre d'accès de l'espace. N'est renseigné que lorsque space_type est défini sur SPACE.
space_uri	string Uniquement en sortie. URI permettant à un utilisateur d'accéder à l'espace.
customer	string Facultatif. Immuable. ID client du domaine de l'espace. Obligatoire uniquement lors de la création d'un espace avec authentification de l'application et lorsque SpaceType est SPACE. Sinon, ne doit pas être défini. Au format customers/{customer}, où customer correspond au id de la [ressource client SDK Admin]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Les applications privées peuvent également utiliser l'alias customers/my_customer pour créer l'espace dans la même organisation Google Workspace que l'application. Pour les MP, ce champ n'est pas renseigné. Preview développeur:disponible dans le cadre du programme Preview développeur Google Workspace, qui accorde un accès anticipé à certaines fonctionnalités.
Champ d'union space_permission_settings. Représente les paramètres d'autorisation d'un espace. N'est renseigné que lorsque space_type est défini sur SPACE. Nécessite une authentification de l'utilisateur. space_permission_settings ne peut être qu'un des éléments suivants :
predefined_permission_settings	PredefinedPermissionSettings Facultatif. Uniquement en entrée. Paramètres d'autorisation prédéfinis pour l'espace, à saisir uniquement lors de la création d'un espace. Si ce champ n'est pas défini, un espace de collaboration est créé. Une fois l'espace créé, les paramètres sont renseignés dans le champ PermissionSettings.
permission_settings	PermissionSettings Facultatif. Paramètres d'autorisation pour les espaces existants. Entrée permettant de mettre à jour les paramètres d'autorisation exacts de l'espace, où les paramètres d'autorisation existants sont remplacés. Le résultat liste les paramètres d'autorisation actuels.

AccessSettings

Représente le paramètre d'accès de l'espace.

Champs
access_state	AccessState Uniquement en sortie. Indique l'état d'accès de l'espace.
audience	string Facultatif. Nom de la ressource de l'audience cible pouvant découvrir l'espace, le rejoindre et prévisualiser les messages qu'il contient. Si cette option n'est pas définie, seuls les utilisateurs ou les groupes Google qui ont été invités ou ajoutés individuellement à l'espace peuvent y accéder. Pour en savoir plus, consultez Rendre un espace visible auprès d'une audience cible. Format : audiences/{audience} Pour utiliser l'audience cible par défaut de l'organisation Google Workspace, définissez la valeur sur audiences/default. La lecture de l'audience cible permet de : Authentification des utilisateurs Authentification des applications avec approbation de l'administrateur dont le niveau d'accès chat.app.spaces est défini sur Preview développeur : disponible dans le cadre du programme Preview développeur Google Workspace, qui permet d'accéder en avant-première à certaines fonctionnalités. Ce champ n'est pas renseigné lorsque vous utilisez le champ d'application chat.bot avec l'authentification de l'application. La définition de l'audience cible nécessite une authentification de l'utilisateur.

AccessState

Représente l'état d'accès de l'espace.

Enums
ACCESS_STATE_UNSPECIFIED	L'état de l'accès est inconnu ou non compatible avec cette API.
PRIVATE	Seuls les utilisateurs ou les groupes Google ajoutés ou invités individuellement par d'autres utilisateurs ou par des administrateurs Google Workspace peuvent le découvrir et y accéder.
DISCOVERABLE	Un gestionnaire de l'espace a autorisé une audience cible à accéder à l'espace. Les utilisateurs ou groupes Google qui ont été ajoutés ou invités individuellement à l'espace peuvent également le découvrir et y accéder. Pour en savoir plus, consultez Rendre un espace visible pour des utilisateurs spécifiques. La création d'espaces visibles nécessite une authentification de l'utilisateur.

MembershipCount

Représente le nombre d'adhésions à un espace, regroupées en catégories.

Champs
joined_direct_human_user_count	int32 Nombre d'utilisateurs humains ayant directement rejoint l'espace (sans compter ceux qui ont rejoint un groupe).
joined_group_count	int32 Nombre de groupes ayant rejoint directement l'espace.

PermissionSetting

Représente un paramètre d'autorisation d'espace.

Champs
managers_allowed	bool Indique si les gestionnaires d'espaces disposent de cette autorisation.
members_allowed	bool Indique si les membres non administrateurs disposent de cette autorisation.

PermissionSettings

Paramètres d'autorisation que vous pouvez spécifier lorsque vous modifiez un espace nommé existant.

Pour définir les paramètres d'autorisation lors de la création d'un espace, spécifiez le champ PredefinedPermissionSettings dans votre requête.

Champs
manage_members_and_groups	PermissionSetting Paramètre permettant de gérer les membres et les groupes d'un espace.
modify_space_details	PermissionSetting Paramètre permettant de modifier le nom, l'avatar, la description et les consignes de l'espace.
toggle_history	PermissionSetting Paramètre permettant d'activer ou de désactiver l'historique des espaces.
use_at_mention_all	PermissionSetting Paramètre permettant d'utiliser @tous dans un espace.
manage_apps	PermissionSetting Paramètre permettant de gérer les applications d'un espace.
manage_webhooks	PermissionSetting Paramètre permettant de gérer les webhooks dans un espace.
post_messages	PermissionSetting Uniquement en sortie. Paramètre permettant de publier des messages dans un espace.
reply_messages	PermissionSetting Paramètre pour répondre aux messages dans un espace.

PredefinedPermissionSettings

Paramètres d'autorisation prédéfinis que vous ne pouvez spécifier que lorsque vous créez un espace nommé. D'autres paramètres pourront être ajoutés à l'avenir. Pour en savoir plus sur les paramètres d'autorisation des espaces nommés, consultez En savoir plus sur les espaces.

Enums
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED	Non spécifié. Ne pas utiliser.
COLLABORATION_SPACE	Paramètre permettant de transformer l'espace en espace de collaboration dans lequel tous les membres peuvent publier des messages.
ANNOUNCEMENT_SPACE	Paramètre permettant de transformer l'espace en espace d'annonces où seuls les gestionnaires de l'espace peuvent publier des messages.

SpaceDetails

Informations sur l'espace, y compris sa description et ses règles

Champs
description	string Facultatif. Description de l'espace. Par exemple, décrivez le sujet de la discussion, l'objectif fonctionnel ou les participants de l'espace. Il peut comporter jusqu'à 150 caractères.
guidelines	string Facultatif. Les règles, les attentes et l'étiquette de l'espace. Il peut comporter jusqu'à 5 000 caractères.

SpaceThreadingState

Spécifie le type d'état de thread dans l'espace Chat.

Enums
SPACE_THREADING_STATE_UNSPECIFIED	Réservé.
THREADED_MESSAGES	Espaces nommés compatibles avec les fils de discussion Lorsque les utilisateurs répondent à un message, ils peuvent le faire dans le fil de discussion, ce qui permet de garder leur réponse dans le contexte du message d'origine.
GROUPED_MESSAGES	Espaces nommés dans lesquels les conversations sont organisées par sujet. Les sujets et leurs réponses sont regroupés.
UNTHREADED_MESSAGES	Messages privés (MP) entre deux personnes et conversations de groupe entre trois personnes ou plus.

SpaceType

Type d'espace. Obligatoire lors de la création ou de la mise à jour d'un espace. Sortie uniquement pour une autre utilisation.

Enums
SPACE_TYPE_UNSPECIFIED	Réservé.
SPACE	Un espace où les utilisateurs peuvent envoyer des messages, partager des fichiers et collaborer. Un SPACE peut inclure des applications Chat.
GROUP_CHAT	Conversations de groupe entre trois personnes ou plus. Un GROUP_CHAT peut inclure des applications Chat.
DIRECT_MESSAGE	Messages privés entre deux personnes ou entre une personne et une application Chat

Type

Obsolète: utilisez plutôt SpaceType.

Enums
TYPE_UNSPECIFIED	Réservé.
ROOM	Conversations entre deux personnes ou plus.
DM	Message privé entre une personne et une application Chat, où tous les messages sont plats Notez que cela n'inclut pas les messages privés entre deux personnes.

SpaceBatchUpdatedEventData

Charge utile d'événement pour plusieurs mises à jour d'un espace.

Type d'événement: google.workspace.chat.space.v1.batchUpdated

Champs
spaces[]	SpaceUpdatedEventData Liste des espaces mis à jour.

SpaceEvent

Événement représentant une modification ou une activité dans un espace Google Chat. Pour en savoir plus, consultez Gérer les événements Google Chat.

Champs
name	string Nom de ressource de l'événement de l'espace. Format : spaces/{space}/spaceEvents/{spaceEvent}
event_time	Timestamp Heure à laquelle l'événement s'est produit.
event_type	string Type d'événement dans l'espace. Chaque type d'événement comporte une version par lot, qui représente plusieurs instances du type d'événement qui se produisent sur une courte période. Pour les requêtes spaceEvents.list(), omettez les types d'événements par lot dans votre filtre de requête. Par défaut, le serveur renvoie à la fois le type d'événement et sa version de lot. Types d'événements compatibles pour les messages: Nouveau message: google.workspace.chat.message.v1.created Message modifié: google.workspace.chat.message.v1.updated Message supprimé : google.workspace.chat.message.v1.deleted Plusieurs nouveaux messages: google.workspace.chat.message.v1.batchCreated Plusieurs messages modifiés: google.workspace.chat.message.v1.batchUpdated Plusieurs messages supprimés : google.workspace.chat.message.v1.batchDeleted Types d'événements compatibles avec les souscriptions: Nouvel abonnement: google.workspace.chat.membership.v1.created Abonnement mis à jour : google.workspace.chat.membership.v1.updated Abonnement supprimé: google.workspace.chat.membership.v1.deleted Plusieurs nouveaux abonnements : google.workspace.chat.membership.v1.batchCreated Plusieurs abonnements mis à jour : google.workspace.chat.membership.v1.batchUpdated Plusieurs abonnements supprimés: google.workspace.chat.membership.v1.batchDeleted Types d'événements compatibles avec les réactions: Nouvelle réaction: google.workspace.chat.reaction.v1.created Réaction supprimée : google.workspace.chat.reaction.v1.deleted Plusieurs nouvelles réactions : google.workspace.chat.reaction.v1.batchCreated Plusieurs réactions supprimées : google.workspace.chat.reaction.v1.batchDeleted Types d'événements acceptés concernant l'espace : Espace mis à jour: google.workspace.chat.space.v1.updated Plusieurs mises à jour de l'espace : google.workspace.chat.space.v1.batchUpdated
Champ d'union payload. payload ne peut être qu'un des éléments suivants :
message_created_event_data	MessageCreatedEventData Charge utile d'événement pour un nouveau message. Type d'événement : google.workspace.chat.message.v1.created
message_updated_event_data	MessageUpdatedEventData Charge utile de l'événement pour un message mis à jour. Type d'événement: google.workspace.chat.message.v1.updated
message_deleted_event_data	MessageDeletedEventData Charge utile d'événement pour un message supprimé. Type d'événement: google.workspace.chat.message.v1.deleted
message_batch_created_event_data	MessageBatchCreatedEventData Charge utile d'événement pour plusieurs nouveaux messages. Type d'événement : google.workspace.chat.message.v1.batchCreated
message_batch_updated_event_data	MessageBatchUpdatedEventData Charge utile de l'événement pour plusieurs messages mis à jour. Type d'événement: google.workspace.chat.message.v1.batchUpdated
message_batch_deleted_event_data	MessageBatchDeletedEventData Charge utile de l'événement pour plusieurs messages supprimés. Type d'événement: google.workspace.chat.message.v1.batchDeleted
space_updated_event_data	SpaceUpdatedEventData Charge utile de l'événement pour une mise à jour d'un espace. Type d'événement: google.workspace.chat.space.v1.updated
space_batch_updated_event_data	SpaceBatchUpdatedEventData Charge utile d'événement pour plusieurs mises à jour d'un espace. Type d'événement : google.workspace.chat.space.v1.batchUpdated
membership_created_event_data	MembershipCreatedEventData Charge utile de l'événement pour une nouvelle souscription. Type d'événement : google.workspace.chat.membership.v1.created
membership_updated_event_data	MembershipUpdatedEventData Charge utile de l'événement pour un abonnement mis à jour. Type d'événement: google.workspace.chat.membership.v1.updated
membership_deleted_event_data	MembershipDeletedEventData Charge utile de l'événement pour un abonnement supprimé. Type d'événement : google.workspace.chat.membership.v1.deleted
membership_batch_created_event_data	MembershipBatchCreatedEventData Charge utile de l'événement pour plusieurs nouvelles adhésions. Type d'événement : google.workspace.chat.membership.v1.batchCreated
membership_batch_updated_event_data	MembershipBatchUpdatedEventData Charge utile de l'événement pour plusieurs abonnements mis à jour. Type d'événement: google.workspace.chat.membership.v1.batchUpdated
membership_batch_deleted_event_data	MembershipBatchDeletedEventData Charge utile de l'événement pour plusieurs souscriptions supprimées. Type d'événement : google.workspace.chat.membership.v1.batchDeleted
reaction_created_event_data	ReactionCreatedEventData Charge utile de l'événement pour une nouvelle réaction. Type d'événement: google.workspace.chat.reaction.v1.created
reaction_deleted_event_data	ReactionDeletedEventData Charge utile de l'événement pour une réaction supprimée. Type d'événement : google.workspace.chat.reaction.v1.deleted
reaction_batch_created_event_data	ReactionBatchCreatedEventData Charge utile d'événement pour plusieurs nouvelles réactions. Type d'événement: google.workspace.chat.reaction.v1.batchCreated
reaction_batch_deleted_event_data	ReactionBatchDeletedEventData Charge utile d'événement pour plusieurs réactions supprimées. Type d'événement: google.workspace.chat.reaction.v1.batchDeleted

SpaceReadState

État de lecture d'un utilisateur dans un espace, utilisé pour identifier les messages lus et non lus.

Champs
name	string Nom de ressource de l'état de lecture de l'espace. Format : users/{user}/spaces/{space}/spaceReadState
last_read_time	Timestamp Facultatif. Heure à laquelle l'état de lecture de l'espace de l'utilisateur a été mis à jour. Il s'agit généralement du code temporel du dernier message lu ou d'un code temporel spécifié par l'utilisateur pour marquer la dernière position de lecture dans un espace.

SpaceUpdatedEventData

Charge utile d'événement pour un espace mis à jour.

Type d'événement : google.workspace.chat.space.v1.updated

Champs
space	Space Espace mis à jour.

Thread

Un fil de discussion dans un espace Google Chat Pour obtenir des exemples d'utilisation, consultez Démarrer un fil de discussion ou y répondre.

Si vous spécifiez un fil de discussion lorsque vous créez un message, vous pouvez définir le champ messageReplyOption pour déterminer ce qui se passe si aucun fil de discussion correspondant n'est trouvé.

Champs
name	string Nom de ressource du thread. Exemple : spaces/{space}/threads/{thread}
thread_key	string Facultatif. Saisie pour créer ou mettre à jour un fil de discussion Sinon, sortie uniquement. ID du thread. Il peut comporter jusqu'à 4 000 caractères. Cet ID est propre à l'application Chat qui le définit. Par exemple, si plusieurs applications Chat créent un message à l'aide de la même clé de fil de discussion, les messages sont publiés dans différents fils de discussion. Pour répondre dans un fil de discussion créé par une personne ou une autre application Chat, spécifiez plutôt le champ name du fil de discussion.

ThreadReadState

État de lecture d'un utilisateur dans un fil de discussion, utilisé pour identifier les messages lus et non lus.

Champs
name	string Nom de ressource de l'état de lecture du thread. Format : users/{user}/spaces/{space}/threads/{thread}/threadReadState
last_read_time	Timestamp Heure à laquelle l'état de lecture du fil de discussion de l'utilisateur a été mis à jour. Il s'agit généralement de l'horodatage du dernier message lu dans un fil de discussion.

UpdateMembershipRequest

Message de requête pour mettre à jour une adhésion.

Champs
membership	Membership Obligatoire. Abonnement à mettre à jour. Seuls les champs spécifiés par update_mask sont mis à jour.
update_mask	FieldMask Obligatoire. Chemins de champ à mettre à jour. Séparez plusieurs valeurs par des virgules ou utilisez * pour mettre à jour tous les chemins de champ. Chemins de champ actuellement acceptés : role
use_admin_access	bool Lorsque la valeur est true, la méthode s'exécute à l'aide des droits d'administrateur Google Workspace de l'utilisateur. L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit Gérer les conversations Chat et Espaces. Requiert le champ d'application OAuth 2.0 chat.admin.memberships.

UpdateMessageRequest

Requête de mise à jour d'un message.

Champs
message	Message Obligatoire. Message avec des champs mis à jour.
update_mask	FieldMask Obligatoire. Chemins d'accès des champs à mettre à jour. Séparez plusieurs valeurs par des virgules ou utilisez * pour mettre à jour tous les chemins de champ. Chemins d'accès de champs actuellement acceptés: text attachment cards (nécessite une authentification de l'application) cards_v2 (nécessite une authentification de l'application) accessory_widgets (nécessite une authentification de l'application)
allow_missing	bool Facultatif. Si true et le message est introuvable, un nouveau message est créé et updateMask est ignoré. L'ID de message spécifié doit être attribué par le client, sinon la requête échoue.

UpdateSpaceReadStateRequest

Message de requête pour l'API UpdateSpaceReadState.

Champs
space_read_state	SpaceReadState Obligatoire. État de lecture de l'espace et champs à mettre à jour. Prend uniquement en charge la mise à jour de l'état de lecture pour l'utilisateur appelant. Pour faire référence à l'utilisateur appelant, définissez l'une des valeurs suivantes : Alias me. Exemple :users/me/spaces/{space}/spaceReadState son adresse e-mail Workspace ; Par exemple, users/[e-mail]/spaces/{space}/spaceReadState. son ID utilisateur ; Par exemple, users/123456789/spaces/{space}/spaceReadState. Format : users/{user}/spaces/{space}/spaceReadState
update_mask	FieldMask Obligatoire. Chemins de champ à mettre à jour. Chemins de champ actuellement acceptés : last_read_time Lorsque last_read_time est antérieur à la date et à l'heure de création du dernier message, l'espace apparaît comme non lu dans l'interface utilisateur. Pour marquer l'espace comme lu, définissez last_read_time sur une valeur ultérieure (supérieure) à la date de création du dernier message. La valeur last_read_time est forcée pour correspondre à la date et à l'heure de création du dernier message. Notez que l'état de lecture de l'espace ne concerne que l'état de lecture des messages visibles dans la conversation de niveau supérieur de l'espace. Les réponses dans les fils de discussion ne sont pas affectées par cet horodatage et dépendent de l'état de lecture du fil de discussion.

UpdateSpaceRequest

Requête permettant de mettre à jour un seul espace.

Champs
space	Space Obligatoire. Espace avec des champs à mettre à jour. Space.name doit être renseigné au format spaces/{space}. Seuls les champs spécifiés par update_mask sont mis à jour.
update_mask	FieldMask Obligatoire. Chemins de champ mis à jour, séparés par une virgule s'il y en a plusieurs. Vous pouvez modifier les champs suivants pour un espace : space_details: met à jour la description de l'espace. Il peut comporter jusqu'à 150 caractères. display_name : permet uniquement de modifier le nom à afficher pour les espaces où le champ spaceType est SPACE. Si le message d'erreur ALREADY_EXISTS s'affiche, essayez une autre valeur. Un espace existant dans l'organisation Google Workspace utilise peut-être déjà ce nom à afficher. space_type: permet uniquement de remplacer un type d'espace GROUP_CHAT par SPACE. Incluez display_name avec space_type dans le masque de mise à jour, et assurez-vous que l'espace spécifié a un nom à afficher et le type d'espace SPACE. L'inclusion du masque space_type et du type SPACE dans l'espace spécifié lors de la mise à jour du nom à afficher est facultative si l'espace existant est déjà du type SPACE. Toute tentative de modification du type d'espace entraîne une erreur d'argument non valide. space_type n'est pas compatible avec useAdminAccess. space_history_state: active ou désactive l'historique de l'espace pour mettre à jour les paramètres de l'historique des espaces. Cette fonctionnalité n'est disponible que si les paramètres d'historique sont activés pour l'organisation Google Workspace. Pour mettre à jour l'état de l'historique de l'espace, vous devez omettre tous les autres masques de champ dans votre requête. space_history_state n'est pas compatible avec useAdminAccess. access_settings.audience : met à jour le paramètre d'accès des utilisateurs autorisés à découvrir l'espace, à le rejoindre et à prévisualiser les messages dans l'espace nommé où le champ spaceType est SPACE. Si l'espace existant dispose d'une audience cible, vous pouvez la supprimer et limiter l'accès à l'espace en omisssant une valeur pour ce masque de champ. Pour mettre à jour les paramètres d'accès d'un espace, l'utilisateur qui s'authentifie doit être un administrateur de l'espace et omettre tous les autres masques de champ dans votre requête. Vous ne pouvez pas modifier ce champ si l'espace est en mode importation. Pour en savoir plus, consultez Rendre un espace visible pour des utilisateurs spécifiques. access_settings.audience n'est pas compatible avec useAdminAccess. permission_settings : permet de modifier les paramètres d'autorisation d'un espace. Lorsque vous mettez à jour les paramètres d'autorisation, vous ne pouvez spécifier que permissionSettings masques de champ. vous ne pouvez pas mettre à jour d'autres masques de champ en même temps. permissionSettings n'est pas compatible avec useAdminAccess. Voici les masques de champ compatibles : permission_settings.manageMembersAndGroups permission_settings.modifySpaceDetails permission_settings.toggleHistory permission_settings.useAtMentionAll permission_settings.manageApps permission_settings.manageWebhooks permission_settings.replyMessages
use_admin_access	bool Lorsque la valeur est true, la méthode s'exécute à l'aide des droits d'administrateur Google Workspace de l'utilisateur. L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit Gérer les conversations Chat et Espaces. Requiert le champ d'application OAuth 2.0 chat.admin.spaces. Certaines valeurs FieldMask ne sont pas compatibles avec l'accès administrateur. Pour en savoir plus, consultez la description de update_mask.

Utilisateur

Utilisateur dans Google Chat Lorsqu'il est renvoyé en sortie d'une requête, si votre application Chat s'authentifie en tant qu'utilisateur, la sortie d'une ressource User ne renseigne que les name et type de l'utilisateur.

Champs
name	string Nom de ressource d'un user Google Chat. Format : users/{user}. users/app peut être utilisé comme alias pour l'utilisateur bot de l'application appelante. Pour human users, {user} est le même identifiant utilisateur que : id pour la personne dans l'API People. Par exemple, users/123456789 dans l'API Chat représente la même personne que l'ID de profil de personne 123456789 dans l'API People. id d'un utilisateur dans l'API Directory du SDK Admin. L'adresse e-mail de l'utilisateur peut être utilisée comme alias pour {user} dans les requêtes API. Par exemple, si l'ID de profil de personne de l'API People pour [e-mail] est 123456789, vous pouvez utiliser users/[e-mail] comme alias pour référencer users/123456789. Seul le nom de la ressource canonique (par exemple, users/123456789) sera renvoyé par l'API.
display_name	string Uniquement en sortie. Nom à afficher de l'utilisateur.
domain_id	string Identifiant unique du domaine Google Workspace de l'utilisateur.
type	Type Type d'utilisateur.
is_anonymous	bool Uniquement en sortie. Lorsque true, l'utilisateur est supprimé ou son profil n'est pas visible.

Type

Enums
TYPE_UNSPECIFIED	Valeur par défaut de l'énumération. NE PAS UTILISER.
HUMAN	Utilisateur humain.
BOT	Utilisateur de l'application Chat.

UserMentionMetadata

Métadonnées d'annotation pour les mentions d'utilisateurs (@).

Champs
user	User L'utilisateur a mentionné.
type	Type Type de mention de l'utilisateur.

Type

Enums
TYPE_UNSPECIFIED	Valeur par défaut de l'énumération. Ne pas utiliser.
ADD	Ajoutez un utilisateur à l'espace.
MENTION	Mentionner un utilisateur dans un espace

WidgetMarkup

Un widget est un élément d'interface utilisateur qui présente du texte et des images.

Champs
buttons[]	Button Liste des boutons. La valeur Buttons est également oneof data. Un seul de ces champs doit être défini.
Champ d'union data. Un élément WidgetMarkup ne peut contenir qu'un seul des éléments suivants. Vous pouvez utiliser plusieurs champs WidgetMarkup pour afficher plus d'éléments. data ne peut être que l'un des éléments suivants:
text_paragraph	TextParagraph Afficher un paragraphe de texte dans ce widget.
image	Image Affichez une image dans ce widget.
key_value	KeyValue Affichez un élément clé-valeur dans ce widget.

Bouton

Un bouton. Il peut s'agir d'un bouton textuel ou d'un bouton image.

Champs
Champ d'union type. type ne peut être qu'un des éléments suivants :
text_button	TextButton Bouton avec du texte et une action onclick.
image_button	ImageButton Bouton avec image et action onclick.

FormAction

Une action de formulaire décrit le comportement lorsque le formulaire est envoyé. Par exemple, vous pouvez appeler Apps Script pour gérer le formulaire.

Champs
action_method_name	string Le nom de la méthode permet d'identifier la partie du formulaire qui a déclenché son envoi. Ces informations sont renvoyées à l'application Chat dans le cadre de l'événement de clic sur la fiche. Vous pouvez utiliser le même nom de méthode pour plusieurs éléments qui déclenchent un comportement commun.
parameters[]	ActionParameter Liste des paramètres d'action.

ActionParameter

Liste des paramètres de chaîne à fournir lorsque la méthode d'action est appelée. Par exemple, considérons trois boutons de répétition : répéter maintenant, répéter un jour, répéter la semaine prochaine. Vous pouvez utiliser action method = snooze() en transmettant le type et la durée de la mise en pause dans la liste des paramètres de chaîne.

Champs
key	string Nom du paramètre du script d'action.
value	string Valeur du paramètre.

Icône

Ensemble des icônes compatibles.

Enums
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

Image

Une image spécifiée par une URL et pouvant avoir une action onclick.

Champs
image_url	string URL de l'image
on_click	OnClick L'action onclick.
aspect_ratio	double Rapport d'aspect de cette image (largeur et hauteur). Ce champ vous permet de réserver la hauteur appropriée pour l'image en attendant qu'elle se charge. Elle n'est pas destinée à remplacer le format intégré de l'image. Si cette valeur n'est pas définie, le serveur la remplit en préchargeant l'image.

ImageButton

Bouton Image avec une action onclick.

Champs
on_click	OnClick Action onclick.
name	string Nom de cet élément image_button utilisé pour l'accessibilité. Une valeur par défaut est fournie si ce nom n'est pas spécifié.
Champ d'union icons. L'icône peut être spécifiée par un Icon enum ou une URL. icons ne peut être qu'un des éléments suivants :
icon	Icon Icône spécifiée par un enum qui indexe une icône fournie par l'API Chat.
icon_url	string Icône spécifiée par une URL.

KeyValue

Un élément d'interface utilisateur contient une clé (libellé) et une valeur (contenu). Cet élément peut également contenir des actions telles que le bouton onclick.

Champs
top_label	string Texte du libellé du haut. Texte mis en forme accepté. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme le texte dans les applications Google Chat et Mettre en forme le texte dans les modules complémentaires Google Workspace.
content	string Texte du contenu. Le texte formaté est accepté et toujours obligatoire. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme le texte dans les applications Google Chat et Mettre en forme le texte dans les modules complémentaires Google Workspace.
content_multiline	bool Indique si le contenu doit être multiligne.
bottom_label	string Texte du libellé du bas. Texte mis en forme accepté. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme le texte dans les applications Google Chat et Mettre en forme le texte dans les modules complémentaires Google Workspace.
on_click	OnClick Action onclick. Seuls le libellé du haut, le libellé du bas et la zone de contenu sont cliquables.
Champ d'union icons. Vous devez définir au moins l'une des icônes top_label et bottom_label. icons ne peut être qu'un des éléments suivants :
icon	Icon Valeur d'énumération remplacée par l'API Chat par l'image d'icône correspondante.
icon_url	string Icône spécifiée par une URL.
Champ d'union control. Un widget de contrôle Vous pouvez définir button ou switch_widget, mais pas les deux. control ne peut être que l'un des éléments suivants:
button	Button Bouton cliquable pour déclencher une action.

OnClick

Une action onclick (par exemple, ouvrir un lien).

Champs
Champ d'union data. data ne peut être qu'un des éléments suivants :
action	FormAction Si elle est spécifiée, une action de formulaire est déclenchée par cette action onclick.
open_link	OpenLink Cette action onclick déclenche une action de lien ouvert si elle est spécifiée.

OpenLink

Lien qui ouvre une nouvelle fenêtre.

Champs
url	string URL à ouvrir.

TextButton

Bouton avec du texte et une action onclick.

Champs
text	string Texte du bouton
on_click	OnClick Action onclick du bouton.

TextParagraph

Un paragraphe de texte. Texte mis en forme 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.

Champs
text	string