Package google.chat.v1

ButtonList

Liste des boutons.

ResponseType

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

string

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

DialogAction

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

UpdatedWidget

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

SelectionItem

Tableau d'objets SelectionItem.

string

ID du widget mis à jour. L'ID doit correspondre à celui du widget qui a déclenché la demande de mise à jour.

SelectionItems

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

Code

Code d'état.

string

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 status_code est envoyé.

AnnotationType

Type de cette annotation.

int32

Longueur de la sous-chaîne dans le corps du message en texte brut à laquelle cette annotation correspond.

int32

Indice de début (basé sur 0, inclus) dans le corps du message en texte brut auquel cette annotation correspond.

UserMentionMetadata

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

SlashCommandMetadata

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

RichLinkMetadata

Métadonnées d'un lien riche.

string

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

string

Facultatif. Nom de la ressource de l'attachement, au format spaces/{space}/messages/{message}/attachments/{attachment}.

string

Uniquement en sortie. Nom de fichier d'origine du contenu, et non chemin d'accès complet.

string

Uniquement en sortie. Type de contenu (type MIME) du fichier.

string

Uniquement en sortie. URL de la vignette à utiliser pour prévisualiser la pièce jointe auprès d'un utilisateur Les applications de chat ne doivent pas utiliser cette URL pour télécharger le contenu des pièces jointes.

string

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 des pièces jointes.

Source

Uniquement en sortie. Source de la pièce jointe.

AttachmentDataRef

Facultatif. Référence aux données de l'attachement. Ce champ permet de créer ou de mettre à jour des messages avec des pièces jointes, ou d'utiliser l'API multimédia pour télécharger les données des pièces jointes.

DriveDataRef

Uniquement en sortie. Référence à la pièce jointe Google Drive. Ce champ est utilisé avec l'API Google Drive.

string

Facultatif. Nom de la ressource des données de pièce jointe. Ce champ est utilisé avec l'API multimédia pour télécharger les données de l'attachement.

string

Facultatif. Jeton opaque contenant une référence à une pièce jointe importée. Traité par les clients comme une chaîne opaque et utilisé pour créer ou mettre à jour des messages Chat avec des pièces jointes.

string

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.

string

Espace de la ressource d'espace Chat associé.

Format : spaces/{space}

string

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

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

string

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

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

string

Obligatoire. Nom de la ressource de l'espace en mode importation.

Format : spaces/{space}

Space

Espace en mode importation.

CardHeader

En-tête de la fiche. Un en-tête contient généralement un titre et une image.

Section

Les sections sont séparées par une ligne de séparation.

CardAction

Actions de cette fiche.

string

Nom de la fiche.

string

Le libellé s'affichait dans l'élément de menu d'action.

OnClick

Action onclick pour cet élément d'action.

string

Vous devez spécifier le titre. La hauteur de l'en-tête est fixe: si un titre et un sous-titre sont spécifiés, chacun occupe une ligne. Si seul le titre est spécifié, il occupe les deux lignes.

string

Sous-titre de l'en-tête de la fiche.

ImageStyle

Type de l'image (par exemple, bordure carrée ou circulaire).

string

URL de l'image dans l'en-tête de la fiche.

string

En-tête de la section. Le texte formaté est accepté. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme du texte dans les applications Google Chat et Mettre en forme du texte dans les modules complémentaires Google Workspace.

WidgetMarkup

Une section doit contenir au moins un widget.

CustomEmoji

Obligatoire. Emoji personnalisé à créer.

string

Obligatoire. Nom de la ressource de l'espace pour lequel créer l'abonnement.

Format: spaces/{space}

Membership

Obligatoire. Relation d'appartenance à créer.

Le champ memberType doit contenir un utilisateur dont les champs user.name et user.type sont renseignés. Le serveur attribue un nom de ressource et écrase tout ce qui est spécifié.

Lorsqu'une application Chat crée une relation d'appartenance pour un utilisateur humain, elle doit utiliser certains champs d'autorisation et définir des valeurs spécifiques pour certains champs:

• Lors de l'authentification en tant qu'utilisateur, le champ d'autorisation chat.memberships est obligatoire.

• Lors de l'authentification en tant qu'application, le champ d'application chat.app.memberships est obligatoire. L'authentification en tant qu'application est disponible dans

• Définissez user.type sur HUMAN et user.name avec le format users/{user}, où {user} peut être l'adresse e-mail de l'utilisateur. Pour les utilisateurs de la même organisation Workspace, {user} peut également être l'id de la personne de l'API People ou l'id de l'utilisateur dans l'API Directory. Par exemple, si l'ID de profil de personne de l'API People pour user@example.com est 123456789, vous pouvez ajouter l'utilisateur à l'espace en définissant membership.member.name sur users/user@example.com ou users/123456789.

Lorsqu'une application Chat crée une relation d'appartenance pour elle-même, elle doit s'authentifier en tant qu'utilisateur et utiliser le champ d'application chat.memberships.app, définir user.type sur BOT et user.name sur users/app.

bool

Facultatif. Lorsque la valeur est true, la méthode s'exécute à l'aide des droits d'administrateur Google Workspace de l'utilisateur.

L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit Gérer les conversations Chat et Espaces.

Requiert le champ d'application OAuth 2.0 chat.admin.memberships.

Il n'est pas possible de créer des adhésions à une application ou des adhésions pour des utilisateurs externes à l'organisation Google Workspace de l'administrateur à l'aide de l'accès administrateur.

string

Obligatoire. Nom de la ressource de l'espace dans lequel créer un message.

Format : spaces/{space}

Message

Obligatoire. Corps du message.

string

Facultatif. Obsolète: utilisez thread.thread_key à la place. ID du thread. 4 000 caractères maximum. Pour démarrer un fil de discussion ou en ajouter un, créez un message et spécifiez un threadKey ou le thread.name. Pour obtenir un exemple d'utilisation, consultez Démarrer ou répondre à un fil de discussion.

string

Facultatif. ID de requête unique pour ce message. Spécifier un ID de requête existant renvoie le message créé avec cet ID au lieu d'en créer un autre.

MessageReplyOption

Facultatif. Indique si un message démarre un fil de discussion ou y répond. Compatible uniquement avec les espaces nommés.

Lorsque vous répondez aux interactions des utilisateurs, ce champ est ignoré. Pour les interactions dans un fil de discussion, la réponse est créée dans le même fil. Sinon, la réponse est créée en tant que nouveau fil de discussion.

string

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 la ressource du message (représenté dans le champ name du message).

La valeur de ce champ doit répondre aux exigences suivantes:

• Commence par client-. Par exemple, client-custom-name est un ID personnalisé valide, mais custom-name ne l'est pas.
• Il peut contenir jusqu'à 63 caractères et ne doit contenir que des lettres minuscules, des chiffres et des tirets.
• Il est unique dans un espace. Une application Chat ne peut pas utiliser le même ID personnalisé pour différents messages.

Pour en savoir plus, consultez Nommer un message.

string

Obligatoire. Message dans lequel la réaction est créée.

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

Reaction

Obligatoire. Réaction à créer.

Space

Obligatoire. Les champs displayName et spaceType doivent être renseignés. Seuls SpaceType.SPACE et SpaceType.GROUP_CHAT sont acceptés. SpaceType.GROUP_CHAT ne peut être utilisé que si importMode est défini sur "true".

Si le message d'erreur ALREADY_EXISTS s'affiche, essayez un autre displayName. Il est possible qu'un espace existant de l'organisation Google Workspace utilise déjà ce nom à afficher.

L'espace name est attribué sur le serveur. Par conséquent, tout ce qui est spécifié dans ce champ sera ignoré.

string

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. Spécifier un ID de requête existant de la même application Chat avec un autre utilisateur authentifié génère une erreur.

string

Identifiant. Nom de ressource de l'emoji personnalisé, attribué par le serveur.

Format : customEmojis/{customEmoji}

string

Uniquement en sortie. Clé unique de la ressource d'emoji personnalisés.

string

Facultatif. Immuable. Nom fourni par l'utilisateur pour l'emoji personnalisé, qui doit être unique au sein de l'organisation.

Obligatoire lors de la création de l'emoji personnalisé, uniquement en sortie dans le cas contraire.

Les noms des emoji doivent commencer et se terminer par des deux-points, être en minuscules et ne contenir que des caractères alphanumériques, des traits d'union et des traits de soulignement. Les traits d'union et les traits de soulignement servent à séparer les mots et ne peuvent pas être utilisés de manière consécutive.

Exemple : :valid-emoji-name:

string

Uniquement en sortie. URL de l'image de l'emoji personnalisé, valide pendant au moins 10 minutes. Notez que ce champ n'est pas renseigné dans la réponse lorsque l'emoji personnalisé est créé.

CustomEmojiPayload

Facultatif. Uniquement en entrée. Données de charge utile. Obligatoire lors de la création de l'emoji personnalisé.

bytes

Obligatoire. Uniquement en entrée. Image utilisée pour l'emoji personnalisé.

La charge utile doit être inférieure à 256 ko et la dimension de l'image doit être comprise entre 64 et 500 pixels. Ces restrictions sont susceptibles d'être modifiées.

string

Obligatoire. Uniquement en entrée. Nom du fichier image.

Extensions de fichier compatibles: .png, .jpg, .gif.

string

Obligatoire. Nom de ressource de l'emoji personnalisé à supprimer.

Format : customEmojis/{customEmoji}

Vous pouvez utiliser le nom de l'emoji comme alias pour {customEmoji}. Par exemple, customEmojis/:example-emoji:, où :example-emoji: correspond au nom de l'emoji personnalisé.

string

Obligatoire. Nom de ressource de l'abonnement à supprimer. Les applications de chat peuvent supprimer les adhésions d'utilisateurs ou les leurs. Les applications Chat ne peuvent pas supprimer les appartenances d'autres applications.

Lorsque vous supprimez une appartenance à un utilisateur, vous devez spécifier la portée chat.memberships et le format spaces/{space}/members/{member}. Vous pouvez utiliser l'adresse e-mail comme alias pour {member}. Par exemple, spaces/{space}/members/example@gmail.com, où example@gmail.com correspond à l'adresse e-mail de l'utilisateur Google Chat.

Lorsque vous supprimez une appartenance à une application, vous devez utiliser le champ d'application chat.memberships.app et le format spaces/{space}/members/app.

Format: spaces/{space}/members/{member} ou spaces/{space}/members/app.

bool

Facultatif. Lorsque la valeur est true, la méthode s'exécute à l'aide des droits d'administrateur Google Workspace de l'utilisateur.

L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit Gérer les conversations Chat et Espaces.

Requiert le champ d'application OAuth 2.0 chat.admin.memberships.

Il n'est pas possible de supprimer des appartenances à des applications dans un espace à l'aide d'un accès administrateur.

string

Obligatoire. Nom de ressource du message.

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

Si vous avez défini un ID personnalisé pour votre message, vous pouvez utiliser la valeur du champ clientAssignedMessageId pour {message}. Pour en savoir plus, consultez Nommer un message.

bool

Facultatif. Lorsque true est activé, la suppression d'un message entraîne également la suppression des réponses associées. Lorsque false est défini, si un message comporte des réponses sous forme de fil de discussion, la suppression échoue.

Ne s'applique que lors de l'authentification en tant qu'utilisateur. N'a aucun effet lors de l'authentification en tant qu'application Chat.

string

Obligatoire. Nom de la réaction à supprimer.

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

string

Obligatoire. Nom de la ressource de l'espace à supprimer.

Format : spaces/{space}

bool

Facultatif. Lorsque la valeur est true, la méthode s'exécute à l'aide des droits d'administrateur Google Workspace de l'utilisateur.

L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit Gérer les conversations Chat et Espaces.

Requiert le champ d'application OAuth 2.0 chat.admin.delete.

DeletionType

Indique qui a supprimé le message.

Card

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

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.

Dialog

Uniquement en entrée. Dialog (Boîte de dialogue) pour la requête.

string

ID du fichier Drive. À utiliser avec l'API Drive.

DriveDataRef

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

string

Type MIME de la ressource Google Drive associée.

string

Facultatif. Emoji de base représenté par une chaîne Unicode.

CustomEmoji

Uniquement en sortie. Un emoji personnalisé.

Emoji

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

int32

Uniquement en sortie. Nombre total de réactions utilisant l'emoji associé.

string

Obligatoire. Nom de la ressource de l'utilisateur avec lequel envoyer un message privé.

Format: users/{user}, où {user} correspond à l'id de la personne de l'API People ou à l'id de l'utilisateur de l'API Directory. Par exemple, si l'ID de profil de l'API People est 123456789, vous pouvez trouver un message privé avec cette personne en utilisant users/123456789 comme name. Lorsque vous êtes authentifié en tant qu'utilisateur, vous pouvez utiliser l'adresse e-mail comme alias pour {user}. Par exemple, users/example@gmail.com, où example@gmail.com correspond à l'adresse e-mail de l'utilisateur Google Chat.

string

Obligatoire. Nom de la ressource de l'attachement, au format spaces/{space}/messages/{message}/attachments/{attachment}.

string

Obligatoire. Nom de ressource de l'emoji personnalisé.

Format : customEmojis/{customEmoji}

Vous pouvez utiliser le nom de l'emoji comme alias pour {customEmoji}. Par exemple, customEmojis/:example-emoji:, où :example-emoji: correspond au nom de l'emoji personnalisé.

string

Obligatoire. Nom de ressource de l'abonnement à récupérer.

Pour obtenir l'appartenance de l'application à l'aide de l'authentification utilisateur, vous pouvez utiliser spaces/{space}/members/app.

Format: spaces/{space}/members/{member} ou spaces/{space}/members/app

Vous pouvez utiliser l'adresse e-mail de l'utilisateur comme alias pour {member}. Par exemple, spaces/{space}/members/example@gmail.com, où example@gmail.com correspond à l'adresse e-mail de l'utilisateur Google Chat.

bool

Facultatif. Lorsque la valeur est true, la méthode s'exécute à l'aide des droits d'administrateur Google Workspace de l'utilisateur.

L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit Gérer les conversations Chat et Espaces.

Requiert les champs d'application OAuth 2.0 chat.admin.memberships ou chat.admin.memberships.readonly.

Il n'est pas possible d'obtenir les adhésions aux applications dans un espace lorsque vous utilisez un accès administrateur.

string

Obligatoire. Nom de ressource du message.

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

Si vous avez défini un ID personnalisé pour votre message, vous pouvez utiliser la valeur du champ clientAssignedMessageId pour {message}. Pour en savoir plus, consultez Nommer un message.

string

Obligatoire. Nom de la ressource de l'événement de l'espace.

Format : spaces/{space}/spaceEvents/{spaceEvent}

string

Obligatoire. Format: users/{user}/spaces/{space}/spaceNotificationSetting

• users/me/spaces/{space}/spaceNotificationSetting, OU
• users/user@example.com/spaces/{space}/spaceNotificationSetting, OU
• users/123456789/spaces/{space}/spaceNotificationSetting. Remarque: Seul l'ID utilisateur ou l'adresse e-mail de l'appelant est autorisé dans le chemin d'accès.

string

Obligatoire. Nom de la ressource de l'état de lecture de l'espace à récupérer.

Permet uniquement d'obtenir l'état de lecture de l'utilisateur appelant.

Pour faire référence à l'utilisateur appelant, définissez l'une des valeurs suivantes:

• Alias me. Exemple :users/me/spaces/{space}/spaceReadState

• Son adresse e-mail Workspace Par exemple, users/user@example.com/spaces/{space}/spaceReadState.

• Son ID utilisateur. Par exemple, users/123456789/spaces/{space}/spaceReadState.

Format: users/{user}/spaces/{space}/spaceReadState

string

Obligatoire. Nom de la ressource de l'espace, au format spaces/{space}.

Format : spaces/{space}

bool

Facultatif. Lorsque la valeur est true, la méthode s'exécute à l'aide des droits d'administrateur Google Workspace de l'utilisateur.

L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit Gérer les conversations Chat et Espaces.

Requiert les champs d'application OAuth 2.0 chat.admin.spaces ou chat.admin.spaces.readonly.

string

Obligatoire. Nom de ressource de l'état de lecture du thread à récupérer.

Permet uniquement d'obtenir l'état de lecture de l'utilisateur appelant.

Pour faire référence à l'utilisateur appelant, définissez l'une des valeurs suivantes:

• Alias me. Exemple :users/me/spaces/{space}/threads/{thread}/threadReadState

• Son adresse e-mail Workspace Par exemple, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState.

• Son ID utilisateur. Par exemple, users/123456789/spaces/{space}/threads/{thread}/threadReadState.

Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState

string

Nom de ressource d'un groupe Google.

Représente un groupe dans l'API Cloud Identity Groups.

Format: groups/{group}

int32

Facultatif. Nombre maximal d'emoji personnalisés renvoyés. Le service peut renvoyer un nombre inférieur à cette valeur. Si elle n'est pas spécifiée, la valeur par défaut est 25. La valeur maximale est 200. Les valeurs supérieures sont remplacées par 200.

string

Facultatif. (Si vous reprenez à partir d'une requête précédente.)

Jeton de page reçu lors d'un appel d'emoji personnalisés de liste précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, la valeur du filtre doit correspondre à l'appel ayant fourni le jeton de page. Transmettre une valeur différente peut entraîner des résultats inattendus.

string

Facultatif. Filtre de requête

Prend en charge le filtrage par créateur.

Pour filtrer par créateur, vous devez spécifier une valeur valide. Actuellement, seuls creator("users/me") et NOT creator("users/me") sont acceptés pour filtrer les emoji personnalisés selon qu'ils ont été créés par l'utilisateur appelant ou non.

Par exemple, la requête suivante renvoie les emoji personnalisés créés par l'appelant:

creator("users/me")

Les requêtes non valides sont rejetées par le serveur avec une erreur INVALID_ARGUMENT.

CustomEmoji

Liste non ordonnée. Liste des emoji personnalisés sur la page demandée (ou première).

string

Jeton que vous pouvez envoyer en tant que pageToken pour récupérer la page de résultats suivante. Si ce champ est vide, aucune page suivante n'existe.

string

Obligatoire. Nom de ressource de l'espace pour lequel extraire une liste de membres.

Format: spaces/{space}

int32

Facultatif. Nombre maximal d'adhésions à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur.

Si aucune valeur n'est spécifiée, 100 souscriptions 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 INVALID_ARGUMENT.

string

Facultatif. Jeton de page reçu d'un appel précédent pour lister les adhésions. Fournissez ce paramètre pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis doivent correspondre à l'appel ayant fourni le jeton de page. Transmettre des valeurs différentes aux autres paramètres peut entraîner des résultats inattendus.

string

Facultatif. Filtre de requête

Vous pouvez filtrer les adhésions par rôle (role) et type (member.type) des membres.

Pour filtrer par rôle, définissez role sur ROLE_MEMBER ou ROLE_MANAGER.

Pour filtrer par type, définissez member.type sur HUMAN ou BOT. Vous pouvez également filtrer pour member.type à l'aide de l'opérateur !=.

Pour filtrer à la fois par rôle et par type, utilisez l'opérateur AND. Pour filtrer par rôle ou type, utilisez l'opérateur OR.

member.type = "HUMAN" ou member.type != "BOT" est obligatoire lorsque use_admin_access est défini sur "true". Les autres filtres de type de membre seront refusés.

Par exemple, les requêtes suivantes sont valides:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

Les requêtes suivantes ne sont pas valides:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

Les requêtes non valides sont rejetées par le serveur avec une erreur INVALID_ARGUMENT.

bool

Facultatif. Lorsque la valeur est true, renvoie également les souscriptions associées à un Google Group, en plus des autres types de souscriptions. Si un filter est défini, les appartenances Google Group qui ne correspondent pas aux critères de filtre ne sont pas renvoyées.

bool

Facultatif. Lorsque la valeur est true, renvoie également les souscriptions associées aux membres invited, en plus des autres types de souscriptions. Si un filtre est défini, les appartenances invited qui ne correspondent pas aux critères de filtre ne sont pas renvoyées.

Actuellement, elle nécessite l'authentification des utilisateurs.

bool

Facultatif. Lorsque la valeur est true, la méthode s'exécute à l'aide des droits d'administrateur Google Workspace de l'utilisateur.

L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit Gérer les conversations Chat et Espaces.

Nécessite le champ d'application OAuth 2.0 chat.admin.memberships.readonly ou chat.admin.memberships.

Il n'est pas possible de lister les appartenances à des applications dans un espace lorsque vous utilisez un accès administrateur.

Membership

Liste non ordonnée. Liste des adhésions sur la page demandée (ou première).

string

Jeton que vous pouvez envoyer en tant que pageToken pour récupérer la page de résultats suivante. Si ce champ est vide, aucune page suivante n'existe.

string

Obligatoire. Nom de la ressource de l'espace à partir duquel lister les messages.

Format : spaces/{space}

int32

Facultatif. Nombre maximal de messages renvoyés. Le service peut renvoyer un nombre inférieur à cette valeur.

Si aucune valeur n'est spécifiée, 25 éléments sont renvoyés au maximum.

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

string

Facultatif. Jeton de page reçu lors d'un appel de liste de messages précédent. Fournissez ce paramètre pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis doivent correspondre à l'appel ayant fourni le jeton de page. Transmettre des valeurs différentes aux autres paramètres peut entraîner des résultats inattendus.

string

Facultatif. Filtre de requête

Vous pouvez filtrer les messages par date (create_time) et par fil de discussion (thread.name).

Pour filtrer les messages en fonction de la date de leur création, spécifiez create_time avec un code temporel au format RFC-3339 et des guillemets doubles. Par exemple, "2023-04-21T11:30:00-04:00". Vous pouvez utiliser l'opérateur supérieur à > pour lister les messages créés après un code temporel ou l'opérateur inférieur à < pour lister les messages créés avant un code temporel. Pour filtrer les messages dans un intervalle de temps, utilisez l'opérateur AND entre deux horodatages.

Pour filtrer par thread, spécifiez le thread.name, au format spaces/{space}/threads/{thread}. Vous ne pouvez spécifier qu'un seul thread.name par requête.

Pour filtrer à la fois par fil de discussion et par date, utilisez l'opérateur AND dans votre requête.

Par exemple, les requêtes suivantes sont valides:

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

Les requêtes non valides sont rejetées par le serveur avec une erreur INVALID_ARGUMENT.

string

Facultatif. Ordre de la liste des messages. Spécifiez une valeur à trier par une opération de tri. Les valeurs d'opération de tri valides sont les suivantes:

• ASC pour l'ordre croissant.

• DESC pour décroissant.

L'ordre par défaut est create_time ASC.

bool

Facultatif. Indique si les messages supprimés doivent être inclus. Les messages supprimés incluent l'heure de suppression et les métadonnées sur la suppression, mais leur contenu n'est pas disponible.

Message

Liste des messages.

string

Vous pouvez envoyer un jeton en tant que pageToken pour récupérer la page de résultats suivante. Si ce champ est vide, aucune page suivante n'existe.

string

Obligatoire. Message auquel les utilisateurs ont réagi.

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

int32

Facultatif. Nombre maximal de réactions renvoyées. Le service peut renvoyer un nombre inférieur à cette valeur. Si elle n'est pas spécifiée, la valeur par défaut est 25. La valeur maximale est 200. Les valeurs supérieures sont remplacées par 200.

string

Facultatif. (Si vous reprenez à partir d'une requête précédente.)

Jeton de page reçu lors d'un appel de liste de réactions précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, la valeur du filtre doit correspondre à l'appel ayant fourni le jeton de page. Transmettre une valeur différente peut entraîner des résultats inattendus.

string

Facultatif. Filtre de requête

Vous pouvez filtrer les réactions par emoji (emoji.unicode ou emoji.custom_emoji.uid) et utilisateur (user.name).

Pour filtrer les réactions pour plusieurs emoji ou utilisateurs, joignez des champs similaires à l'aide de l'opérateur OR, comme emoji.unicode = "🙂" OR emoji.unicode = "👍" et user.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

Pour filtrer les réactions par emoji et par utilisateur, utilisez l'opérateur AND, par exemple emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

Si votre requête utilise à la fois AND et OR, regroupez-les à l'aide de parenthèses.

Par exemple, les requêtes suivantes sont valides:

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

Les requêtes suivantes ne sont pas valides:

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

Les requêtes non valides sont rejetées par le serveur avec une erreur INVALID_ARGUMENT.

Reaction

Liste des réactions sur la page demandée (ou première).

string

Jeton de continuation permettant de récupérer la page de résultats suivante. Il est vide pour la dernière page de résultats.

string

Obligatoire. Nom de la ressource de l'espace Google Chat dans lequel les événements se sont produits.

Format : spaces/{space}.

int32

Facultatif. Nombre maximal d'événements d'espace renvoyés. Le service peut renvoyer un nombre inférieur à cette valeur.

Les valeurs négatives renvoient une erreur INVALID_ARGUMENT.

string

Facultatif. Jeton de page reçu d'un appel d'événements d'espace de liste précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis aux événements de liste d'espaces doivent correspondre à l'appel ayant fourni le jeton de page. Transmettre des valeurs différentes aux autres paramètres peut entraîner des résultats inattendus.

string

Obligatoire. Filtre de requête

Vous devez spécifier au moins un type d'événement (event_type) à l'aide de l'opérateur a :. Pour filtrer par plusieurs types d'événements, utilisez l'opérateur OR. Omettre les types d'événements groupés dans votre filtre La requête renvoie automatiquement tous les événements de lot associés. Par exemple, si vous filtrez par nouvelles réactions (google.workspace.chat.reaction.v1.created), le serveur renvoie également des événements de nouvelles réactions par lot (google.workspace.chat.reaction.v1.batchCreated). Pour obtenir la liste des types d'événements compatibles, consultez la documentation de référence sur SpaceEvents.

Vous pouvez également filtrer les données par heure de début (start_time) et heure de fin (end_time):

• start_time: code temporel exclusif à partir duquel commencer à lister les événements de l'espace. Vous pouvez lister les événements qui se sont produits il y a jusqu'à 28 jours. Si ce paramètre n'est pas spécifié, la liste des événements de l'espace au cours des 28 derniers jours s'affiche.
• end_time: code temporel inclusif jusqu'auquel les événements de l'espace sont listés. Si ce paramètre n'est pas spécifié, les événements sont listés jusqu'à l'heure de la requête.

Pour spécifier une heure de début ou de fin, utilisez l'opérateur égal à = et le format RFC-3339. Pour filtrer à la fois par start_time et end_time, utilisez l'opérateur AND.

Par exemple, les requêtes suivantes sont valides:

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"

start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

Les requêtes suivantes ne sont pas valides:

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"

event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

Les requêtes non valides sont rejetées par le serveur avec une erreur INVALID_ARGUMENT.

SpaceEvent

Les résultats sont renvoyés dans l'ordre chronologique (événement le plus ancien en premier). Remarque: Le champ permissionSettings n'est pas renvoyé dans l'objet Space pour les requêtes de liste.

string

Jeton de continuation utilisé pour extraire d'autres événements. Si ce champ est omis, il n'y a pas d'autres pages.

int32

Facultatif. Nombre maximal d'espaces à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur.

Si ce paramètre n'est pas spécifié, 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 INVALID_ARGUMENT.

string

Facultatif. Jeton de page reçu d'un appel de liste d'espaces précédent. Fournissez ce paramètre pour récupérer la page suivante.

Lors de la pagination, la valeur du filtre doit correspondre à l'appel ayant fourni le jeton de page. Transmettre une valeur différente peut entraîner des résultats inattendus.

string

Facultatif. Filtre de requête

Vous pouvez filtrer les espaces par type (space_type).

Pour filtrer par type d'espace, vous devez spécifier une valeur d'énumération valide, telle que SPACE ou GROUP_CHAT (space_type ne peut pas être SPACE_TYPE_UNSPECIFIED). Pour rechercher plusieurs types d'espaces, utilisez l'opérateur OR.

Par exemple, les requêtes suivantes sont valides:

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

Les requêtes non valides sont rejetées par le serveur avec une erreur INVALID_ARGUMENT.

Space

Liste des espaces de la page demandée (ou première). Remarque: Le champ permissionSettings n'est pas renvoyé dans l'objet Space pour les requêtes de liste.

string

Vous pouvez envoyer un jeton en tant que pageToken pour récupérer la page de résultats suivante. Si ce champ est vide, aucune page suivante n'existe.

string

Uniquement en sortie. URL correspondante.

string

Identifiant. Nom de la ressource de l'abonnement, attribué par le serveur.

Format : spaces/{space}/members/{member}

MembershipState

Uniquement en sortie. État de l'abonnement.

MembershipRole

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é qu'en entrée dans UpdateMembership.

Timestamp

Facultatif. Immuable. Date de création de l'appartenance, par exemple lorsque le membre a rejoint ou a été invité à rejoindre un espace. Ce champ est à usage exclusif en sortie, sauf lorsqu'il est utilisé pour importer des adhésions historiques dans des espaces en mode importation.

Timestamp

Facultatif. Immuable. Heure de suppression de l'appartenance, par exemple lorsque le membre a quitté ou a été exclu d'un espace. Ce champ est à usage exclusif en sortie, sauf lorsqu'il est utilisé pour importer des adhésions historiques dans des espaces en mode importation.

User

Facultatif. Utilisateur ou application Google Chat à laquelle l'appartenance correspond. Si votre application Chat s'authentifie en tant qu'utilisateur, la sortie renseigne les utilisateurs name et type.

Group

Facultatif. Groupe Google auquel l'appartenance correspond.

La lecture ou la modification des adhésions à Google Groupes nécessite l'authentification des utilisateurs.

MembershipCreatedEventData

Liste des nouveaux abonnements.

MembershipDeletedEventData

Liste des souscriptions supprimées.

MembershipUpdatedEventData

Liste des adhésions mises à jour.

Membership

Le nouvel abonnement.

Membership

Abonnement supprimé. Seuls les champs name et state sont renseignés.

Membership

L'appartenance mise à jour.

string

Identifiant. Nom de ressource du message.

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

Où {space} correspond à l'ID de l'espace dans lequel le message est publié et {message} à un ID attribué par le système au 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.

User

Uniquement en sortie. Utilisateur ayant créé le message. Si votre application Chat s'authentifie en tant qu'utilisateur, la sortie renseigne les utilisateurs name et type.

Timestamp

Facultatif. Immuable. Pour les espaces créés dans Chat, l'heure à laquelle le message a été créé. Ce champ est à usage exclusif en 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 au moment de la création du message dans la source afin de conserver l'heure de création d'origine.

Timestamp

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.

Timestamp

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

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.

string

Uniquement en sortie. Contient le message text avec des balisages ajoutés pour communiquer la mise en forme. Ce champ ne capture peut-être pas toute la mise en forme visible dans l'interface utilisateur, mais inclut les éléments suivants:

• Syntaxe de balisage pour le gras, l'italique, le texte barré, la police monotype, le bloc de texte monotype et la liste à puces.

• 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 le texte affiché (par exemple, <http://example.com|custom text>).

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

Pour en savoir plus, consultez Afficher le formatage du texte envoyé dans un message.

Card

Obsolète: utilisez cards_v2 à la place.

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 fiches sont généralement affichées sous le corps du message en texte brut. cards et cards_v2 peuvent avoir une taille maximale de 32 Ko.

CardWithId

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 à l'aide de l'outil de création de fiches.

Annotation

Uniquement en sortie. Annotations associées au text dans ce message.

Thread

Fil de discussion auquel le message appartient. 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 name.

string

Facultatif. Description au format texte brut des fiches du message, utilisée lorsque les fiches réelles 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 publication de sa réponse.

string

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

SlashCommand

Uniquement en sortie. Informations sur les commandes à barre oblique, le cas échéant.

Attachment

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

MatchedUrl

Uniquement en sortie. URL dans spaces.messages.text correspondant à un format d'aperçu de lien. Pour en savoir plus, consultez Liens d'aperçu.

bool

Uniquement en sortie. Si la valeur est true, le message est une réponse dans un fil de discussion. Si la valeur est false, le message est visible dans la conversation de niveau supérieur de l'espace en tant que premier message d'un fil de discussion ou en tant que message sans réponses sous forme de fil de discussion.

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

string

Facultatif. ID personnalisé du message. Vous pouvez utiliser ce champ pour identifier un message, ou pour l'obtenir, le supprimer ou le mettre à jour. 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.

EmojiReactionSummary

Uniquement en sortie. Liste des résumés des réactions emoji sur le message.

User

Facultatif. Immuable. Entrée pour créer 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:

• Rattachements
• Widgets d'accessoires

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

DeletionMetadata

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

QuotedMessageMetadata

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.

AttachedGif

Uniquement en sortie. Images GIF jointes au message

AccessoryWidget

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.

MessageCreatedEventData

Liste des nouveaux messages.

MessageDeletedEventData

Liste des messages supprimés.

MessageUpdatedEventData

Liste des messages mis à jour.

Message

Nouveau message.

Message

Message supprimé. Seuls les champs name, createTime, deleteTime et deletionMetadata sont renseignés.

Message

Message mis à jour.

string

Uniquement en sortie. Nom de ressource du message cité.

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

Timestamp

Uniquement en sortie. Code temporel de création ou de dernière mise à jour du message cité.

string

Identifiant. Nom de la ressource de la réaction.

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

User

Uniquement en sortie. Utilisateur ayant créé la réaction.

Emoji

Obligatoire. Emoji utilisé dans la réaction.

ReactionCreatedEventData

Liste des nouvelles réactions.

ReactionDeletedEventData

Liste des réactions supprimées.

Reaction

Nouvelle réaction.

Reaction

Réaction supprimée.

string

URI de ce lien.

RichLinkType

Type de lien enrichi.

DriveLinkData

Données pour un lien Drive.

ChatSpaceLinkData

Données pour un lien vers un espace Chat.

bool

Lorsque la valeur est true, la méthode s'exécute à l'aide des droits d'administrateur Google Workspace de l'utilisateur.

L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit Gérer les conversations Chat et Espaces.

Nécessite le champ d'application OAuth 2.0 chat.admin.spaces.readonly ou chat.admin.spaces.

Cette méthode n'est actuellement compatible qu'avec l'accès administrateur. Par conséquent, seul true est accepté pour ce champ.

int32

Nombre maximal d'espaces à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur.

Si ce paramètre n'est pas spécifié, 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.

string

Jeton reçu lors de l'appel d'espaces de recherche précédent. Fournissez ce paramètre pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis doivent correspondre à l'appel ayant fourni le jeton de page. Transmettre des valeurs différentes aux autres paramètres peut entraîner des résultats inattendus.

string

Obligatoire. Requête de recherche.

Vous pouvez effectuer une recherche à l'aide des paramètres suivants:

• create_time
• customer
• display_name
• external_user_allowed
• last_active_time
• space_history_state
• space_type

create_time et last_active_time acceptent un code temporel au format RFC-3339. Les opérateurs de comparaison acceptés sont les suivants: =, <, >, <= et >=.

customer est obligatoire et permet d'indiquer le client à partir duquel extraire les espaces. customers/my_customer est la seule valeur acceptée.

display_name n'accepte que l'opérateur HAS (:). Le texte à faire correspondre est d'abord tokenisé en jetons, et chaque jeton est mis en correspondance avec un préfixe, sans distinction de casse et de manière indépendante, en tant que sous-chaîne n'importe où dans l'display_name de l'espace. Par exemple, Fun Eve correspond à Fun event ou The evening was fun, mais pas à notFun event ou even.

external_user_allowed accepte true ou false.

space_history_state n'accepte que les valeurs du champ historyState d'une ressource space.

space_type est obligatoire, et la seule valeur valide est SPACE.

Dans les différents champs, seuls les opérateurs AND sont acceptés. space_type = "SPACE" AND display_name:"Hello" est un exemple valide, tandis que space_type = "SPACE" OR display_name:"Hello" est un exemple non valide.

Dans le même champ, space_type n'est pas compatible avec les opérateurs AND ou OR. display_name, "space_history_state" et "external_user_allowed" n'acceptent que les opérateurs OR. last_active_time et create_time acceptent les opérateurs AND et OR. AND ne peut être utilisé que pour représenter un intervalle, tel que last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00".

Les exemples de requêtes suivants sont valides:

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")

string

Facultatif. Ordre de la liste des espaces.

Les attributs acceptés pour la commande sont les suivants:

• membership_count.joined_direct_human_user_count : indique le nombre d'utilisateurs humains ayant rejoint directement un espace.
• last_active_time : indique l'heure à laquelle le dernier élément éligible a été ajouté à un sujet de cet espace.
• create_time : indique l'heure de création de l'espace.

Les valeurs d'opération d'ordonnancement valides sont les suivantes:

• ASC pour l'ordre croissant. Valeur par défaut.

• DESC pour décroissant.

Les syntaxes acceptées sont les suivantes:

• membership_count.joined_direct_human_user_count DESC
• membership_count.joined_direct_human_user_count ASC
• last_active_time DESC
• last_active_time ASC
• create_time DESC
• create_time ASC

Space

Page des espaces demandés.

string

Jeton permettant de récupérer la page suivante. Si ce champ est vide, aucune page suivante n'existe.

int32

Nombre total d'espaces correspondant à la requête, sur toutes les pages. Si le résultat est supérieur à 10 000 espaces, cette valeur est une estimation.

Space

Obligatoire. Le champ Space.spaceType est obligatoire.

Pour créer un espace, définissez Space.spaceType sur SPACE et Space.displayName. Si le message d'erreur ALREADY_EXISTS s'affiche lorsque vous configurez un espace, essayez un autre displayName. Il est possible qu'un espace existant de l'organisation Google Workspace utilise déjà ce nom à afficher.

Pour créer un chat de groupe, définissez Space.spaceType sur GROUP_CHAT. Ne définissez pas Space.displayName.

Pour créer une conversation privée entre deux utilisateurs, définissez Space.spaceType sur DIRECT_MESSAGE et Space.singleUserBotDm sur false. Ne définissez pas Space.displayName ni Space.spaceDetails.

Pour créer une conversation privée entre un humain et l'application Chat appelante, définissez Space.spaceType sur DIRECT_MESSAGE et Space.singleUserBotDm sur true. Ne définissez pas Space.displayName ni Space.spaceDetails.

Si un espace DIRECT_MESSAGE existe déjà, il est renvoyé au lieu d'en créer un.

string

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. Spécifier un ID de requête existant de la même application Chat avec un autre utilisateur authentifié génère une erreur.

Membership

Facultatif. Les utilisateurs ou groupes Google Chat à inviter à rejoindre l'espace. Omettre l'utilisateur appelant, car il est ajouté automatiquement.

L'ensemble autorise actuellement jusqu'à 20 membres (en plus de l'appelant).

Pour l'appartenance à un groupe d'utilisateurs, le champ Membership.member doit contenir un user avec name renseigné (format: users/{user}) et type défini sur User.Type.HUMAN. Vous ne pouvez ajouter que des utilisateurs humains lorsque vous configurez un espace (l'ajout d'applications Chat n'est compatible qu'avec la configuration de messages privés avec l'application d'appel). Vous pouvez également ajouter des membres en utilisant l'adresse e-mail de l'utilisateur comme alias pour {user}. Par exemple, user.name peut être users/example@gmail.com. Pour inviter des utilisateurs Gmail ou des utilisateurs de domaines Google Workspace externes, vous devez utiliser leur adresse e-mail pour {user}.

Pour l'appartenance à un groupe Google, le champ Membership.group_member doit contenir un group avec name renseigné (format groups/{group}). Vous ne pouvez ajouter des groupes Google que lorsque vous définissez Space.spaceType sur SPACE.

Facultatif lorsque vous définissez Space.spaceType sur SPACE.

Obligatoire lorsque vous définissez Space.spaceType sur GROUP_CHAT, ainsi que pour au moins deux adhésions.

Obligatoire lorsque vous définissez Space.spaceType sur DIRECT_MESSAGE avec un utilisateur humain, ainsi qu'un seul abonnement.

Doit être vide lorsque vous créez une conversation privée entre un humain et l'application Chat appelante (lorsque vous définissez Space.spaceType sur DIRECT_MESSAGE et Space.singleUserBotDm sur true).

int64

ID de la commande à barre oblique appelée.

User

Application Chat dont la commande a été appelée.

Type

Type de commande à barre oblique.

string

Nom de la commande à barre oblique appelée.

int64

ID de la commande à barre oblique appelée.

bool

Indique si la commande à barre oblique est destinée à une boîte de dialogue.

string

Identifiant. Nom de la ressource de l'espace.

Format : spaces/{space}

Où {space} représente l'ID attribué par le système à l'espace. Vous pouvez obtenir l'ID de l'espace en appelant la méthode spaces.list() ou à partir de l'URL de l'espace. Par exemple, si l'URL de l'espace est https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, l'ID de l'espace est AAAAAAAAA.

Type

Uniquement en sortie. Obsolète: utilisez space_type à la place. Type d'espace.

SpaceType

Facultatif. Type d'espace. Obligatoire lors de la création d'un espace ou de la mise à jour de son type. Sortie uniquement pour une autre utilisation.

bool

Facultatif. Indique si l'espace est un message privé entre une application Chat et une personne.

bool

Uniquement en sortie. Obsolète: utilisez spaceThreadingState à la place. Indique si les messages sont organisés en fils de discussion dans cet espace.

string

Facultatif. Nom à afficher de l'espace. Obligatoire lors de la création d'un espace avec un spaceType de SPACE. Si le message d'erreur ALREADY_EXISTS s'affiche lorsque vous créez un espace ou mettez à jour le displayName, essayez un autre displayName. Il est possible qu'un espace existant de l'organisation Google Workspace utilise déjà ce nom à afficher.

Pour les messages privés, ce champ peut être vide.

Peut contenir jusqu'à 128 caractères.

bool

Facultatif. Immuable. Indique si cet espace autorise tout utilisateur Google Chat à en être membre. Valeur à saisir lorsque vous créez un espace dans une organisation Google Workspace. Omettre ce champ lorsque vous créez des espaces dans les conditions suivantes:

• L'utilisateur authentifié utilise un compte personnel (compte utilisateur non géré). Par défaut, un espace créé avec un compte personnel autorise tous les utilisateurs de Google Chat.

Pour les espaces existants, ce champ est de sortie uniquement.

SpaceThreadingState

Uniquement en sortie. État des fils de discussion dans l'espace Chat.

SpaceDetails

Facultatif. Informations sur l'espace, y compris sa description et ses règles

HistoryState

Facultatif. État de l'historique des messages pour les messages et les fils de discussion de cet espace.

bool

Facultatif. Indique si cet espace est créé dans Import Mode lors d'une migration de données vers Google Workspace. Pendant l'importation des espaces, ils ne sont pas visibles par les utilisateurs tant que l'importation n'est pas terminée.

La création d'un espace dans Import Mode nécessite l'authentification des utilisateurs.

Timestamp

Facultatif. Immuable. Pour les espaces créés dans Chat, l'heure à laquelle ils ont été créés. Ce champ est à usage exclusif en 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 au moment de la création de l'espace dans la source afin de conserver l'heure de création d'origine.

N'est renseigné dans la sortie que lorsque spaceType est GROUP_CHAT ou SPACE.

Timestamp

Uniquement en sortie. Code temporel du dernier message dans l'espace.

bool

Uniquement en sortie. Pour les espaces de messages privés (MP) avec une application Chat, indique si l'espace a été créé par un administrateur Google Workspace. Les administrateurs peuvent installer et configurer un message privé avec une application Chat au nom des utilisateurs de leur organisation.

Pour être compatible avec l'installation par administrateur, votre application Chat doit proposer les messages privés.

MembershipCount

Uniquement en sortie. Nombre d'adhésions regroupées par type de membre. Renseigné lorsque space_type est SPACE, DIRECT_MESSAGE ou GROUP_CHAT.

AccessSettings

Facultatif. Indique le paramètre d'accès de l'espace. N'est renseigné que lorsque space_type est défini sur SPACE.

string

Uniquement en sortie. URI permettant à un utilisateur d'accéder à l'espace.

string

Facultatif. Immuable. ID client du domaine de l'espace. Obligatoire uniquement lors de la création d'un espace avec authentification de l'application et lorsque SpaceType est SPACE. Sinon, ne doit pas être défini.

Au format customers/{customer}, où customer correspond à id de la [ressource client du SDK Admin]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Les applications privées peuvent également utiliser l'alias customers/my_customer pour créer l'espace dans la même organisation Google Workspace que l'application.

Pour les MP, ce champ n'est pas renseigné.

PredefinedPermissionSettings

Facultatif. Uniquement en entrée. Paramètres d'autorisation prédéfinis pour l'espace, saisis uniquement lors de la création de l'espace. Si le champ n'est pas défini, un espace de collaboration est créé. Une fois l'espace créé, les paramètres sont renseignés dans le champ PermissionSettings.

PermissionSettings

Facultatif. Paramètres d'autorisation des espaces pour les espaces existants. Saisie permettant de modifier les paramètres d'autorisation exacts de l'espace, où les paramètres d'autorisation existants sont remplacés. La sortie liste les paramètres d'autorisation actuels.

AccessState

Uniquement en sortie. Indique l'état d'accès de l'espace.

string

Facultatif. Nom de la ressource de l'audience cible pouvant découvrir l'espace, le rejoindre et prévisualiser les messages qu'il contient. Si cette option n'est pas définie, seuls les utilisateurs ou les groupes Google qui ont été invités ou ajoutés individuellement à l'espace peuvent y accéder. Pour en savoir plus, consultez Rendre un espace visible par une audience cible.

Format : audiences/{audience}

Pour utiliser l'audience cible par défaut de l'organisation Google Workspace, définissez la valeur sur audiences/default.

La lecture de l'audience cible permet de:

• Authentification des utilisateurs

• Authentification de l'application avec approbation de l'administrateur avec le champ d'application chat.app.spaces dans

Ce champ n'est pas renseigné lorsque vous utilisez la portée chat.bot avec l'authentification de l'application.

Pour définir l'audience cible, vous devez vous authentifier.

int32

Uniquement en sortie. Nombre d'utilisateurs humains ayant rejoint directement l'espace, sans compter les utilisateurs qui y ont accédé en tant que membres d'un groupe associé.

int32

Uniquement en sortie. Nombre de groupes ayant rejoint directement l'espace.

bool

Facultatif. Indique si les gestionnaires d'espaces disposent de cette autorisation.

bool

Facultatif. Indique si les membres non administrateurs disposent de cette autorisation.

PermissionSetting

Facultatif. Paramètre permettant de gérer les membres et les groupes dans un espace.

PermissionSetting

Facultatif. Paramètre permettant de modifier le nom, l'avatar, la description et les consignes de l'espace.

PermissionSetting

Facultatif. Paramètre permettant d'activer ou de désactiver l'historique des espaces.

PermissionSetting

Facultatif. Paramètre permettant d'utiliser @tous dans un espace.

PermissionSetting

Facultatif. Paramètre permettant de gérer les applications dans un espace.

PermissionSetting

Facultatif. Paramètre permettant de gérer les webhooks dans un espace.

PermissionSetting

Uniquement en sortie. Paramètre permettant de publier des messages dans un espace.

PermissionSetting

Facultatif. Paramètre pour répondre aux messages dans un espace.

string

Facultatif. Description de l'espace. Par exemple, décrivez le sujet de discussion, l'objectif fonctionnel ou les participants de l'espace.

Peut contenir jusqu'à 150 caractères.

string

Facultatif. Les règles, les attentes et l'étiquette de l'espace

Peut contenir jusqu'à 5 000 caractères.

SpaceUpdatedEventData

Liste des espaces mis à jour.

string

Nom de ressource de l'événement de l'espace.

Format : spaces/{space}/spaceEvents/{spaceEvent}

Timestamp

Heure à laquelle l'événement s'est produit.

string

Type d'événement dans l'espace. Chaque type d'événement comporte une version par lot, qui représente plusieurs instances du type d'événement qui se produisent sur une courte période. Pour les requêtes spaceEvents.list(), omettez les types d'événements par lot dans votre filtre de requête. Par défaut, le serveur renvoie à la fois le type d'événement et sa version de lot.

Types d'événements acceptés pour les messages:

• Nouveau message: google.workspace.chat.message.v1.created
• Message mis à jour: google.workspace.chat.message.v1.updated
• Message supprimé: google.workspace.chat.message.v1.deleted
• Plusieurs nouveaux messages: google.workspace.chat.message.v1.batchCreated
• Plusieurs messages mis à jour: google.workspace.chat.message.v1.batchUpdated
• Plusieurs messages supprimés: google.workspace.chat.message.v1.batchDeleted

Types d'événements acceptés pour les adhésions:

• Nouveaux membres: google.workspace.chat.membership.v1.created
• Abonnement mis à jour: google.workspace.chat.membership.v1.updated
• Abonnement supprimé: google.workspace.chat.membership.v1.deleted
• Plusieurs nouveaux abonnements: google.workspace.chat.membership.v1.batchCreated
• Plusieurs abonnements mis à jour: google.workspace.chat.membership.v1.batchUpdated
• Plusieurs adhésions supprimées: google.workspace.chat.membership.v1.batchDeleted

Types d'événements acceptés pour les réactions:

• Nouvelle réaction: google.workspace.chat.reaction.v1.created
• Réaction supprimée: google.workspace.chat.reaction.v1.deleted
• Plusieurs nouvelles réactions: google.workspace.chat.reaction.v1.batchCreated
• Plusieurs réactions supprimées: google.workspace.chat.reaction.v1.batchDeleted

Types d'événements acceptés concernant l'espace:

• Espace mis à jour: google.workspace.chat.space.v1.updated
• Plusieurs mises à jour de l'espace: google.workspace.chat.space.v1.batchUpdated

MessageCreatedEventData

Charge utile d'événement pour un nouveau message.

Type d'événement: google.workspace.chat.message.v1.created

MessageUpdatedEventData

Charge utile de l'événement pour un message mis à jour.

Type d'événement: google.workspace.chat.message.v1.updated

MessageDeletedEventData

Charge utile d'événement pour un message supprimé.

Type d'événement: google.workspace.chat.message.v1.deleted

MessageBatchCreatedEventData

Charge utile d'événement pour plusieurs nouveaux messages.

Type d'événement: google.workspace.chat.message.v1.batchCreated

MessageBatchUpdatedEventData

Charge utile d'événement pour plusieurs messages mis à jour.

Type d'événement: google.workspace.chat.message.v1.batchUpdated

MessageBatchDeletedEventData

Charge utile d'événement pour plusieurs messages supprimés.

Type d'événement: google.workspace.chat.message.v1.batchDeleted

SpaceUpdatedEventData

Charge utile de l'événement pour une mise à jour d'un espace.

Type d'événement: google.workspace.chat.space.v1.updated

SpaceBatchUpdatedEventData

Charge utile d'événement pour plusieurs mises à jour d'un espace.

Type d'événement: google.workspace.chat.space.v1.batchUpdated

MembershipCreatedEventData

Charge utile de l'événement pour une nouvelle souscription.

Type d'événement: google.workspace.chat.membership.v1.created

MembershipUpdatedEventData

Charge utile de l'événement pour un abonnement mis à jour.

Type d'événement: google.workspace.chat.membership.v1.updated

MembershipDeletedEventData

Charge utile de l'événement pour un abonnement supprimé.

Type d'événement: google.workspace.chat.membership.v1.deleted

MembershipBatchCreatedEventData

Charge utile de l'événement pour plusieurs nouveaux abonnements.

Type d'événement: google.workspace.chat.membership.v1.batchCreated

MembershipBatchUpdatedEventData

Charge utile de l'événement pour plusieurs abonnements mis à jour.

Type d'événement: google.workspace.chat.membership.v1.batchUpdated

MembershipBatchDeletedEventData

Charge utile de l'événement pour plusieurs souscriptions supprimées.

Type d'événement: google.workspace.chat.membership.v1.batchDeleted

ReactionCreatedEventData

Charge utile de l'événement pour une nouvelle réaction.

Type d'événement: google.workspace.chat.reaction.v1.created

ReactionDeletedEventData

Charge utile de l'événement pour une réaction supprimée.

Type d'événement: google.workspace.chat.reaction.v1.deleted

ReactionBatchCreatedEventData

Charge utile d'événement pour plusieurs nouvelles réactions.

Type d'événement: google.workspace.chat.reaction.v1.batchCreated

ReactionBatchDeletedEventData

Charge utile d'événement pour plusieurs réactions supprimées.

Type d'événement: google.workspace.chat.reaction.v1.batchDeleted

string

Identifiant. Nom de ressource du paramètre de notification de l'espace. Format : users/{user}/spaces/{space}/spaceNotificationSetting.

NotificationSetting

Paramètre de notification.

MuteSetting

Paramètre de désactivation des notifications de l'espace.

string

Nom de la ressource de l'état de lecture de l'espace.

Format : users/{user}/spaces/{space}/spaceReadState

Timestamp

Facultatif. Heure à laquelle l'état de lecture de l'espace de l'utilisateur a été mis à jour. Il s'agit généralement du code temporel du dernier message lu ou d'un code temporel spécifié par l'utilisateur pour marquer la dernière position de lecture dans un espace.

Space

Espace mis à jour.

string

Identifiant. Nom de ressource du thread.

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

string

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 name du fil de discussion.

string

Nom de ressource de l'état de lecture du thread.

Format : users/{user}/spaces/{space}/threads/{thread}/threadReadState

Timestamp

Heure à laquelle l'état de lecture du thread de l'utilisateur a été mis à jour. Il s'agit généralement de l'horodatage du dernier message lu dans un fil de discussion.

Membership

Obligatoire. Abonnement à mettre à jour. Seuls les champs spécifiés par update_mask sont mis à jour.

FieldMask

Obligatoire. Chemins de champ à mettre à jour. Séparez plusieurs valeurs par des virgules ou utilisez * pour mettre à jour tous les chemins de champ.

Chemins de champ actuellement acceptés:

• role

bool

Facultatif. Lorsque la valeur est true, la méthode s'exécute à l'aide des droits d'administrateur Google Workspace de l'utilisateur.

L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit Gérer les conversations Chat et Espaces.

Requiert le champ d'application OAuth 2.0 chat.admin.memberships.

Message

Obligatoire. Message avec des champs mis à jour.

FieldMask

Obligatoire. Chemins de champ à mettre à jour. Séparez plusieurs valeurs par des virgules ou utilisez * pour mettre à jour tous les chemins de champ.

Chemins de champ actuellement acceptés:

• text

• attachment

• cards (Authentification de l'application requise)

• cards_v2 (Authentification de l'application requise)

• accessory_widgets (Authentification de l'application requise)

bool

Facultatif. Si true et le message ne sont pas trouvés, un nouveau message est créé et updateMask est ignoré. L'ID de message spécifié doit être attribué par le client, sinon la requête échoue.

SpaceNotificationSetting

Obligatoire. Le nom de la ressource des paramètres de notification de l'espace doit être au format users/{user}/spaces/{space}/spaceNotificationSetting. Seuls les champs spécifiés par update_mask sont mis à jour.

FieldMask

Obligatoire. Chemins de champ compatibles: - notification_setting - mute_setting

SpaceReadState

Obligatoire. État de lecture de l'espace et champs à mettre à jour.

Compatible uniquement avec 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 valeurs suivantes:

• Alias me. Exemple :users/me/spaces/{space}/spaceReadState

• Son adresse e-mail Workspace Par exemple, users/user@example.com/spaces/{space}/spaceReadState.

• Son ID utilisateur. Par exemple, users/123456789/spaces/{space}/spaceReadState.

Format: users/{user}/spaces/{space}/spaceReadState

FieldMask

Obligatoire. Chemins de champ à mettre à jour. Chemins de champ actuellement acceptés:

• last_read_time

Lorsque la date de création de l'last_read_time est antérieure à celle du dernier message, l'espace apparaît comme non lu dans l'interface utilisateur.

Pour marquer l'espace comme lu, définissez last_read_time sur une valeur ultérieure (supérieure) à la date de création du dernier message. last_read_time est forcé à correspondre à la dernière heure de création du message. Notez que l'état de lecture de l'espace ne concerne que l'état de lecture des messages visibles dans la conversation de niveau supérieur de l'espace. Les réponses dans les fils de discussion ne sont pas affectées par cet horodatage, mais dépendent de l'état de lecture du fil.

Space

Obligatoire. Espace avec des champs à mettre à jour. Space.name doit être renseigné au format spaces/{space}. Seuls les champs spécifiés par update_mask sont mis à jour.

FieldMask

Obligatoire. Les chemins de champ mis à jour, séparés par une virgule s'il y en a plusieurs.

Vous pouvez modifier les champs suivants pour un espace:

space_details: met à jour la description de l'espace. Peut contenir jusqu'à 150 caractères.

display_name: permet uniquement de modifier le nom à afficher pour les espaces où le champ spaceType est SPACE. Si le message d'erreur ALREADY_EXISTS s'affiche, essayez une autre valeur. Il est possible qu'un espace existant de l'organisation Google Workspace utilise déjà ce nom à afficher.

space_type: permet uniquement de remplacer un type d'espace GROUP_CHAT par SPACE. Incluez display_name avec space_type dans le masque de mise à jour et assurez-vous que l'espace spécifié possède un nom à afficher non vide et le type d'espace SPACE. L'inclusion du masque space_type et du type SPACE dans l'espace spécifié lors de la mise à jour du nom à afficher est facultative si l'espace existant possède déjà le type SPACE. Toute tentative de mise à jour du type d'espace par un autre moyen génère une erreur d'argument non valide. space_type n'est pas compatible avec useAdminAccess.

space_history_state: met à jour les paramètres de l'historique de l'espace en activant ou en désactivant l'historique pour l'espace. Cette fonctionnalité n'est disponible que si les paramètres d'historique sont activés pour l'organisation Google Workspace. Pour mettre à jour l'état de l'historique de l'espace, vous devez omettre tous les autres masques de champ dans votre requête. space_history_state n'est pas compatible avec useAdminAccess.

access_settings.audience: met à jour le paramètre d'accès des utilisateurs autorisés à découvrir l'espace, à le rejoindre et à prévisualiser les messages dans l'espace nommé où le champ spaceType est SPACE. Si l'espace existant dispose d'une audience cible, vous pouvez la supprimer et limiter l'accès à l'espace en omisssant une valeur pour ce masque de champ. Pour mettre à jour les paramètres d'accès d'un espace, l'utilisateur qui s'authentifie doit être un administrateur de l'espace et omettre tous les autres masques de champ dans votre requête. Vous ne pouvez pas modifier ce champ si l'espace est en mode importation. Pour en savoir plus, consultez Rendre un espace visible pour des utilisateurs spécifiques. access_settings.audience n'est pas compatible avec useAdminAccess.

permission_settings: permet de modifier les paramètres d'autorisation d'un espace. Lorsque vous mettez à jour les paramètres d'autorisation, vous ne pouvez spécifier que des masques de champ permissionSettings. Vous ne pouvez pas mettre à jour d'autres masques de champ en même temps. permissionSettings n'est pas compatible avec useAdminAccess. Voici les masques de champ compatibles:

• permission_settings.manageMembersAndGroups
• permission_settings.modifySpaceDetails
• permission_settings.toggleHistory
• permission_settings.useAtMentionAll
• permission_settings.manageApps
• permission_settings.manageWebhooks
• permission_settings.replyMessages

bool

Facultatif. Lorsque la valeur est true, la méthode s'exécute à l'aide des droits d'administrateur Google Workspace de l'utilisateur.

L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit Gérer les conversations Chat et Espaces.

Requiert le champ d'application OAuth 2.0 chat.admin.spaces.

Certaines valeurs FieldMask ne sont pas compatibles avec l'accès administrateur. Pour en savoir plus, consultez la description de update_mask.

string

Nom de la ressource pour un user Google Chat.

Format : users/{user}. users/app peut être utilisé comme alias pour l'utilisateur bot de l'application appelante.

Pour human users, {user} est le même identifiant utilisateur que:

• id pour la personne dans l'API People. Par exemple, users/123456789 dans l'API Chat représente la même personne que l'ID de profil de personne 123456789 dans l'API People.

• id d'un utilisateur dans l'API Directory du SDK Admin.

• l'adresse e-mail de l'utilisateur peut être utilisée comme alias pour {user} dans les requêtes API. Par exemple, si l'ID de profil de personne de l'API People pour user@example.com est 123456789, vous pouvez utiliser users/user@example.com comme alias pour référencer users/123456789. Seul le nom de la ressource canonique (par exemple, users/123456789) sera renvoyé par l'API.

string

Uniquement en sortie. Nom à afficher de l'utilisateur.

string

Identifiant unique du domaine Google Workspace de l'utilisateur.

Type

Type d'utilisateur.

bool

Uniquement en sortie. Lorsque l'état est true, l'utilisateur est supprimé ou son profil n'est pas visible.

User

Utilisateur mentionné.

Type

Type de mention d'utilisateur.

Button

Liste des boutons. Buttons est également oneof data, et un seul de ces champs doit être défini.

TextParagraph

Afficher un paragraphe de texte dans ce widget.

Image

Affichez une image dans ce widget.

KeyValue

Afficher un élément clé-valeur dans ce widget.

TextButton

Bouton avec du texte et une action onclick.

ImageButton

Bouton avec image et action onclick.

string

Le nom de la méthode permet d'identifier la partie du formulaire qui a déclenché l'envoi du formulaire. Ces informations sont renvoyées à l'application Chat dans le cadre de l'événement de clic sur la fiche. Vous pouvez utiliser le même nom de méthode pour plusieurs éléments qui déclenchent un comportement commun.

ActionParameter

Liste des paramètres d'action.

string

Nom du paramètre du script d'action.

string

Valeur du paramètre.

string

URL de l'image

OnClick

Action onclick.

double

Rapport d'aspect de cette image (largeur et hauteur). Ce champ vous permet de réserver la bonne hauteur pour l'image en attendant qu'elle se charge. Il ne doit pas remplacer le format intégré de l'image. Si cet attribut n'est pas défini, le serveur le remplit en préchargeant l'image.

OnClick

Action onclick.

string

Nom de cet élément image_button utilisé pour l'accessibilité. Une valeur par défaut est fournie si ce nom n'est pas spécifié.

Icon

Icône spécifiée par un enum qui indexe une icône fournie par l'API Chat.

string

Icône spécifiée par une URL.