Index
ChatService(interface)AccessoryWidget(message)ActionResponse(message)ActionResponse.ResponseType(enum)ActionResponse.SelectionItems(message)ActionResponse.UpdatedWidget(message)ActionStatus(message)Annotation(message)AnnotationType(enum)AppCommandMetadata(message)AppCommandMetadata.AppCommandType(enum)AttachedGif(message)Attachment(message)Attachment.Source(enum)AttachmentDataRef(message)Audience(message)Availability(message)Availability.State(enum)CalendarEventLinkData(message)CardWithId(message)ChatSpaceLinkData(message)Citation(message)CitedSource(message)CitedSource.Footer(message)CitedSource.Snippet(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)CreateMessageNotificationOptions(message)CreateMessageNotificationOptions.NotificationType(enum)CreateMessagePinRequest(message)CreateMessageRequest(message)CreateMessageRequest.MessageReplyOption(enum)CreateReactionRequest(message)CreateSectionRequest(message)CreateSpaceRequest(message)CustomEmoji(message)CustomEmoji.CustomEmojiPayload(message)CustomEmojiMetadata(message)CustomStatus(message)DeleteCustomEmojiRequest(message)DeleteMembershipRequest(message)DeleteMessagePinRequest(message)DeleteMessageRequest(message)DeleteReactionRequest(message)DeleteSectionRequest(message)DeleteSpaceRequest(message)DeletionMetadata(message)DeletionMetadata.DeletionType(enum)Dialog(message)DialogAction(message)DoNotDisturbMetadata(message)DriveDataRef(message)DriveLinkData(message)Elements(message)ElementsImage(message)Emoji(message)EmojiReactionSummary(message)FindDirectMessageRequest(message)FindGroupChatsRequest(message)FindGroupChatsResponse(message)ForwardedMetadata(message)GetAttachmentRequest(message)GetAvailabilityRequest(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)ListMessagePinsRequest(message)ListMessagePinsResponse(message)ListMessagesRequest(message)ListMessagesResponse(message)ListReactionsRequest(message)ListReactionsResponse(message)ListSectionItemsRequest(message)ListSectionItemsResponse(message)ListSectionsRequest(message)ListSectionsResponse(message)ListSpaceEventsRequest(message)ListSpaceEventsResponse(message)ListSpacesRequest(message)ListSpacesResponse(message)MarkAsActiveRequest(message)MarkAsAwayRequest(message)MarkAsDoNotDisturbRequest(message)MarkupSyntax(enum)MatchedUrl(message)MeetSpaceLinkData(message)MeetSpaceLinkData.HuddleStatus(enum)MeetSpaceLinkData.Type(enum)Membership(message)Membership.Affiliation(enum)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)MessagePin(message)MessageUpdatedEventData(message)MoveSectionItemRequest(message)MoveSectionItemResponse(message)PositionSectionRequest(message)PositionSectionRequest.Position(enum)PositionSectionResponse(message)QuotedMessageMetadata(message)QuotedMessageMetadata.QuoteType(enum)QuotedMessageSnapshot(message)Reaction(message)ReactionBatchCreatedEventData(message)ReactionBatchDeletedEventData(message)ReactionCreatedEventData(message)ReactionDeletedEventData(message)ReplaceMessageCardsRequest(message)ReplaceMessageCardsResponse(message)RichLinkMetadata(message)RichLinkMetadata.RichLinkType(enum)SearchMessageResult(message)SearchMessagesRequest(message)SearchMessagesRequest.SearchMessagesView(enum)SearchMessagesResponse(message)SearchSpacesRequest(message)SearchSpacesResponse(message)SearchSpacesResponse.SearchSpaceResult(message)Section(message)Section.SectionType(enum)SectionItem(message)SetUpSpaceRequest(message)SlashCommand(message)SlashCommandMetadata(message)SlashCommandMetadata.Type(enum)Space(message)Space.AccessPermissionSetting(message)Space.AccessPermissionSettings(message)Space.AccessSettings(message)Space.AccessSettings.AccessState(enum)Space.MembershipCount(message)Space.PermissionSetting(message)Space.PermissionSettings(message)Space.PredefinedPermissionSettings(enum)Space.Principal(message)Space.SpaceDetails(message)Space.SpaceThreadingState(enum)Space.SpaceType(enum)Space.Type(enum)SpaceBatchUpdatedEventData(message)SpaceEvent(message)SpaceNotificationSetting(message)SpaceNotificationSetting.MuteSetting(enum)SpaceNotificationSetting.NotificationSetting(enum)SpaceReadState(message)SpaceUpdatedEventData(message)SpaceView(enum)Thread(message)ThreadReadState(message)UpdateAvailabilityRequest(message)UpdateMembershipRequest(message)UpdateMessageRequest(message)UpdateSectionRequest(message)UpdateSpaceNotificationSettingRequest(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 |
|---|
|
Termine le processus d'importation pour l'espace spécifié et le rend visible par les utilisateurs. Nécessite l'authentification des utilisateurs et la délégation au niveau du domaine avec le champ d'application de l'autorisation :
Pour en savoir plus, consultez Autoriser les applications Google Chat à importer des données.
|
| CreateCustomEmoji |
|---|
|
Crée un emoji personnalisé. Les emoji personnalisés ne sont disponibles que pour les comptes Google Workspace, et l'administrateur doit les activer pour l'organisation. Pour en savoir plus, consultez À propos des emoji personnalisés dans Google Chat et Gérer les autorisations pour les emoji personnalisés. Nécessite l'authentification de l'utilisateur avec le champ d'application d'autorisation :
|
| CreateMembership |
|---|
|
Crée une appartenance pour l'application Chat appelante, un utilisateur ou un groupe Google. Vous ne pouvez pas créer d'appartenances pour d'autres applications Chat. Lors de la création d'une adhésion, 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'une adhésion ajoute directement le membre à l'espace spécifié. Il est compatible avec les types d'authentification suivants :
L'authentification des applications n'est pas compatible avec les cas d'utilisation suivants :
Pour obtenir des exemples d'utilisation, consultez les pages suivantes :
|
| CreateMessage |
|---|
|
Crée un message dans un espace Google Chat. Pour obtenir un exemple, consultez Envoyer un message. Il est compatible avec les types d'authentification suivants :
Chat attribue l'expéditeur du message différemment selon le type d'authentification que vous utilisez dans votre requête. L'image suivante montre comment Chat attribue un message lorsque vous utilisez l'authentification de l'application. Chat affiche l'application Chat comme expéditeur du message. Le contenu du message peut inclure du texte (
L'image suivante montre comment Chat attribue un message lorsque vous utilisez l'authentification des utilisateurs. Chat affiche 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 (
La taille maximale d'un message, y compris son contenu, est de 32 000 octets. Pour les requêtes de webhook, la réponse ne contient pas le message complet. La réponse ne renseigne que les champs
|
| CreateMessagePin |
|---|
|
Crée une épingle de message. Nécessite l'authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :
|
| CreateReaction |
|---|
|
Crée une réaction et l'ajoute à un message. Pour obtenir un exemple, consultez Ajouter une réaction à un message. Nécessite l'authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :
|
| CreateSection |
|---|
|
Crée une section dans Google Chat. Les sections aident les utilisateurs à regrouper les conversations et à personnaliser la liste des espaces affichés dans le panneau de navigation de Chat. Seules les sections de type Nécessite l'authentification de l'utilisateur avec le champ d'application d'autorisation :
|
| CreateSpace |
|---|
|
Crée un espace. Peut être utilisé pour créer un espace nommé ou un chat de groupe dans Il est compatible avec les types d'authentification suivants :
Lors de l'authentification en tant qu'application, le champ Lors de l'authentification en tant qu'application, l'application Chat est ajoutée en tant que membre de l'espace. Toutefois, contrairement à l'authentification humaine, l'application Chat n'est pas ajoutée en tant que gestionnaire d'espace. Par défaut, l'application Chat peut être supprimée de l'espace par tous les membres de l'espace. Pour n'autoriser que les gestionnaires d'espace à supprimer l'application d'un espace, définissez L'appartenance à un espace lors de sa création dépend de l'endroit où il est créé dans
Si le message d'erreur
|
| DeleteCustomEmoji |
|---|
|
Supprime un emoji personnalisé. Par défaut, les utilisateurs ne peuvent supprimer que les emoji personnalisés qu'ils ont créés. Les gestionnaires d'emoji désignés par l'administrateur peuvent supprimer n'importe quel emoji personnalisé de l'organisation. Consultez À propos des emoji personnalisés dans Google Chat. Les emoji personnalisés ne sont disponibles que pour les comptes Google Workspace, et l'administrateur doit les activer pour l'organisation. Pour en savoir plus, consultez À propos des emoji personnalisés dans Google Chat et Gérer les autorisations pour les emoji personnalisés. Nécessite l'authentification de l'utilisateur avec le champ d'application d'autorisation :
|
| DeleteMembership |
|---|
|
Supprime une ressource Membership. Pour obtenir un exemple, consultez Supprimer un utilisateur ou une application Google Chat d'un espace. Il est compatible avec les types d'authentification suivants :
L'authentification des applications n'est pas compatible avec les cas d'utilisation suivants :
Pour supprimer des gestionnaires d'un espace, le demandeur doit être un gestionnaire de l'espace. Si vous utilisez l'authentification par application, l'application Chat doit être le créateur de l'espace.
|
| DeleteMessage |
|---|
|
Supprime un message. Pour obtenir un exemple, consultez Supprimer un message. Il est compatible avec les types d'authentification suivants :
Lorsque vous utilisez l'authentification par application, les requêtes ne peuvent supprimer que les messages créés par l'application Chat appelante.
|
| DeleteMessagePin |
|---|
|
Supprime un message épinglé. Nécessite l'authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :
|
| DeleteReaction |
|---|
|
Supprime une réaction à un message. Pour obtenir un exemple, consultez Supprimer une réaction. Nécessite l'authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :
|
| DeleteSection |
|---|
|
Supprime une section de type Si la section contient des éléments, tels que des espaces, ils sont déplacés vers les sections par défaut de Google Chat et ne sont pas supprimés. Pour en savoir plus, consultez Créer et organiser des sections dans Google Chat. Nécessite l'authentification de l'utilisateur avec le champ d'application d'autorisation :
|
| DeleteSpace |
|---|
|
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. Il est compatible avec les types d'authentification suivants :
|
| FindDirectMessage |
|---|
|
Renvoie le message privé existant avec l'utilisateur spécifié. Si aucun espace de message privé n'est trouvé, renvoie une erreur Avec l'authentification de l'application, renvoie l'espace de message privé entre l'utilisateur spécifié et l'application Chat appelante. Avec l'authentification des utilisateurs, renvoie l'espace de message privé entre l'utilisateur spécifié et l'utilisateur authentifié. Il est compatible avec les types d'authentification suivants :
|
| FindGroupChats |
|---|
|
Renvoie tous les espaces avec Si l'utilisateur appelant bloque certains utilisateurs ou est bloqué par eux, et qu'aucun espace contenant l'ensemble des utilisateurs spécifiés n'est trouvé, cette méthode renvoie les espaces qui n'incluent pas les utilisateurs bloqués ou qui bloquent. L'ensemble d'utilisateurs spécifié ne doit contenir que des membres humains (pas d'applications). Une requête contenant des utilisateurs non humains ne renvoie aucun espace. Nécessite l'authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :
|
| GetAttachment |
|---|
|
Récupère les métadonnées d'une pièce jointe de message. Les données de la pièce jointe sont récupérées à l'aide de l'API Media. Pour obtenir un exemple, consultez Obtenir les métadonnées d'une pièce jointe. Nécessite l'authentification de l'application avec le champ d'application d'autorisation :
|
| GetAvailability |
|---|
|
Renvoie les informations de disponibilité d'un utilisateur humain dans Google Chat. Par exemple, cela peut être utilisé pour vérifier si un utilisateur est en ligne ou absent, ou pour récupérer son message d'état personnalisé. Cette méthode ne récupère que la disponibilité de l'utilisateur authentifié. Nécessite l'authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :
|
| GetCustomEmoji |
|---|
|
Renvoie des informations sur un emoji personnalisé. Les emoji personnalisés ne sont disponibles que pour les comptes Google Workspace, et l'administrateur doit les activer pour l'organisation. Pour en savoir plus, consultez À propos des emoji personnalisés dans Google Chat et Gérer les autorisations pour les emoji personnalisés. Nécessite l'authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :
|
| GetMembership |
|---|
|
Renvoie des informations sur une appartenance. Pour obtenir un exemple, consultez Obtenir des informations sur l'appartenance d'un utilisateur ou d'une application Google Chat. Il est compatible avec les types d'authentification suivants :
|
| GetMessage |
|---|
|
Renvoie des détails sur un message. Pour obtenir un exemple, consultez Obtenir des informations sur un message. Il est compatible avec les types d'authentification suivants :
Remarque : Peut renvoyer un message d'un membre ou d'un espace bloqué.
|
| GetSpace |
|---|
|
Renvoie des informations sur un espace. Pour obtenir un exemple, consultez Obtenir des informations sur un espace. Il est compatible avec les types d'authentification suivants :
L'authentification des applications présente les limites suivantes :
|
| GetSpaceEvent |
|---|
|
Renvoie un événement d'un espace Google Chat. La charge utile de l'événement contient la version la plus récente de la ressource qui a été modifiée. Par exemple, si vous demandez un événement concernant un nouveau message, mais que le message a été mis à jour par la suite, le serveur renvoie la ressource Remarque : Le champ Il accepte les types d'authentification suivants avec un champ d'application d'autorisation approprié pour lire les données demandées :
Pour obtenir un événement, l'appelant authentifié doit être membre de l'espace. Pour obtenir un exemple, consultez Obtenir des informations sur un événement à partir d'un espace Google Chat.
|
| GetSpaceNotificationSetting |
|---|
|
Récupère le paramètre de notification de l'espace. Pour obtenir un exemple, consultez Obtenir le paramètre de notification d'espace de l'appelant. Nécessite l'authentification de l'utilisateur avec le champ d'application d'autorisation :
|
| GetSpaceReadState |
|---|
|
Renvoie des informations sur l'état de lecture d'un utilisateur dans un espace, utilisé pour identifier les messages lus et non lus. Pour obtenir un exemple, consultez Obtenir des informations sur l'état de lecture d'un espace par un utilisateur. Nécessite l'authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :
|
| GetThreadReadState |
|---|
|
Renvoie des détails sur l'état de lecture d'un utilisateur dans un fil de discussion, utilisé pour identifier les messages lus et non lus. Pour obtenir un exemple, consultez Obtenir des informations sur l'état de lecture d'un fil de discussion par un utilisateur. Nécessite l'authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :
|
| ListCustomEmojis |
|---|
|
Répertorie les emoji personnalisés visibles par l'utilisateur authentifié. Les emoji personnalisés ne sont disponibles que pour les comptes Google Workspace, et l'administrateur doit les activer pour l'organisation. Pour en savoir plus, consultez À propos des emoji personnalisés dans Google Chat et Gérer les autorisations pour les emoji personnalisés. Nécessite l'authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :
|
| ListMemberships |
|---|
|
Répertorie les appartenances à un espace. Pour obtenir un exemple, consultez Lister les utilisateurs et les applications Google Chat dans un espace. L'affichage de la liste des membres avec l'authentification par application liste les membres des espaces auxquels l'application Chat a accès, mais exclut les membres de l'application Chat, y compris les siens. Lister les appartenances avec l'authentification des utilisateurs liste les appartenances dans les espaces auxquels l'utilisateur authentifié a accès. Il est compatible avec les types d'authentification suivants :
|
| ListMessagePins |
|---|
|
Liste les messages épinglés dans un espace. Les utilisateurs peuvent épingler des messages importants dans les espaces pour y accéder facilement. Pour en savoir plus, consultez Épingler ou retirer une conversation dans Google Chat. Nécessite l'authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :
|
| ListMessages |
|---|
|
Répertorie les messages d'un espace dont l'appelant est membre, y compris les messages des membres et des espaces bloqués. Les messages système, comme ceux annonçant l'arrivée de nouveaux membres dans l'espace, ne sont pas inclus. Si vous listez les messages d'un espace qui n'en contient aucun, la réponse est un objet vide. Lorsque vous utilisez une interface REST/HTTP, la réponse contient un objet JSON vide, Il est compatible avec les types d'authentification suivants :
|
| ListReactions |
|---|
|
Répertorie les réactions à un message. Pour obtenir un exemple, consultez Lister les réactions à un message. Nécessite l'authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :
|
| ListSectionItems |
|---|
|
Liste les articles d'une section. Seuls les espaces peuvent être des éléments de section. Pour en savoir plus, consultez Créer et organiser des sections dans Google Chat. Nécessite l'authentification de l'utilisateur avec le champ d'application d'autorisation :
|
| ListSections |
|---|
|
Répertorie les sections disponibles pour l'utilisateur Chat. Les sections permettent aux utilisateurs de regrouper leurs conversations et de personnaliser la liste des espaces affichés dans le panneau de navigation de Chat. Pour en savoir plus, consultez Créer et organiser des sections dans Google Chat. Nécessite l'authentification de l'utilisateur avec le champ d'application d'autorisation :
|
| ListSpaceEvents |
|---|
|
Répertorie les événements d'un espace Google Chat. Pour chaque événement, la charge utile contient la version la plus récente de la ressource Chat. Par exemple, si vous listez les événements concernant les nouveaux membres d'un espace, le serveur renvoie des ressources Il accepte les types d'authentification suivants avec un champ d'application d'autorisation approprié pour lire les données demandées :
Pour lister les événements, l'appelant authentifié doit être membre de l'espace. Pour obtenir un exemple, consultez Lister les événements d'un espace Google Chat.
|
| ListSpaces |
|---|
|
Répertorie les espaces dont l'appelant est membre. Les chats de groupe et les messages privés ne sont pas listés tant que le premier message n'a pas été envoyé. Pour obtenir un exemple, consultez Lister les espaces. Il est compatible avec les types d'authentification suivants :
Pour lister tous les espaces nommés par organisation Google Workspace, utilisez plutôt la méthode
|
| MarkAsActive |
|---|
|
Marque l'utilisateur comme Définit l'état de disponibilité de l'utilisateur sur Cette méthode ne met à jour que la disponibilité de l'utilisateur authentifié. Nécessite l'authentification des utilisateurs avec le champ d'application d'autorisation :
|
| MarkAsAway |
|---|
|
Marque l'utilisateur comme Définit l'état de l'utilisateur sur "Absent". Cet état n'est pas affecté par l'activité de l'utilisateur. Cette méthode ne met à jour que la disponibilité de l'utilisateur authentifié. Nécessite l'authentification des utilisateurs avec le champ d'application d'autorisation :
|
| MarkAsDoNotDisturb |
|---|
|
Marque l'utilisateur comme Définit l'état de disponibilité d'un utilisateur sur Cette méthode ne met à jour que la disponibilité de l'utilisateur authentifié. Nécessite l'authentification des utilisateurs avec le champ d'application d'autorisation :
|
| MoveSectionItem |
|---|
|
Déplace un élément d'une section à une autre. Par exemple, si une section contient des espaces, cette méthode peut être utilisée pour déplacer un espace vers une autre section. Pour en savoir plus, consultez Créer et organiser des sections dans Google Chat. Nécessite l'authentification de l'utilisateur avec le champ d'application d'autorisation :
|
| PositionSection |
|---|
|
Modifie l'ordre de tri d'une section. Pour en savoir plus, consultez Créer et organiser des sections dans Google Chat. Nécessite l'authentification de l'utilisateur avec le champ d'application d'autorisation :
|
| ReplaceMessageCards |
|---|
|
Remplace les fiches incluses dans un message. Une application Chat ne peut remplacer les fiches d'un message créé par un humain que si le message contient déjà des fiches et que celles-ci ont été créées par l'application. Si l'application remplace les cartes par une liste vide, les cartes sont supprimées. Une fois les fiches supprimées, l'application ne peut pas les rajouter au message. Nécessite l'authentification de l'application avec le champ d'application de l'autorisation : -
|
| SearchMessages |
|---|
|
Recherche les messages dans Google Chat auxquels l'utilisateur appelant a accès. Renvoie une liste de messages correspondant aux critères de recherche. Pour effectuer une recherche dans tous les espaces auxquels l'utilisateur a accès, définissez Cette API ne renvoie pas tous les types de messages. Les types de messages listés ci-dessous ne sont pas inclus dans la réponse. Utilisez
Nécessite l'authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :
|
| SearchSpaces |
|---|
|
Renvoie la liste des espaces d'une organisation Google Workspace. Pour obtenir un exemple, consultez Rechercher et gérer des espaces. Lorsque Il est compatible avec les types d'authentification suivants :
|
| SetUpSpace |
|---|
|
Crée un espace et y ajoute les utilisateurs spécifiés. L'utilisateur appelant est automatiquement ajouté à l'espace et ne doit pas être spécifié en tant que membre dans la requête. Pour obtenir un exemple, consultez Configurer un espace avec des membres initiaux. Pour spécifier les membres humains à ajouter, ajoutez des appartenances avec le Pour spécifier les groupes Google à ajouter, ajoutez des appartenances avec le Pour un espace nommé ou un chat de groupe, si l'appelant bloque certains membres, est bloqué par certains membres ou n'est pas autorisé à ajouter certains membres, ces membres ne sont pas ajoutés à l'espace créé. Pour créer un message privé (MP) entre l'utilisateur appelant et un autre utilisateur humain, spécifiez exactement une appartenance pour représenter l'utilisateur humain. Si l'un des utilisateurs bloque l'autre, la requête échoue et le MP n'est pas créé. Pour créer un MP entre l'utilisateur appelant et l'application appelante, définissez Si un MP existe déjà entre deux utilisateurs, même si l'un d'eux bloque l'autre au moment de la requête, le MP existant est renvoyé. Les espaces avec des réponses organisées en fils de discussion ne sont pas acceptés. Si vous recevez le message d'erreur Nécessite l'authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :
|
| UpdateAvailability |
|---|
|
Met à jour les informations de disponibilité d'un utilisateur humain. Seul le champ Cette méthode ne met à jour que la disponibilité de l'utilisateur authentifié. Nécessite l'authentification de l'utilisateur avec l'un des champs d'application d'autorisation suivants :
|
| UpdateMembership |
|---|
|
Met à jour une ressource Membership. Pour obtenir un exemple, consultez Modifier l'appartenance d'un utilisateur à un espace. Il est compatible avec les types d'authentification suivants :
|
| UpdateMessage |
|---|
|
Met à jour un message. Il existe une différence entre les méthodes Il est compatible avec les types d'authentification suivants :
Lorsque vous utilisez l'authentification par application, les requêtes ne peuvent mettre à jour que les messages créés par l'application Chat appelante.
|
| UpdateSection |
|---|
|
Met à jour une section. Seules les sections de type Nécessite l'authentification de l'utilisateur avec le champ d'application d'autorisation :
|
| UpdateSpace |
|---|
|
Met à jour un espace. Pour obtenir un exemple, consultez Mettre à jour un espace. Si vous mettez à jour le champ Il est compatible avec les types d'authentification suivants :
L'authentification des applications présente les limites suivantes :
|
| UpdateSpaceNotificationSetting |
|---|
|
Met à jour le paramètre de notification de l'espace. Pour obtenir un exemple, consultez Mettre à jour le paramètre de notification de l'appelant pour l'espace. Nécessite l'authentification de l'utilisateur avec le champ d'application d'autorisation :
|
| UpdateSpaceReadState |
|---|
|
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 Mettre à jour l'état de lecture d'un espace pour un utilisateur. Nécessite l'authentification de l'utilisateur avec le champ d'application d'autorisation :
|
AccessoryWidget
Un ou plusieurs widgets interactifs qui s'affichent en bas d'un message. Pour en savoir plus, consultez Ajouter des widgets interactifs au bas d'un message.
| Champs | |
|---|---|
Champ d'union action. Type d'action. action ne peut être qu'un des éléments suivants : |
|
button_list |
Liste de boutons. |
ActionResponse
Paramètres qu'une application Chat peut utiliser pour configurer la façon dont sa réponse est publiée.
| Champs | |
|---|---|
type |
Uniquement en entrée. Type de réponse de l'application Chat. |
url |
Uniquement en entrée. URL permettant aux utilisateurs de s'authentifier ou de configurer l'application. (Uniquement pour les types de réponses |
dialog_action |
Uniquement en entrée. Réponse à un événement d'interaction lié à une boîte de dialogue. Doit être accompagnée de |
updated_widget |
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é comme NEW_MESSAGE. |
NEW_MESSAGE |
Publiez-la en tant que nouveau message dans le sujet. |
UPDATE_MESSAGE |
Mettez à jour le message de l'application Chat. Cela n'est autorisé que pour un événement CARD_CLICKED où le type d'expéditeur du message est BOT. |
UPDATE_USER_MESSAGE_CARDS |
Mettre à jour les fiches du message d'un utilisateur. Cela n'est autorisé qu'en réponse à un événement MESSAGE avec une URL correspondante ou à un événement CARD_CLICKED où le type d'expéditeur du message est HUMAN. Le texte est ignoré. |
REQUEST_CONFIG |
Demandez en privé à l'utilisateur de procéder à une authentification ou à une configuration supplémentaire. |
DIALOG |
Présente une boîte de dialogue. |
UPDATE_WIDGET |
Requête d'options de saisie semi-automatique du texte du widget. |
SelectionItems
Liste des résultats de la saisie semi-automatique du widget.
| Champs | |
|---|---|
items[] |
Tableau d'objets SelectionItem. |
UpdatedWidget
Pour les widgets selectionInput, renvoie des suggestions de saisie semi-automatique pour un menu à sélection multiple.
| Champs | |
|---|---|
widget |
ID du widget mis à jour. L'ID doit correspondre à celui du widget qui a déclenché la demande de mise à jour. |
Champ d'union updated_widget. Le widget a été mis à jour en réponse à une action de l'utilisateur. updated_widget ne peut être qu'un des éléments suivants : |
|
suggestions |
Liste des résultats de saisie semi-automatique du widget |
ActionStatus
Représente l'état d'une requête d'appel ou d'envoi d'une boîte de dialogue.
| Champs | |
|---|---|
status_code |
Code d'état. |
user_facing_message |
Message à envoyer aux utilisateurs concernant l'état de leur demande. Si ce champ n'est pas défini, un message générique basé sur |
Annotation
Les annotations peuvent être associées au corps du message en texte brut ou à des chips qui renvoient à des ressources Google Workspace telles que Google Docs ou Sheets avec start_index et length de 0. 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 d'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 |
Type de cette annotation. |
length |
Longueur de la sous-chaîne dans le corps du message en texte brut à laquelle correspond cette annotation. Si elle n'est pas présente, elle indique une longueur de 0. |
start_index |
Index de début (base 0, inclus) dans le corps du message en texte brut auquel correspond cette annotation. |
Champ d'union metadata. Métadonnées supplémentaires sur l'annotation. metadata ne peut être qu'un des éléments suivants : |
|
user_mention |
Métadonnées de la mention d'utilisateur. |
slash_command |
Métadonnées d'une commande à barre oblique. |
rich_link_metadata |
Métadonnées d'un lien enrichi. |
custom_emoji_metadata |
Métadonnées d'un emoji personnalisé. |
AnnotationType
Type de l'annotation.
| Enums | |
|---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Valeur par défaut de l'énumération. Ne pas utiliser. |
USER_MENTION |
Un utilisateur est mentionné. |
SLASH_COMMAND |
Une commande à barre oblique est appelée. |
RICH_LINK |
Annotation de lien enrichi. |
CUSTOM_EMOJI |
Annotation d'emoji personnalisé. |
AppCommandMetadata
Métadonnées d'une commande d'application Chat.
| Champs | |
|---|---|
app_command_id |
ID de la commande spécifié dans la configuration de l'API Chat. |
app_command_type |
Type de commande d'application Chat. |
AppCommandType
Type de commande d'application Chat. Pour en savoir plus, consultez Types de commandes d'application Chat.
| Enums | |
|---|---|
APP_COMMAND_TYPE_UNSPECIFIED |
Valeur par défaut. Non spécifié. |
SLASH_COMMAND |
Une commande à barre oblique. L'utilisateur envoie la commande dans un message de chat. |
QUICK_COMMAND |
Une commande rapide. L'utilisateur sélectionne la commande dans le menu Chat de la zone de réponse au message. |
MESSAGE_ACTION |
Action liée au message. L'utilisateur sélectionne la commande dans le menu contextuel du message dans Chat. |
AttachedGif
Image GIF spécifiée par une URL.
| Champs | |
|---|---|
uri |
Uniquement en sortie. URL qui héberge l'image GIF. |
Pièce jointe
Une pièce jointe dans Google Chat.
| Champs | |
|---|---|
name |
Identifiant. Nom de ressource de la pièce jointe. Format : |
content_name |
Uniquement en sortie. Nom de fichier d'origine du contenu, et non le chemin d'accès complet. |
content_type |
Uniquement en sortie. Type de contenu (type MIME) du fichier. |
thumbnail_uri |
Uniquement en sortie. URL de la miniature à utiliser pour prévisualiser la pièce jointe pour un utilisateur humain. Les applications Chat ne doivent pas utiliser cette URL pour télécharger le contenu des pièces jointes. |
download_uri |
Uniquement en sortie. URL de téléchargement à utiliser pour permettre à un utilisateur humain de télécharger la pièce jointe. Les applications Chat ne doivent pas utiliser cette URL pour télécharger le contenu des pièces jointes. |
source |
Uniquement en sortie. Source de la pièce jointe. |
Champ d'union data_ref. Référence de données à la pièce jointe. data_ref ne peut être qu'un des éléments suivants : |
|
attachment_data_ref |
Facultatif. Référence aux données de la pièce jointe. Ce champ permet de créer ou de mettre à jour des messages avec des pièces jointes, ou d'utiliser l'API Media pour télécharger les données des pièces jointes. |
drive_data_ref |
Uniquement en sortie. Référence à la pièce jointe Google Drive. Ce champ est utilisé avec l'API Google Drive. |
Source
Source de la pièce jointe.
| Enums | |
|---|---|
SOURCE_UNSPECIFIED |
Réservé. |
DRIVE_FILE |
Le fichier est un fichier Google Drive. |
UPLOADED_CONTENT |
Le fichier est importé dans Chat. |
AttachmentDataRef
Référence aux données de la pièce jointe.
| Champs | |
|---|---|
resource_name |
Facultatif. Nom de ressource des données de la pièce jointe. Ce champ est utilisé avec l'API Media pour télécharger les données de la pièce jointe. |
attachment_upload_token |
Facultatif. 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 de chat avec des pièces jointes. |
Audience
Une audience cible dans Google Chat. Une audience cible représente un groupe d'utilisateurs au sein d'une organisation Google Workspace, défini par un administrateur. Les audiences cibles permettent de configurer les paramètres d'accès et de visibilité des ressources, par exemple pour rendre un espace visible par un groupe d'utilisateurs spécifique.
Pour en savoir plus, consultez Audiences cibles et Rendre un espace visible pour une audience cible.
| Champs | |
|---|---|
name |
Nom de ressource de l'audience cible qui peut découvrir ou rejoindre l'espace. Pour en savoir plus, consultez Rendre un espace visible par une audience cible. Format : Pour utiliser l'audience cible par défaut de l'organisation Google Workspace, définissez la valeur sur |
Disponibilité
Représente les informations de disponibilité actuelles d'un utilisateur dans Google Chat, y compris son état (par exemple, Actif, Absent, Ne pas déranger) et tout état personnalisé.
| Champs | |
|---|---|
name |
Identifiant. Nom de ressource de la disponibilité de l'utilisateur. Format :
L'adresse e-mail de l'utilisateur ou |
state |
Uniquement en sortie. État de disponibilité actuel de l'utilisateur. |
custom_status |
Facultatif. État personnalisé de l'utilisateur. |
Champ d'union state_metadata. Métadonnées supplémentaires associées à l'état de disponibilité de l'utilisateur. state_metadata ne peut être qu'un des éléments suivants : |
|
do_not_disturb_metadata |
Uniquement en sortie. Métadonnées si l'état de l'utilisateur est défini sur DO_NOT_DISTURB. |
État
Représente l'état de disponibilité actuel de l'utilisateur.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Valeur par défaut. L'état n'est pas spécifié. |
ACTIVE |
L'utilisateur est actuellement actif, d'après son activité récente. |
IDLE |
L'utilisateur est actuellement inactif. Cet état indique une période d'inactivité après l'état ACTIF, avant de passer potentiellement à l'état ABSENT. |
AWAY |
L'utilisateur est actuellement absent. Cet état peut être défini automatiquement après une période d'inactivité dans l'état ACTIVE ou IDLE, ou manuellement par l'utilisateur. Lorsqu'il est défini manuellement via MarkAsAway, cet état persiste, quelle que soit l'activité de l'utilisateur. |
DO_NOT_DISTURB |
L'utilisateur est en mode Ne pas déranger, qui est défini manuellement. |
CalendarEventLinkData
Données pour les liens d'événements d'agenda.
| Champs | |
|---|---|
calendar_id |
L'identifiant d'agenda de l'agenda associé. |
event_id |
L'identifiant d'événement de l'événement d'agenda associé. |
CardWithId
Fiche dans un message Google Chat.
Les applications Chat peuvent créer des fiches avec l'authentification de l'application. Dans le cadre du programme Preview développeur, si votre application Chat s'authentifie en tant qu'utilisateur, elle peut créer des messages de fiches. Si votre application Chat ne fait pas partie du programme Preview développeur, elle ne peut pas créer de fiches avec authentification des utilisateurs.
Pour savoir comment créer un message contenant des fiches, consultez Envoyer un message.
Concevez et prévisualisez des fiches avec le générateur de fiches.
Ouvrir le générateur de fiches| Champs | |
|---|---|
card_id |
Obligatoire si le message contient plusieurs fiches. Identifiant unique d'une fiche dans un message. |
card |
Une fiche La taille maximale est de 32 Ko. |
owner_user |
Uniquement en sortie. L'application propriétaire de la carte. |
ChatSpaceLinkData
Données pour les liens vers les espaces Chat.
| Champs | |
|---|---|
space |
Espace de la ressource d'espace Chat associée. Format : |
thread |
Fil de discussion de la ressource d'espace Chat associée. Format : |
message |
Message de la ressource d'espace Chat associée. Format : |
Citation
<chat-citation data-id="{id}">{text}</chat-citation>. Les citations ne sont acceptées que lorsque le champ markup_syntax du message est défini sur MARKDOWN.Les citations non référencées dans Elements.citations (celles qui n'ont pas de balise <chat-citation> correspondante dans le texte du message) sont ignorées et n'entraînent pas le rejet du message.
| Champs | |
|---|---|
id |
Obligatoire. ID défini par l'application. Il ne doit contenir que des lettres et des chiffres ASCII, et comporter moins de 63 caractères. |
cited_sources[] |
Facultatif. Liste des sources pertinentes pour la citation. Les sources s'affichent dans la fiche de citation qui apparaît lorsque vous pointez sur une citation. |
CitedSource
| Champs | |
|---|---|
title |
Obligatoire. Titre en texte brut de l'élément |
uri |
Obligatoire. URI pointant vers la ressource référencée par ce |
snippet |
Facultatif. Extrait contenant des informations provenant directement de la source. |
footer |
Facultatif. Informations supplémentaires à afficher à côté de l'extrait sous la forme d'un pied de page. |
Extrait
| Champs | |
|---|---|
text |
Facultatif. Court extrait en texte brut directement issu du corpus, qui peut être affiché dans Chat. Le format Markdown n'est pas accepté. |
image_preview |
Facultatif. Aperçu de l'image de l'extrait fourni en entrée lors de la création de la citation. |
CompleteImportSpaceRequest
Message de requête pour finaliser le processus d'importation d'un espace.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de l'espace en mode importation. Format : |
CompleteImportSpaceResponse
Message de réponse pour terminer le processus d'importation d'un espace.
| Champs | |
|---|---|
space |
Espace en mode importation. |
ContextualAddOnMarkup
Ce type ne comporte aucun champ.
Balisage permettant aux développeurs de spécifier le contenu d'un module complémentaire contextuel.
Carte
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 |
En-tête de la carte. Un en-tête contient généralement un titre et une image. |
sections[] |
Les sections sont séparées par une ligne de séparation. |
card_actions[] |
Actions de cette fiche. |
name |
Nom de la carte. |
CardAction
Une action de fiche est l'action associée à la fiche. Pour une fiche de facture, une action typique serait de supprimer la facture, de l'envoyer par e-mail ou de l'ouvrir dans un navigateur.
Non compatible avec les applications Google Chat.
| Champs | |
|---|---|
action_label |
Libellé utilisé pour l'affichage dans l'élément de menu d'action. |
on_click |
Action onclick pour cet élément d'action. |
CardHeader
| Champs | |
|---|---|
title |
Vous devez spécifier le titre. L'en-tête a une hauteur fixe : si un titre et un sous-titre sont spécifiés, chacun occupe une ligne. Si seul le titre est spécifié, il occupe les deux lignes. |
subtitle |
Sous-titre de l'en-tête de la fiche. |
image_style |
Type de l'image (par exemple, bordure carrée ou circulaire). |
image_url |
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 fiches 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 |
En-tête de la section. Le texte mis en forme est accepté. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme du texte dans les applications Google Chat et Mettre en forme du texte dans les modules complémentaires Google Workspace. |
widgets[] |
Une section doit contenir au moins un widget. |
CreateCustomEmojiRequest
Requête de création d'un emoji personnalisé.
| Champs | |
|---|---|
custom_emoji |
Obligatoire. Emoji personnalisé à créer. |
CreateMembershipRequest
Message de requête pour créer une appartenance.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource de l'espace pour lequel créer l'appartenance. Format : spaces/{space} |
membership |
Obligatoire. Relation d'appartenance à créer. Le champ Lorsqu'une application Chat crée une relation d'appartenance pour un utilisateur humain, elle doit utiliser certains champs d'application d'autorisation et définir des valeurs spécifiques pour certains champs :
Pour inviter des utilisateurs externes à l'organisation Workspace propriétaire de l'espace, une authentification des utilisateurs est requise. 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 |
use_admin_access |
Facultatif. Lorsque la valeur est L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit "Gérer les conversations Chat et Espaces". Nécessite le champ d'application OAuth 2.0 La création d'appartenances à des applications ou d'appartenances pour des utilisateurs en dehors de l'organisation Google Workspace de l'administrateur n'est pas possible avec l'accès administrateur. |
CreateMessageNotificationOptions
Options de comportement des notifications lorsque le message est publié.
| Champs | |
|---|---|
notification_type |
Type de notification pour le message. |
NotificationType
Options de types de notifications pour le message.
| Enums | |
|---|---|
NOTIFICATION_TYPE_NONE |
Comportement par défaut Le comportement des notifications est semblable à celui d'un utilisateur humain qui envoie un message à l'aide de l'UI Chat : aucune notification n'est envoyée à l'expéditeur humain. |
NOTIFICATION_TYPE_FORCE_NOTIFY |
Forcer la notification des destinataires. Cela contourne les paramètres de notification des espaces et les paramètres Ne pas déranger de Chat des utilisateurs. Cette option ne permet pas d'ignorer les paramètres "Ne pas déranger" au niveau de l'appareil. Nécessite l'authentification de l'application. |
NOTIFICATION_TYPE_SILENT |
Ne pas avertir les destinataires et ne pas marquer le message comme non lu. Le comportement est semblable à celui d'un utilisateur qui coupe le son de la conversation ou qui active le mode Ne pas déranger dans Chat. Nécessite l'authentification de l'application. |
CreateMessagePinRequest
Message de requête pour créer un message épinglé.
| Champs | |
|---|---|
parent |
Obligatoire. Espace parent dans lequel créer l'épingle de message. Format : spaces/{space} |
message_pin |
Obligatoire. MessagePin à créer. |
CreateMessageRequest
Crée un message.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource de l'espace dans lequel créer un message. Format : |
message |
Obligatoire. Corps du message. |
thread_key |
Facultatif. Obsolète : utilisez |
request_id |
Facultatif. Identifiant unique de cette requête. Nous vous recommandons d'utiliser un UUID aléatoire. La spécification d'un ID de requête rend la requête idempotente, ce qui garantit que plusieurs requêtes identiques avec le même ID de requête n'entraînent la création que d'un seul message. Les requêtes ultérieures avec le même ID de requête renvoient le message existant et ne le mettent pas à jour, même si les détails demandés diffèrent de l'état actuel. Pour utiliser ce champ efficacement :
|
message_reply_option |
Facultatif. Indique si un message démarre un fil de discussion ou y répond. Uniquement disponible dans les espaces nommés. Lors de la réponse aux interactions utilisateur, ce champ est ignoré. Pour les interactions dans un fil de discussion, la réponse est créée dans le même fil. Sinon, la réponse est créée en tant que nouveau fil de discussion. |
message_id |
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 La valeur de ce champ doit répondre aux exigences suivantes :
Pour en savoir plus, consultez Nommer un message. |
create_message_notification_options |
Facultatif. Contrôle le comportement des notifications lorsque le message est publié. Pour en savoir plus, consultez Forcer les notifications ou envoyer des messages silencieux. |
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 fil de discussion. Cette option ignore les éléments thread ID ou |
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 |
REPLY_MESSAGE_OR_FAIL |
Crée le message en tant que réponse au fil de discussion spécifié par thread ID ou thread_key est utilisé, un 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 |
Obligatoire. Message dans lequel la réaction est créée. Format : |
reaction |
Obligatoire. Réaction à créer. |
CreateSectionRequest
Message de requête pour créer une section.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de la ressource parente dans laquelle la section est créée. Format : |
section |
Obligatoire. Section à créer. |
CreateSpaceRequest
Requête de création d'un espace nommé sans membres.
| Champs | |
|---|---|
space |
Obligatoire. Les champs Si le message d'erreur L'espace |
request_id |
Facultatif. Identifiant unique de cette requête. Nous vous recommandons d'utiliser un UUID aléatoire. La spécification d'un ID de requête rend la requête idempotente, ce qui garantit que plusieurs requêtes identiques avec le même ID de requête n'entraînent la création que d'un seul espace. Les requêtes ultérieures avec le même ID de requête renvoient l'espace existant et ne le mettent pas à jour, même si les détails demandés diffèrent de l'état actuel. Pour utiliser ce champ efficacement :
|
CustomEmoji
Représente un emoji personnalisé.
| Champs | |
|---|---|
name |
Identifiant. Nom de ressource de l'emoji personnalisé, attribué par le serveur. Format : |
uid |
Uniquement en sortie. Clé unique de la ressource d'emoji personnalisé. |
emoji_name |
Facultatif. Immuable. Nom fourni par l'utilisateur pour l'emoji personnalisé, qui est unique au sein de l'organisation. Obligatoire lors de la création de l'emoji personnalisé, en sortie uniquement sinon. Les noms d'emojis doivent commencer et se terminer par un deux-points, être en minuscules et ne contenir que des caractères alphanumériques, des traits d'union et des traits de soulignement. Les traits d'union et les traits de soulignement servent à séparer les mots et ne peuvent pas être utilisés de manière consécutive. Exemple : |
temporary_image_uri |
Uniquement en sortie. URL d'image temporaire 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éé. |
payload |
Facultatif. Uniquement en entrée. Données de charge utile. Obligatoire lors de la création de l'emoji personnalisé. |
CustomEmojiPayload
Données de charge utile pour l'emoji personnalisé.
| Champs | |
|---|---|
file_content |
Obligatoire. Uniquement en entrée. Image utilisée pour l'emoji personnalisé. La charge utile doit être inférieure à 256 ko, et l'image doit être carrée et mesurer entre 64 et 500 pixels. Les restrictions sont susceptibles d'être modifiées. |
filename |
Obligatoire. Uniquement en entrée. Nom du fichier image. Extensions de fichier acceptées : |
CustomEmojiMetadata
Métadonnées d'annotation pour les emoji personnalisés.
| Champs | |
|---|---|
custom_emoji |
L'emoji personnalisé. |
CustomStatus
Représente l'état personnalisé d'un utilisateur dans Google Chat. Il s'agit d'un court message texte avec un emoji facultatif qu'un utilisateur définit pour donner plus de contexte sur sa disponibilité.
| Champs | |
|---|---|
text |
Obligatoire. Texte de l'état personnalisé. Il s'agit d'une chaîne d'une longueur maximale de 64 caractères. |
emoji |
Obligatoire. Emoji de l'état personnalisé. Seuls les emoji Unicode sont acceptés. Les emoji personnalisés ne sont pas acceptés. |
Champ d'union expiration. Heure d'expiration de l'état personnalisé. Il peut être spécifié sous la forme d'un code temporel absolu ou d'une durée de vie. expiration ne peut être qu'un des éléments suivants : |
|
expire_time |
Code temporel de l'expiration de l'état personnalisé. |
ttl |
Uniquement en entrée. Durée de vie après laquelle l'état personnalisé expire. |
DeleteCustomEmojiRequest
Requête de suppression d'un emoji personnalisé.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de l'emoji personnalisé à supprimer. Format : Vous pouvez utiliser le nom de l'emoji comme alias pour |
DeleteMembershipRequest
Requête de suppression d'un membre d'un espace.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de l'appartenance à supprimer. Les applications Chat peuvent supprimer les adhésions des utilisateurs humains ou les leurs. Les applications Chat ne peuvent pas supprimer les adhésions d'autres applications. Lors de la suppression d'un membre humain, nécessite le champ d'application Lors de la suppression d'une appartenance à une application, nécessite le champ d'application Format : |
use_admin_access |
Facultatif. Lorsque la valeur est L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit "Gérer les conversations Chat et Espaces". Nécessite le champ d'application OAuth 2.0 La suppression des applications membres d'un espace n'est pas possible avec un accès administrateur. |
DeleteMessagePinRequest
Message de requête pour supprimer un message épinglé.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de l'épingle de message à supprimer. Format : spaces/{space}/messagePins/{message_pin} |
DeleteMessageRequest
Requête de suppression d'un message.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource du message. Format : Si vous avez défini un ID personnalisé pour votre message, vous pouvez utiliser la valeur du champ |
force |
Facultatif. Lorsque l'option S'applique uniquement lors de l'authentification en tant qu'utilisateur. N'a aucun effet lors de l'authentification en tant qu'application Chat. |
DeleteReactionRequest
Supprime une réaction à un message.
| Champs | |
|---|---|
name |
Obligatoire. Nom de la réaction à supprimer. Format : |
DeleteSectionRequest
Message de requête pour supprimer une section.
| Champs | |
|---|---|
name |
Obligatoire. Nom de la section à supprimer. Format : |
DeleteSpaceRequest
Requête de suppression d'un espace.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de l'espace à supprimer. Format : |
use_admin_access |
Facultatif. Lorsque la valeur est L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit "Gérer les conversations Chat et Espaces". Nécessite le champ d'application OAuth 2.0 |
DeletionMetadata
Informations sur un message supprimé. Un message est supprimé lorsque delete_time est défini.
| Champs | |
|---|---|
deletion_type |
Indique qui a supprimé le message. |
DeletionType
Qui a supprimé le message et comment il a été supprimé D'autres valeurs pourront être ajoutées à l'avenir. Pour savoir quand les messages peuvent être supprimés, consultez Modifier ou supprimer un message dans Google Chat.
| Enums | |
|---|---|
DELETION_TYPE_UNSPECIFIED |
Cette valeur n'est pas utilisée. |
CREATOR |
L'utilisateur a supprimé son propre message. |
SPACE_OWNER |
Un propriétaire ou un gestionnaire a supprimé le message. |
ADMIN |
Un administrateur Google Workspace a supprimé le message. Les administrateurs peuvent supprimer n'importe quel message de l'espace, y compris les messages envoyés par un membre de l'espace ou une application Chat. |
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 son auteur (à l'aide de l'authentification de l'utilisateur). |
SPACE_OWNER_VIA_APP |
Une application Chat a supprimé le message au nom d'un gestionnaire de l'espace (à l'aide de l'authentification des utilisateurs). |
SPACE_MEMBER |
Un membre de l'espace a supprimé le message. Les utilisateurs peuvent supprimer les messages envoyés par les applications. |
Dialog
Wrapper autour du corps de la carte de la boîte de dialogue.
| Champs | |
|---|---|
body |
Uniquement en entrée. Corps de la boîte de dialogue, qui s'affiche dans une fenêtre modale. Les applications Google Chat ne sont pas compatibles avec les entités de fiche suivantes : |
DialogAction
Contient un dialog et un code d'état de la requête.
| Champs | |
|---|---|
action_status |
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 |
Uniquement en entrée. Boîte de dialogue de la requête. |
DoNotDisturbMetadata
Métadonnées associées à l'état de disponibilité DO_NOT_DISTURB, spécifiant la date d'expiration de l'état.
| Champs | |
|---|---|
expiration_time |
Uniquement en sortie. Horodatage jusqu'auquel l'utilisateur doit être marqué comme DO_NOT_DISTURB. Cette date peut être postérieure d'un an maximum à la date du jour. |
DriveDataRef
Référence aux données d'une pièce jointe Drive.
| Champs | |
|---|---|
drive_file_id |
ID du fichier Drive. Utilisez-le avec l'API Drive. |
DriveLinkData
Données pour les liens Google Drive.
| Champs | |
|---|---|
drive_data_ref |
DriveDataRef qui fait référence à un fichier Google Drive. |
mime_type |
Type MIME de la ressource Google Drive associée. |
Éléments
| Champs | |
|---|---|
cited_sources[] |
Liste des sources à afficher sous le message sous forme de liens de pied de page. Ils ne sont pas référencés de manière intégrée. Pour les références intégrées, utilisez |
citations[] |
Liste des citations intégrées référencées dans le texte du message (via des balises |
ElementsImage
| Champs | |
|---|---|
Champ d'union image. Obligatoire. L'une des représentations d'image acceptées. image ne peut être qu'un des éléments suivants : |
|
image_uri |
Obligatoire. URI d'une image accessible au public. |
Emoji
Emoji utilisé comme réaction à un message.
| Champs | |
|---|---|
Champ d'union content. Obligatoire. Contenu de l'emoji. content ne peut être qu'un des éléments suivants : |
|
unicode |
Facultatif. Emoji de base représenté par une chaîne Unicode. |
custom_emoji |
Un emoji personnalisé. |
EmojiReactionSummary
Nombre de personnes ayant réagi à un message avec un emoji spécifique.
| Champs | |
|---|---|
emoji |
Uniquement en sortie. Emoji associé aux réactions. |
reaction_count |
Uniquement en sortie. Nombre total de réactions utilisant l'emoji associé. |
FindDirectMessageRequest
Requête permettant d'obtenir un espace de message privé en fonction de la ressource utilisateur.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de l'utilisateur avec lequel rechercher un message privé. Format : |
FindGroupChatsRequest
Requête permettant d'obtenir des espaces de chat de groupe en fonction des ressources utilisateur.
| Champs | |
|---|---|
users[] |
Facultatif. Noms de ressources de tous les utilisateurs humains dans le chat de groupe avec l'utilisateur appelant. Les applications Chat ne peuvent pas être incluses dans la requête. Le nombre maximal d'utilisateurs pouvant être spécifiés dans une même requête est de Format : |
page_size |
Facultatif. Nombre maximal d'espaces à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, 10 espaces au maximum sont renvoyés. La valeur maximale est 30. Si vous utilisez une valeur supérieure à 30, elle est automatiquement remplacée par 30. Les valeurs négatives renvoient une erreur |
page_token |
Facultatif. Jeton de page reçu d'un appel précédent pour rechercher des chats de groupe. 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 ayant fourni le jeton. La transmission de valeurs différentes peut entraîner des résultats inattendus. |
space_view |
Type de vue de l'espace demandé. Si cette valeur n'est pas définie, la valeur par défaut est |
FindGroupChatsResponse
Réponse contenant des espaces de chat de groupe avec exactement l'utilisateur appelant et les utilisateurs demandés.
| Champs | |
|---|---|
spaces[] |
Liste des espaces de la page demandée (ou de la première page). |
next_page_token |
Jeton que vous pouvez envoyer en tant que |
ForwardedMetadata
Métadonnées sur l'espace source à partir duquel un message a été transféré.
| Champs | |
|---|---|
space |
Uniquement en sortie. Nom de ressource de l'espace source. Format : spaces/{space} |
space_display_name |
Uniquement en sortie. Nom à afficher de l'espace ou du MP source au moment du transfert. Pour |
GetAttachmentRequest
Requête d'obtention d'un rattachement.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource du rattachement, au format |
GetAvailabilityRequest
Message de requête pour la méthode GetAvailability.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de la disponibilité à récupérer. Format : users/{user}/availability
L'adresse e-mail de l'utilisateur ou |
GetCustomEmojiRequest
Requête permettant de renvoyer un seul emoji personnalisé.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de l'emoji personnalisé. Format : Vous pouvez utiliser le nom de l'emoji comme alias pour |
GetMembershipRequest
Requête d'obtention d'une appartenance à un espace.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de l'appartenance à récupérer. Pour obtenir l'appartenance de l'application à l'aide de l'authentification des utilisateurs, vous pouvez éventuellement utiliser Format : Vous pouvez utiliser l'adresse e-mail de l'utilisateur comme alias pour |
use_admin_access |
Facultatif. Lorsque la valeur est L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit "Gérer les conversations Chat et Espaces". Nécessite les champs d'application OAuth 2.0 L'obtention des appartenances d'applications dans un espace n'est pas possible avec un accès administrateur. |
GetMessageRequest
Requête d'obtention d'un message.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource du message. Format : Si vous avez défini un ID personnalisé pour votre message, vous pouvez utiliser la valeur du champ |
markup_syntax |
Facultatif. Spécifie la syntaxe de sortie souhaitée pour le champ |
GetSpaceEventRequest
Message de requête pour obtenir un événement d'espace.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de l'événement d'espace. Format : |
GetSpaceNotificationSettingRequest
Message de requête pour obtenir les paramètres de notification d'un espace. Seule l'obtention du paramètre de notification pour l'utilisateur appelant est acceptée.
| Champs | |
|---|---|
name |
Obligatoire. Format : users/{user}/spaces/{space}/spaceNotificationSetting
|
GetSpaceReadStateRequest
Message de requête pour l'API GetSpaceReadState.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de l'état de lecture de l'espace à récupérer. Seule l'obtention de l'état de lecture de l'utilisateur appelant est possible. Pour faire référence à l'utilisateur appelant, définissez l'un des éléments suivants :
Format : users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
Requête permettant de renvoyer un seul espace.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de l'espace, au format Format : |
use_admin_access |
Facultatif. Lorsque la valeur est L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit "Gérer les conversations Chat et Espaces". Nécessite les champs d'application OAuth 2.0 |
GetThreadReadStateRequest
Message de requête pour l'API GetThreadReadStateRequest.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de l'état de lecture du fil de discussion à récupérer. Seule l'obtention de l'état de lecture de l'utilisateur appelant est possible. Pour faire référence à l'utilisateur appelant, définissez l'un des éléments suivants :
Format : users/{user}/spaces/{space}/threads/{thread}/threadReadState |
Groupe
Un groupe Google dans Google Chat.
| Champs | |
|---|---|
name |
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. Spécifie 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 permettant de renvoyer une liste d'emojis personnalisés.
| Champs | |
|---|---|
page_size |
Facultatif. Nombre maximal d'emojis personnalisés renvoyés. Le service peut renvoyer un nombre d'emojis personnalisés 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 sont réduites à 200. |
page_token |
Facultatif. (si vous reprenez une requête précédente). Jeton de page reçu d'un appel précédent pour lister les emoji personnalisés. 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. La transmission d'une valeur différente peut entraîner des résultats inattendus. |
filter |
Facultatif. Un filtre de requête. Permet de filtrer par créateur. Pour filtrer par créateur, vous devez spécifier une valeur valide. Actuellement, seuls Par exemple, la requête suivante renvoie les emoji personnalisés créés par l'appelant : Les requêtes non valides sont rejetées avec une erreur |
ListCustomEmojisResponse
Réponse pour lister les emoji personnalisés.
| Champs | |
|---|---|
custom_emojis[] |
Liste non triée. Liste d'emojis personnalisés. |
next_page_token |
Jeton que vous pouvez envoyer en tant que |
ListMembershipsRequest
Message de requête pour lister les appartenances.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource de l'espace pour lequel récupérer une liste de membres. Format : spaces/{space} |
page_size |
Facultatif. Nombre maximal d'appartenances à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, 100 appartenances au maximum sont renvoyées. La valeur maximale est de 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 |
page_token |
Facultatif. Jeton de page reçu d'un appel précédent pour lister les appartenances. 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 ayant fourni le jeton de page. La transmission de valeurs différentes aux autres paramètres peut entraîner des résultats inattendus. |
filter |
Facultatif. Un filtre de requête. Vous pouvez filtrer les appartenances par rôle ( Pour filtrer par rôle, définissez Pour filtrer par type, définissez Pour filtrer à la fois par rôle et par type, utilisez l'opérateur
Par exemple, les requêtes suivantes sont valides : Les requêtes suivantes ne sont pas valides : Les requêtes non valides sont rejetées par le serveur avec une erreur |
show_groups |
Facultatif. Lorsque la valeur est |
show_invited |
Facultatif. Lorsque la valeur est Nécessite actuellement l'authentification de l'utilisateur. |
use_admin_access |
Facultatif. Lorsque la valeur est L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit "Gérer les conversations Chat et Espaces". Nécessite le champ d'application OAuth 2.0 La liste des applications membres d'un espace n'est pas disponible avec l'accès administrateur. |
ListMembershipsResponse
Réponse pour lister les membres de l'espace.
| Champs | |
|---|---|
memberships[] |
Liste non triée. Liste des appartenances sur la page demandée (ou la première page). |
next_page_token |
Jeton que vous pouvez envoyer en tant que |
ListMessagePinsRequest
Message de requête pour lister les messages épinglés.
| Champs | |
|---|---|
parent |
Obligatoire. Espace parent qui possède la collection d'éléments épinglés. Format : |
page_size |
Facultatif. Nombre maximal d'épingles de message renvoyées. Le service peut renvoyer un nombre de messages inférieur à cette valeur. La valeur maximale est de 100. Si vous utilisez une valeur supérieure à 100, elle est automatiquement remplacée par 100. Si aucune valeur n'est spécifiée, 100 messages épinglés au maximum sont renvoyés. Les valeurs négatives renvoient une erreur |
page_token |
Facultatif. Jeton de page reçu d'un appel précédent de liste des messages épinglés. 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 ayant fourni le jeton de page. La transmission de valeurs différentes aux autres paramètres peut entraîner des résultats inattendus. |
ListMessagePinsResponse
Message de réponse pour lister les messages épinglés.
| Champs | |
|---|---|
message_pins[] |
Messages épinglés de l'espace spécifié. |
next_page_token |
Vous pouvez envoyer un jeton en tant que |
ListMessagesRequest
Répertorie les messages de l'espace spécifié dont l'utilisateur est membre.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource de l'espace dont vous souhaitez lister les messages. Format : |
page_size |
Facultatif. Nombre maximal de messages renvoyés. Le service peut renvoyer un nombre de messages inférieur à cette valeur. Si aucune valeur n'est spécifiée, 25 résultats au maximum sont renvoyés. La valeur maximale est de 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 |
page_token |
Facultatif. Jeton de page reçu d'un appel de liste de messages précédent. 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 ayant fourni le jeton de page. La transmission de valeurs différentes aux autres paramètres peut entraîner des résultats inattendus. |
filter |
Facultatif. Un filtre de requête. Vous pouvez filtrer les messages par date ( Pour filtrer les messages en fonction de leur date de création, spécifiez Pour filtrer par fil de discussion, spécifiez le Pour filtrer par fil de discussion et par date, utilisez l'opérateur Par exemple, les requêtes suivantes sont valides : Les requêtes non valides sont rejetées par le serveur avec une erreur |
order_by |
Facultatif. Comment la liste des messages est ordonnée. Spécifiez une valeur pour trier par opération de tri. Les valeurs d'opération de tri valides sont les suivantes :
L'ordre par défaut est |
show_deleted |
Facultatif. Indique si les messages supprimés doivent être inclus. Les messages supprimés incluent l'heure de suppression et les métadonnées concernant leur suppression, mais le contenu des messages n'est pas disponible. |
markup_syntax |
Facultatif. Spécifie la syntaxe de sortie souhaitée pour le champ |
ListMessagesResponse
Message de réponse pour la liste des messages.
| Champs | |
|---|---|
messages[] |
Liste des messages. |
next_page_token |
Vous pouvez envoyer un jeton en tant que |
ListReactionsRequest
Répertorie les réactions à un message.
| Champs | |
|---|---|
parent |
Obligatoire. Message auquel les utilisateurs ont réagi. Format : |
page_size |
Facultatif. Nombre maximal de réactions renvoyées. Le service peut renvoyer un nombre de réactions 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 sont réduites à 200. |
page_token |
Facultatif. (si vous reprenez une requête précédente). Jeton de page reçu d'un appel de liste de réactions 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. La transmission d'une valeur différente peut entraîner des résultats inattendus. |
filter |
Facultatif. Un filtre de requête. Vous pouvez filtrer les réactions par emoji ( Pour filtrer les réactions de plusieurs emoji ou utilisateurs, associez des champs similaires à l'aide de l'opérateur Pour filtrer les réactions par emoji et par utilisateur, utilisez l'opérateur Si votre requête utilise à la fois Par exemple, les requêtes suivantes sont valides : Les requêtes suivantes ne sont pas valides : Les requêtes non valides sont rejetées avec une erreur |
ListReactionsResponse
Réponse à une requête de liste de réactions.
| Champs | |
|---|---|
reactions[] |
Liste des réactions sur la page demandée (ou la première page). |
next_page_token |
Jeton de continuation permettant de récupérer la page de résultats suivante. Il est vide pour la dernière page de résultats. |
ListSectionItemsRequest
Message de requête pour lister les éléments d'une section.
| Champs | |
|---|---|
parent |
Obligatoire. Parent, qui est le nom de ressource de la section propriétaire de cette collection d'éléments de section. Seule la liste des éléments de section pour l'utilisateur appelant est acceptée. Lorsque vous filtrez par espace, utilisez le caractère générique Format : |
page_size |
Facultatif. Nombre maximal d'éléments de section à afficher. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, un maximum de 10 éléments de section est affiché. La valeur maximale est de 100. Si vous utilisez une valeur supérieure à 100, elle est automatiquement remplacée par 100. Les valeurs négatives renvoient une erreur |
page_token |
Facultatif. Jeton de page reçu d'un appel précédent pour répertorier des éléments de section. Fournissez-le pour récupérer la page suivante. Lors de la pagination, tous les autres paramètres fournis doivent correspondre à l'appel ayant fourni le jeton de page. La transmission de valeurs différentes aux autres paramètres peut entraîner des résultats inattendus. |
filter |
Facultatif. Un filtre de requête. Actuellement, seul le filtrage par espace est possible. Par exemple : Les requêtes non valides sont rejetées avec une erreur |
ListSectionItemsResponse
Message de réponse pour la liste des éléments de section.
| Champs | |
|---|---|
section_items[] |
Éléments de la section spécifiée. |
next_page_token |
Jeton pouvant être envoyé en tant que |
ListSectionsRequest
Message de requête pour lister les sections.
| Champs | |
|---|---|
parent |
Obligatoire. Parent, qui est le nom de la ressource utilisateur propriétaire de cette collection de sections. Seule la liste des sections de l'utilisateur appelant est acceptée. Pour faire référence à l'utilisateur appelant, définissez l'un des éléments suivants :
Format : |
page_size |
Facultatif. Nombre maximal de sections à afficher. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, un maximum de 10 sections est affiché. La valeur maximale est de 100. Si vous utilisez une valeur supérieure à 100, elle est automatiquement remplacée par 100. Les valeurs négatives renvoient une erreur |
page_token |
Facultatif. Jeton de page reçu d'un appel précédent pour répertorier des sections. Fournissez-le pour récupérer la page suivante. Lors de la pagination, tous les autres paramètres fournis doivent correspondre à l'appel ayant fourni le jeton de page. La transmission de valeurs différentes aux autres paramètres peut entraîner des résultats inattendus. |
ListSectionsResponse
Message de réponse pour la liste des sections.
| Champs | |
|---|---|
sections[] |
Sections de l'utilisateur spécifié. |
next_page_token |
Jeton pouvant être envoyé en tant que |
ListSpaceEventsRequest
Message de requête pour lister les événements d'un espace.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource de l'espace Google Chat où les événements se sont produits. Format : |
page_size |
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 |
page_token |
Facultatif. Jeton de page reçu d'un appel précédent pour lister les événements d'un espace. 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 ayant fourni le jeton de page. La transmission de valeurs différentes aux autres paramètres peut entraîner des résultats inattendus. |
filter |
Obligatoire. Un filtre de requête. Vous devez spécifier au moins un type d'événement ( Vous pouvez également filtrer par heure de début (
Pour spécifier une heure de début ou de fin, utilisez l'opérateur égal Par exemple, les requêtes suivantes sont valides : Les requêtes suivantes ne sont pas valides : Les requêtes non valides sont rejetées par le serveur avec une erreur |
ListSpaceEventsResponse
Message de réponse pour lister les événements d'un espace.
| Champs | |
|---|---|
space_events[] |
Les résultats sont renvoyés par ordre chronologique (l'événement le plus ancien en premier). Remarque : Le champ |
next_page_token |
Jeton de continuation utilisé pour récupérer 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 |
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 de 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 |
page_token |
Facultatif. Jeton de page reçu d'un appel précédent pour lister les 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. La transmission d'une valeur différente peut entraîner des résultats inattendus. |
filter |
Facultatif. Un filtre de requête. Vous pouvez filtrer les espaces par type ( Pour filtrer par type d'espace, vous devez spécifier une valeur d'énumération valide, telle que Par exemple, les requêtes suivantes sont valides : Les requêtes non valides sont rejetées par le serveur avec une erreur |
ListSpacesResponse
Réponse à une requête de liste d'espaces.
| Champs | |
|---|---|
spaces[] |
Liste des espaces de la page demandée (ou de la première page). Remarque : Le champ |
next_page_token |
Vous pouvez envoyer un jeton en tant que |
MarkAsActiveRequest
Message de requête pour la méthode MarkAsActive.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de la disponibilité à marquer comme active. Format : users/{user}/availability
L'adresse e-mail de l'utilisateur ou |
Champ d'union expiration. Expiration de l'état de disponibilité ACTIVE. L'utilisateur sera marqué comme absent après l'expiration. Si aucune date d'expiration n'est indiquée, l'état ACTIVE expire 30 minutes après l'heure actuelle. expiration ne peut être qu'un des éléments suivants : |
|
expire_time |
Code temporel absolu de l'expiration de l'état ACTIVE. |
ttl |
Durée entre l'heure actuelle et l'expiration de l'état ACTIF. L'utilisation d'un TTL court peut réinitialiser efficacement l'état de l'utilisateur en fonction de son activité après cette brève durée. |
MarkAsAwayRequest
Message de requête pour la méthode MarkAsAway.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de la disponibilité à marquer comme absent. Format : users/{user}/availability
L'adresse e-mail de l'utilisateur ou |
MarkAsDoNotDisturbRequest
Message de requête pour la méthode MarkAsDoNotDisturb.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de la disponibilité à marquer comme "Ne pas déranger". Format : users/{user}/availability
L'adresse e-mail de l'utilisateur ou |
Champ d'union expiration. Obligatoire. Expiration de l'état de disponibilité "Ne pas déranger". L'utilisateur sera marqué comme absent après l'expiration. Cette date ne peut pas être postérieure de plus d'un an à la date actuelle. expiration ne peut être qu'un des éléments suivants : |
|
expire_time |
Code temporel absolu de l'expiration de l'état NPD. |
ttl |
Durée entre l'heure actuelle et l'expiration de l'état NPD. |
MarkupSyntax
Spécifie la syntaxe de balisage utilisée pour mettre en forme le texte du message de chat. S'applique au champ text de la ressource Message.
| Enums | |
|---|---|
MARKUP_SYNTAX_UNSPECIFIED |
Représente la valeur non spécifiée. |
MARKUP_SYNTAX_CHAT |
Utilise la syntaxe de balisage de Google Chat. Pour en savoir plus, consultez https://developers.google.com/workspace/chat/format-messages#format-texts. |
MARKUP_SYNTAX_MARKDOWN |
Utilise la syntaxe Markdown. Cette syntaxe est basée sur la spécification CommonMark, avec des extensions supplémentaires. Pour en savoir plus, consultez https://developers.google.com/workspace/chat/format-messages#format-texts. |
MatchedUrl
URL correspondante dans un message de chat. Les applications Chat peuvent prévisualiser les URL correspondantes. Pour en savoir plus, consultez Prévisualiser des liens.
| Champs | |
|---|---|
url |
Uniquement en sortie. URL correspondante. |
MeetSpaceLinkData
Données pour les liens vers les espaces Meet.
| Champs | |
|---|---|
meeting_code |
Code de réunion de l'espace Meet associé. |
type |
Indique le type d'espace de réunion. |
huddle_status |
Facultatif. Uniquement en sortie. Si la réunion Meet est un Huddle, indique l'état du Huddle. Sinon, ce champ n'est pas défini. |
HuddleStatus
État de la réunion
| Enums | |
|---|---|
HUDDLE_STATUS_UNSPECIFIED |
Valeur par défaut de l'énumération. Ne pas utiliser. |
STARTED |
L'appel d'équipe a commencé. |
ENDED |
L'appel d'équipe est terminé. Dans ce cas, l'URI et les identifiants de l'espace Meet ne seront plus valides. |
MISSED |
L'appel d'équipe a été manqué. Dans ce cas, l'URI et les identifiants de l'espace Meet ne seront plus valides. |
Type
Type de l'espace Meet.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Valeur par défaut de l'énumération. Ne pas utiliser. |
MEETING |
L'espace Meet est un espace de réunion. |
HUDDLE |
L'espace Meet est un huddle. |
Abonnement
Représente une relation d'appartenance dans Google Chat, par exemple si un utilisateur ou une application Chat est invité, fait partie ou est absent d'un espace.
| Champs | |
|---|---|
name |
Identifiant. Nom de ressource de l'appartenance, attribué par le serveur. Format : |
state |
Uniquement en sortie. État de l'appartenance. |
role |
Facultatif. Rôle de l'utilisateur dans un espace Chat, qui détermine les actions qu'il est autorisé à effectuer dans l'espace. Ce champ ne peut être utilisé que comme entrée dans |
create_time |
Facultatif. Immuable. Date et heure de création de l'appartenance, par exemple lorsqu'un membre a rejoint un espace ou a été invité à le rejoindre. Ce champ est réservé à la sortie, sauf lorsqu'il est utilisé pour importer des adhésions historiques dans des espaces en mode importation. |
delete_time |
Facultatif. Immuable. Heure de suppression de l'appartenance, par exemple lorsqu'un membre a quitté un espace ou en a été exclu. Ce champ est réservé à la sortie, sauf lorsqu'il est utilisé pour importer des adhésions historiques dans des espaces en mode importation. |
affiliation |
Uniquement en sortie. Relation d'un utilisateur avec l'organisation Workspace propriétaire de l'espace. Dans les espaces appartenant à des comptes personnels, l'affiliation de tous les membres est |
Champ d'union memberType. Membre associé à cette ressource Membership. D'autres types de membres pourraient être pris en charge à l'avenir. memberType ne peut être qu'un des éléments suivants : |
|
member |
Facultatif. Utilisateur ou application Google Chat auquel correspond l'appartenance. Si votre application Chat s'authentifie en tant qu'utilisateur, le résultat ne renseigne que les champs user |
group_member |
Facultatif. Groupe Google auquel l'appartenance correspond. La lecture ou la modification des appartenances à des groupes Google nécessite l'authentification des utilisateurs. |
Affiliation
Représente l'affiliation d'un utilisateur à l'organisation Google Workspace propriétaire de l'espace. D'autres valeurs pourront être ajoutées à cette énumération à l'avenir.
| Enums | |
|---|---|
AFFILIATION_UNSPECIFIED |
Valeur par défaut. Cette valeur n'est pas utilisée. |
INTERNAL |
Un compte géré par la même organisation Google Workspace que celle qui possède l'espace. |
EXTERNAL |
Un compte externe à l'organisation Google Workspace propriétaire de l'espace (par exemple, un compte personnel ou un compte géré par une autre organisation Workspace). |
MANAGED_EXTERNAL |
Compte géré par l'organisation Workspace propriétaire de l'espace, mais provisionné pour un utilisateur externe à l'organisation (par exemple, un utilisateur invité). Pour en savoir plus sur les invités, consultez https://support.google.com/chat/answer/16997417. |
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 : il n'est pas membre de l'espace, mais peut être invité. Pour Google Groups : ce rôle leur est toujours attribué (d'autres valeurs d'énumération pourront être utilisées à l'avenir). |
ROLE_MEMBER |
Membre de l'espace. Dans l'interface utilisateur de Chat, ce rôle est appelé "Membre". L'utilisateur dispose d'autorisations de base, comme l'envoi de messages à l'espace. Les gestionnaires et les propriétaires peuvent accorder des autorisations supplémentaires aux membres d'un espace, y compris :
Dans les messages privés et les conversations de groupe sans nom, tout le monde dispose de ce rôle. |
ROLE_MANAGER |
un propriétaire de l'espace ; Dans l'UI de Chat, ce rôle est appelé "Propriétaire". L'utilisateur dispose de l'ensemble des autorisations d'espace pour gérer l'espace, y compris :
Uniquement compatible avec Pour en savoir plus, consultez En savoir plus sur votre rôle de propriétaire ou de gestionnaire d'un espace. |
ROLE_ASSISTANT_MANAGER |
un gestionnaire de l'espace ; Dans l'UI de Chat, ce rôle est appelé "Gestionnaire". L'utilisateur dispose de toutes les autorisations de base de
Par défaut, les autorisations des gestionnaires incluent, sans s'y limiter :
Uniquement compatible avec Pour en savoir plus, consultez Gérer les paramètres d'un espace. |
MembershipState
Spécifie la relation du membre avec un espace. D'autres états d'appartenance pourraient être pris en charge à 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 rejoint. |
NOT_A_MEMBER |
L'utilisateur n'appartient pas à l'espace et n'a pas d'invitation en attente pour le rejoindre. |
MembershipBatchCreatedEventData
Charge utile d'événement pour plusieurs nouvelles adhésions.
Type d'événement : google.workspace.chat.membership.v1.batchCreated
| Champs | |
|---|---|
memberships[] |
Liste des nouvelles souscriptions. |
MembershipBatchDeletedEventData
Charge utile d'événement pour plusieurs abonnements supprimés.
Type d'événement : google.workspace.chat.membership.v1.batchDeleted
| Champs | |
|---|---|
memberships[] |
Liste des appartenances supprimées. |
MembershipBatchUpdatedEventData
Charge utile d'événement pour plusieurs abonnements mis à jour.
Type d'événement : google.workspace.chat.membership.v1.batchUpdated
| Champs | |
|---|---|
memberships[] |
Liste des abonnements mis à jour. |
MembershipCreatedEventData
Charge utile d'événement pour une nouvelle adhésion.
Type d'événement : google.workspace.chat.membership.v1.created.
| Champs | |
|---|---|
membership |
Le nouvel abonnement. |
MembershipDeletedEventData
Charge utile d'événement pour une adhésion supprimée.
Type d'événement : google.workspace.chat.membership.v1.deleted
| Champs | |
|---|---|
membership |
La ressource Membership supprimée. Seuls les champs |
MembershipUpdatedEventData
Charge utile d'événement pour une adhésion mise à jour.
Type d'événement : google.workspace.chat.membership.v1.updated
| Champs | |
|---|---|
membership |
La ressource Membership mise à jour. |
Message
Message dans un espace Google Chat.
| Champs | |
|---|---|
name |
Identifiant. Nom de ressource du message. Format : Où 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 |
sender |
Uniquement en sortie. Utilisateur qui a créé le message. Si votre application Chat s'authentifie en tant qu'utilisateur, le résultat ne renseigne que les champs user |
create_time |
Facultatif. Immuable. Pour les espaces créés dans Chat, l'heure à laquelle le message a été créé. Ce champ est réservé à la sortie, sauf s'il est utilisé dans des espaces en mode importation. Pour les espaces en mode importation, définissez ce champ sur le code temporel historique auquel le message a été créé dans la source afin de conserver l'heure de création d'origine. |
last_update_time |
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 |
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 |
Facultatif. 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 |
Uniquement en sortie. Contient le message
Pour en savoir plus, consultez Afficher la mise en forme du texte envoyé dans un message. |
cards[] |
Obsolète : utilisez Cartes 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 normalement affichées sous le corps du message en texte brut. |
cards_v2[] |
Facultatif. Tableau de cartes. Les applications Chat peuvent créer des fiches avec l'authentification de l'application. Dans le cadre du programme Preview développeur, si votre application Chat s'authentifie en tant qu'utilisateur, elle peut créer des messages de fiches. Si votre application Chat ne fait pas partie du programme Preview développeur, elle ne peut pas créer de fiches avec authentification des utilisateurs. Pour savoir comment créer un message contenant des fiches, consultez Envoyer un message. Concevez et prévisualisez des fiches avec le générateur de fiches. Ouvrir le générateur de fiches |
annotations[] |
Uniquement en sortie. Les annotations peuvent être associées au corps du message en texte brut ou à des chips qui renvoient à des ressources Google Workspace telles que Google Docs ou Sheets avec |
thread |
Fil de discussion auquel le message appartient. Pour obtenir un exemple d'utilisation, consultez Démarrer un fil de discussion ou y répondre. |
space |
Uniquement en sortie. Si votre application Chat s'authentifie en tant qu'utilisateur, le résultat ne renseigne que l'espace |
fallback_text |
Facultatif. Description en texte brut des fiches du message, utilisée lorsque les fiches réelles ne peuvent pas être affichées (par exemple, dans les notifications mobiles). |
action_response |
Uniquement en entrée. Paramètres qu'une application Chat peut utiliser pour configurer la façon dont sa réponse est publiée. |
argument_text |
Uniquement en sortie. Corps du message en texte brut, sans les mentions de l'application Chat. |
slash_command |
Uniquement en sortie. Informations sur la commande à barre oblique, le cas échéant. |
attachment[] |
Facultatif. Pièce jointe importée par l'utilisateur. |
matched_url |
Uniquement en sortie. Une URL dans le champ |
thread_reply |
Uniquement en sortie. Lorsque Si l'espace n'accepte pas les réponses dans les fils de discussion, ce champ est toujours |
silent |
Uniquement en sortie. Indique s'il s'agit d'un message silencieux. Les messages silencieux sont des messages pour lesquels Chat supprime les notifications push pour les destinataires. |
client_assigned_message_id |
Facultatif. ID personnalisé du message. Vous pouvez utiliser ce champ pour identifier un message, ou pour obtenir, supprimer ou mettre à jour un message. Pour définir un ID personnalisé, spécifiez le champ |
emoji_reaction_summaries[] |
Uniquement en sortie. Liste des résumés des réactions emoji au message. |
private_message_viewer |
Facultatif. Immuable. Entrée pour créer un message, sinon sortie uniquement. Utilisateur pouvant afficher le message. Lorsqu'il est défini, le message est privé et n'est visible que 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 de l'application et omettre les éléments suivants : Pour en savoir plus, consultez Envoyer un message privé. |
deletion_metadata |
Uniquement en sortie. Informations sur un message supprimé. Un message est supprimé lorsque |
quoted_message_metadata |
Facultatif. Informations sur un message cité par un autre message. Lorsque vous créez un message, vous pouvez citer des messages du même fil de discussion ou citer un message racine pour en créer un autre. Toutefois, vous ne pouvez pas citer une réponse à un message provenant d'un autre fil de discussion. Lorsque vous mettez à jour un message, vous ne pouvez pas ajouter ni remplacer le champ Pour obtenir un exemple d'utilisation, consultez Citer un autre message. |
attached_gifs[] |
Uniquement en sortie. Images GIF jointes au message. |
accessory_widgets[] |
Facultatif. Un ou plusieurs widgets interactifs qui s'affichent en bas d'un message. Vous pouvez ajouter des widgets d'accessoires aux messages contenant du texte, des fiches, ou du texte et des fiches. 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. |
elements |
Facultatif. Les éléments sont des composants supplémentaires fournis lors de la création du message, qui peuvent ou non être associés à des parties spécifiques du texte du message. Elles diffèrent des annotations, qui sont en sortie uniquement et fournissent des informations supplémentaires liées à des fragments de message ou à l'intégralité du texte du message. |
markup_syntax |
Facultatif. Spécifie comment le serveur interprète le contenu du champ |
MessageBatchCreatedEventData
Charge utile d'événement pour plusieurs nouveaux messages.
Type d'événement : google.workspace.chat.message.v1.batchCreated
| Champs | |
|---|---|
messages[] |
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[] |
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[] |
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 |
Le nouveau message. |
MessageDeletedEventData
Charge utile d'événement pour un message supprimé.
Type d'événement : google.workspace.chat.message.v1.deleted
| Champs | |
|---|---|
message |
Le message supprimé. Seuls les champs |
MessagePin
Épingle sur un message de chat. Pour en savoir plus, consultez Épingler un message.
| Champs | |
|---|---|
name |
Identifiant. Nom de ressource du message épinglé. Format : |
message |
Obligatoire. Immuable. Nom de ressource du message épinglé. Format : |
MessageUpdatedEventData
Charge utile d'événement pour un message mis à jour.
Type d'événement : google.workspace.chat.message.v1.updated
| Champs | |
|---|---|
message |
Message mis à jour. |
MoveSectionItemRequest
Message de requête pour déplacer un élément de section d'une section à une autre.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de l'élément de section à déplacer. Format : |
target_section |
Obligatoire. Nom de ressource de la section vers laquelle déplacer l'élément de section. Format : |
MoveSectionItemResponse
Message de réponse pour le déplacement d'un élément de section.
| Champs | |
|---|---|
section_item |
Élément de section mis à jour. |
PositionSectionRequest
Message de requête pour positionner une section.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de la section à positionner. Format : |
Champ d'union position. Obligatoire. Nouvelle position de la section. position ne peut être qu'un des éléments suivants : |
|
sort_order |
Facultatif. Position absolue de la section dans la liste des sections. La position doit être supérieure à 0. Si la position est supérieure au nombre de sections, la section sera ajoutée à la fin de la liste. Cette opération insère la section à la position indiquée et déplace la section d'origine à cette position, ainsi que celles situées en dessous, vers la position suivante. |
relative_position |
Facultatif. Position relative de la section dans la liste des sections. |
Position
Position de la section.
| Enums | |
|---|---|
POSITION_UNSPECIFIED |
Position non spécifiée. |
START |
Début de la liste des sections. |
END |
Fin de la liste des sections. |
PositionSectionResponse
Message de réponse pour le positionnement d'une section.
| Champs | |
|---|---|
section |
La section mise à jour. |
QuotedMessageMetadata
Informations sur un message cité par un autre message.
Lorsque vous mettez à jour un message, vous ne pouvez pas ajouter ni remplacer le champ quotedMessageMetadata, mais vous pouvez le supprimer.
Pour obtenir un exemple d'utilisation, consultez Citer un autre message.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource du message cité. Format : |
last_update_time |
Obligatoire. Code temporel de la création ou de la dernière mise à jour du message cité. Si le message a été modifié, utilisez ce champ : Si |
quote_type |
Facultatif. Spécifie le type de devis. Si ce champ n'est pas défini, la valeur par défaut est REPLY dans le chemin de lecture/écriture du message pour assurer la rétrocompatibilité. |
quoted_message_snapshot |
Uniquement en sortie. Un instantané du contenu du message cité. |
forwarded_metadata |
Uniquement en sortie. Métadonnées sur l'espace source du message cité. Renseigné uniquement pour le type de devis FORWARD. |
QuoteType
Type de citation du message cité.
| Enums | |
|---|---|
QUOTE_TYPE_UNSPECIFIED |
Réservé. Cette valeur n'est pas utilisée. |
REPLY |
Lorsque
|
FORWARD |
Lorsque
|
QuotedMessageSnapshot
Fournit un aperçu du contenu du message cité au moment où il est cité ou transféré.
| Champs | |
|---|---|
sender |
Uniquement en sortie. Nom de l'auteur du message cité. Renseigné pour les types de citation REPLY et FORWARD. |
text |
Uniquement en sortie. Instantané du contenu textuel du message cité. |
formatted_text |
Uniquement en sortie. Contient le message cité |
annotations[] |
Uniquement en sortie. Annotations analysées à partir du corps du texte du message cité. Renseigné uniquement pour le type de devis FORWARD. |
attachments[] |
Uniquement en sortie. Pièces jointes qui faisaient partie du message cité. Il s'agit de copies des métadonnées de la pièce jointe du message cité. Renseigné uniquement pour le type de devis FORWARD. |
Réaction
Réaction à un message.
| Champs | |
|---|---|
name |
Identifiant. Nom de ressource de la réaction. Format : |
user |
Uniquement en sortie. Utilisateur qui a créé la réaction. |
emoji |
Obligatoire. Emoji utilisé dans la réaction. |
ReactionBatchCreatedEventData
Charge utile d'événement pour plusieurs nouvelles réactions.
Type d'événement : google.workspace.chat.reaction.v1.batchCreated
| Champs | |
|---|---|
reactions[] |
Liste des nouvelles réactions. |
ReactionBatchDeletedEventData
Charge utile d'événement pour plusieurs réactions supprimées.
Type d'événement : google.workspace.chat.reaction.v1.batchDeleted
| Champs | |
|---|---|
reactions[] |
Liste des réactions supprimées. |
ReactionCreatedEventData
Charge utile d'événement pour une nouvelle réaction.
Type d'événement : google.workspace.chat.reaction.v1.created
| Champs | |
|---|---|
reaction |
La nouvelle réaction. |
ReactionDeletedEventData
Charge utile d'événement pour une réaction supprimée.
Type : google.workspace.chat.reaction.v1.deleted
| Champs | |
|---|---|
reaction |
La réaction supprimée. |
ReplaceMessageCardsRequest
Message de requête pour la méthode d'API ReplaceMessageCards.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource du message. Format : |
cards_v2[] |
Facultatif. Tableau de fiches à inclure dans le message. Ces fiches remplaceront les fiches existantes du message. Si ce champ est vide, les fiches d'origine incluses dans le message seront effacées. |
ReplaceMessageCardsResponse
Ce type ne comporte aucun champ.
Message de réponse pour l'API ReplaceMessageCards.
RichLinkMetadata
Lien enrichi vers une ressource. Les liens enrichis peuvent être associés au corps du message en texte brut ou représenter des chips qui renvoient vers des ressources Google Workspace telles que Google Docs ou Sheets avec start_index et length de 0.
| Champs | |
|---|---|
uri |
URI de ce lien. |
rich_link_type |
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 |
Données d'un lien Drive. |
chat_space_link_data |
Données d'un lien vers un espace Chat. |
meet_space_link_data |
Données d'un lien vers un espace Meet. |
calendar_event_link_data |
Données d'un lien vers un événement d'agenda. |
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 enrichi Google Drive. |
CHAT_SPACE |
Type de lien enrichi d'un espace Chat. Par exemple, un chip intelligent d'espace. |
GMAIL_MESSAGE |
Type de lien enrichi vers un message Gmail. Plus précisément, un chip Gmail de Partager dans Chat. L'API n'est compatible qu'avec la lecture des messages contenant des liens enrichis GMAIL_MESSAGE. |
MEET_SPACE |
Type de lien enrichi de message Meet. Par exemple, un chip Meet. |
CALENDAR_EVENT |
Type de lien enrichi pour un message Agenda. Par exemple, un chip Agenda. |
SearchMessageResult
Élément de résultat unique d'une recherche de messages.
| Champs | |
|---|---|
message |
Le message correspondant. |
space_mute_setting |
Paramètre de coupure du son de l'utilisateur appelant pour l'espace où le message est publié. L'application appelante peut utiliser ces informations pour décider comment traiter le message, selon que l'espace est ignoré ou non par l'utilisateur. Renvoyé uniquement si la vue de la requête est
|
read |
Indique si le message correspondant est lu par l'utilisateur appelant. Uniquement renvoyé si la vue de la requête est
|
SearchMessagesRequest
Message de requête pour rechercher des messages.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource de l'espace dans lequel effectuer la recherche. Pour effectuer une recherche dans tous les espaces auxquels l'utilisateur a accès, définissez ce champ sur Pour limiter la recherche à un ou plusieurs espaces, utilisez |
filter |
Obligatoire. Une requête de recherche. La requête peut spécifier un ou plusieurs mots clés de recherche, qui sont utilisés pour filtrer les résultats, Vous pouvez également filtrer les résultats à l'aide des champs de message suivants :
Pour le filtrage avancé, les fonctions suivantes sont également disponibles :
Pour utiliser les filtres
Pour utiliser le filtre
Pour les différents champs, seuls les opérateurs Dans le même champ :
Les parenthèses sont requises pour lever l'ambiguïté sur la priorité des opérateurs lorsque vous combinez les opérateurs Les exemples de requêtes suivants sont valides : La longueur maximale de la requête est de 1 000 caractères. Les requêtes non valides sont rejetées par le serveur avec une erreur |
page_size |
Facultatif. Nombre maximal de résultats à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, 25 résultats au maximum sont renvoyés. La valeur maximale est de 100. Si vous utilisez une valeur supérieure à 100, elle est automatiquement remplacée par 100. |
page_token |
Facultatif. Jeton reçu de l'appel de recherche de messages précédent. 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 ayant fourni le jeton de page. La transmission de valeurs différentes aux autres paramètres peut entraîner des résultats inattendus. |
order_by |
Facultatif. Ordre de la liste des résultats. Les attributs acceptés pour le tri sont les suivants :
L'ordre par défaut est |
markup_syntax |
Facultatif. Spécifie la syntaxe de sortie souhaitée pour le champ |
view |
Facultatif. Spécifie le type de vue des résultats de recherche à renvoyer. La valeur par défaut est |
SearchMessagesView
Types de vues compatibles avec les résultats de recherche partiels.
| Enums | |
|---|---|
SEARCH_MESSAGES_VIEW_UNSPECIFIED |
Valeur par défaut / non définie. Par défaut, l'API utilise la vue BASIC. |
SEARCH_MESSAGES_VIEW_BASIC |
Inclut uniquement les messages correspondants dans les résultats, mais pas de métadonnées supplémentaires. Il s'agit de la valeur par défaut. |
SEARCH_MESSAGES_VIEW_FULL |
Inclut tous les éléments des résultats : les messages correspondants et des métadonnées supplémentaires. |
SearchMessagesResponse
Message de réponse pour la recherche de messages.
| Champs | |
|---|---|
results[] |
Liste des résultats de recherche correspondant à la requête. |
next_page_token |
Jeton pouvant être utilisé pour récupérer la page suivante. Si ce champ est vide, aucune page suivante n'existe. |
SearchSpacesRequest
Requête permettant de rechercher une liste d'espaces en fonction d'une requête.
| Champs | |
|---|---|
use_admin_access |
Lorsque la valeur est L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit "Gérer les conversations Chat et Espaces". Nécessite le champ d'application OAuth 2.0 |
page_size |
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 de 1 000 lorsque |
page_token |
Jeton reçu de l'appel d'espaces de recherche précédent. 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 ayant fourni le jeton de page. La transmission de valeurs différentes aux autres paramètres peut entraîner des résultats inattendus. |
query |
Obligatoire. Une requête de recherche. Vous pouvez effectuer une recherche à l'aide des paramètres suivants lorsque
Lorsque
Pour les différents champs, seuls les opérateurs Pour un même champ, Les exemples de requêtes suivants sont valides lorsque Les exemples de requêtes suivants sont valides lorsque La longueur maximale de la requête est de 1 000 caractères. Les requêtes non valides sont rejetées par le serveur avec une erreur |
order_by |
Facultatif. Comment la liste des espaces est-elle classée ? Les attributs acceptés pour le tri sont les suivants :
Lorsque Les valeurs d'opération de tri valides sont les suivantes :
La syntaxe acceptée lorsque
Lorsque
|
SearchSpacesResponse
Réponse contenant une liste d'espaces correspondant à la requête de recherche d'espaces.
| Champs | |
|---|---|
spaces[] |
Obsolète : veuillez utiliser le nouveau champ |
next_page_token |
Jeton pouvant être utilisé pour récupérer la page suivante. Si ce champ est vide, aucune page suivante n'existe. Renseigné uniquement lorsque |
total_size |
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. Renseigné uniquement lorsque |
results[] |
Uniquement en sortie. Liste des résultats de recherche correspondant à la requête. |
SearchSpaceResult
Élément de résultat unique d'une recherche d'espace.
| Champs | |
|---|---|
space |
Uniquement en sortie. L'espace correspondant. |
Section
Représente une section dans Google Chat. Les sections aident les utilisateurs à organiser leurs espaces. Il existe deux types de sections :
Sections système : sections prédéfinies gérées par Google Chat. Leurs noms de ressources sont fixes, et ils ne peuvent pas être créés, supprimés ni voir leur
display_namemodifié. Voici quelques exemples :users/{user}/sections/default-direct-messagesusers/{user}/sections/default-spacesusers/{user}/sections/default-apps
Sections personnalisées : sections créées et gérées par l'utilisateur. La création d'une section personnalisée à l'aide de
CreateSectionnécessite undisplay_name. Les sections personnalisées peuvent être mises à jour à l'aide deUpdateSectionet supprimées à l'aide deDeleteSection.
| Champs | |
|---|---|
name |
Identifiant. Nom de ressource de la section. Pour les sections système, l'ID de section est une chaîne constante :
Format : |
display_name |
Facultatif. Nom à afficher de la section. Renseigné uniquement pour les sections de type |
sort_order |
Uniquement en sortie. Ordre de la section par rapport aux autres sections. Les sections ayant une valeur |
type |
Obligatoire. Type de la section. |
SectionType
Types de sections.
| Enums | |
|---|---|
SECTION_TYPE_UNSPECIFIED |
Type de section non spécifié. |
CUSTOM_SECTION |
Section personnalisée. |
DEFAULT_DIRECT_MESSAGES |
Section par défaut contenant les espaces DIRECT_MESSAGE entre deux utilisateurs humains ou les espaces GROUP_CHAT qui n'appartiennent à aucune section personnalisée. |
DEFAULT_SPACES |
Espaces par défaut qui n'appartiennent à aucune section personnalisée. |
DEFAULT_APPS |
Section par défaut contenant les applications installées d'un utilisateur. |
SectionItem
Élément de section défini par l'utilisateur. Cette option permet de représenter les éléments d'une section, tels que les espaces, regroupés sous une section.
| Champs | |
|---|---|
name |
Identifiant. Nom de ressource de l'élément de section. Format : |
Champ d'union item. Obligatoire. Élément de la section. item ne peut être qu'un des éléments suivants : |
|
space |
Facultatif. Nom de la ressource d'espace. Format : |
SetUpSpaceRequest
Demandez la création d'un espace et l'ajout d'utilisateurs spécifiques à cet espace.
| Champs | |
|---|---|
space |
Obligatoire. Le champ Pour créer un espace, définissez Pour créer un chat de groupe, définissez Pour créer une conversation privée entre des humains, définissez Pour créer une conversation privée entre un humain et l'application Chat appelante, définissez Si un espace |
request_id |
Facultatif. Identifiant unique de cette requête. Nous vous recommandons d'utiliser un UUID aléatoire. La spécification d'un ID de requête rend la requête idempotente, ce qui garantit que plusieurs requêtes identiques avec le même ID de requête n'entraînent la création que d'un seul espace. Les requêtes ultérieures avec le même ID de requête renvoient l'espace existant et ne le mettent pas à jour, même si les détails demandés diffèrent de l'état actuel. Pour utiliser ce champ efficacement :
|
memberships[] |
Facultatif. Utilisateurs ou groupes Google Chat à inviter à rejoindre l'espace. Omettez l'utilisateur appelant, car il est ajouté automatiquement. L'ensemble autorise actuellement jusqu'à 49 appartenances (en plus de l'appelant). Pour l'appartenance d'un utilisateur, le champ Pour l'appartenance à un groupe Google, le champ Facultatif lorsque vous définissez Obligatoire lorsque vous définissez Obligatoire lorsque vous définissez Doit être vide lors de la création d'une conversation privée entre un humain et l'application Chat appelante (lorsque |
SlashCommand
Métadonnées d'une commande à barre oblique dans Google Chat.
| Champs | |
|---|---|
command_id |
ID de la commande à barre oblique. |
SlashCommandMetadata
Métadonnées d'annotation pour les commandes à barre oblique (/).
| Champs | |
|---|---|
bot |
L'application Chat dont la commande a été appelée. |
type |
Type de commande à barre oblique. |
command_name |
Nom de la commande à barre oblique appelée. |
command_id |
ID de la commande à barre oblique appelée. |
triggers_dialog |
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 |
Ajouter l'application Chat à l'espace |
INVOKE |
Appeler une commande à barre oblique dans un espace. |
Espace
Un 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 |
Identifiant. Nom de ressource de l'espace. Format : où |
type |
Uniquement en sortie. Obsolète : utilisez |
space_type |
Facultatif. Type d'espace. Obligatoire lors de la création d'un espace ou de la modification du type d'un espace. Uniquement en sortie pour d'autres utilisations. |
single_user_bot_dm |
Facultatif. Indique si l'espace est un MP entre une application Chat et un seul utilisateur. |
threaded |
Uniquement en sortie. Obsolète : utilisez |
display_name |
Facultatif. Nom à afficher de l'espace. Obligatoire lorsque vous créez un espace avec un Pour les messages privés, ce champ peut être vide. Peut contenir jusqu'à 128 caractères. |
external_user_allowed |
Facultatif. Immuable. Indique si cet espace autorise n'importe quel utilisateur de Google Chat en tant que 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 :
Pour les espaces existants, ce champ est en sortie uniquement. |
space_threading_state |
Uniquement en sortie. État du fil de discussion dans l'espace Chat. |
space_details |
Facultatif. Informations sur l'espace, y compris sa description et ses règles. |
space_history_state |
Facultatif. État de l'historique des messages pour les messages et les fils de discussion de cet espace. |
import_mode |
Facultatif. Indique si cet espace est créé dans Pour créer un espace dans |
create_time |
Facultatif. Immuable. Pour les espaces créés dans Chat, heure de création de l'espace. Ce champ est réservé à la sortie, sauf s'il est utilisé dans des espaces en mode importation. Pour les espaces en mode d'importation, définissez ce champ sur le code temporel historique auquel l'espace a été créé dans la source afin de conserver l'heure de création d'origine. Renseigné dans la sortie uniquement lorsque |
last_active_time |
Uniquement en sortie. Code temporel du dernier message de l'espace. |
admin_installed |
Uniquement en sortie. Pour les espaces de messages privés (MP) avec une application Chat, 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 permettre l'installation par l'administrateur, votre application Chat doit proposer la messagerie privée. |
membership_count |
Uniquement en sortie. Nombre d'abonnements rejoints, regroupés par type de membre. Renseigné lorsque |
access_settings |
Facultatif. Spécifie le paramètre d'accès de l'espace. N'est renseigné que lorsque |
space_uri |
Uniquement en sortie. URI permettant à un utilisateur d'accéder à l'espace. |
import_mode_expire_time |
Uniquement en sortie. Heure à laquelle l'espace sera automatiquement supprimé par le système s'il reste en mode importation. Chaque espace créé en mode importation doit quitter ce mode avant l'heure d'expiration à l'aide de Ce champ n'est renseigné que pour les espaces créés en mode importation. |
customer |
Facultatif. Immuable. Numéro client du domaine de l'espace. Obligatoire uniquement lors de la création d'un espace avec l'authentification de l'application et si Au format Ce champ n'est pas renseigné pour les messages privés (MP) ni lorsque l'espace est créé par des utilisateurs non Google Workspace. |
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. space_permission_settings ne peut être qu'un des éléments suivants : |
|
predefined_permission_settings |
Facultatif. Uniquement en entrée. Paramètres d'autorisation d'espace prédéfinis, à saisir uniquement lors de la création d'un espace. Si le 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 La définition de paramètres d'autorisation prédéfinis est compatible avec :
|
permission_settings |
Facultatif. Paramètres d'autorisation des 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. La sortie liste les paramètres d'autorisation actuels. La lecture et la mise à jour des paramètres d'autorisation sont compatibles avec :
|
AccessPermissionSetting
Un paramètre d'autorisation d'accès.
| Champs | |
|---|---|
principals[] |
Facultatif. Liste non triée. Comptes principaux autorisés pour cette autorisation. |
AccessPermissionSettings
accéder aux paramètres d'autorisation d'un espace ;
| Champs | |
|---|---|
discover_space_setting |
Facultatif. Paramètre d'autorisation d'accès pour découvrir l'espace. |
join_space_setting |
Facultatif. Paramètre d'autorisation d'accès pour rejoindre l'espace. |
view_space_membership_setting |
Facultatif. Paramètre d'autorisation d'accès pour afficher les membres d'un espace. Doit être spécifié avec |
AccessSettings
Représente le paramètre d'accès de l'espace.
| Champs | |
|---|---|
access_state |
Uniquement en sortie. Indique l'état d'accès de l'espace. |
audience |
Facultatif. Nom de ressource de l'audience cible qui peut 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 par une audience cible. Format : Pour utiliser l'audience cible par défaut de l'organisation Google Workspace, définissez la valeur sur La lecture de l'audience cible est compatible avec :
Ce champ n'est pas renseigné lorsque vous utilisez le champ d'application La définition de l'audience cible nécessite l'authentification de l'utilisateur. |
access_permission_settings |
Facultatif. accéder aux paramètres d'autorisation de l'espace ; Pour définir l'audience cible lors de la création d'un espace, spécifiez le champ |
AccessState
Représente l'état d'accès de l'espace.
| Enums | |
|---|---|
ACCESS_STATE_UNSPECIFIED |
L'état d'accès est inconnu ou n'est pas pris en charge dans cette API. |
PRIVATE |
Seuls les utilisateurs ou les groupes Google qui ont été ajoutés ou invités individuellement par d'autres utilisateurs ou par des administrateurs Google Workspace peuvent découvrir l'espace et y accéder. |
DISCOVERABLE |
Un gestionnaire d'espace a accordé l'accès à l'espace à une audience cible. Les utilisateurs ou les groupes Google qui ont été ajoutés ou invités individuellement à l'espace peuvent également le trouver 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 l'authentification des utilisateurs. |
MembershipCount
Représente le nombre de membres d'un espace, regroupés par catégories.
| Champs | |
|---|---|
joined_direct_human_user_count |
Uniquement en sortie. Nombre d'utilisateurs humains ayant directement rejoint l'espace, sans compter les utilisateurs ayant rejoint l'espace en tant que membres d'un groupe. |
joined_group_count |
Uniquement en sortie. Nombre de tous les groupes qui ont rejoint directement l'espace. |
PermissionSetting
Représente un paramètre d'autorisation d'espace.
| Champs | |
|---|---|
managers_allowed |
Facultatif. Indique si les propriétaires d'espace ( |
members_allowed |
Facultatif. Indique si les membres de l'espace de base ( |
assistant_managers_allowed |
Facultatif. Indique si les gestionnaires d'espace ( |
PermissionSettings
Paramètres d'autorisation que vous pouvez spécifier lors de la mise à jour d'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 |
Facultatif. Paramètre permettant de gérer les membres et les groupes d'un espace. |
modify_space_details |
Facultatif. Paramètre permettant de modifier le nom, l'avatar, la description et les consignes d'un espace. |
toggle_history |
Facultatif. Paramètre permettant d'activer ou de désactiver l'historique des espaces. |
use_at_mention_all |
Facultatif. Paramètre permettant d'utiliser @tous dans un espace. |
manage_apps |
Facultatif. Paramètre permettant de gérer les applications dans un espace. |
manage_webhooks |
Facultatif. Paramètre permettant de gérer les webhooks dans un espace. |
post_messages |
Uniquement en sortie. Paramètre permettant de publier des messages dans un espace. |
reply_messages |
Facultatif. Paramètre permettant de répondre aux messages dans un espace. |
view_space_membership |
Facultatif. Paramètre permettant d'afficher l'appartenance à un espace. Doit être spécifié avec |
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 pourraient ê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 où tous les membres peuvent publier des messages. |
ANNOUNCEMENT_SPACE |
Paramètre permettant de transformer l'espace en espace d'annonce où seuls les gestionnaires de l'espace peuvent publier des messages. |
Principal
Compte principal représentant une entité autorisée à accéder à la ressource.
| Champs | |
|---|---|
Champ d'union principal_type. Type de compte principal. principal_type ne peut être qu'un des éléments suivants : |
|
audience |
Une audience. |
SpaceDetails
Informations sur l'espace, y compris sa description et ses règles.
| Champs | |
|---|---|
description |
Facultatif. Description de l'espace. Par exemple, décrivez le sujet de discussion, l'objectif fonctionnel ou les participants de l'espace. Peut contenir jusqu'à 4 096 caractères. |
guidelines |
Facultatif. Les règles, les attentes et l'étiquette de l'espace La limite est de 5 000 caractères. |
SpaceThreadingState
Spécifie le type d'état des fils de discussion dans l'espace Chat.
| Enums | |
|---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
Réservé. |
THREADED_MESSAGES |
Espaces compatibles avec les fils de discussion. Lorsqu'un utilisateur répond à un message, il peut le faire dans le fil de discussion, ce qui permet de conserver le contexte du message d'origine. |
GROUPED_MESSAGES |
Espaces nommés dans lesquels la conversation est organisée par sujet. Les sujets et leurs réponses sont regroupés. |
UNTHREADED_MESSAGES |
Espaces qui ne sont pas compatibles avec les fils de discussion. Cet état de l'organisation des conversations dans l'espace n'est utilisé que dans des cas particuliers, y compris :
|
SpaceType
Type d'espace. Obligatoire lors de la création ou de la mise à jour d'un espace. Uniquement en sortie pour d'autres utilisations.
| Enums | |
|---|---|
SPACE_TYPE_UNSPECIFIED |
Réservé. |
SPACE |
Un endroit où les utilisateurs envoient des messages, partagent des fichiers et collaborent. 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 SpaceType à la place.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Réservé. |
ROOM |
Conversations entre deux humains ou plus. |
DM |
Message privé entre un humain 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[] |
Liste des espaces mis à jour. |
SpaceEvent
Événement qui représente une modification ou une activité dans un espace Google Chat. Pour en savoir plus, consultez Utiliser des événements de Google Chat.
| Champs | |
|---|---|
name |
Nom de ressource de l'événement d'espace. Format : |
event_time |
Heure à laquelle l'événement s'est produit. |
event_type |
Type d'événement d'espace. Chaque type d'événement possède 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 Types d'événements acceptés pour les messages :
Types d'événements acceptés pour les abonnements :
Types d'événements compatibles avec les réactions :
Types d'événements acceptés concernant l'espace :
|
Champ d'union
|
|
message_created_event_data |
Charge utile d'événement pour un nouveau message. Type d'événement : |
message_updated_event_data |
Charge utile d'événement pour un message mis à jour. Type d'événement : |
message_deleted_event_data |
Charge utile d'événement pour un message supprimé. Type d'événement : |
message_batch_created_event_data |
Charge utile d'événement pour plusieurs nouveaux messages. Type d'événement : |
message_batch_updated_event_data |
Charge utile d'événement pour plusieurs messages mis à jour. Type d'événement : |
message_batch_deleted_event_data |
Charge utile d'événement pour plusieurs messages supprimés. Type d'événement : |
space_updated_event_data |
Charge utile d'événement pour une mise à jour d'espace. Type d'événement : |
space_batch_updated_event_data |
Charge utile d'événement pour plusieurs mises à jour d'un espace. Type d'événement : |
membership_created_event_data |
Charge utile d'événement pour une nouvelle adhésion. Type d'événement : |
membership_updated_event_data |
Charge utile d'événement pour une adhésion mise à jour. Type d'événement : |
membership_deleted_event_data |
Charge utile d'événement pour une adhésion supprimée. Type d'événement : |
membership_batch_created_event_data |
Charge utile d'événement pour plusieurs nouvelles adhésions. Type d'événement : |
membership_batch_updated_event_data |
Charge utile d'événement pour plusieurs abonnements mis à jour. Type d'événement : |
membership_batch_deleted_event_data |
Charge utile d'événement pour plusieurs abonnements supprimés. Type d'événement : |
reaction_created_event_data |
Charge utile d'événement pour une nouvelle réaction. Type d'événement : |
reaction_deleted_event_data |
Charge utile d'événement pour une réaction supprimée. Type d'événement : |
reaction_batch_created_event_data |
Charge utile d'événement pour plusieurs nouvelles réactions. Type d'événement : |
reaction_batch_deleted_event_data |
Charge utile d'événement pour plusieurs réactions supprimées. Type d'événement : |
SpaceNotificationSetting
Paramètre de notification d'un utilisateur dans un espace.
| Champs | |
|---|---|
name |
Identifiant. Nom de ressource du paramètre de notification de l'espace. Format : |
notification_setting |
Paramètre de notification. |
mute_setting |
Paramètre de coupure des notifications de l'espace. |
MuteSetting
Types de paramètres de désactivation des notifications d'un espace.
| Enums | |
|---|---|
MUTE_SETTING_UNSPECIFIED |
Réservé. |
UNMUTED |
L'utilisateur recevra des notifications pour l'espace en fonction du paramètre de notification. |
MUTED |
L'utilisateur ne recevra aucune notification pour l'espace, quel que soit le paramètre de notification. |
NotificationSetting
Types de paramètres de notification. D'autres types pourraient être pris en charge à l'avenir.
| Enums | |
|---|---|
NOTIFICATION_SETTING_UNSPECIFIED |
Réservé. |
ALL |
Les notifications sont déclenchées par les @mentions, les fils de discussion suivis et le premier message des nouveaux fils de discussion. Tous les nouveaux fils de discussion sont automatiquement suivis, sauf si l'utilisateur s'en désabonne manuellement. |
MAIN_CONVERSATIONS |
La notification est déclenchée par les @mentions, les fils de discussion suivis et le premier message des nouveaux fils de discussion. Non disponible pour les messages privés. |
FOR_YOU |
La notification est déclenchée par les @mentions et les fils de discussion suivis. Non disponible pour les messages privés. |
OFF |
La notification est désactivée. |
SpaceReadState
État de lecture d'un utilisateur dans un espace, utilisé pour identifier les messages lus et non lus.
| Champs | |
|---|---|
name |
Nom de ressource de l'état de lecture de l'espace. Format : |
last_read_time |
Facultatif. Heure à laquelle l'état de lecture de l'espace de l'utilisateur a été mis à jour. En général, cela correspond au code temporel du dernier message lu ou à un code temporel spécifié par l'utilisateur pour marquer la dernière position lue 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 |
Espace mis à jour. |
SpaceView
Vue spécifiant les champs à renseigner sur la ressource Space. Pour assurer la compatibilité avec les futures versions, nous vous recommandons de prendre en compte les valeurs supplémentaires dans votre code.
| Enums | |
|---|---|
SPACE_VIEW_UNSPECIFIED |
Valeur par défaut / non définie. |
SPACE_VIEW_RESOURCE_NAME_ONLY |
Indique uniquement le nom de la ressource Space. |
SPACE_VIEW_EXPANDED |
Renseigne les champs de la ressource Space. Remarque : Le champ permissionSettings ne sera pas renseigné. Les requêtes qui spécifient SPACE_VIEW_EXPANDED doivent inclure des champs d'application permettant de lire les données de l'espace, par exemple https://www.googleapis.com/auth/chat.spaces ou https://www.googleapis.com/auth/chat.spaces.readonly. |
Thread
Un fil de discussion dans un espace Google Chat. Pour obtenir un exemple d'utilisation, consultez Démarrer un fil de discussion ou y répondre.
Si vous spécifiez un fil de discussion lors de la création d'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 |
Identifiant. Nom de ressource du fil de discussion. Exemple : |
thread_key |
Facultatif. Entrée pour créer ou mettre à jour un fil de discussion. Sinon, sortie uniquement. ID du fil de discussion. 4 000 caractères maximum. 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 des fils de discussion différents. Pour répondre dans un fil de discussion créé par une personne ou une autre application Chat, spécifiez plutôt le champ |
ThreadReadState
État de lecture d'un utilisateur dans un fil de discussion, utilisé pour identifier les messages lus et non lus.
| Champs | |
|---|---|
name |
Nom de ressource de l'état de lecture du fil de discussion. Format : |
last_read_time |
Heure à laquelle l'état de lecture du fil de discussion de l'utilisateur a été mis à jour. Il correspond généralement au code temporel du dernier message lu dans un fil de discussion. |
UpdateAvailabilityRequest
Message de requête pour la méthode UpdateAvailability.
| Champs | |
|---|---|
availability |
Obligatoire. Disponibilité à mettre à jour. |
update_mask |
Obligatoire. Liste des champs à mettre à jour. Seul le champ |
UpdateMembershipRequest
Message de requête pour mettre à jour une ressource Membership.
| Champs | |
|---|---|
membership |
Obligatoire. Ressource Membership à mettre à jour. Seuls les champs spécifiés par |
update_mask |
Obligatoire. Chemins d'accès aux champs à mettre à jour. Séparez les valeurs par une virgule ou utilisez Chemins de champ actuellement acceptés :
|
use_admin_access |
Facultatif. Lorsque la valeur est L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit "Gérer les conversations Chat et Espaces". Nécessite le champ d'application OAuth 2.0 |
UpdateMessageRequest
Requête de mise à jour d'un message.
| Champs | |
|---|---|
message |
Obligatoire. Message avec des champs mis à jour. |
update_mask |
Obligatoire. Chemins d'accès aux champs à mettre à jour. Séparez les valeurs par une virgule ou utilisez Chemins de champ actuellement acceptés :
|
allow_missing |
Facultatif. Si |
UpdateSectionRequest
Message de requête pour mettre à jour une section.
| Champs | |
|---|---|
section |
Obligatoire. Section à mettre à jour. |
update_mask |
Obligatoire. Masque permettant de spécifier les champs à mettre à jour. Chemins de champ actuellement acceptés :
|
UpdateSpaceNotificationSettingRequest
Requête de mise à jour des paramètres de notification de l'espace. Seule la mise à jour du paramètre de notification pour l'utilisateur appelant est acceptée.
| Champs | |
|---|---|
space_notification_setting |
Obligatoire. Le nom de ressource des paramètres de notification de l'espace doit être renseigné au format |
update_mask |
Obligatoire. Chemins de champ acceptés :
|
UpdateSpaceReadStateRequest
Message de requête pour l'API UpdateSpaceReadState.
| Champs | |
|---|---|
space_read_state |
Obligatoire. État de lecture de l'espace et champs à mettre à jour. Seule la mise à jour de l'état de lecture pour l'utilisateur appelant est acceptée. Pour faire référence à l'utilisateur appelant, définissez l'un des éléments suivants :
Format : users/{user}/spaces/{space}/spaceReadState |
update_mask |
Obligatoire. Chemins d'accès aux champs à mettre à jour. Chemins de champ actuellement acceptés :
Lorsque la valeur de Pour marquer l'espace comme lu, définissez |
UpdateSpaceRequest
Requête de mise à jour d'un seul espace.
| Champs | |
|---|---|
space |
Obligatoire. Espace avec les champs à mettre à jour. |
update_mask |
Obligatoire. Chemins d'accès aux champs mis à jour, séparés par une virgule s'il y en a plusieurs. Vous pouvez modifier les champs suivants pour un espace :
|
use_admin_access |
Facultatif. Lorsque la valeur est L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit "Gérer les conversations Chat et Espaces". Nécessite le champ d'application OAuth 2.0 Certaines valeurs |
Utilisateur
Un utilisateur dans Google Chat.
Lorsqu'elle est renvoyée en tant que résultat d'une requête, si votre application Chat s'authentifie en tant qu'utilisateur, la sortie d'une ressource User (comme dans les API Messages et Memberships) ne renseigne que les champs name et type pour les utilisateurs internes et externes, sauf s'ils sont membres de l'espace ou s'ils ont une affinité préalable avec l'utilisateur appelant.
| Champs | |
|---|---|
name |
Nom de ressource pour un Format : Pour
|
display_name |
Uniquement en sortie. Nom à afficher de l'utilisateur. Renseigné pour l'authentification de l'application et de l'utilisateur. Ce champ est toujours renseigné pour les requêtes effectuées avec l'authentification de l'application. Lorsque vous appelez les API Messages et Memberships avec l'authentification des utilisateurs, ce champ est renseigné pour les utilisateurs internes et externes pour le |
avatar_url |
Uniquement en sortie. URL de l'avatar de l'utilisateur. Lorsque vous appelez les API Messages et Memberships avec l'authentification des utilisateurs, ce champ est renseigné pour les utilisateurs internes et externes pour le |
email |
Uniquement en sortie. Adresse e-mail de l'utilisateur. Lorsque vous appelez les API Messages et Memberships avec l'authentification des utilisateurs, ce champ est renseigné pour les utilisateurs internes et externes pour le |
domain_id |
Identifiant unique du domaine Google Workspace de l'utilisateur. |
type |
Type d'utilisateur. |
is_anonymous |
Uniquement en sortie. Lorsque |
Type
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Valeur par défaut de l'énumération. N'UTILISEZ PAS CE CHAMP. |
HUMAN |
Utilisateur humain. |
BOT |
Utilisateur de l'application Chat. |
UserMentionMetadata
Métadonnées d'annotation pour les mentions d'utilisateurs (@).
| Champs | |
|---|---|
user |
L'utilisateur mentionné. |
type |
Type de mention d'utilisateur. |
Type
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Valeur par défaut de l'énumération. Ne pas utiliser. |
ADD |
Ajouter 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[] |
Liste de boutons. "Buttons" est également |
Champ d'union data. Un WidgetMarkup ne peut comporter qu'un seul des éléments suivants. Vous pouvez utiliser plusieurs champs WidgetMarkup pour afficher plus d'articles. data ne peut être qu'un des éléments suivants : |
|
text_paragraph |
Affichez un paragraphe de texte dans ce widget. |
image |
Affichez une image dans ce widget. |
key_value |
Affichez un élément clé-valeur dans ce widget. |
Bouton
Bouton A. Il peut s'agir d'un bouton de texte ou d'un bouton d'image.
| Champs | |
|---|---|
Champ d'union
|
|
text_button |
Bouton avec du texte et l'action |
image_button |
Bouton avec image et action |
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 |
Le nom de la méthode permet d'identifier la partie du formulaire qui a déclenché l'envoi du formulaire. 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[] |
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, imaginez trois boutons de report : "Reporter maintenant", "Reporter d'un jour" et "Reporter d'une semaine". Vous pouvez utiliser action method = snooze(), en transmettant le type et la durée de répétition dans la liste des paramètres de chaîne.
| Champs | |
|---|---|
key |
Nom du paramètre du script d'action. |
value |
Valeur du paramètre. |
Icône
Ensemble d'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
Image spécifiée par une URL et pouvant avoir une action onclick.
| Champs | |
|---|---|
image_url |
URL de l'image |
on_click |
L'action |
aspect_ratio |
Format de cette image (largeur et hauteur). Ce champ vous permet de réserver la bonne hauteur pour l'image en attendant qu'elle se charge. Il n'est pas destiné à remplacer le format intégré de l'image. Si ce champ n'est pas défini, le serveur le remplit en préchargeant l'image. |
ImageButton
Bouton d'image avec une action onclick.
| Champs | |
|---|---|
on_click |
L'action |
name |
Nom de ce |
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 |
Icône spécifiée par un |
icon_url |
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 certaines actions, comme un bouton onclick.
| Champs | |
|---|---|
top_label |
Texte du libellé supérieur. 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. |
content |
Texte du contenu. Le texte mis en forme est accepté et toujours obligatoire. 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. |
content_multiline |
Indique si le contenu doit être multiligne. |
bottom_label |
Texte du libellé inférieur. Le texte mis en forme est accepté. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme du texte dans les applications Google Chat et Mettre en forme du texte dans les modules complémentaires Google Workspace. |
on_click |
L'action |
Champ d'union icons. Au moins l'un des éléments "icons", top_label et bottom_label doit être défini. icons ne peut être qu'un des éléments suivants : |
|
icon |
Valeur d'énumération remplacée par l'API Chat par l'image d'icône correspondante. |
icon_url |
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 qu'un des éléments suivants : |
|
button |
Bouton sur lequel l'utilisateur peut cliquer pour déclencher une action. |
OnClick
Une action onclick (par exemple, ouvrir un lien).
| Champs | |
|---|---|
Champ d'union
|
|
action |
Une action de formulaire est déclenchée par cette action |
open_link |
Cette action |
OpenLink
Lien qui ouvre une nouvelle fenêtre.
| Champs | |
|---|---|
url |
URL à ouvrir. |
TextButton
Bouton avec du texte et l'action onclick.
| Champs | |
|---|---|
text |
Texte du bouton |
on_click |
L'action |
TextParagraph
Un paragraphe de texte. Le texte mis en forme est accepté. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme du texte dans les applications Google Chat et Mettre en forme du texte dans les modules complémentaires Google Workspace.
| Champs | |
|---|---|
text |
|