- Ressource : Message
- Représentation JSON
- Carte
- CardHeader
- ImageStyle
- Section
- WidgetMarkup
- TextParagraph
- Image
- OnClick
- FormAction
- ActionParameter
- OpenLink
- KeyValue
- Icône
- Bouton
- TextButton
- ImageButton
- CardAction
- CardWithId
- Carte
- CardHeader
- ImageType
- Section
- Widget
- TextParagraph
- Image
- OnClick
- Action
- ActionParameter
- LoadIndicator
- Interaction
- OpenLink
- OpenAs
- OnClose
- OverflowMenu
- OverflowMenuItem
- Icône
- MaterialIcon
- DecoratedText
- Bouton
- Couleur
- Type
- SwitchControl
- ControlType
- ButtonList
- TextInput
- Type
- Suggestions
- SuggestionItem
- Validation
- InputType
- SelectionInput
- SelectionType
- SelectionItem
- PlatformDataSource
- CommonDataSource
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- SpaceDataSource
- DateTimePicker
- DateTimePickerType
- Séparateur
- Grille
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- BorderType
- GridItemLayout
- Colonnes
- Colonne
- HorizontalSizeStyle
- HorizontalAlignment
- VerticalAlignment
- Widgets
- ChipList
- Disposition
- Chip
- CollapseControl
- DividerStyle
- CardAction
- CardFixedFooter
- DisplayStyle
- Annotation
- AnnotationType
- UserMentionMetadata :
- Type
- SlashCommandMetadata
- Type
- RichLinkMetadata
- RichLinkType
- DriveLinkData
- ChatSpaceLinkData
- Fil de discussion
- ActionResponse
- ResponseType
- DialogAction
- Boîte de dialogue
- ActionStatus
- Code
- UpdatedWidget
- SelectionItems
- SlashCommand
- MatchedUrl
- EmojiReactionSummary
- DeletionMetadata
- DeletionType
- QuotedMessageMetadata
- AttachedGif
- AccessoryWidget
- Méthodes
Ressource : Message
Un message dans un espace Google Chat
Représentation JSON |
---|
{ "name": string, "sender": { object ( |
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 ayant créé le message. Si votre application Chat s'authentifie en tant qu'utilisateur, la sortie renseigne les utilisateurs |
create |
Facultatif. Immuable. Pour les espaces créés dans Chat, l'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 |
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 |
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 |
Uniquement en sortie. Contient le message
Pour en savoir plus, consultez Afficher le formatage du texte envoyé dans un message. |
cards[] |
Obsolète : utilisez Cartes riches, 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. |
cards |
Facultatif. Tableau de fiches. Seules les applications Chat peuvent créer des fiches. Si votre application Chat s'authentifie en tant qu'utilisateur, les messages ne peuvent pas contenir de cartes. Pour savoir comment créer un message contenant des fiches, consultez Envoyer un message. Concevez et prévisualisez des fiches avec l'outil de création de fiches. Ouvrir l'outil de création de cartes |
annotations[] |
Uniquement en sortie. Annotations associées à |
thread |
Fil de discussion auquel appartient le message. Pour obtenir un exemple d'utilisation, consultez Démarrer ou répondre à un fil de discussion. |
space |
Uniquement en sortie. Si votre application Chat s'authentifie en tant qu'utilisateur, la sortie ne renseigne que l'espace |
fallback |
Facultatif. Description en texte brut des cartes du message, utilisée lorsque les cartes ne peuvent pas être affichées (notifications mobiles, par exemple). |
action |
Uniquement en entrée. Paramètres qu'une application Chat peut utiliser pour configurer la publication de sa réponse. |
argument |
Uniquement en sortie. Corps en texte brut du message avec toutes les mentions de l'application Chat supprimées. |
slash |
Uniquement en sortie. Les informations sur la commande à barre oblique, le cas échéant. |
attachment[] |
Facultatif. Pièce jointe importée par un utilisateur. |
matched |
Uniquement en sortie. URL dans |
thread |
Uniquement en sortie. Lorsque la valeur est Si l'espace n'autorise pas les réponses dans les fils de discussion, ce champ est toujours |
client |
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 |
Uniquement en sortie. Liste des résumés des réactions emoji sur le message. |
private |
Facultatif. Immuable. Entrée pour la création d'un message, sinon sortie uniquement. Utilisateur autorisé à voir le message. Lorsque ce champ est défini, le message est privé et visible uniquement 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 |
Uniquement en sortie. Informations sur un message supprimé. Un message est supprimé lorsque |
quoted |
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 |
Uniquement en sortie. Images GIF jointes au message |
accessory |
Facultatif. Un ou plusieurs widgets interactifs qui s'affichent en bas d'un message. Vous pouvez ajouter des widgets accessoires aux messages contenant du texte, des fiches 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 une authentification de l'application. |
CardWithId
Fiche dans un message Google Chat
Seules les applications Chat peuvent créer des fiches. Si votre application Chat s'authentifie en tant qu'utilisateur, le message ne peut pas contenir de cartes.
Concevez et prévisualisez des fiches avec l'outil de création de fiches.
Ouvrir l'outil de création de cartesReprésentation JSON |
---|
{
"cardId": string,
"card": {
object ( |
Champs | |
---|---|
card |
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. |
Annotation
Uniquement en sortie. Annotations associées au corps en texte brut du message. Pour ajouter une mise en forme de base à un message, consultez Mettre en forme des messages.
Exemple de corps de message en texte brut :
Hello @FooBot how are you!"
Les 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"
}
}]
Représentation JSON |
---|
{ "type": enum ( |
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 |
Indice de début (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 |
Métadonnées de la mention d'un utilisateur. |
slash |
Métadonnées d'une commande à barre oblique. |
rich |
Métadonnées d'un lien interactif. |
AnnotationType
Type de l'annotation.
Enums | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Valeur par défaut de l'énumération. Ne pas utiliser. |
USER_MENTION |
Un utilisateur est mentionné. |
SLASH_COMMAND |
Une commande à barre oblique est appelée. |
RICH_LINK |
Annotation de lien enrichi. |
UserMentionMetadata
Métadonnées d'annotation pour les mentions de l'utilisateur (@).
Représentation JSON |
---|
{ "user": { object ( |
Champs | |
---|---|
user |
Utilisateur mentionné. |
type |
Type de mention de l'utilisateur. |
Type
Enums | |
---|---|
TYPE_UNSPECIFIED |
Valeur par défaut de l'énumération. Ne pas utiliser. |
ADD |
Ajoutez un utilisateur à l'espace. |
MENTION |
Mentionner un utilisateur dans un espace |
SlashCommandMetadata
Métadonnées d'annotation pour les commandes à barre oblique (/).
Représentation JSON |
---|
{ "bot": { object ( |
Champs | |
---|---|
bot |
Application Chat dont la commande a été appelée. |
type |
Type de commande à barre oblique. |
command |
Nom de la commande à barre oblique appelée. |
command |
ID de la commande à barre oblique appelée. |
triggers |
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 |
RichLinkMetadata
Lien enrichi vers une ressource.
Représentation JSON |
---|
{ "uri": string, "richLinkType": enum ( |
Champs | |
---|---|
uri |
URI de ce lien. |
rich |
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 |
Données d'un lien Drive. |
chat |
Données pour un lien vers un espace Chat. |
RichLinkType
Type de lien enrichi. D'autres types pourront être ajoutés à l'avenir.
Enums | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
Valeur par défaut de l'énumération. Ne pas utiliser. |
DRIVE_FILE |
Type de lien Google Drive enrichi. |
CHAT_SPACE |
Type de lien riche pour un espace Chat. (par exemple, un chip d'espace intelligent). |
DriveLinkData
Données pour les liens Google Drive.
Représentation JSON |
---|
{
"driveDataRef": {
object ( |
Champs | |
---|---|
drive |
DriveDataRef qui fait référence à un fichier Google Drive. |
mime |
Type MIME de la ressource Google Drive associée. |
ChatSpaceLinkData
Données pour les liens d'espace Chat.
Représentation JSON |
---|
{ "space": string, "thread": string, "message": string } |
Champs | |
---|---|
space |
Espace de la ressource d'espace Chat associé. 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 : |
Thread
Fil de discussion dans un espace Google Chat Pour obtenir un exemple d'utilisation, consultez Démarrer ou répondre à un fil de discussion.
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é.
Représentation JSON |
---|
{ "name": string, "threadKey": string } |
Champs | |
---|---|
name |
Identifiant. Nom de ressource du thread. Exemple : |
thread |
Facultatif. Saisie pour créer ou mettre à jour un fil de discussion Sinon, sortie uniquement. ID du thread. 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 différents fils de discussion. Pour répondre à un fil de discussion créé par une personne ou une autre application Chat, spécifiez plutôt le champ |
ActionResponse
Paramètres qu'une application de chat peut utiliser pour configurer la publication de sa réponse.
Représentation JSON |
---|
{ "type": enum ( |
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. (Uniquement pour les types de réponse |
dialog |
Uniquement en entrée. Réponse à un événement d'interaction lié à une dialog. Doit être accompagné de |
updated |
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 |
modifier le message de l'application Chat ; Cette opération n'est autorisée que pour un événement CARD_CLICKED où le type d'expéditeur de message est BOT . |
UPDATE_USER_MESSAGE_CARDS |
Mettre à jour les fiches du message d'un utilisateur Cette opération n'est autorisée que comme réponse à un événement MESSAGE avec une URL correspondante ou à un événement CARD_CLICKED où le type d'expéditeur de message est HUMAN . Le texte est ignoré. |
REQUEST_CONFIG |
Demander à l'utilisateur de procéder à une authentification ou à une configuration supplémentaires en privé. |
DIALOG |
Affiche une boîte de dialogue. |
UPDATE_WIDGET |
Requête sur les options de saisie semi-automatique du texte du widget. |
DialogAction
Contient une boîte de dialogue et un code d'état de la requête.
Représentation JSON |
---|
{ "actionStatus": { object ( |
Champs | |
---|---|
action |
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. Dialog pour la requête. |
Dialog
Enveloppe autour du corps de la fiche de la boîte de dialogue.
Représentation JSON |
---|
{
"body": {
object ( |
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 fiche suivantes : |
ActionStatus
Représente l'état d'une requête d'appel ou d'envoi d'une boîte de dialogue.
Représentation JSON |
---|
{
"statusCode": enum ( |
Champs | |
---|---|
status |
Code d'état. |
user |
Message à envoyer aux utilisateurs concernant l'état de leur demande. Si cette valeur n'est pas définie, un message générique basé sur |
Code
Les codes d'erreur canoniques pour les API de gRPC.
Parfois, plusieurs codes d'erreur peuvent s'appliquer. Les services doivent renvoyer le code d'erreur le plus spécifique qui s'applique. Par exemple, préférez OUT_OF_RANGE
à FAILED_PRECONDITION
si les deux codes s'appliquent. De même, préférez NOT_FOUND
ou ALREADY_EXISTS
à FAILED_PRECONDITION
.
Enums | |
---|---|
OK |
Pas une erreur, affiché en cas de réussite. Mise en correspondance HTTP : 200 OK |
CANCELLED |
L'opération a été annulée, généralement par l'appelant. Mise en correspondance HTTP : 499 Le client a fermé la requête |
UNKNOWN |
Erreur inconnue. Par exemple, cette erreur peut s'afficher lorsqu'une valeur Mise en correspondance HTTP : 500 Erreur de serveur interne |
INVALID_ARGUMENT |
Le client a spécifié un argument non valide. Notez que cette erreur diffère de Mise en correspondance HTTP : 400 Requête incorrecte |
DEADLINE_EXCEEDED |
Le délai a expiré avant que l'opération puisse se terminer. Pour les opérations qui modifient l'état du système, cette erreur peut être affichée même si l'opération s'est terminée avec succès. Par exemple, une réponse réussie d'un serveur aurait pu être retardée suffisamment longtemps pour que le délai expire. Mappage HTTP : 504 Passerelle hors délai |
NOT_FOUND |
Une entité demandée (fichier ou répertoire, par exemple) est introuvable. Remarque pour les développeurs de serveurs : Mise en correspondance HTTP : 404 Page introuvable |
ALREADY_EXISTS |
L'entité qu'un client a tenté de créer (par exemple, un fichier ou un répertoire) existe déjà. Mise en correspondance HTTP : 409 Conflit |
PERMISSION_DENIED |
L'appelant n'a pas l'autorisation d'exécuter l'opération spécifiée. Mise en correspondance HTTP : 403 Accès interdit |
UNAUTHENTICATED |
La requête ne dispose pas d'identifiants d'authentification valides pour l'opération. Mise en correspondance HTTP : 401 Accès non autorisé |
RESOURCE_EXHAUSTED |
Certaines ressources ont été épuisées ; par exemple, un quota par utilisateur a été atteint ou le système de fichiers dans son intégralité manque d'espace. Mise en correspondance HTTP : 429 Requêtes trop nombreuses |
FAILED_PRECONDITION |
L'opération a été rejetée car le système n'est pas dans un état requis pour exécuter l'opération. Par exemple, le répertoire à supprimer n'est pas vide, une opération rmdir est appliquée à un emplacement qui n'est pas un répertoire, etc. Les développeurs de services peuvent suivre les instructions suivantes pour choisir entre Mise en correspondance HTTP : 400 Requête incorrecte |
ABORTED |
L'opération a été abandonnée, généralement en raison d'un problème de simultanéité, tel qu'un échec de vérification du séquenceur ou un abandon de transaction. Consultez les instructions ci-dessus pour choisir entre Mise en correspondance HTTP : 409 Conflit |
OUT_OF_RANGE |
L'opération a été tentée au-delà de la plage valide. Par exemple, rechercher ou lire après la fin du fichier. Contrairement à Il existe des cas où Mise en correspondance HTTP : 400 Requête incorrecte |
UNIMPLEMENTED |
L'opération n'est pas implémentée ou n'est pas prise en charge/activée dans ce service. Mise en correspondance HTTP : 501 Non implémenté |
INTERNAL |
Erreurs internes. Cela signifie que certains invariants attendus par le système sous-jacent n'ont pas été respectés. Ce code d'erreur est réservé aux erreurs graves. Mise en correspondance HTTP : 500 Erreur de serveur interne |
UNAVAILABLE |
Le service est actuellement indisponible. Il s'agit probablement d'une condition temporaire qui peut être corrigée en réessayant après avoir laissé passer un intervalle entre les tentatives. Notez qu'il n'est pas toujours sûr de relancer des opérations non idempotentes. Consultez les instructions ci-dessus pour choisir entre Mise en correspondance HTTP : 503 Service non disponible |
DATA_LOSS |
Perte ou corruption de données irrécupérable. Mise en correspondance HTTP : 500 Erreur de serveur interne |
UpdatedWidget
Pour les widgets selectionInput
, renvoie des suggestions de saisie semi-automatique pour un menu multi-sélection.
Représentation JSON |
---|
{ "widget": string, // Union field |
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 |
SelectionItems
Liste des résultats de saisie semi-automatique du widget.
Représentation JSON |
---|
{
"items": [
{
object ( |
Champs | |
---|---|
items[] |
Tableau d'objets SelectionItem. |
SlashCommand
Commande à barre oblique dans Google Chat
Représentation JSON |
---|
{ "commandId": string } |
Champs | |
---|---|
command |
ID de la commande à barre oblique appelée. |
MatchedUrl
URL correspondante dans un message Chat. Les applications Chat peuvent prévisualiser les URL correspondantes. Pour en savoir plus, consultez la section Prévisualiser les liens.
Représentation JSON |
---|
{ "url": string } |
Champs | |
---|---|
url |
Uniquement en sortie. URL correspondante. |
EmojiReactionSummary
Nombre de personnes qui ont réagi à un message avec un emoji spécifique.
Représentation JSON |
---|
{
"emoji": {
object ( |
Champs | |
---|---|
emoji |
Uniquement en sortie. Emoji associés aux réactions. |
reaction |
Uniquement en sortie. Nombre total de réactions utilisant l'emoji associé. |
DeletionMetadata
Informations sur un message supprimé. Un message est supprimé lorsque deleteTime
est défini.
Représentation JSON |
---|
{
"deletionType": enum ( |
Champs | |
---|---|
deletion |
Indique qui a supprimé le message. |
DeletionType
Qui a supprimé le message et comment D'autres valeurs pourront être ajoutées à l'avenir.
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 à son expiration. |
CREATOR_VIA_APP |
Une application Chat a supprimé le message au nom de l'utilisateur. |
SPACE_OWNER_VIA_APP |
Une application Chat a supprimé le message au nom du propriétaire de l'espace. |
QuotedMessageMetadata
Informations sur un message cité.
Représentation JSON |
---|
{ "name": string, "lastUpdateTime": string } |
Champs | |
---|---|
name |
Uniquement en sortie. Nom de ressource du message entre guillemets. Format : |
last |
Uniquement en sortie. Code temporel de création ou de dernière mise à jour du message cité. |
AttachedGif
Une image GIF spécifiée par une URL.
Représentation JSON |
---|
{ "uri": string } |
Champs | |
---|---|
uri |
Uniquement en sortie. URL qui héberge l'image GIF. |
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.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union action . Type d'action. action ne peut être qu'un des éléments suivants : |
|
button |
Liste des boutons. |
Méthodes |
|
---|---|
|
Crée un message dans un espace Google Chat. |
|
Supprime un message. |
|
Affiche les détails d'un message. |
|
Liste les messages d'un espace dont l'appelant est membre, y compris les messages de membres et d'espaces bloqués. |
|
Met à jour un message. |
|
Met à jour un message. |