Index
ChatService
(interface)AccessoryWidget
(message)ActionResponse
(message)ActionResponse.ResponseType
(enum)ActionResponse.SelectionItems
(message)ActionResponse.UpdatedWidget
(message)ActionStatus
(message)Annotation
(message)AnnotationType
(enum)AttachedGif
(message)Attachment
(message)Attachment.Source
(enum)AttachmentDataRef
(message)CardWithId
(message)ChatSpaceLinkData
(message)CompleteImportSpaceRequest
(message)CompleteImportSpaceResponse
(message)ContextualAddOnMarkup
(message)ContextualAddOnMarkup.Card
(message)ContextualAddOnMarkup.Card.CardAction
(message)ContextualAddOnMarkup.Card.CardHeader
(message)ContextualAddOnMarkup.Card.CardHeader.ImageStyle
(enum)ContextualAddOnMarkup.Card.Section
(message)CreateMembershipRequest
(message)CreateMessageRequest
(message)CreateMessageRequest.MessageReplyOption
(enum)CreateReactionRequest
(message)CreateSpaceRequest
(message)CustomEmoji
(message)DeleteMembershipRequest
(message)DeleteMessageRequest
(message)DeleteReactionRequest
(message)DeleteSpaceRequest
(message)DeletionMetadata
(message)DeletionMetadata.DeletionType
(enum)Dialog
(message)DialogAction
(message)DriveDataRef
(message)DriveLinkData
(message)Emoji
(message)EmojiReactionSummary
(message)FindDirectMessageRequest
(message)GetAttachmentRequest
(message)GetMembershipRequest
(message)GetMessageRequest
(message)GetSpaceEventRequest
(message)GetSpaceReadStateRequest
(message)GetSpaceRequest
(message)GetThreadReadStateRequest
(message)Group
(message)HistoryState
(enum)ListMembershipsRequest
(message)ListMembershipsResponse
(message)ListMessagesRequest
(message)ListMessagesResponse
(message)ListReactionsRequest
(message)ListReactionsResponse
(message)ListSpaceEventsRequest
(message)ListSpaceEventsResponse
(message)ListSpacesRequest
(message)ListSpacesResponse
(message)MatchedUrl
(message)Membership
(message)Membership.MembershipRole
(enum)Membership.MembershipState
(enum)MembershipBatchCreatedEventData
(message)MembershipBatchDeletedEventData
(message)MembershipBatchUpdatedEventData
(message)MembershipCreatedEventData
(message)MembershipDeletedEventData
(message)MembershipUpdatedEventData
(message)Message
(message)MessageBatchCreatedEventData
(message)MessageBatchDeletedEventData
(message)MessageBatchUpdatedEventData
(message)MessageCreatedEventData
(message)MessageDeletedEventData
(message)MessageUpdatedEventData
(message)QuotedMessageMetadata
(message)Reaction
(message)ReactionBatchCreatedEventData
(message)ReactionBatchDeletedEventData
(message)ReactionCreatedEventData
(message)ReactionDeletedEventData
(message)RichLinkMetadata
(message)RichLinkMetadata.RichLinkType
(enum)SearchSpacesRequest
(message)SearchSpacesResponse
(message)SetUpSpaceRequest
(message)SlashCommand
(message)SlashCommandMetadata
(message)SlashCommandMetadata.Type
(enum)Space
(message)Space.AccessSettings
(message)Space.AccessSettings.AccessState
(enum)Space.MembershipCount
(message)Space.PermissionSetting
(message)Space.PermissionSettings
(message)Space.PredefinedPermissionSettings
(enum)Space.SpaceDetails
(message)Space.SpaceThreadingState
(enum)Space.SpaceType
(enum)Space.Type
(enum)SpaceBatchUpdatedEventData
(message)SpaceEvent
(message)SpaceReadState
(message)SpaceUpdatedEventData
(message)Thread
(message)ThreadReadState
(message)UpdateMembershipRequest
(message)UpdateMessageRequest
(message)UpdateSpaceReadStateRequest
(message)UpdateSpaceRequest
(message)User
(message)User.Type
(enum)UserMentionMetadata
(message)UserMentionMetadata.Type
(enum)WidgetMarkup
(message)WidgetMarkup.Button
(message)WidgetMarkup.FormAction
(message)WidgetMarkup.FormAction.ActionParameter
(message)WidgetMarkup.Icon
(enum)WidgetMarkup.Image
(message)WidgetMarkup.ImageButton
(message)WidgetMarkup.KeyValue
(message)WidgetMarkup.OnClick
(message)WidgetMarkup.OpenLink
(message)WidgetMarkup.TextButton
(message)WidgetMarkup.TextParagraph
(message)
ChatService
Permet aux développeurs de créer des applications et des intégrations Chat sur la plate-forme Google Chat.
CompleteImportSpace |
---|
Effectue le processus d'importation de l'espace spécifié et le rend visible par les utilisateurs. Nécessite l'authentification de l'application et la délégation au niveau du domaine. Pour en savoir plus, consultez Autoriser les applications Google Chat à importer des données.
|
CreateMembership |
---|
Crée un abonnement pour l'application Chat appelante, un utilisateur ou un groupe Google. Il n'est pas possible de créer des abonnements pour d'autres applications Chat. Lors de la création d'un abonnement, si le membre spécifié a désactivé la règle d'acceptation automatique, il est invité et doit accepter l'invitation à l'espace avant de rejoindre l'espace. Sinon, créer un abonnement ajoute le membre directement à l'espace spécifié. Nécessite une authentification de l'utilisateur. Pour en savoir plus sur l'utilisation, consultez les pages suivantes:
|
CreateMessage |
---|
Crée un message dans un espace Google Chat. Pour obtenir un exemple, consultez la section Envoyer un message. La méthode L'image suivante montre comment Chat attribue un message lorsque vous utilisez l'authentification par application. Chat affiche l'application Chat en tant qu'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 utilisateur. Chat présente l'utilisateur en tant qu'expéditeur du message et attribue l'application Chat au message en affichant son nom. Le contenu du message ne peut contenir que du texte ( La taille maximale du message, contenu inclus, est de 32 000 octets.
|
CreateReaction |
---|
Crée une réaction et l'ajoute à un message. Seuls les emoji Unicode sont acceptés. Pour obtenir un exemple, consultez Ajouter une réaction à un message. Nécessite une authentification de l'utilisateur.
|
CreateSpace |
---|
Crée un espace nommé. Les espaces dont les groupes sont regroupés par sujet ne sont pas acceptés. Pour obtenir un exemple, consultez Créer un espace. Si le message d'erreur Nécessite une authentification de l'utilisateur.
|
DeleteMembership |
---|
Supprime un abonnement. Pour obtenir un exemple, consultez Exclure un utilisateur ou une application Google Chat d'un espace. Nécessite une authentification de l'utilisateur.
|
DeleteMessage |
---|
Supprime un message. Pour obtenir un exemple, consultez la section Supprimer un message. Nécessite une authentification. Accepte l'authentification des applications et l'authentification des utilisateurs. Lorsque vous utilisez l'authentification des applications, les requêtes ne peuvent supprimer que les messages créés par l'application Chat qui est à l'origine de l'appel.
|
DeleteReaction |
---|
Supprime une réaction à un message. Seuls les emoji Unicode sont acceptés. Vous trouverez un exemple dans la section Supprimer une réaction. Nécessite une authentification de l'utilisateur.
|
DeleteSpace |
---|
Supprime un espace nommé. Effectue toujours une suppression en cascade, ce qui signifie que les ressources enfants de l'espace, telles que les messages publiés et les membres de l'espace, sont également supprimées. Vous trouverez un exemple dans la section Supprimer un espace. Requiert une authentification de la part d'un utilisateur autorisé à supprimer l'espace.
|
FindDirectMessage |
---|
Renvoie le message privé existant avec l'utilisateur spécifié. Si aucun espace de message privé n'est trouvé, une erreur Avec l'authentification de l'utilisateur, renvoie l'espace de messages privés entre l'utilisateur spécifié et l'utilisateur authentifié. Avec l'authentification de l'application, renvoie l'espace de message privé entre l'utilisateur spécifié et l'application Chat appelante. Nécessite l'authentification des utilisateurs ou l'authentification des applications.
|
GetAttachment |
---|
Récupère les métadonnées d'une pièce jointe. Les données des pièces jointes sont récupérées à l'aide de l'API multimédia. Pour obtenir un exemple, consultez Obtenir les métadonnées d'une pièce jointe à un message. Nécessite l'authentification de l'application.
|
GetMembership |
---|
Affiche les détails d'un abonnement. Pour obtenir un exemple, consultez Obtenir des informations sur l'adhésion d'un utilisateur ou d'une application Google Chat. Nécessite une authentification. Accepte l'authentification des applications et l'authentification des utilisateurs.
|
GetMessage |
---|
Affiche les détails d'un message. Pour obtenir un exemple, consultez Obtenir des informations sur un message. Nécessite une authentification. Accepte l'authentification des applications et l'authentification des utilisateurs. Remarque: il est possible que vous receviez un message d'un membre ou d'un espace bloqué.
|
GetSpace |
---|
Affiche les détails d'un espace. Pour obtenir un exemple, consultez Obtenir des informations sur un espace. Nécessite une authentification. Accepte l'authentification des applications et l'authentification des utilisateurs.
|
GetSpaceEvent |
---|
Affiche un événement d'un espace Google Chat. La charge utile de l'événement contient la version la plus récente de la ressource qui a été modifiée. Par exemple, si vous demandez un événement concernant un nouveau message, mais que le message a été mis à jour ultérieurement, le serveur renvoie la ressource Nécessite une authentification de l'utilisateur. Pour obtenir un événement, l'utilisateur authentifié doit être membre de l'espace. Pour obtenir un exemple, consultez Obtenir des informations sur un événement dans un espace Google Chat.
|
GetSpaceReadState |
---|
Affiche des détails sur l'état de lecture d'un utilisateur dans un espace, permettant d'identifier les messages lus et non lus. Pour obtenir un exemple, consultez Obtenir des informations sur l'état de lecture d'un espace utilisateur. Nécessite une authentification de l'utilisateur.
|
GetThreadReadState |
---|
Affiche des détails sur l'état de lecture d'un utilisateur dans un fil de discussion, permettant d'identifier les messages lus et non lus. Pour obtenir un exemple, consultez Obtenir des informations sur l'état de lecture d'un thread d'un utilisateur. Nécessite une authentification de l'utilisateur.
|
ListMemberships |
---|
Liste les membres d'un espace. Pour obtenir un exemple, consultez Répertorier les utilisateurs et les applications Google Chat d'un espace. La liste des membres avec authentification des applications répertorie les membres des espaces auxquels l'application Chat a accès, mais exclut les membres de l'application Chat, y compris la sienne. Si vous répertoriez les adhésions avec l'authentification des utilisateurs, elles sont également répertoriées dans les espaces auxquels l'utilisateur authentifié a accès. Nécessite une authentification. Accepte l'authentification des applications et l'authentification des utilisateurs.
|
ListMessages |
---|
Liste les messages d'un espace dont l'appelant est membre, y compris les messages des membres et des espaces bloqués. Si vous répertoriez les messages d'un espace sans messages, la réponse est un objet vide. Lorsque vous utilisez une interface REST/HTTP, la réponse contient un objet JSON vide,
|
ListReactions |
---|
Liste les réactions à un message. Pour obtenir un exemple, consultez Répertorier les réactions à un message. Nécessite une authentification de l'utilisateur.
|
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 répertoriez des événements concernant les nouveaux membres d'un espace, le serveur renvoie les ressources Nécessite une authentification de l'utilisateur. Pour lister les événements, l'utilisateur authentifié doit être membre de l'espace. Pour obtenir un exemple, consultez Répertorier les événements d'un espace Google Chat.
|
ListSpaces |
---|
Répertorie les espaces dont l'appelant est membre. Les chats de groupe et les MP ne sont pas listés tant que le premier message n'a pas été envoyé. Pour obtenir un exemple, consultez Répertorier les espaces. Nécessite une authentification. Accepte l'authentification des applications et l'authentification des utilisateurs. Répertorie les espaces visibles par l'appelant ou l'utilisateur authentifié. Les chats de groupe et les MP ne sont pas listés tant que le premier message n'a pas été envoyé. Pour répertorier tous les espaces nommés par organisation Google Workspace, utilisez plutôt la méthode
|
SearchSpaces |
---|
use_admin_access sur true .
|
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é comme membre dans la demande. Pour obtenir un exemple, consultez Configurer un espace avec des membres initiaux. Pour spécifier les membres humains à ajouter, ajoutez des adhésions avec le Pour spécifier les groupes Google à ajouter, ajoutez des adhésions avec le Pour un espace nommé ou un chat de groupe, si l'appelant bloque, est bloqué par certains membres ou n'est pas autorisé à ajouter des membres, ceux-ci ne sont pas ajoutés à l'espace créé. Pour créer un message privé (MP) entre l'utilisateur appelant et un autre utilisateur humain, spécifiez exactement un abonnement pour le représenter. Si un utilisateur 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 un utilisateur bloque l'autre au moment où une demande est effectuée, le MP existant est renvoyé. Les espaces avec des réponses organisées en fils de discussion ne sont pas acceptées. Si le message d'erreur Nécessite une authentification de l'utilisateur.
|
UpdateMembership |
---|
Met à jour un abonnement. Pour obtenir un exemple, consultez Modifier l'appartenance d'un utilisateur à un espace. Nécessite une authentification de l'utilisateur.
|
UpdateMessage |
---|
Met à jour un message. Il existe une différence entre les méthodes Nécessite une authentification. Accepte l'authentification des applications et l'authentification des utilisateurs. Lorsque vous utilisez l'authentification d'application, les requêtes ne peuvent mettre à jour que les messages créés par l'application Chat qui est à l'origine de l'appel.
|
UpdateSpace |
---|
Met à jour un espace. Pour obtenir un exemple, consultez Mettre à jour un espace. Si vous mettez à jour le champ Nécessite une authentification de l'utilisateur.
|
UpdateSpaceReadState |
---|
Met à jour l'état de lecture d'un utilisateur dans un espace, permettant d'identifier les messages lus et non lus. Pour obtenir un exemple, consultez Modifier l'état de lecture d'un espace utilisateur. Nécessite une authentification de l'utilisateur.
|
AccessoryWidget
Un ou plusieurs widgets interactifs qui s'affichent au bas d'un message. Pour en savoir plus, consultez Ajouter des widgets interactifs au bas d'un message.
Champs | |
---|---|
Champ d'union action . Type d'action. action ne peut être qu'un des éléments suivants : |
|
button_list |
Liste de boutons. |
ActionResponse
Paramètres qu'une application de chat peut utiliser pour configurer la publication de sa réponse.
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 les configurer. (Uniquement pour les types de réponses |
dialog_action |
Uniquement en entrée. Réponse à un événement d'interaction lié à une dialog. Doit être accompagné 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é en tant que NEW_MESSAGE . |
NEW_MESSAGE |
Publier 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 dans le 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 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 des objets SelectionItem. |
UpdatedWidget
Réponse du widget mis à jour. Permet de fournir des options de saisie semi-automatique pour un widget.
Champs | |
---|---|
widget |
ID du widget mis à jour. L'ID doit correspondre à celui du widget qui a déclenché la requête de mise à jour. |
Champ d'union updated_widget . Widget mis à jour en réponse à une action de l'utilisateur. updated_widget ne peut être qu'un des éléments suivants : |
|
suggestions |
Liste des résultats de la saisie semi-automatique du widget |
ActionStatus
Représente l'état d'une requête visant à appeler ou à envoyer une boîte de dialogue.
Champs | |
---|---|
status_code |
Code d'état. |
user_facing_message |
Message à envoyer aux utilisateurs concernant l'état de leur demande. Si cette règle n'est pas configurée, un message générique basé sur |
Annotation
Uniquement en sortie. Annotations associées au corps en texte brut du message. Pour ajouter une mise en forme de base à un message, consultez Mettre en forme des messages texte.
Exemple de corps de message en texte brut:
Hello @FooBot how are you!"
Métadonnées des annotations correspondantes:
"annotations":[{
"type":"USER_MENTION",
"startIndex":6,
"length":7,
"userMention": {
"user": {
"name":"users/{user}",
"displayName":"FooBot",
"avatarUrl":"https://goo.gl/aeDtrS",
"type":"BOT"
},
"type":"MENTION"
}
}]
Champs | |
---|---|
type |
Type de l'annotation. |
length |
Longueur de la sous-chaîne dans le corps du message en texte brut à laquelle cette annotation correspond. |
start_index |
Index de départ (basé sur 0, inclus) dans le corps du message en texte brut auquel cette annotation correspond. |
Champ d'union metadata . Métadonnées supplémentaires concernant l'annotation. metadata ne peut être qu'un des éléments suivants : |
|
user_mention |
Métadonnées de la mention de l'utilisateur. |
slash_command |
Métadonnées d'une commande à barre oblique. |
rich_link_metadata |
Métadonnées d'un lien enrichi. |
AnnotationType
Type de l'annotation.
Enums | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Valeur par défaut de l'énumération. Ne pas utiliser. |
USER_MENTION |
Un utilisateur est mentionné. |
SLASH_COMMAND |
Une commande à barre oblique est appelée. |
RICH_LINK |
Annotation de lien enrichi. |
AttachedGif
Une image GIF spécifiée par une URL.
Champs | |
---|---|
uri |
Uniquement en sortie. URL qui héberge l'image GIF. |
Pièce jointe
Une pièce jointe dans Google Chat
Champs | |
---|---|
name |
Nom de ressource du rattachement, au format |
content_name |
Uniquement en sortie. Nom de fichier d'origine du contenu, pas 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 vignette à utiliser pour prévisualiser la pièce jointe et la montrer à un utilisateur humain. Les applications de chat ne doivent pas utiliser cette URL pour télécharger le contenu d'une pièce jointe. |
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 de chat ne doivent pas utiliser cette URL pour télécharger le contenu d'une pièce jointe. |
source |
Uniquement en sortie. Source du rattachement. |
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 |
Référence aux données de la pièce jointe. Ce champ est utilisé avec l'API Media pour télécharger les données des pièces jointes. |
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 du rattachement.
Enums | |
---|---|
SOURCE_UNSPECIFIED |
Réservé. |
DRIVE_FILE |
Il s'agit d'un fichier Google Drive. |
UPLOADED_CONTENT |
Le fichier est importé dans Chat. |
AttachmentDataRef
Référence aux données de la pièce jointe.
Champs | |
---|---|
resource_name |
Nom de ressource des données de rattachement. Ce champ est utilisé avec l'API Media pour télécharger les données des pièces jointes. |
attachment_upload_token |
Jeton opaque contenant une référence à une pièce jointe importée. Traitée par les clients comme une chaîne opaque et utilisée pour créer ou mettre à jour des messages Chat contenant des pièces jointes. |
CardWithId
Une fiche dans un message Google Chat
Seules les applications Chat peuvent créer des fiches. Si votre application Chat s'authentifie en tant qu'utilisateur, le message ne peut pas contenir de fiche.
Créez et prévisualisez des fiches avec Card Builder.
Ouvrir Card BuilderChamps | |
---|---|
card_id |
Obligatoire si le message contient plusieurs fiches. Identifiant unique d'une carte dans un message. |
card |
Une fiche La taille maximale est de 32 Ko. |
ChatSpaceLinkData
Données pour les liens d'espace 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 : |
CompleteImportSpaceRequest
Message de requête pour terminer le processus d'importation d'un espace.
Champs | |
---|---|
name |
Obligatoire. Nom de ressource de l'espace en mode d'importation. Format : |
CompleteImportSpaceResponse
Message de réponse pour la fin du processus d'importation d'un espace.
Champs | |
---|---|
space |
Espace en mode d'importation. |
ContextualAddOnMarkup
Ce type ne comporte aucun champ.
Balisage permettant aux développeurs de spécifier le contenu d'un module complémentaire contextuel.
Fiche
Une carte est un élément d'interface utilisateur qui peut contenir des widgets d'interface utilisateur, tels que du texte et des images.
Champs | |
---|---|
header |
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 un séparateur de lignes. |
card_actions[] |
Actions associées à cette fiche. |
name |
Nom de la carte. |
CardAction
Une action est associée à la fiche. Pour une fiche de facture, vous pouvez supprimer la facture, l'envoyer par e-mail ou ouvrir la facture dans un navigateur.
Non compatible avec les applications Google Chat.
Champs | |
---|---|
action_label |
Libellé qui apparaissait dans l'élément de menu d'actions. |
on_click |
L'action "onclick" pour cet élément d'action. |
CardHeader
Champs | |
---|---|
title |
Vous devez indiquer le titre. L'en-tête a une hauteur fixe: si un titre et un sous-titre sont tous les deux 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 carte. |
image_style |
Type de l'image (par exemple, bordure carrée ou bordure 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. Les propriétés de mise en page (par exemple, float, par exemple) ne sont donc pas nécessaires pour le moment.
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 le texte dans les applications Google Chat et Mettre en forme le texte dans les modules complémentaires Google Workspace. |
widgets[] |
Une section doit contenir au moins un widget. |
CreateMembershipRequest
Message de requête pour la création d'un abonnement.
Champs | |
---|---|
parent |
Obligatoire. Nom de ressource de l'espace pour lequel vous souhaitez créer l'abonnement. Format: espaces/{espace} |
membership |
Obligatoire. Relation d'appartenance à créer. Le champ |
use_admin_access |
true , la méthode s'exécute avec les droits d'administrateur Google Workspace de l'utilisateur.L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit de gérer les conversations Chat et Espaces. Nécessite le champ d'application OAuth 2.0 Il n'est pas possible de créer des adhésions à des applications ni pour des utilisateurs externes à l'organisation Google Workspace de l'administrateur. |
CreateMessageRequest
Crée un message.
Champs | |
---|---|
parent |
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 plutôt |
request_id |
Facultatif. Identifiant de requête unique pour ce message. Si vous indiquez un ID de requête existant, le message créé avec cet ID s'affiche au lieu d'en créer un autre. |
message_reply_option |
Facultatif. Indique si un message démarre un fil de discussion ou répond à un fil de discussion. Compatible uniquement avec les espaces nommés. |
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 Attribuer un nom à un message. |
MessageReplyOption
Indique 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. L'utilisation de cette option ignore toutes les valeurs thread ID ou incluses. |
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 . S'il échoue, le message démarre un nouveau fil de discussion. |
REPLY_MESSAGE_OR_FAIL |
Crée le message en tant que réponse au fil de discussion spécifié par thread ID ou . Si un nouveau thread_key est utilisé, un nouveau fil de discussion est créé. Si la création du message échoue, une erreur NOT_FOUND est renvoyée. |
CreateReactionRequest
Crée une réaction à un message.
Champs | |
---|---|
parent |
Obligatoire. Le message dans lequel la réaction est créée. Format : |
reaction |
Obligatoire. Réaction à créer. |
CreateSpaceRequest
Requête permettant de créer un espace nommé.
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. Si vous spécifiez un ID de requête existant, l'espace créé avec cet ID est renvoyé au lieu d'en créer un autre. Si vous spécifiez un ID de requête existant provenant de la même application Chat avec un autre utilisateur authentifié, une erreur est renvoyée. |
CustomEmoji
Représente un emoji personnalisé.
Champs | |
---|---|
uid |
Uniquement en sortie. Clé unique pour la ressource d'emoji personnalisé. |
DeleteMembershipRequest
Demande de suppression de membres d'un espace.
Champs | |
---|---|
name |
Obligatoire. Nom de ressource de l'appartenance à supprimer. Les applications de chat peuvent supprimer des utilisateurs ou de leurs propres abonnements. Les applications de chat ne peuvent pas supprimer d'autres applications les adhésions. Lors de la suppression d'une appartenance humaine, le champ d'application Lors de la suppression d'une adhésion à une application, le champ d'application Format: |
use_admin_access |
true , la méthode s'exécute avec les droits d'administrateur Google Workspace de l'utilisateur.L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit de gérer les conversations Chat et Espaces. Nécessite le champ d'application OAuth 2.0 Il n'est pas possible de supprimer des abonnements à des applications d'un espace à l'aide d'un accès administrateur. |
DeleteMessageRequest
Demande 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 |
Lorsqu'un message est S'applique uniquement lors de l'authentification en tant qu'utilisateur. Cela n'a aucun effet en cas d'authentification en tant qu'application Chat. |
DeleteReactionRequest
Supprime une réaction à un message.
Champs | |
---|---|
name |
Obligatoire. Nom de la réaction à supprimer. Format : |
DeleteSpaceRequest
Requête de suppression d'un espace.
Champs | |
---|---|
name |
Obligatoire. Nom de ressource de l'espace à supprimer. Format : |
use_admin_access |
true , la méthode s'exécute avec les droits d'administrateur Google Workspace de l'utilisateur.L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit de gérer les conversations Chat et Espaces. Nécessite le champ d'application OAuth 2.0 |
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
l'auteur et la manière dont le message a été supprimé.
Enums | |
---|---|
DELETION_TYPE_UNSPECIFIED |
Cette valeur n'est pas utilisée. |
CREATOR |
L'utilisateur a supprimé son propre message. |
SPACE_OWNER |
Le propriétaire de l'espace a supprimé le message. |
ADMIN |
Un administrateur Google Workspace a supprimé le message. |
APP_MESSAGE_EXPIRY |
Une application Chat a supprimé son propre message lorsqu'il a expiré. |
CREATOR_VIA_APP |
Une application Chat a supprimé le message pour le compte de l'utilisateur. |
SPACE_OWNER_VIA_APP |
Une application Chat a supprimé le message au nom du propriétaire de l'espace. |
Dialog
Enveloppe autour du corps de la fiche de la boîte de dialogue.
Champs | |
---|---|
body |
Uniquement en entrée. Corps de la boîte de dialogue, affiché sous forme de modale. Les applications Google Chat ne sont pas compatibles avec les entités de cartes suivantes: |
DialogAction
Contient une boîte de dialogue et un code d'état de la requête.
Champs | |
---|---|
action_status |
Uniquement en entrée. État d'une demande 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. |
DriveDataRef
Référence aux données d'un rattachement de disque.
Champs | |
---|---|
drive_file_id |
ID du fichier Drive. Utilisez-la avec l'API Drive. |
DriveLinkData
Données pour les associations à Google Drive.
Champs | |
---|---|
drive_data_ref |
Élément DriveDataRef qui référence un fichier Google Drive. |
mime_type |
Type MIME de la ressource Google Drive associée. |
Emoji
Emoji utilisé comme réaction à un message.
Champs | |
---|---|
Champ d'union content . Contenu de l'emoji. content ne peut être qu'un des éléments suivants : |
|
unicode |
Emoji de base représenté par une chaîne Unicode. |
custom_emoji |
Uniquement en sortie. Un emoji personnalisé. |
EmojiReactionSummary
Nombre de personnes ayant réagi à un message avec un emoji spécifique.
Champs | |
---|---|
emoji |
Emoji associés aux réactions. |
reaction_count |
Nombre total de réactions avec l'emoji associé. |
FindDirectMessageRequest
Requête d'obtention d'un espace de message privé en fonction de la ressource utilisateur.
Champs | |
---|---|
name |
Obligatoire. Nom de ressource de l'utilisateur avec lequel rechercher le message privé. Format: |
GetAttachmentRequest
Requête d'obtention d'une pièce jointe.
Champs | |
---|---|
name |
Obligatoire. Nom de ressource du rattachement, au format |
GetMembershipRequest
Demande d'adhésion à un espace.
Champs | |
---|---|
name |
Obligatoire. Nom de ressource de l'appartenance à récupérer. Pour obtenir l'appartenance à l'application en utilisant l'authentification de l'utilisateur, vous pouvez éventuellement utiliser Format: Une fois authentifié en tant qu'utilisateur, vous pouvez utiliser son adresse e-mail comme alias pour |
use_admin_access |
true , la méthode s'exécute avec les droits d'administrateur Google Workspace de l'utilisateur.L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit de gérer les conversations Chat et Espaces. Nécessite les champs d'application OAuth 2.0 Il n'est pas possible de souscrire des abonnements à des applications dans un espace lorsque vous utilisez 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 |
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 : |
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. Prend uniquement en charge l'obtention de l'état de lecture pour l'utilisateur appelant. Pour faire référence à l'utilisateur appelant, définissez l'une des options suivantes:
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 |
true , la méthode s'exécute avec les droits d'administrateur Google Workspace de l'utilisateur.L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit de gérer les conversations Chat et Espaces. Nécessite 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 thread à récupérer. Prend uniquement en charge l'obtention de l'état de lecture pour l'utilisateur appelant. Pour faire référence à l'utilisateur appelant, définissez l'une des options suivantes:
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. |
ListMembershipsRequest
Message de requête pour la liste des adhésions.
Champs | |
---|---|
parent |
Obligatoire. Nom de ressource de l'espace pour lequel extraire une liste de membres. Format: espaces/{espace} |
page_size |
Facultatif. Nombre maximal d'adhésions à renvoyer. Le service peut renvoyer moins que cette valeur. Si aucune valeur n'est spécifiée, 100 adhésions au maximum sont renvoyées. La valeur maximale est 1 000. Si vous utilisez une valeur supérieure à 1 000, elle est automatiquement remplacée par 1 000. Les valeurs négatives renvoient une erreur |
page_token |
Facultatif. Jeton de page, reçu d'un appel précédent pour répertorier les adhésions. Indiquez ce paramètre pour récupérer la page suivante. Lors de la pagination, tous les autres paramètres fournis doivent correspondre à l'appel qui a fourni le jeton de page. 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 adhésions par rôle ( Pour filtrer par rôle, définissez Pour filtrer par type, définissez Pour filtrer par rôle et par type, utilisez l'opérateur Lorsque 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 |
show_invited |
Facultatif. Lorsque Cette fonctionnalité nécessite actuellement une authentification de l'utilisateur. |
use_admin_access |
true , la méthode s'exécute avec les droits d'administrateur Google Workspace de l'utilisateur.L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit de gérer les conversations Chat et Espaces. Nécessite le champ d'application OAuth 2.0 Il n'est pas possible de lister les abonnements à des applications dans un espace lorsque vous utilisez l'accès administrateur. |
ListMembershipsResponse
Réponse à la liste des membres de l'espace.
Champs | |
---|---|
memberships[] |
Liste à puces. Liste des adhésions sur la page demandée (ou la première page). |
next_page_token |
Jeton que vous pouvez envoyer en tant que |
ListMessagesRequest
Liste les messages de l'espace spécifié dont l'utilisateur est membre.
Champs | |
---|---|
parent |
Obligatoire. Nom de ressource de l'espace à partir duquel répertorier les messages. Format : |
page_size |
Nombre maximal de messages renvoyés. Le service peut renvoyer moins de messages que cette valeur. Si aucune valeur n'est spécifiée, 25 valeurs au maximum sont renvoyées. La valeur maximale est 1 000. Si vous utilisez une valeur supérieure à 1 000, elle est automatiquement remplacée par 1 000. Les valeurs négatives renvoient une erreur |
page_token |
Facultatif, si vous reprenez une requête précédente. Jeton de page reçu d'un précédent appel de liste de messages. Indiquez ce paramètre pour récupérer la page suivante. Lors de la pagination, tous les autres paramètres fournis doivent correspondre à l'appel qui a fourni le jeton de page. La transmission de valeurs différentes aux autres paramètres peut entraîner des résultats inattendus. |
filter |
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 thread, spécifiez l'élément 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, si vous reprenez une requête précédente. Façon dont la liste des messages est organisée. Spécifiez une valeur à trier par le biais d'une opération de tri. Les valeurs valides pour les opérations de tri sont les suivantes:
L'ordre par défaut est |
show_deleted |
Permet d'inclure ou non les messages supprimés. Les messages supprimés incluent l'heure et les métadonnées concernant leur suppression, mais leur contenu n'est pas disponible. |
ListMessagesResponse
Message de réponse pour la liste des messages.
Champs | |
---|---|
messages[] |
Liste des messages. |
next_page_token |
Vous pouvez envoyer un jeton en tant que |
ListReactionsRequest
Liste 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 moins de réactions que cette valeur. Si aucune valeur n'est spécifiée, la valeur par défaut est 25. La valeur maximale est 200. les valeurs supérieures à 200 sont remplacées par 200. |
page_token |
Facultatif. (Si vous reprenez une requête précédente.) Jeton de page reçu d'un précédent appel de réactions à une liste. Fournissez-le pour récupérer la page suivante. Lors de la pagination, la valeur du filtre doit correspondre à l'appel qui a 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 ( Afin de filtrer les réactions pour plusieurs emoji ou utilisateurs, joignez des champs similaires avec 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 par le serveur avec une erreur |
ListReactionsResponse
Réponse à une demande 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 continuité pour récupérer la page de résultats suivante. Ce champ est vide pour la dernière page de résultats. |
ListSpaceEventsRequest
Message de requête pour lister les événements de l'espace.
Champs | |
---|---|
parent |
Obligatoire. Nom de la 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 moins que cette valeur. Les valeurs négatives renvoient une erreur |
page_token |
Jeton de page reçu d'un appel d'événement de liste précédent. Fournissez-le pour récupérer la page suivante. Lors de la pagination, tous les autres paramètres fournis pour lister les événements d'espace doivent correspondre à l'appel qui a fourni le jeton de page. 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 est égal(e) à 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 la liste des événements de l'espace.
Champs | |
---|---|
space_events[] |
Les résultats sont renvoyés dans l'ordre chronologique (les événements les plus anciens en premier). |
next_page_token |
Jeton de continuation utilisé pour récupérer plus d'é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 moins que cette valeur. Si aucune valeur n'est spécifiée, 100 espaces au maximum sont renvoyés. La valeur maximale est 1 000. Si vous utilisez une valeur supérieure à 1 000, elle est automatiquement remplacée par 1 000. Les valeurs négatives renvoient une erreur |
page_token |
Facultatif. Jeton de page, reçu d'un appel de liste précédent d'espaces. Indiquez ce paramètre pour récupérer la page suivante. Lors de la pagination, la valeur du filtre doit correspondre à l'appel qui a 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 d'affichage de la liste des espaces.
Champs | |
---|---|
spaces[] |
Liste des espaces sur la page demandée (ou la première page). |
next_page_token |
Vous pouvez envoyer un jeton en tant que |
MatchedUrl
URL correspondante dans un message Chat. Les applications de chat peuvent prévisualiser les URL correspondantes. Pour en savoir plus, consultez Liens d'aperçu.
Champs | |
---|---|
url |
Uniquement en sortie. URL correspondante. |
Abonnement
Représente une relation d'appartenance dans Google Chat (par exemple, un utilisateur ou une application Chat est invité, fait partie ou absent d'un espace).
Champs | |
---|---|
name |
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 autorisées dans l'espace. Ce champ ne peut être utilisé que comme entrée dans |
create_time |
Facultatif. Immuable. Heure de création de l'abonnement, par exemple quand un membre a rejoint un espace ou y a été invité. Ce champ ne sert que de sortie, sauf s'il est utilisé pour importer des adhésions historiques dans des espaces en mode importation. |
delete_time |
Facultatif. Immuable. Heure de suppression de l'abonnement, par exemple le moment où un membre a quitté un espace ou en a été exclu. Ce champ ne sert que de sortie, sauf s'il est utilisé pour importer des adhésions historiques dans des espaces en mode importation. |
Champ d'union memberType . Membre associé à cet abonnement. D'autres types de membres pourraient être acceptés à l'avenir. memberType ne peut être qu'un des éléments suivants : |
|
member |
Application ou utilisateur Google Chat auquel l'abonnement correspond. Si votre application Chat s'authentifie en tant qu'utilisateur, la sortie renseigne les champs user |
group_member |
Groupe Google auquel l'appartenance correspond. |
MembershipRole
Représente les actions autorisées d'un utilisateur dans un espace Chat. D'autres valeurs d'énumération pourront être ajoutées à l'avenir.
Enums | |
---|---|
MEMBERSHIP_ROLE_UNSPECIFIED |
Valeur par défaut. Pour users : cette personne ne fait pas partie de l'espace, mais peut être invitée. Pour Google Groups : ce rôle leur est toujours attribué (d'autres valeurs d'énumération pourront être utilisées à l'avenir). |
ROLE_MEMBER |
un membre de l'espace ; L'utilisateur dispose d'autorisations de base, comme l'envoi de messages à l'espace. Dans les conversations de groupe privées et sans nom, tout le monde a ce rôle. |
ROLE_MANAGER |
Un gestionnaire de l'espace. L'utilisateur dispose de toutes les autorisations de base, ainsi que des autorisations d'administration qui lui permettent de gérer l'espace (ajouter ou supprimer des membres, par exemple). Disponible uniquement en SpaceType.SPACE . |
MembershipState
Spécifie la relation du membre avec un espace. D'autres états d'adhésion pourraient être acceptés à l'avenir.
Enums | |
---|---|
MEMBERSHIP_STATE_UNSPECIFIED |
Valeur par défaut. Ne pas utiliser. |
JOINED |
L'utilisateur est ajouté à l'espace et peut y participer. |
INVITED |
L'utilisateur est invité à rejoindre l'espace, mais il ne l'a pas 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 de l'événement pour plusieurs nouvelles adhésions.
Type d'événement: google.workspace.chat.membership.v1.batchCreated
Champs | |
---|---|
memberships[] |
Liste des nouveaux abonnements. |
MembershipBatchDeletedEventData
Charge utile de l'événement pour plusieurs abonnements supprimés.
Type d'événement: google.workspace.chat.membership.v1.batchDeleted
Champs | |
---|---|
memberships[] |
Liste des abonnements supprimés. |
MembershipBatchUpdatedEventData
Charge utile de l'événement pour plusieurs abonnements mis à jour.
Type d'événement: google.workspace.chat.membership.v1.batchUpdated
Champs | |
---|---|
memberships[] |
Liste des adhésions mises à jour. |
MembershipCreatedEventData
Charge utile de l'événement pour une nouvelle adhésion.
Type d'événement: google.workspace.chat.membership.v1.created
.
Champs | |
---|---|
membership |
Le nouvel abonnement. |
MembershipDeletedEventData
Charge utile de l'événement pour un abonnement supprimé.
Type d'événement: google.workspace.chat.membership.v1.deleted
Champs | |
---|---|
membership |
L'abonnement supprimé. Seuls les champs |
MembershipUpdatedEventData
Charge utile de l'événement pour un abonnement mis à jour.
Type d'événement: google.workspace.chat.membership.v1.updated
Champs | |
---|---|
membership |
Abonnement mis à jour. |
Message
Un message dans un espace Google Chat
Champs | |
---|---|
name |
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, la sortie renseigne les champs user |
create_time |
Facultatif. Immuable. Pour les espaces créés dans Chat, heure à laquelle le message a été créé. Ce champ sert uniquement de sortie, sauf lorsqu'il est utilisé dans des espaces en mode importation. Pour les espaces en mode importation, définissez ce champ sur l'horodatage historique de la création du message 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 |
Corps en texte brut du message. 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 en savoir plus sur la création de SMS, 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ée dans un message. |
cards[] |
Obsolète: utilisez plutôt Fiches enrichies, mises en forme et interactives, que vous pouvez utiliser pour afficher des éléments d'interface utilisateur tels que des textes mis en forme, des boutons et des images cliquables. Les cartes s'affichent normalement sous le corps en texte brut du message. La taille maximale de |
cards_v2[] |
Tableau de fiches. Seules les applications Chat peuvent créer des fiches. Si votre application Chat s'authentifie en tant qu'utilisateur, les messages ne peuvent pas contenir de fiches. Pour savoir comment créer un message contenant des fiches, consultez Envoyer un message. Créez et prévisualisez des fiches avec Card Builder. Ouvrir Card Builder |
annotations[] |
Uniquement en sortie. Annotations associées à |
thread |
Fil de discussion auquel appartient le message. Pour obtenir des exemples d'utilisation, consultez Démarrer un fil de discussion ou y répondre. |
space |
Si votre application Chat s'authentifie en tant qu'utilisateur, la sortie renseigne l'espace |
fallback_text |
Description en texte brut des cartes du message, utilisée lorsque les cartes ne peuvent pas être affichées (notifications mobiles, par exemple). |
action_response |
Uniquement en entrée. Paramètres qu'une application de chat peut utiliser pour configurer la publication de sa réponse. |
argument_text |
Uniquement en sortie. Corps en texte brut du message avec toutes les mentions de l'application Chat supprimées. |
slash_command |
Uniquement en sortie. Les informations sur la commande à barre oblique, le cas échéant. |
attachment[] |
Pièce jointe importée par un utilisateur. |
matched_url |
Uniquement en sortie. URL dans |
thread_reply |
Uniquement en sortie. Lorsque la valeur est Si l'espace ne permet pas de répondre dans les fils de discussion, ce champ est toujours défini sur |
client_assigned_message_id |
Facultatif. ID personnalisé du message. Vous pouvez utiliser des champs 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 sur le message. |
private_message_viewer |
Immuable. Entrée pour la création d'un message, sinon sortie uniquement. Utilisateur autorisé à consulter le message. Lorsque ce paramètre est défini, le message est privé et uniquement visible par l'utilisateur spécifié et l'application Chat. Les aperçus des liens et les pièces jointes ne sont pas compatibles avec les messages privés. Seules les applications Chat peuvent envoyer des messages privés. Si votre application Chat s'authentifie en tant qu'utilisateur pour envoyer un message, le message ne peut pas être privé et doit omettre ce champ. Pour en savoir plus, consultez Envoyer un message en mode privé. |
deletion_metadata |
Uniquement en sortie. Informations sur un message supprimé. Un message est supprimé lorsque |
quoted_message_metadata |
Uniquement en sortie. Informations sur un message cité par un utilisateur Google Chat dans un espace. Les utilisateurs de Google Chat peuvent citer un message pour y répondre. |
attached_gifs[] |
Uniquement en sortie. Images GIF jointes au message. |
accessory_widgets[] |
Un ou plusieurs widgets interactifs qui s'affichent au bas d'un message. Vous pouvez ajouter des widgets accessoires aux messages qui contiennent du texte, des cartes ou les deux. Non compatible avec les messages contenant des boîtes de dialogue. Pour en savoir plus, consultez Ajouter des widgets interactifs au bas d'un message. La création d'un message avec des widgets accessoires nécessite l'authentification de l'application. |
MessageBatchCreatedEventData
Charge utile de l'événement pour plusieurs nouveaux messages.
Type d'événement: google.workspace.chat.message.v1.batchCreated
Champs | |
---|---|
messages[] |
Liste des nouveaux messages. |
MessageBatchDeletedEventData
Charge utile de l'é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 de l'é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 de l'événement pour un nouveau message.
Type d'événement: google.workspace.chat.message.v1.created
Champs | |
---|---|
message |
Nouveau message. |
MessageDeletedEventData
Charge utile de l'événement pour un message supprimé.
Type d'événement: google.workspace.chat.message.v1.deleted
Champs | |
---|---|
message |
Message supprimé. Seuls les champs |
MessageUpdatedEventData
Charge utile de l'événement pour un message mis à jour.
Type d'événement: google.workspace.chat.message.v1.updated
Champs | |
---|---|
message |
Message mis à jour. |
QuotedMessageMetadata
Informations sur un message cité.
Champs | |
---|---|
name |
Uniquement en sortie. Nom de ressource du message entre guillemets. Format : |
last_update_time |
Uniquement en sortie. Horodatage de la création ou de la dernière mise à jour du message cité. |
Réaction
Réaction à un message.
Champs | |
---|---|
name |
Nom de ressource de la réaction. Format : |
user |
Uniquement en sortie. Utilisateur qui a créé la réaction. |
emoji |
Emoji utilisé dans la réaction. |
ReactionBatchCreatedEventData
Charge utile de l'événement pour plusieurs nouvelles réactions.
Type d'événement: google.workspace.chat.reaction.v1.batchCreated
Champs | |
---|---|
reactions[] |
Liste des nouvelles réactions. |
ReactionBatchDeletedEventData
Charge utile de l'événement pour plusieurs réactions supprimées.
Type d'événement: google.workspace.chat.reaction.v1.batchDeleted
Champs | |
---|---|
reactions[] |
Liste des réactions supprimées. |
ReactionCreatedEventData
Charge utile de l'événement pour une nouvelle réaction.
Type d'événement: google.workspace.chat.reaction.v1.created
Champs | |
---|---|
reaction |
La nouvelle réaction. |
ReactionDeletedEventData
Charge utile de l'événement pour une réaction supprimée.
Type : google.workspace.chat.reaction.v1.deleted
Champs | |
---|---|
reaction |
Réaction supprimée. |
RichLinkMetadata
Lien enrichi vers une ressource.
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 d'espace Chat. |
RichLinkType
Type de lien enrichi. D'autres types pourront être ajoutés à l'avenir.
Enums | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
Valeur par défaut de l'énumération. Ne pas utiliser. |
DRIVE_FILE |
Lien enrichi Google Drive. |
CHAT_SPACE |
Lien enrichi d'un espace Chat. (par exemple, un chip d'espace intelligent). |
SearchSpacesRequest
Requête de recherche d'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 de gérer les conversations Chat et Espaces. Nécessite le champ d'application OAuth 2.0 Actuellement, cette méthode n'accepte que l'accès administrateur. Par conséquent, seul |
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 1 000. Si vous utilisez une valeur supérieure à 1 000, elle est automatiquement remplacée par 1 000. |
page_token |
Jeton reçu de l'appel précédent dans les espaces de recherche. Indiquez ce paramètre pour récupérer la page suivante. Lors de la pagination, tous les autres paramètres fournis doivent correspondre à l'appel qui a fourni le jeton de page. 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:
Dans les différents champs, seuls les opérateurs Parmi le même champ, Les exemples de requêtes suivants sont valides:
|
order_by |
Facultatif. Façon dont la liste des espaces est organisée. Les attributs acceptés pour trier par sont les suivants:
Les valeurs valides pour les opérations de tri sont les suivantes:
La syntaxe acceptée est la suivante:
|
SearchSpacesResponse
Réponse avec une liste d'espaces correspondant à la requête d'espaces de recherche.
Champs | |
---|---|
spaces[] |
Une page des espaces demandés. |
next_page_token |
Jeton permettant de récupérer la page suivante. Si ce champ est vide, il n'y a pas de pages suivantes. |
total_size |
Nombre total d'espaces correspondant à la requête, sur l'ensemble des pages. Si le résultat est supérieur à 10 000 espaces, cette valeur est une estimation. |
SetUpSpaceRequest
Demande de création d'un espace et d'ajout des utilisateurs spécifiés à celui-ci.
Champs | |
---|---|
space |
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 réviseurs humains, définissez Pour créer une conversation privée entre une personne et l'application Chat qui est à l'origine de l'appel, définissez Si un espace |
request_id |
Facultatif. Identifiant unique de cette requête. Nous vous recommandons d'utiliser un UUID aléatoire. Si vous spécifiez un ID de requête existant, l'espace créé avec cet ID est renvoyé au lieu d'en créer un autre. Si vous spécifiez un ID de requête existant provenant de la même application Chat avec un autre utilisateur authentifié, une erreur est renvoyée. |
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'à 20 adhésions (en plus de l'appelant). Pour les membres humains, le champ Pour les membres d'un groupe Google, le champ Facultatif lorsque vous définissez Obligatoire lorsque vous définissez Obligatoire lorsque vous définissez Ce champ doit être vide lors de la création d'une conversation privée entre un humain et l'application Chat qui est à l'origine de l'appel (lorsque vous définissez |
SlashCommand
Une commande à barre oblique dans Google Chat
Champs | |
---|---|
command_id |
ID de la commande à barre oblique appelée. |
SlashCommandMetadata
Métadonnées d'annotation pour les commandes à barre oblique (/).
Champs | |
---|---|
bot |
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 |
Ajoutez l'application Chat à l'espace. |
INVOKE |
Appelez une commande à barre oblique dans l'espace. |
Espace
Un espace dans Google Chat Les espaces sont des conversations entre deux utilisateurs ou plus, ou des messages 1:1 entre un utilisateur et une application Chat.
Champs | |
---|---|
name |
Nom de ressource de l'espace. Format : Où |
type |
Uniquement en sortie. Obsolète: utilisez plutôt |
space_type |
Type d'espace. Obligatoire pour créer un espace ou modifier son type. Sortie uniquement pour les autres utilisations. |
single_user_bot_dm |
Facultatif. Indique si l'espace est un MP entre une application Chat et une seule personne. |
threaded |
Uniquement en sortie. Obsolète: utilisez plutôt |
display_name |
Nom à afficher de l'espace. Obligatoire lors de la création d'un espace. Si le message d'erreur Pour les messages privés, ce champ peut être vide. Il peut contenir jusqu'à 128 caractères. |
external_user_allowed |
Immuable. Indique si cet espace autorise tous les utilisateurs de Google Chat à devenir 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 n'est fourni qu'en sortie. |
space_threading_state |
Uniquement en sortie. État des fils de discussion dans l'espace Chat. |
space_details |
Informations sur l'espace, y compris sa description et ses règles |
space_history_state |
État de l'historique des messages et des fils de discussion de cet espace. |
import_mode |
Facultatif. Indique si cet espace est créé dans |
create_time |
Facultatif. Immuable. Pour les espaces créés dans Chat, date et heure de création de l'espace. Ce champ sert uniquement de sortie, sauf lorsqu'il est utilisé dans des espaces en mode importation. Pour les espaces en mode importation, définissez ce champ sur l'horodatage historique de la création de l'espace dans la source, afin de conserver l'heure de création d'origine. N'est renseigné que dans la sortie lorsque |
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) comportant une application Chat, qu'ils aient été créés par un administrateur Google Workspace Les administrateurs peuvent installer et configurer un message privé avec une application Chat pour le compte des utilisateurs de leur organisation. Pour permettre l'installation par l'administrateur, votre application Chat doit comporter la messagerie privée. |
membership_count |
Uniquement en sortie. Nombre d'adhésions membres, regroupées par type de membre. Renseigné lorsque |
access_settings |
Facultatif. Spécifie le paramètre d'accès de l'espace. Renseigné uniquement lorsque |
space_uri |
Uniquement en sortie. URI permettant à un utilisateur d'accéder à l'espace. |
Champ d'union space_permission_settings . Représente les paramètres d'autorisation d'un espace. Renseigné uniquement lorsque space_type est défini sur SPACE . space_permission_settings ne peut être que l'un des éléments suivants: |
|
predefined_permission_settings |
Facultatif. Uniquement en entrée. Paramètres d'autorisation de l'espace. Entrée pour la création d'un espace. Un espace de collaboration est créé si ce champ n'est pas défini. Une fois l'espace créé, les paramètres sont insérés dans le champ |
permission_settings |
Facultatif. Paramètres d'autorisation exacts qui peuvent être définis pour mettre à jour l'espace. Entrée pour la modification d'un espace. Sinon, il ne s'agit que de la sortie. Pour créer un espace, utilisez plutôt |
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 y prévisualiser les messages. Si cette règle n'est pas configurée, seuls les utilisateurs ou les groupes Google qui ont été invités ou ajoutés individuellement à l'espace peuvent y accéder. Pour en savoir plus, consultez Rendre un espace visible auprès d'une audience cible. Format : Pour utiliser l'audience cible par défaut de l'organisation Google Workspace, définissez-la sur |
AccessState
Représente l'état d'accès de l'espace.
Enums | |
---|---|
ACCESS_STATE_UNSPECIFIED |
L'état de l'accès est inconnu ou non compatible avec cette API. |
PRIVATE |
Seuls les utilisateurs ou les groupes Google ajoutés ou invités individuellement par d'autres utilisateurs ou par des administrateurs Google Workspace peuvent le découvrir et y accéder. |
DISCOVERABLE |
Un gestionnaire de l'espace a autorisé une audience cible à accéder à l'espace. Les utilisateurs ou les groupes Google qui ont été individuellement ajoutés ou invités à l'espace peuvent également le découvrir et y accéder. Pour en savoir plus, consultez Rendre un espace visible par des utilisateurs spécifiques. |
MembershipCount
Champs | |
---|---|
joined_direct_human_user_count |
Nombre d'utilisateurs humains ayant directement rejoint l'espace (sans compter ceux qui ont rejoint un groupe). |
joined_group_count |
Nombre de groupes ayant directement rejoint l'espace. |
PermissionSetting
Représente un paramètre d'autorisation d'espace.
Champs | |
---|---|
managers_allowed |
Indique si les gestionnaires de l'espace disposent de cette autorisation. |
members_allowed |
Indique si les membres non administrateurs disposent de cette autorisation. |
PermissionSettings
Paramètres d'autorisation pour un espace nommé Pour définir des paramètres d'autorisation lorsque vous créez un espace, spécifiez le champ PredefinedPermissionSettings
dans votre requête.
Champs | |
---|---|
manage_members_and_groups |
Paramètre permettant de gérer les membres et les groupes d'un espace. |
modify_space_details |
Paramètre permettant de modifier le nom, l'avatar, la description et les consignes de l'espace. |
toggle_history |
Paramètre permettant d'activer et de désactiver l'historique des espaces. |
use_at_mention_all |
Paramètre permettant d'utiliser @tous dans un espace. |
manage_apps |
Paramètre permettant de gérer les applications d'un espace. |
manage_webhooks |
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 |
Paramètre permettant de répondre aux messages dans un espace. |
PredefinedPermissionSettings
Paramètres d'autorisation de l'espace que vous pouvez spécifier lorsque vous créez un espace nommé. D'autres paramètres pourront être ajoutés à l'avenir. Pour en savoir plus sur les paramètres d'autorisation des espaces nommés, consultez En savoir plus sur les espaces.
Enums | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
Non spécifié. Ne pas utiliser. |
COLLABORATION_SPACE |
Paramètre permettant de transformer l'espace en espace de collaboration dans lequel tous les membres peuvent publier des messages. |
ANNOUNCEMENT_SPACE |
Paramètre permettant de transformer l'espace en espace d'annonce dont seuls les gestionnaires peuvent publier des messages. |
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 la discussion, l'objectif fonctionnel ou les participants de l'espace. Il peut contenir jusqu'à 150 caractères. |
guidelines |
Facultatif. Les règles, les attentes et l'étiquette de l'espace. Il peut comporter jusqu'à 5 000 caractères. |
SpaceThreadingState
Spécifie le type d'état des fils de discussion dans l'espace Chat.
Enums | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
Réservé. |
THREADED_MESSAGES |
Espaces nommés compatibles avec les fils de discussion Lorsque les utilisateurs répondent à un message, ils peuvent y répondre dans le fil de discussion, ce qui permet de conserver leur réponse dans le contexte du message d'origine. |
GROUPED_MESSAGES |
Espaces nommés dans lesquels les conversations sont organisées par sujet. Les sujets et leurs réponses sont regroupés. |
UNTHREADED_MESSAGES |
Messages privés (MP) entre deux personnes et conversations de groupe entre trois personnes ou plus. |
SpaceType
Type d'espace. Obligatoire lors de la création ou de la mise à jour d'un espace. Sortie uniquement pour les autres utilisations.
Enums | |
---|---|
SPACE_TYPE_UNSPECIFIED |
Réservé. |
SPACE |
Un endroit où les utilisateurs peuvent envoyer des messages, partager des fichiers et collaborer. Un SPACE peut inclure des applications Chat. |
GROUP_CHAT |
Conversations de groupe entre trois personnes ou plus. Un GROUP_CHAT peut inclure des applications Chat. |
DIRECT_MESSAGE |
Messages privés entre deux personnes ou une personne et une application Chat |
Type
Obsolète: utilisez plutôt SpaceType
.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Réservé. |
ROOM |
Conversations entre deux personnes ou plus. |
DM |
Message privé entre une personne et une application Chat, où tous les messages sont plats Notez que cela n'inclut pas les messages privés entre deux personnes. |
SpaceBatchUpdatedEventData
Charge utile de l'é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 représentant une modification ou une activité dans un espace Google Chat. Pour en savoir plus, consultez Gérer les événements Google Chat.
Champs | |
---|---|
name |
Nom de ressource de l'événement de l'espace. Format : |
event_time |
Heure à laquelle l'événement s'est produit. |
event_type |
Type d'événement de l'espace. Chaque type d'événement est associé à une version de traitement par lot, qui représente plusieurs instances du type d'événement qui se produisent dans un court laps de temps. Pour les requêtes Types d'événements compatibles pour les messages:
Types d'événements compatibles avec les souscriptions:
Types d'événements compatibles avec les réactions:
Types d'événements compatibles avec l'espace:
|
Champ d'union
|
|
message_created_event_data |
Charge utile de l'événement pour un nouveau message. Type d'événement: |
message_updated_event_data |
Charge utile de l'événement pour un message mis à jour. Type d'événement: |
message_deleted_event_data |
Charge utile de l'événement pour un message supprimé. Type d'événement: |
message_batch_created_event_data |
Charge utile de l'événement pour plusieurs nouveaux messages. Type d'événement: |
message_batch_updated_event_data |
Charge utile de l'événement pour plusieurs messages mis à jour. Type d'événement: |
message_batch_deleted_event_data |
Charge utile de l'événement pour plusieurs messages supprimés. Type d'événement: |
space_updated_event_data |
Charge utile de l'événement pour une mise à jour de l'espace. Type d'événement: |
space_batch_updated_event_data |
Charge utile de l'événement pour plusieurs mises à jour d'un espace. Type d'événement: |
membership_created_event_data |
Charge utile de l'événement pour une nouvelle adhésion. Type d'événement: |
membership_updated_event_data |
Charge utile de l'événement pour un abonnement mis à jour. Type d'événement: |
membership_deleted_event_data |
Charge utile de l'événement pour un abonnement supprimé. Type d'événement: |
membership_batch_created_event_data |
Charge utile de l'événement pour plusieurs nouvelles adhésions. Type d'événement: |
membership_batch_updated_event_data |
Charge utile de l'événement pour plusieurs abonnements mis à jour. Type d'événement: |
membership_batch_deleted_event_data |
Charge utile de l'événement pour plusieurs abonnements supprimés. Type d'événement: |
reaction_created_event_data |
Charge utile de l'événement pour une nouvelle réaction. Type d'événement: |
reaction_deleted_event_data |
Charge utile de l'événement pour une réaction supprimée. Type d'événement: |
reaction_batch_created_event_data |
Charge utile de l'événement pour plusieurs nouvelles réactions. Type d'événement: |
reaction_batch_deleted_event_data |
Charge utile de l'événement pour plusieurs réactions supprimées. Type d'événement: |
SpaceReadState
État de lecture d'un utilisateur dans un espace, permettant d'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. Cela correspond généralement à l'horodatage du dernier message lu ou à un horodatage spécifié par l'utilisateur pour marquer la dernière position lue dans un espace. |
SpaceUpdatedEventData
Charge utile de l'événement pour un espace mis à jour.
Type d'événement: google.workspace.chat.space.v1.updated
Champs | |
---|---|
space |
Espace mis à jour. |
Thread
Un fil de discussion dans un espace Google Chat Pour obtenir des exemples d'utilisation, consultez Démarrer un fil de discussion ou y répondre.
Si vous spécifiez un fil de discussion lorsque vous créez un message, vous pouvez définir le champ messageReplyOption
pour déterminer ce qui se passe si aucun fil de discussion correspondant n'est trouvé.
Champs | |
---|---|
name |
Nom de ressource du thread. Exemple : |
thread_key |
Facultatif. Entrée pour la création ou la mise à jour d'un thread. Sinon, il ne s'agit que de la sortie. ID du thread. Il peut comporter jusqu'à 4 000 caractères. Cet ID est propre à l'application Chat qui le définit. Par exemple, si plusieurs applications Chat créent un message à l'aide de la même clé de fil de discussion, les messages sont publiés dans 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, permettant d'identifier les messages lus et non lus.
Champs | |
---|---|
name |
Nom de ressource de l'état de lecture du thread. Format : |
last_read_time |
Heure à laquelle l'état de lecture du fil de discussion de l'utilisateur a été mis à jour. En général, il correspond à l'horodatage du dernier message lu dans un fil de discussion. |
UpdateMembershipRequest
Message de requête pour la mise à jour d'un abonnement.
Champs | |
---|---|
membership |
Obligatoire. Abonnement à mettre à jour. Seuls les champs spécifiés par |
update_mask |
Obligatoire. Chemins d'accès des champs à mettre à jour. Séparez plusieurs valeurs par une virgule ou utilisez Chemins d'accès de champs actuellement acceptés:
|
use_admin_access |
true , la méthode s'exécute avec les droits d'administrateur Google Workspace de l'utilisateur.L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit de gérer les conversations Chat et Espaces. Nécessite le champ d'application OAuth 2.0 |
UpdateMessageRequest
Requête de mise à jour d'un message.
Champs | |
---|---|
message |
Obligatoire. Message avec les champs mis à jour. |
update_mask |
Obligatoire. Chemins d'accès des champs à mettre à jour. Séparez plusieurs valeurs par une virgule ou utilisez Chemins d'accès de champs actuellement acceptés:
|
allow_missing |
Facultatif. Si |
UpdateSpaceReadStateRequest
Message de requête pour l'API UpdateSpaceReadState.
Champs | |
---|---|
space_read_state |
Obligatoire. État de lecture de l'espace et champs à mettre à jour. Prend uniquement en charge la mise à jour de l'état de lecture pour l'utilisateur appelant. Pour faire référence à l'utilisateur appelant, définissez l'une des options suivantes:
Format: users/{user}/spaces/{space}/spaceReadState |
update_mask |
Obligatoire. Chemins d'accès des champs à mettre à jour. Chemins d'accès de champs actuellement acceptés:
Lorsque Pour marquer l'espace comme lu, définissez |
UpdateSpaceRequest
Requête permettant de mettre à jour un seul espace.
Champs | |
---|---|
space |
Obligatoire. Espace avec des champs à mettre à jour. |
update_mask |
Obligatoire. Chemins des 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 |
true , la méthode s'exécute avec les droits d'administrateur Google Workspace de l'utilisateur.L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit de gérer les conversations Chat et Espaces. Nécessite le champ d'application OAuth 2.0 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, le résultat d'une ressource User
ne renseigne que les champs name
et type
de l'utilisateur.
Champs | |
---|---|
name |
Nom de ressource d'un Format : Pour
|
display_name |
Uniquement en sortie. Nom à afficher de l'utilisateur |
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. NE PAS UTILISER. |
HUMAN |
Utilisateur humain. |
BOT |
Utilisateur de l'application Chat. |
UserMentionMetadata
Métadonnées d'annotation pour les mentions de l'utilisateur (@).
Champs | |
---|---|
user |
L'utilisateur a mentionné. |
type |
Type de mention de l'utilisateur. |
Type
Enums | |
---|---|
TYPE_UNSPECIFIED |
Valeur par défaut de l'énumération. Ne pas utiliser. |
ADD |
Ajouter un utilisateur à l'espace. |
MENTION |
Mentionner l'utilisateur dans l'espace. |
WidgetMarkup
Un widget est un élément d'interface utilisateur qui présente du texte et des images.
Champs | |
---|---|
buttons[] |
Liste de boutons. La valeur Buttons est également |
Champ d'union data . Un élément WidgetMarkup ne peut contenir que l'un des éléments suivants. Vous pouvez utiliser plusieurs champs WidgetMarkup pour afficher plus d'éléments. data ne peut être que l'un des éléments suivants: |
|
text_paragraph |
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
Un bouton Il peut s'agir d'un bouton de type texte ou image.
Champs | |
---|---|
Champ d'union
|
|
text_button |
Un bouton avec du texte et une action |
image_button |
Un bouton avec une image et l'action |
FormAction
Une action dans un formulaire décrit le comportement qui s'applique lors de l'envoi du formulaire. 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é son envoi. Ces informations sont renvoyées à l'application Chat dans le cadre de l'événement de clic sur la fiche. Vous pouvez utiliser le même nom de méthode pour plusieurs éléments qui déclenchent un comportement courant. |
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. Prenons l'exemple de trois boutons de mise en attente: répéter maintenant, répéter un jour et répéter la semaine suivante. Vous pouvez utiliser action method = snooze()
en transmettant le type et la durée de la mise en pause dans la liste des paramètres de chaîne.
Champs | |
---|---|
key |
Nom du paramètre pour le script d'action. |
value |
Valeur du paramètre. |
Icône
Ensemble des icônes compatibles.
Enums | |
---|---|
ICON_UNSPECIFIED |
|
AIRPLANE |
|
BOOKMARK |
|
BUS |
|
CAR |
|
CLOCK |
|
CONFIRMATION_NUMBER_ICON |
|
DOLLAR |
|
DESCRIPTION |
|
EMAIL |
|
EVENT_PERFORMER |
|
EVENT_SEAT |
|
FLIGHT_ARRIVAL |
|
FLIGHT_DEPARTURE |
|
HOTEL |
|
HOTEL_ROOM_TYPE |
|
INVITE |
|
MAP_PIN |
|
MEMBERSHIP |
|
MULTIPLE_PEOPLE |
|
OFFER |
|
PERSON |
|
PHONE |
|
RESTAURANT_ICON |
|
SHOPPING_CART |
|
STAR |
|
STORE |
|
TICKET |
|
TRAIN |
|
VIDEO_CAMERA |
|
VIDEO_PLAY |
Image
Une image spécifiée par une URL et pouvant avoir une action onclick
.
Champs | |
---|---|
image_url |
URL de l'image |
on_click |
L'action |
aspect_ratio |
Proportions de cette image (largeur et hauteur). Ce champ vous permet de réserver la hauteur adaptée à l'image en attendant son chargement. Elle n'est pas destinée à remplacer le format intégré de l'image. Si cette règle n'est pas configurée, le serveur la remplit en préchargeant l'image. |
ImageButton
Un bouton 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 enum Icon ou une URL. icons ne peut être que l'un des éléments suivants: |
|
icon |
Icône spécifiée par |
icon_url |
Icône spécifiée par une URL. |
KeyValue
Un élément d'interface utilisateur contient une clé (étiquette) et une valeur (contenu). Cet élément peut également contenir des actions, comme le bouton onclick
.
Champs | |
---|---|
top_label |
Texte du libellé du haut. Texte mis en forme accepté. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme le texte dans les applications Google Chat et Mettre en forme le texte dans les modules complémentaires Google Workspace. |
content |
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 le texte dans les applications Google Chat et Mettre en forme le texte dans les modules complémentaires Google Workspace. |
content_multiline |
Indique si le contenu doit être multiligne. |
bottom_label |
Texte du libellé du bas. Texte mis en forme accepté. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme le texte dans les applications Google Chat et Mettre en forme le texte dans les modules complémentaires Google Workspace. |
on_click |
L'action |
Champ d'union icons . Vous devez définir au moins une icône (top_label et bottom_label ). icons ne peut être que l'un des éléments suivants: |
|
icon |
Valeur d'énumération remplacée par l'API Chat par l'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 que l'un des éléments suivants: |
|
button |
Un 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
Un bouton avec du texte et une action onclick
.
Champs | |
---|---|
text |
Texte du bouton |
on_click |
L'action |
TextParagraph
Un paragraphe de texte. Texte mis en forme accepté. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme le texte dans les applications Google Chat et Mettre en forme le texte dans les modules complémentaires Google Workspace.
Champs | |
---|---|
text |
|