- Ressource: Message
- 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
- DecoratedText
- Icône
- Bouton
- Couleur
- SwitchControl
- ControlType
- ButtonList
- TextInput
- Type
- Suggestions
- SuggestionItem
- 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
- DividerStyle
- CardAction
- CardFixedFooter
- DisplayStyle
- Annotation
- AnnotationType
- UserMentionMetadata
- Type
- SlashCommandMetadata
- Type
- Thread
- ActionResponse
- ResponseType
- DialogAction
- Boîte de dialogue
- ActionStatus
- Code
- UpdatedWidget
- SelectionItems
- SlashCommand
- MatchedUrl
- EmojiReactionSummary
- DeletionMetadata
- DeletionType
- QuotedMessageMetadata
- AttachedGif
- Méthodes
Ressource: Message
Un message dans un espace Google Chat
Représentation JSON |
---|
{ "name": string, "sender": { object ( |
Champs | |
---|---|
name |
Nom de la ressource au format Exemple : |
sender |
Uniquement en sortie. Utilisateur ayant créé le message. Si votre application Chat s'authentifie en tant qu'utilisateur, la sortie renseigne les champs utilisateur |
createTime |
Pour les espaces créés dans Chat, il s'agit de la date et de l'heure de création du message. Ce champ n'est affiché qu'en sortie, sauf lorsqu'il est utilisé dans des espaces importés. Pour les espaces importés, définissez ce champ sur l'horodatage de l'historique de création du message dans la source afin de conserver la date et l'heure de création d'origine. |
lastUpdateTime |
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 |
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 de prévisualisation. Vous pouvez également @mentionner un utilisateur de Google Chat ou tous les membres de l'espace. Pour en savoir plus sur la création de messages, consultez Envoyer un SMS. |
formattedText |
Uniquement en sortie. Contient le message
Pour en savoir plus, consultez Afficher la mise en forme du texte envoyé dans un message. |
cards[] |
Obsolète: utilisez plutôt Des fiches 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 sont généralement affichées sous le corps en texte brut du message. La taille maximale de |
cardsV2[] |
Un 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 en savoir plus sur les fiches et apprendre à en créer, consultez Concevoir des interfaces utilisateur dynamiques, interactives et cohérentes avec des fiches. |
annotations[] |
Uniquement en sortie. Annotations associées à l'élément |
thread |
Fil de discussion auquel le message appartient. Pour obtenir des exemples d'utilisation, consultez Démarrer un fil de discussion ou y répondre. |
space |
Si votre application Chat s'authentifie en tant qu'utilisateur, la sortie est insérée dans l'espace |
fallbackText |
Description en texte brut des cartes du message, utilisée lorsque les cartes ne peuvent pas être affichées (par exemple, les notifications mobiles). |
actionResponse |
Uniquement en entrée. Paramètres qu'une application Chat peut utiliser pour configurer la manière dont sa réponse est publiée |
argumentText |
Uniquement en sortie. Corps du message en texte brut où toutes les mentions de l'application Chat ont été supprimées. |
slashCommand |
Uniquement en sortie. Informations sur la commande Slash, le cas échéant. |
attachment[] |
Pièce jointe importée par un utilisateur. |
matchedUrl |
Uniquement en sortie. URL dans |
threadReply |
Uniquement en sortie. Lorsque la valeur est Si l'espace n'accepte pas les réponses dans les fils de discussion, la valeur de ce champ est toujours |
clientAssignedMessageId |
Nom personnalisé attribué lors de la création d'un message Chat. Le nom doit commencer par |
emojiReactionSummaries[] |
Uniquement en sortie. Liste des résumés des réactions emoji sur le message. |
deletionMetadata |
Uniquement en sortie. Informations sur un message supprimé. Un message est supprimé lorsque la règle |
quotedMessageMetadata |
Uniquement en sortie. Informations sur un message cité par un utilisateur de Google Chat dans un espace. Les utilisateurs de Google Chat peuvent citer un message pour y répondre. |
attachedGifs[] |
Uniquement en sortie. Images GIF jointes au message |
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, les messages ne peuvent pas contenir de fiches.
Représentation JSON |
---|
{
"cardId": string,
"card": {
object ( |
Champs | |
---|---|
cardId |
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 la section Mettre en forme des messages texte.
Exemple de corps de message en texte brut:
Hello @FooBot how are you!"
Les 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 ( |
Champs | |
---|---|
type |
Type de cette annotation. |
length |
Longueur de la sous-chaîne dans le corps du message en texte brut auquel cette annotation correspond. |
startIndex |
Index de début (compris en base 0) dans le corps du message en texte brut auquel cette annotation correspond. |
Champ d'union metadata . Métadonnées supplémentaires sur l'annotation. metadata ne peut être qu'un des éléments suivants : |
|
userMention |
Métadonnées de la mention de l'utilisateur. |
slashCommand |
Métadonnées d'une commande à barre oblique. |
AnnotationType
Type de l'annotation.
Enums | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Valeur par défaut pour l'énumération. Ne pas utiliser. |
USER_MENTION |
Un utilisateur est mentionné. |
SLASH_COMMAND |
Une commande à barre oblique est appelée. |
UserMentionMetadata
Métadonnées d'annotation pour les mentions d'utilisateurs (@).
Représentation JSON |
---|
{ "user": { object ( |
Champs | |
---|---|
user |
L'utilisateur mentionné. |
type |
Type de mention de l'utilisateur. |
Type
Enums | |
---|---|
TYPE_UNSPECIFIED |
Valeur par défaut pour l'énumération. Ne pas utiliser. |
ADD |
Ajouter l'utilisateur à l'espace. |
MENTION |
Mentionner l'utilisateur dans l'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. |
commandName |
Nom de la commande à barre oblique appelée. |
commandId |
ID de commande de la commande à barre oblique appelée. |
triggersDialog |
Indique si la commande à barre oblique est destinée à une boîte de dialogue. |
Type
Enums | |
---|---|
TYPE_UNSPECIFIED |
Valeur par défaut pour l'énumération. Ne pas utiliser. |
ADD |
Ajouter l'application Chat à l'espace |
INVOKE |
Appelez une commande à barre oblique dans l'espace. |
Thread
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 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 |
Uniquement en sortie. Nom de ressource du thread. Exemple : |
threadKey |
Facultatif. Entrée pour créer ou mettre à jour un thread. Sinon, sortie uniquement. ID du fil de discussion. 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 avec 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 |
ActionResponse
Paramètres qu'une application Chat peut utiliser pour configurer la manière dont sa réponse est publiée
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 |
dialogAction |
Uniquement en entrée. Réponse à un événement d'interaction lié à une boîte de dialogue. Doit être accompagné de |
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 |
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 pour lequel 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 |
Affiche une boîte de dialogue. |
UPDATE_WIDGET |
Requête d'options de saisie semi-automatique du texte du widget. |
DialogAction
Contient une boîte de dialogue et le code d'état de la demande.
Représentation JSON |
---|
{ "actionStatus": { object ( |
Champs | |
---|---|
actionStatus |
Uniquement en entrée. État d'une requête permettant d'appeler ou d'envoyer 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
|
|
dialog |
Uniquement en entrée. Boîte de dialogue de la requête. |
Dialog
Enveloppe 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é dans une fenêtre modale. Les applications Google Chat ne sont pas compatibles avec les entités de carte suivantes: |
ActionStatus
Représente l'état d'une requête permettant d'appeler ou d'envoyer une boîte de dialogue.
Représentation JSON |
---|
{
"statusCode": enum ( |
Champs | |
---|---|
statusCode |
Code d'état. |
userFacingMessage |
Message à envoyer aux utilisateurs sur l'état de leur demande. Si cette règle n'est pas configurée, un message générique basé sur la valeur |
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 |
Il ne s'agit pas d'une erreur. Ce code est 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 y a un bon chevauchement entre 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
Réponse du widget mis à jour. Permet de fournir des options de saisie semi-automatique pour un widget.
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 requête de mise à jour. |
Champ d'union
|
|
suggestions |
Liste des résultats de la saisie semi-automatique des widgets |
SelectionItems
Liste des résultats de la saisie semi-automatique des widgets.
Représentation JSON |
---|
{
"items": [
{
object ( |
Champs | |
---|---|
items[] |
Tableau des objets SelectionItem. |
SlashCommand
Une commande à barre oblique dans Google Chat
Représentation JSON |
---|
{ "commandId": string } |
Champs | |
---|---|
commandId |
ID de la commande à barre oblique appelée. |
MatchedUrl
URL correspondante dans un message Chat. Les applications de chat peuvent prévisualiser les URL correspondantes. Pour en savoir plus, consultez Prévisualiser les liens.
Représentation JSON |
---|
{ "url": string } |
Champs | |
---|---|
url |
Uniquement en sortie. URL qui a été mise en correspondance. |
EmojiReactionSummary
Nombre de personnes qui ont réagi à un message avec un emoji spécifique.
Représentation JSON |
---|
{
"emoji": {
object ( |
Champs | |
---|---|
emoji |
Emoji associé aux réactions. |
reactionCount |
Nombre total de réactions utilisant l'emoji associé. |
DeletionMetadata
Informations sur un message supprimé. Un message est supprimé lorsque la règle deleteTime
est définie.
Représentation JSON |
---|
{
"deletionType": enum ( |
Champs | |
---|---|
deletionType |
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 au nom de l'utilisateur. |
SPACE_OWNER_VIA_APP |
Une application Chat a supprimé le message pour le compte 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 cité. Format : |
lastUpdateTime |
Uniquement en sortie. Horodatage de la création du message cité ou de sa dernière mise à jour. |
AttachedGif
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. |
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 des membres bloqués et des espaces. |
|
Met à jour un message. |
|
Met à jour un message. |