REST Resource: spaces.messages

Ressource : Message

Message dans un espace Google Chat.

Représentation JSON 
{
  "name": string,
  "sender": {
    object (User)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "deleteTime": string,
  "text": string,
  "formattedText": string,
  "cards": [
    {
      object (Card)
    }
  ],
  "cardsV2": [
    {
      object (CardWithId)
    }
  ],
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "thread": {
    object (Thread)
  },
  "space": {
    object (Space)
  },
  "fallbackText": string,
  "actionResponse": {
    object (ActionResponse)
  },
  "argumentText": string,
  "slashCommand": {
    object (SlashCommand)
  },
  "attachment": [
    {
      object (Attachment)
    }
  ],
  "matchedUrl": {
    object (MatchedUrl)
  },
  "threadReply": boolean,
  "silent": boolean,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "privateMessageViewer": {
    object (User)
  },
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ],
  "accessoryWidgets": [
    {
      object (AccessoryWidget)
    }
  ],
  "elements": {
    object (Elements)
  },
  "markupSyntax": enum (MarkupSyntax)
}
Champs
name

string

Identifiant. Nom de ressource du message.

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

Où {space} est l'ID de l'espace dans lequel le message est publié et {message} est un ID attribué par le système pour le message. Par exemple, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

Si vous définissez un ID personnalisé lorsque vous créez un message, vous pouvez l'utiliser pour spécifier le message dans une requête en remplaçant {message} par la valeur du champ clientAssignedMessageId. Par exemple, spaces/AAAAAAAAAAA/messages/client-custom-name. Pour en savoir plus, consultez Nommer un message.
sender

object (User)

Uniquement en sortie. Utilisateur qui a créé le message. Si votre application Chat s'authentifie en tant qu'utilisateur, le résultat ne renseigne que les champs user name et type pour les utilisateurs internes et externes, sauf s'ils sont membres de l'espace ou s'ils ont une affinité préalable, comme une conversation par message privé (MP), avec l'utilisateur appelant.
createTime

string (Timestamp format)

Facultatif. Immuable. Pour les espaces créés dans Chat, l'heure à laquelle le message a été créé. Ce champ est réservé à la sortie, sauf s'il est utilisé dans des espaces en mode importation.

Pour les espaces en mode importation, définissez ce champ sur le code temporel historique auquel le message a été créé dans la source afin de conserver l'heure de création d'origine.
lastUpdateTime

string (Timestamp format)

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

string (Timestamp format)

Uniquement en sortie. Heure à laquelle le message a été supprimé dans Google Chat. Si le message n'est jamais supprimé, ce champ est vide.
text

string

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

string

Uniquement en sortie. Contient le message text avec des balises ajoutées pour communiquer la mise en forme. Il est possible que ce champ ne capture pas toutes les mises en forme visibles dans l'UI, mais il inclut les éléments suivants :

  • Syntaxe de balisage pour le gras, l'italique, le barré, la police à chasse fixe, le bloc à chasse fixe, la liste à puces et la citation en bloc.

  • Mentions d'utilisateurs au format <users/{user}>.

  • Liens hypertextes personnalisés au format <{url}|{rendered_text}>, où la première chaîne est l'URL et la seconde est le texte affiché (par exemple, <http://example.com|custom text>).

  • Emoji personnalisé au format :{emojiName}:, par exemple :smile:. Cela ne s'applique pas aux emoji Unicode, tels que U+1F600 pour un emoji visage souriant.

  • Utilisez des astérisques (*) pour créer des listes à puces, par exemple : * item.

Pour en savoir plus, consultez Afficher la mise en forme du texte envoyé dans un message.
cards[]
(deprecated)

object (Card)

Obsolète : utilisez cardsV2 à la place.

Cartes enrichies, mises en forme et interactives que vous pouvez utiliser pour afficher des éléments d'interface utilisateur tels que des textes mis en forme, des boutons et des images cliquables. Les fiches sont normalement affichées sous le corps du message en texte brut. cards et cardsV2 peuvent avoir une taille maximale de 32 Ko.
cardsV2[]

object (CardWithId)

Facultatif. Tableau de cartes.

Les applications Chat peuvent créer des fiches avec l'authentification de l'application. Dans le cadre du programme Preview développeur, si votre application Chat s'authentifie en tant qu'utilisateur, elle peut créer des messages de fiches. Si votre application Chat ne fait pas partie du programme Preview développeur, elle ne peut pas créer de fiches avec authentification des utilisateurs.

Pour savoir comment créer un message contenant des fiches, consultez Envoyer un message.

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

Ouvrir le générateur de fiches
annotations[]

object (Annotation)

Uniquement en sortie. Les annotations peuvent être associées au corps du message en texte brut ou à des chips qui renvoient à des ressources Google Workspace telles que Google Docs ou Sheets avec startIndex et length de 0.
thread

object (Thread)

Fil de discussion auquel le message appartient. Pour obtenir un exemple d'utilisation, consultez Démarrer un fil de discussion ou y répondre.
space

object (Space)

Uniquement en sortie. Si votre application Chat s'authentifie en tant qu'utilisateur, le résultat ne renseigne que l'espace name.
fallbackText

string

Facultatif. Description en texte brut des fiches du message, utilisée lorsque les fiches réelles ne peuvent pas être affichées (par exemple, dans les notifications mobiles).
actionResponse

object (ActionResponse)

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

string

Uniquement en sortie. Corps du message en texte brut, sans les mentions de l'application Chat.
slashCommand

object (SlashCommand)

Uniquement en sortie. Informations sur la commande à barre oblique, le cas échéant.
attachment[]

object (Attachment)

Facultatif. Pièce jointe importée par l'utilisateur.
matchedUrl

object (MatchedUrl)

Uniquement en sortie. Une URL dans le champ text du message de chat qui correspond à un format d'aperçu de lien. Pour en savoir plus, consultez Prévisualiser les liens.
threadReply

boolean

Uniquement en sortie. Lorsque true, le message est une réponse dans un fil de discussion. Lorsque la valeur est false, le message est visible dans la conversation de niveau supérieur de l'espace, soit en tant que premier message d'un fil de discussion, soit en tant que message sans réponses organisées en fils de discussion.

Si l'espace n'accepte pas les réponses dans les fils de discussion, ce champ est toujours false.
silent

boolean

Uniquement en sortie. Indique s'il s'agit d'un message silencieux. Les messages silencieux sont des messages pour lesquels Chat supprime les notifications push pour les destinataires.
clientAssignedMessageId

string

Facultatif. ID personnalisé du message. Vous pouvez utiliser ce champ pour identifier un message, ou pour obtenir, supprimer ou mettre à jour un message. Pour définir un ID personnalisé, spécifiez le champ messageId lorsque vous créez le message. Pour en savoir plus, consultez Nommer un message.
emojiReactionSummaries[]

object (EmojiReactionSummary)

Uniquement en sortie. Liste des résumés des réactions emoji au message.
privateMessageViewer

object (User)

Facultatif. Immuable. Entrée pour créer un message, sinon sortie uniquement. Utilisateur pouvant afficher le message. Lorsqu'il est défini, le message est privé et n'est visible que par l'utilisateur spécifié et l'application Chat. Pour inclure ce champ dans votre requête, vous devez appeler l'API Chat à l'aide de l'authentification de l'application et omettre les éléments suivants :

Pour en savoir plus, consultez Envoyer un message privé.
deletionMetadata

object (DeletionMetadata)

Uniquement en sortie. Informations sur un message supprimé. Un message est supprimé lorsque deleteTime est défini.
quotedMessageMetadata

object (QuotedMessageMetadata)

Facultatif. Informations sur un message cité par un autre message.

Lorsque vous créez un message, vous pouvez citer des messages du même fil de discussion ou citer un message racine pour en créer un autre. Toutefois, vous ne pouvez pas citer une réponse à un message provenant d'un autre fil de discussion.

Lorsque vous mettez à jour un message, vous ne pouvez pas ajouter ni remplacer le champ quotedMessageMetadata, mais vous pouvez le supprimer.

Pour obtenir un exemple d'utilisation, consultez Citer un autre message.
attachedGifs[]

object (AttachedGif)

Uniquement en sortie. Images GIF jointes au message.
accessoryWidgets[]

object (AccessoryWidget)

Facultatif. Un ou plusieurs widgets interactifs qui s'affichent en bas d'un message. Vous pouvez ajouter des widgets d'accessoires aux messages contenant du texte, des fiches, ou du texte et des fiches. Non compatible avec les messages contenant des boîtes de dialogue. Pour en savoir plus, consultez Ajouter des widgets interactifs au bas d'un message.

La création d'un message avec des widgets accessoires nécessite l'authentification de l'application.
elements

object (Elements)

Facultatif. Les éléments sont des composants supplémentaires fournis lors de la création du message, qui peuvent ou non être associés à des parties spécifiques du texte du message. Elles diffèrent des annotations, qui sont en sortie uniquement et fournissent des informations supplémentaires liées à des fragments de message ou à l'intégralité du texte du message.

markupSyntax

enum (MarkupSyntax)

Facultatif. Spécifie comment le serveur interprète le contenu du champ text du message.

CardWithId

Fiche dans un message Google Chat.

Les applications Chat peuvent créer des fiches avec l'authentification de l'application. Dans le cadre du programme Preview développeur, si votre application Chat s'authentifie en tant qu'utilisateur, elle peut créer des messages de fiches. Si votre application Chat ne fait pas partie du programme Preview développeur, elle ne peut pas créer de fiches avec authentification des utilisateurs.

Pour savoir comment créer un message contenant des fiches, consultez Envoyer un message.

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

Ouvrir le générateur de fiches

Représentation JSON 
{
  "cardId": string,
  "card": {
    object (Card)
  },
  "ownerUser": {
    object (User)
  }
}
Champs
cardId

string

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

object (Card)

Une fiche La taille maximale est de 32 Ko.
ownerUser

object (User)

Uniquement en sortie. L'application propriétaire de la carte.

Annotation

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

Exemple de corps de message en texte brut :

Hello @FooBot how are you!"

Métadonnées d'annotations correspondantes :

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
Représentation JSON 
{
  "type": enum (AnnotationType),
  "length": integer,
  "startIndex": integer,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  },
  "customEmojiMetadata": {
    object (CustomEmojiMetadata)
  }
}
Champs
type

enum (AnnotationType)

Type de cette annotation.
length

integer

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

integer

Index de début (base 0, inclus) dans le corps du message en texte brut auquel correspond cette annotation.
Métadonnées supplémentaires sur l'annotation. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
userMention

object (UserMentionMetadata)

Métadonnées de la mention d'utilisateur.
slashCommand

object (SlashCommandMetadata)

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

object (CustomEmojiMetadata)

Métadonnées d'un emoji personnalisé.
Fin des champs mutuellement exclusifs.

AnnotationType

Type de l'annotation.

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

UserMentionMetadata

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

Représentation JSON 
{
  "user": {
    object (User)
  },
  "type": enum (Type)
}
Champs
user

object (User)

L'utilisateur mentionné.
type

enum (Type)

Type de mention d'utilisateur.

Type

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

SlashCommandMetadata

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

Représentation JSON 
{
  "bot": {
    object (User)
  },
  "type": enum (Type),
  "commandName": string,
  "commandId": string,
  "triggersDialog": boolean
}
Champs
bot

object (User)

L'application Chat dont la commande a été appelée.
type

enum (Type)

Type de commande à barre oblique.
commandName

string

Nom de la commande à barre oblique appelée.
commandId

string (int64 format)

ID de la commande à barre oblique appelée.
triggersDialog

boolean

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. Les liens enrichis peuvent être associés au corps du message en texte brut ou représenter des chips qui renvoient vers des ressources Google Workspace telles que Google Docs ou Sheets avec startIndex et length de 0.

Représentation JSON 
{
  "uri": string,
  "richLinkType": enum (RichLinkType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "driveLinkData": {
    object (DriveLinkData)
  },
  "chatSpaceLinkData": {
    object (ChatSpaceLinkData)
  },
  "meetSpaceLinkData": {
    object (MeetSpaceLinkData)
  },
  "calendarEventLinkData": {
    object (CalendarEventLinkData)
  }
}
Champs
uri

string

URI de ce lien.
Données de la ressource associée. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
Fin des champs mutuellement exclusifs.

RichLinkType

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

Enums
DRIVE_FILE Type de lien enrichi Google Drive.
CHAT_SPACE Type de lien enrichi d'un espace Chat. Par exemple, un chip intelligent d'espace.
GMAIL_MESSAGE Type de lien enrichi vers un message Gmail. Plus précisément, un chip Gmail de Partager dans Chat. L'API n'est compatible qu'avec la lecture des messages contenant des liens enrichis GMAIL_MESSAGE.
MEET_SPACE Type de lien enrichi de message Meet. Par exemple, un chip Meet.
CALENDAR_EVENT Type de lien enrichi pour un message Agenda. Par exemple, un chip Agenda.

DriveLinkData

Données pour les liens Google Drive.

Représentation JSON 
{
  "driveDataRef": {
    object (DriveDataRef)
  },
  "mimeType": string
}
Champs
driveDataRef

object (DriveDataRef)

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

string

Type MIME de la ressource Google Drive associée.

ChatSpaceLinkData

Données pour les liens vers les espaces Chat.

Représentation JSON 
{
  "space": string,
  "thread": string,
  "message": string
}
Champs
space

string

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

Format : spaces/{space}
thread

string

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

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

string

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

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

MeetSpaceLinkData

Données pour les liens vers les espaces Meet.

Représentation JSON 
{
  "meetingCode": string,
  "type": enum (Type),
  "huddleStatus": enum (HuddleStatus)
}
Champs
meetingCode

string

Code de réunion de l'espace Meet associé.
type

enum (Type)

Indique le type d'espace de réunion.
huddleStatus

enum (HuddleStatus)

Facultatif. Uniquement en sortie. Si la réunion Meet est un Huddle, indique l'état du Huddle. Sinon, ce champ n'est pas défini.

Type

Type de l'espace Meet.

Enums
TYPE_UNSPECIFIED Valeur par défaut de l'énumération. Ne pas utiliser.
MEETING L'espace Meet est un espace de réunion.
HUDDLE L'espace Meet est un huddle.

HuddleStatus

État de la réunion

Enums
HUDDLE_STATUS_UNSPECIFIED Valeur par défaut de l'énumération. Ne pas utiliser.
STARTED L'appel d'équipe a commencé.
ENDED L'appel d'équipe est terminé. Dans ce cas, l'URI et les identifiants de l'espace Meet ne seront plus valides.
MISSED L'appel d'équipe a été manqué. Dans ce cas, l'URI et les identifiants de l'espace Meet ne seront plus valides.

CalendarEventLinkData

Données pour les liens d'événements d'agenda.

Représentation JSON 
{
  "calendarId": string,
  "eventId": string
}
Champs
calendarId

string

L'identifiant d'agenda de l'agenda associé.
eventId

string

L'identifiant d'événement de l'événement d'agenda associé.

CustomEmojiMetadata

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

Représentation JSON 
{
  "customEmoji": {
    object (CustomEmoji)
  }
}
Champs
customEmoji

object (CustomEmoji)

L'emoji personnalisé.

Thread

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

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

Représentation JSON 
{
  "name": string,
  "threadKey": string
}
Champs
name

string

Identifiant. Nom de ressource du fil de discussion.

Exemple : spaces/{space}/threads/{thread}
threadKey

string

Facultatif. Entrée pour créer ou mettre à jour un fil de discussion. Sinon, sortie uniquement. ID du fil de discussion. 4 000 caractères maximum.

Cet ID est propre à l'application Chat qui le définit. Par exemple, si plusieurs applications Chat créent un message à l'aide de la même clé de fil de discussion, les messages sont publiés dans des fils de discussion différents. Pour répondre dans un fil de discussion créé par une personne ou une autre application Chat, spécifiez plutôt le champ name du fil de discussion.

ActionResponse

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

Représentation JSON 
{
  "type": enum (ResponseType),
  "url": string,
  "dialogAction": {
    object (DialogAction)
  },
  "updatedWidget": {
    object (UpdatedWidget)
  }
}
Champs
type

enum (ResponseType)

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

string

Uniquement en entrée. URL permettant aux utilisateurs de s'authentifier ou de configurer l'application. (Uniquement pour les types de réponses REQUEST_CONFIG)
dialogAction

object (DialogAction)

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

object (UpdatedWidget)

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

ResponseType

Type de réponse de l'application Chat.

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

DialogAction

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

Représentation JSON 
{
  "actionStatus": {
    object (ActionStatus)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dialog": {
    object (Dialog)
  }
}
Champs
actionStatus

object (ActionStatus)

Uniquement en entrée. État d'une requête d'appel ou d'envoi d'une boîte de dialogue. Affiche un état et un message aux utilisateurs, si nécessaire. Par exemple, en cas d'erreur ou de réussite.
Action à effectuer. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
dialog

object (Dialog)

Uniquement en entrée. Boîte de dialogue de la requête.
Fin des champs mutuellement exclusifs.

Dialog

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

Représentation JSON 
{
  "body": {
    object (Card)
  }
}
Champs
body

object (Card)

Uniquement en entrée. Corps de la boîte de dialogue, qui s'affiche dans une fenêtre modale. Les applications Google Chat ne sont pas compatibles avec les entités de fiche suivantes : DateTimePicker, OnChangeAction.

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 (Code),
  "userFacingMessage": string
}
Champs
statusCode

enum (Code)

Code d'état.
userFacingMessage

string

Message à envoyer aux utilisateurs concernant l'état de leur demande. Si ce champ n'est pas défini, un message générique basé sur statusCode est envoyé.

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 Status reçue d'un autre espace d'adressage appartient à un espace d'erreur inconnu dans cet espace d'adressage. De plus, les erreurs des API qui ne renvoient pas suffisamment d'informations relatives aux erreurs peuvent être converties dans cette erreur.

Mise en correspondance HTTP : 500 Erreur interne du serveur
INVALID_ARGUMENT

Le client a spécifié un argument non valide. Notez que cette erreur diffère de FAILED_PRECONDITION. INVALID_ARGUMENT indique les arguments problématiques, quel que soit l'état du système (par exemple, un nom de fichier incorrect).

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 : NOT_FOUND peut être utilisé si une requête est refusée pour toute une classe d'utilisateurs, telle que le déploiement progressif d'une fonctionnalité ou une liste d'autorisation non documentée. Si une requête est refusée pour certains utilisateurs appartenant à une classe d'utilisateurs, telle que le contrôle des accès basé sur l'utilisateur, PERMISSION_DENIED doit être utilisé.

HTTP Mapping: 404 Not Found
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. PERMISSION_DENIED ne doit pas être utilisé pour les rejets causés par l'épuisement d'une ressource (utilisez plutôt RESOURCE_EXHAUSTED pour ces erreurs). PERMISSION_DENIED ne doit pas être utilisé si l'appelant ne peut pas être identifié (utilisez plutôt UNAUTHENTICATED pour ces erreurs). Ce code d'erreur n'implique pas que la requête soit valide ni que l'entité demandée existe ou qu'elle répond à d'autres pré-requis.

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 FAILED_PRECONDITION, ABORTED et UNAVAILABLE : (a) Utilisez UNAVAILABLE si le client ne peut relancer que l'appel ayant échoué. (b) Utilisez ABORTED si le client doit effectuer une nouvelle tentative à un niveau supérieur (par exemple, lorsqu'un test-and-set spécifié par le client échoue, indiquant que le client doit redémarrer une séquence lecture-modification-écriture). (c) Utilisez FAILED_PRECONDITION si le client ne doit pas effectuer de nouvelle tentative tant que l'état du système n'a pas été explicitement corrigé. Par exemple, si un "rmdir" échoue parce que le répertoire n'est pas vide, FAILED_PRECONDITION doit être affiché car le client ne doit pas réessayer sauf si les fichiers sont supprimés du répertoire.

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 FAILED_PRECONDITION, ABORTED et UNAVAILABLE.

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 à INVALID_ARGUMENT, cette erreur indique un problème pouvant être résolu si l'état du système change. Par exemple, un système de fichiers 32 bits générera INVALID_ARGUMENT s'il est invité à lire avec un décalage qui n'est pas compris dans la plage [0,2 ^ 32-1], mais générera OUT_OF_RANGE s'il est invité à lire avec un décalage qui dépasse la taille du fichier actuel.

Il existe des cas où FAILED_PRECONDITION et OUT_OF_RANGE se chevauchent. Nous vous recommandons d'utiliser OUT_OF_RANGE (l'erreur la plus spécifique) lorsque celle-ci s'applique afin que les appelants qui itèrent dans un espace puissent facilement rechercher une erreur OUT_OF_RANGE pour détecter le moment où ils ont terminé.

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 interne du serveur
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 FAILED_PRECONDITION, ABORTED et UNAVAILABLE.

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 interne du serveur

UpdatedWidget

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

Représentation JSON 
{
  "widget": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "suggestions": {
    object (SelectionItems)
  }
}
Champs
widget

string

ID du widget mis à jour. L'ID doit correspondre à celui du widget qui a déclenché la demande de mise à jour.
Le widget a été mis à jour en réponse à une action de l'utilisateur. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
suggestions

object (SelectionItems)

Liste des résultats de saisie semi-automatique du widget
Fin des champs mutuellement exclusifs.

SelectionItems

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

Représentation JSON 
{
  "items": [
    {
      object (SelectionItem)
    }
  ]
}
Champs
items[]

object (SelectionItem)

Tableau d'objets SelectionItem.

SlashCommand

Métadonnées d'une commande à barre oblique dans Google Chat.

Représentation JSON 
{
  "commandId": string
}
Champs
commandId

string (int64 format)

ID de la commande à barre oblique.

MatchedUrl

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

Représentation JSON 
{
  "url": string
}
Champs
url

string

Uniquement en sortie. URL correspondante.

EmojiReactionSummary

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

Représentation JSON 
{
  "emoji": {
    object (Emoji)
  },
  "reactionCount": integer
}
Champs
emoji

object (Emoji)

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

integer

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 (DeletionType)
}
Champs
deletionType

enum (DeletionType)

Indique qui a supprimé le message.

DeletionType

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

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

QuotedMessageMetadata

Informations sur un message cité par un autre message.

Lorsque vous mettez à jour un message, vous ne pouvez pas ajouter ni remplacer le champ quotedMessageMetadata, mais vous pouvez le supprimer.

Pour obtenir un exemple d'utilisation, consultez Citer un autre message.

Représentation JSON 
{
  "name": string,
  "lastUpdateTime": string,
  "quoteType": enum (QuoteType),
  "quotedMessageSnapshot": {
    object (QuotedMessageSnapshot)
  },
  "forwardedMetadata": {
    object (ForwardedMetadata)
  }
}
Champs
name

string

Obligatoire. Nom de ressource du message cité.

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

string (Timestamp format)

Obligatoire. Code temporel de la création ou de la dernière mise à jour du message cité.

Si le message a été modifié, utilisez ce champ : lastUpdateTime. Si le message n'a jamais été modifié, utilisez createTime.

Si lastUpdateTime ne correspond pas à la dernière version du message cité, la requête échoue.
quoteType

enum (QuoteType)

Facultatif. Spécifie le type de devis. Si ce champ n'est pas défini, la valeur par défaut est REPLY dans le chemin de lecture/écriture du message pour assurer la rétrocompatibilité.
quotedMessageSnapshot

object (QuotedMessageSnapshot)

Uniquement en sortie. Un instantané du contenu du message cité.
forwardedMetadata

object (ForwardedMetadata)

Uniquement en sortie. Métadonnées sur l'espace source du message cité. Renseigné uniquement pour le type de devis FORWARD.

QuoteType

Type de citation du message cité.

Enums
QUOTE_TYPE_UNSPECIFIED Réservé. Cette valeur n'est pas utilisée.
REPLY

Lorsque quoteType est défini sur REPLY, vous pouvez effectuer les opérations suivantes :

  • Si vous répondez dans un fil de discussion, vous pouvez citer un autre message de ce fil.

  • Si vous créez un message racine, vous pouvez citer un autre message racine dans cet espace.
FORWARD

Lorsque quoteType est FORWARD, vous pouvez citer :

  • Message provenant d'un autre espace.

  • Réponse à un message provenant d'un autre fil de discussion dans le même espace.

QuotedMessageSnapshot

Fournit un aperçu du contenu du message cité au moment où il est cité ou transféré.

Représentation JSON 
{
  "sender": string,
  "text": string,
  "formattedText": string,
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "attachments": [
    {
      object (Attachment)
    }
  ]
}
Champs
sender

string

Uniquement en sortie. Nom de l'auteur du message cité. Renseigné pour les types de citation REPLY et FORWARD.
text

string

Uniquement en sortie. Instantané du contenu textuel du message cité.
formattedText

string

Uniquement en sortie. Contient le message cité text avec des balises ajoutées pour prendre en charge la mise en forme enrichie, comme les liens hypertextes, les emoji personnalisés, le balisage, etc. Renseigné uniquement pour le type de citation FORWARD.
annotations[]

object (Annotation)

Uniquement en sortie. Annotations analysées à partir du corps du texte du message cité. Renseigné uniquement pour le type de devis FORWARD.
attachments[]

object (Attachment)

Uniquement en sortie. Pièces jointes qui faisaient partie du message cité. Il s'agit de copies des métadonnées de la pièce jointe du message cité. Renseigné uniquement pour le type de devis FORWARD.

ForwardedMetadata

Métadonnées sur l'espace source à partir duquel un message a été transféré.

Représentation JSON 
{
  "space": string,
  "spaceDisplayName": string
}
Champs
space

string

Uniquement en sortie. Nom de ressource de l'espace source. Format : spaces/{space}
spaceDisplayName

string

Uniquement en sortie. Nom à afficher de l'espace ou du MP source au moment du transfert. Pour SPACE, il s'agit du nom de l'espace. Pour DIRECT_MESSAGE, il s'agit du nom de l'autre participant (par exemple, "Utilisateur A"). Pour GROUP_CHAT, il s'agit d'un nom généré à partir des prénoms des membres, limité à cinq, y compris le créateur (par exemple, "Utilisateur A, Utilisateur B").

AttachedGif

Image GIF spécifiée par une URL.

Représentation JSON 
{
  "uri": string
}
Champs
uri

string

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

AccessoryWidget

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

Représentation JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "buttonList": {
    object (ButtonList)
  }
}
Champs
Type d'action. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
buttonList

object (ButtonList)

Liste de boutons.
Fin des champs mutuellement exclusifs.

Éléments

Les éléments sont des composants supplémentaires qui peuvent être associés ou non au texte du message fourni lors de la création du message.

Représentation JSON 
{
  "citedSources": [
    {
      object (CitedSource)
    }
  ],
  "citations": [
    {
      object (Citation)
    }
  ]
}
Champs
citedSources[]

object (CitedSource)

Liste des sources à afficher sous le message sous forme de liens de pied de page. Ils ne sont pas référencés de manière intégrée. Pour les références intégrées, utilisez citations.
citations[]

object (Citation)

Liste des citations intégrées référencées dans le texte du message (via des balises <chat-citation>) qui s'affichent sous forme de fiches interactives au passage de la souris.

CitedSource

Référence à une source d'informations.

Représentation JSON 
{
  "title": string,
  "uri": string,
  "snippet": {
    object (Snippet)
  },
  "footer": {
    object (Footer)
  }
}
Champs
title

string

Obligatoire. Titre en texte brut de l'élément CitedSource. Ce champ n'est pas compatible avec la mise en forme.
uri

string

Obligatoire. URI pointant vers la ressource référencée par ce CitedSource.
snippet

object (Snippet)

Facultatif. Extrait contenant des informations provenant directement de la source.
footer

object (Footer)

Facultatif. Informations supplémentaires à afficher à côté de l'extrait sous la forme d'un pied de page.

Extrait

Objet d'extrait représentant un extrait d'un corpus plus vaste.

Représentation JSON 
{
  "text": string,
  "imagePreview": {
    object (ElementsImage)
  }
}
Champs
text

string

Facultatif. Court extrait en texte brut directement issu du corpus, qui peut être affiché dans Chat. Le format Markdown n'est pas accepté.
imagePreview

object (ElementsImage)

Facultatif. Aperçu de l'image de l'extrait fourni en entrée lors de la création de la citation.

ElementsImage

Objet encapsulant différentes manières de représenter une image. Représentations actuellement acceptées : - Une image extraite d'un URI. D'autres représentations pourraient être prises en charge à l'avenir.

Représentation JSON 
{

  "imageUri": string
}
Champs
Obligatoire. L'une des représentations d'image acceptées. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
imageUri

string

Obligatoire. URI d'une image accessible au public.
Fin des champs mutuellement exclusifs.

Pied de page d'une source, utilisé pour l'attribution.

Représentation JSON 
{
  "text": string
}
Champs
text

string

Facultatif. Texte à afficher dans le pied de page.

Citation

Les citations sont des références intégrées qui peuvent fournir aux utilisateurs des informations plus détaillées sur la référence intégrée. Les citations intégrées correspondantes doivent être présentes dans le texte du message au format de balisage <chat-citation data-id="{id}">{text}</chat-citation>. Les citations ne sont acceptées que lorsque le champ markupSyntax du message est défini sur MARKDOWN.

Les citations non référencées dans Elements.citations (celles qui n'ont pas de balise <chat-citation> correspondante dans le texte du message) sont ignorées et n'entraînent pas le rejet du message.

Représentation JSON 
{
  "id": string,
  "citedSources": [
    {
      object (CitedSource)
    }
  ]
}
Champs
id

string

Obligatoire. ID défini par l'application. Il ne doit contenir que des lettres et des chiffres ASCII, et comporter moins de 63 caractères.
citedSources[]

object (CitedSource)

Facultatif. Liste des sources pertinentes pour la citation. Les sources s'affichent dans la fiche de citation qui apparaît lorsque vous pointez sur une citation.

MarkupSyntax

Spécifie la syntaxe de balisage utilisée pour mettre en forme le texte du message de chat. S'applique au champ text de la ressource Message.

Enums
MARKUP_SYNTAX_UNSPECIFIED Représente la valeur non spécifiée.
MARKUP_SYNTAX_CHAT Utilise la syntaxe de balisage de Google Chat. Pour en savoir plus, consultez https://developers.google.com/workspace/chat/format-messages#format-texts.
MARKUP_SYNTAX_MARKDOWN Utilise la syntaxe Markdown. Cette syntaxe est basée sur la spécification CommonMark, avec des extensions supplémentaires. Pour en savoir plus, consultez https://developers.google.com/workspace/chat/format-messages#format-texts.

Méthodes

create

 Crée un message dans un espace Google Chat.

delete

 Supprime un message.

get

 Renvoie des détails sur un message.

list

 Répertorie les messages d'un espace dont l'appelant est membre, y compris les messages des membres et des espaces bloqués.

patch

 Met à jour un message.

replaceCards

 Remplace les fiches incluses dans un message.
Recherche les messages dans Google Chat auxquels l'utilisateur appelant a accès.

update

 Met à jour un message.