- Recurso: Mensaje
- Representación JSON0
- Tarjeta
- CardHeader
- ImageStyle
- Sección
- WidgetMarkup
- TextParagraph
- Imagen
- OnClick
- FormAction
- ActionParameter
- OpenLink
- KeyValue
- Ícono
- Botón
- TextButton
- ImageButton
- CardAction
- CardWithId
- Tarjeta
- CardHeader
- ImageType
- Sección
- Widget
- TextParagraph
- Imagen
- OnClick
- Acción
- ActionParameter
- LoadIndicator
- Interacción
- OpenLink
- OpenAs
- OnClose
- DecoratedText
- Ícono
- MaterialIcon
- Botón
- Color
- SwitchControl
- ControlType
- ButtonList
- TextInput
- Tipo
- Sugerencias
- SuggestionItem
- SelectionInput
- SelectionType
- SelectionItem
- PlatformDataSource
- CommonDataSource
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- SpaceDataSource
- DateTimePicker
- DateTimePickerType
- Divider
- Cuadrícula
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- BorderType
- GridItemLayout
- Columnas
- Columna
- HorizontalSizeStyle
- HorizontalAlignment
- VerticalAlignment
- Widgets
- DividerStyle
- CardAction
- CardFixedFooter
- DisplayStyle
- Anotación
- AnnotationType
- UserMentionMetadata
- Tipo
- SlashCommandMetadata
- Tipo
- RichLinkMetadata
- RichLinkType
- DriveLinkData
- Subproceso
- ActionResponse
- ResponseType
- DialogAction
- Diálogo
- ActionStatus
- Código
- UpdatedWidget
- SelectionItems
- SlashCommand
- MatchedUrl
- EmojiReactionSummary
- DeletionMetadata
- DeletionType
- QuotedMessageMetadata
- AttachedGif
- AccessoryWidget
- Métodos
Recurso: Mensaje
Un mensaje en un espacio de Google Chat.
Representación JSON |
---|
{ "name": string, "sender": { object ( |
Campos | |
---|---|
name |
Es el nombre del recurso del mensaje. Formato: Donde Si estableces un ID personalizado cuando creas un mensaje, puedes usarlo para especificar el mensaje en una solicitud. Para ello, reemplaza |
sender |
Solo salida. El usuario que creó el mensaje. Si tu app de Chat se autentica como un usuario, el resultado se propaga al usuario |
createTime |
Opcional. Inmutable. Para los espacios creados en Chat, la hora a la que se creó el mensaje. Este campo es solo de salida, excepto cuando se usa en espacios en modo de importación. Para los espacios en modo de importación, establece este campo en la marca de tiempo histórica en la que se creó el mensaje en la fuente para conservar la hora de creación original. |
lastUpdateTime |
Solo salida. La hora en la que un usuario editó el mensaje por última vez. Si nunca se editó el mensaje, este campo estará vacío. |
deleteTime |
Solo salida. La hora a la que se borró el mensaje en Google Chat. Si el mensaje nunca se borra, este campo estará vacío. |
text |
Es el cuerpo del mensaje en texto sin formato. El primer vínculo a una imagen, un video o una página web genera un chip de vista previa. También puedes @mencionar a un usuario de Google Chat o a todas las personas del espacio. Para obtener información sobre cómo crear mensajes de texto, consulta Cómo enviar un mensaje de texto. |
formattedText |
Solo salida. Contiene el mensaje
Para obtener más información, consulta Cómo ver el formato de texto enviado en un mensaje. |
cards[] |
Obsoleto: usa Tarjetas enriquecidas, interactivas y con formato que puedes usar para mostrar elementos de la IU, como textos con formato, imágenes en las que se puede hacer clic y botones. Por lo general, las tarjetas se muestran debajo del cuerpo en texto sin formato del mensaje. |
cardsV2[] |
Un array de tarjetas. Solo las apps de Chat pueden crear tarjetas. Si tu app de Chat se autentica como un usuario, los mensajes no pueden contener tarjetas. Para obtener más información sobre las tarjetas y cómo crearlas, consulta Cómo enviar mensajes de tarjetas. Diseña tarjetas y obtén una vista previa de ellas con el Creador de tarjetas. Abre el Creador de tarjetas |
annotations[] |
Solo salida. Anotaciones asociadas con el |
thread |
La conversación a la que pertenece el mensaje. Para ver ejemplos de uso, consulta Cómo iniciar o responder una conversación de mensajes. |
space |
Si tu app de Chat se autentica como un usuario, el resultado propaga el espacio |
fallbackText |
Una descripción de texto sin formato de las tarjetas del mensaje, que se usa cuando no se pueden mostrar las tarjetas reales (por ejemplo, notificaciones móviles). |
actionResponse |
Solo entrada. Los parámetros que una app de Chat puede usar para configurar cómo se publica su respuesta. |
argumentText |
Solo salida. Cuerpo del mensaje en texto sin formato con todas las menciones de la app de Chat quitadas. |
slashCommand |
Solo salida. Información del comando de barra, si corresponde |
attachment[] |
Archivo adjunto subido por un usuario. |
matchedUrl |
Solo salida. Una URL en |
threadReply |
Solo salida. Cuando es Si el espacio no admite respuestas en las conversaciones, este campo siempre será |
clientAssignedMessageId |
Opcional. Un ID personalizado para el mensaje Puedes usar el campo para identificar un mensaje, o bien para obtener, borrar o actualizar un mensaje. Para establecer un ID personalizado, especifica el campo |
emojiReactionSummaries[] |
Solo salida. La lista de resúmenes de reacciones con emojis en el mensaje. |
privateMessageViewer |
Inmutable. Entrada para crear un mensaje; de lo contrario, solo salida. El usuario que puede ver el mensaje. Cuando se configura, el mensaje es privado y solo lo pueden ver los usuarios especificados y la app de Chat. Las vistas previas de vínculos y los archivos adjuntos no son compatibles con los mensajes privados. Solo las apps de Chat pueden enviar mensajes privados. Si tu app de Chat se autentica como un usuario para enviar un mensaje, este no puede ser privado y se debe omitir este campo. Para conocer más detalles, consulta Envía mensajes privados a usuarios de Google Chat. |
deletionMetadata |
Solo salida. Información sobre un mensaje borrado. Se borra un mensaje cuando se configura |
quotedMessageMetadata |
Solo salida. Información sobre un mensaje citado por un usuario de Google Chat en un espacio. Los usuarios de Google Chat pueden citar un mensaje para responderlo. |
attachedGifs[] |
Solo salida. Son las imágenes GIF adjuntas al mensaje. |
accessoryWidgets[] |
Uno o más widgets interactivos que aparecen en la parte inferior de un mensaje. Puedes agregar widgets de accesorios a los mensajes que contengan texto, tarjetas o ambos. No se admite para mensajes que contienen diálogos. Para obtener más información, consulta Cómo agregar widgets interactivos al final de un mensaje. Para crear un mensaje con widgets de accesorios, se requiere autenticación de apps. |
CardWithId
Una tarjeta en un mensaje de Google Chat
Solo las apps de Chat pueden crear tarjetas. Si tu app de Chat se autentica como un usuario, el mensaje no puede contener tarjetas.
Diseña tarjetas y obtén una vista previa de ellas con el Creador de tarjetas.
Abre el Creador de tarjetasRepresentación JSON |
---|
{
"cardId": string,
"card": {
object ( |
Campos | |
---|---|
cardId |
Obligatorio si el mensaje contiene varias tarjetas. Es un identificador único para una tarjeta en un mensaje. |
card |
Una tarjeta El tamaño máximo es de 32 KB. |
Anotación
Solo salida. Anotaciones asociadas con el cuerpo del texto sin formato del mensaje Para agregar formato básico a un mensaje de texto, consulta Cómo dar formato a los mensajes de texto.
Ejemplo de cuerpo del mensaje de texto sin formato:
Hello @FooBot how are you!"
Los metadatos de anotaciones correspondientes:
"annotations":[{
"type":"USER_MENTION",
"startIndex":6,
"length":7,
"userMention": {
"user": {
"name":"users/{user}",
"displayName":"FooBot",
"avatarUrl":"https://goo.gl/aeDtrS",
"type":"BOT"
},
"type":"MENTION"
}
}]
Representación JSON |
---|
{ "type": enum ( |
Campos | |
---|---|
type |
Es el tipo de esta anotación. |
length |
Longitud de la substring en el cuerpo del mensaje de texto sin formato a la que corresponde esta anotación. |
startIndex |
Índice de inicio (basado en 0, inclusivo) en el cuerpo del mensaje de texto sin formato al que corresponde esta anotación. |
Campo de unión metadata . Metadatos adicionales sobre la anotación. Las direcciones (metadata ) solo pueden ser una de las siguientes opciones: |
|
userMention |
Los metadatos de la mención del usuario. |
slashCommand |
Los metadatos para un comando de barra. |
richLinkMetadata |
Los metadatos de un vínculo enriquecido. |
AnnotationType
Es el tipo de anotación.
Enumeradores | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Es el valor predeterminado de la enumeración. No utilizar. |
USER_MENTION |
Se menciona a un usuario. |
SLASH_COMMAND |
Se invoca un comando de barra. |
RICH_LINK |
Una anotación de vínculo enriquecida. |
UserMentionMetadata
Metadatos de anotaciones de las menciones del usuario (@).
Representación JSON |
---|
{ "user": { object ( |
Campos | |
---|---|
user |
El usuario mencionó. |
type |
Corresponde al tipo de mención del usuario. |
Tipo
Enumeradores | |
---|---|
TYPE_UNSPECIFIED |
Es el valor predeterminado de la enumeración. No utilizar. |
ADD |
Agrega un usuario al espacio. |
MENTION |
Mencionar al usuario en el espacio. |
SlashCommandMetadata
Metadatos de anotaciones para comandos de barra (/).
Representación JSON |
---|
{ "bot": { object ( |
Campos | |
---|---|
bot |
La app de Chat cuyo comando se invocó. |
type |
El tipo de comando de barra. |
commandName |
El nombre del comando de barra que se invocó. |
commandId |
El ID del comando de barra que se invocó. |
triggersDialog |
Indica si el comando de barra es para un diálogo. |
Tipo
Enumeradores | |
---|---|
TYPE_UNSPECIFIED |
Es el valor predeterminado de la enumeración. No utilizar. |
ADD |
Agrega la app de Chat al espacio. |
INVOKE |
Invoca el comando de barra en el espacio. |
RichLinkMetadata
Es un vínculo enriquecido a un recurso.
Representación JSON |
---|
{ "uri": string, "richLinkType": enum ( |
Campos | |
---|---|
uri |
Es el URI de este vínculo. |
richLinkType |
Es el tipo de vínculo enriquecido. |
Campo de unión data . Datos del recurso vinculado. Las direcciones (data ) solo pueden ser una de las siguientes opciones: |
|
driveLinkData |
Datos de un vínculo de Drive. |
RichLinkType
Es el tipo de vínculo enriquecido. Es posible que se agreguen más tipos en el futuro.
Enumeradores | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
Es el valor predeterminado de la enumeración. No utilizar. |
DRIVE_FILE |
Es un tipo de vínculo enriquecido de Google Drive. |
DriveLinkData
Datos de vínculos de Google Drive.
Representación JSON |
---|
{
"driveDataRef": {
object ( |
Campos | |
---|---|
driveDataRef |
Un DriveDataRef que hace referencia a un archivo de Google Drive |
mimeType |
El tipo MIME del recurso de Google Drive vinculado. |
Conversación
Una conversación en un espacio de Google Chat Para ver ejemplos de uso, consulta Cómo iniciar o responder una conversación de mensajes.
Si especificas una conversación cuando creas un mensaje, puedes configurar el campo messageReplyOption
para determinar qué sucede si no se encuentra una conversación que coincida.
Representación JSON |
---|
{ "name": string, "threadKey": string } |
Campos | |
---|---|
name |
Solo salida. Es el nombre del recurso del subproceso. Ejemplo: |
threadKey |
Opcional. Entrada para crear o actualizar un subproceso. De lo contrario, solo el resultado. Es el ID del subproceso. Admite hasta 4,000 caracteres. Este ID es exclusivo de la aplicación de Chat que lo configura. Por ejemplo, si varias apps de Chat crean un mensaje con la misma clave de conversación, los mensajes se publican en diferentes conversaciones. Si, en cambio, quieres responder en una conversación creada por una persona o por otra app de Chat, especifica el campo |
ActionResponse
Los parámetros que una app de Chat puede usar para configurar cómo se publica su respuesta.
Representación JSON |
---|
{ "type": enum ( |
Campos | |
---|---|
type |
Solo entrada. El tipo de respuesta de la app de Chat. |
url |
Solo entrada. URL para que los usuarios se autentiquen o configuren. (Solo para tipos de respuesta |
dialogAction |
Solo entrada. Es una respuesta a un evento de interacción relacionado con un diálogo. Debe estar acompañado de |
updatedWidget |
Solo entrada. La respuesta del widget actualizado. |
ResponseType
El tipo de respuesta de la app de Chat.
Enumeradores | |
---|---|
TYPE_UNSPECIFIED |
Es el tipo predeterminado que se maneja como NEW_MESSAGE . |
NEW_MESSAGE |
Publicar como un mensaje nuevo en el tema |
UPDATE_MESSAGE |
Actualiza el mensaje de la app de Chat. Esto solo se permite en un evento CARD_CLICKED en el que el tipo de remitente del mensaje es BOT . |
UPDATE_USER_MESSAGE_CARDS |
Actualizar las tarjetas en el mensaje de un usuario Esto solo se permite como respuesta a un evento MESSAGE con una URL coincidente o a un evento CARD_CLICKED en el que el tipo de remitente del mensaje es HUMAN . Se ignora el texto. |
REQUEST_CONFIG |
Solicitarle al usuario una configuración o autenticación adicional de forma privada |
DIALOG |
Presenta un diálogo. |
UPDATE_WIDGET |
Consulta de opciones de autocompletado del texto del widget. |
DialogAction
Contiene un diálogo y el código de estado de la solicitud.
Representación JSON |
---|
{ "actionStatus": { object ( |
Campos | |
---|---|
actionStatus |
Solo entrada. Estado de una solicitud para invocar o enviar un diálogo. Muestra un estado y un mensaje a los usuarios, si es necesario. Por ejemplo, en caso de error o éxito. |
Campo de unión action . Acción que se debe realizar. Las direcciones (action ) solo pueden ser una de las siguientes opciones: |
|
dialog |
Solo entrada. Dialog para la solicitud. |
De diálogo
Wrapper alrededor del cuerpo de la tarjeta del diálogo.
Representación JSON |
---|
{
"body": {
object ( |
Campos | |
---|---|
body |
Solo entrada. Cuerpo del diálogo, que se renderiza de forma modal Las apps de Google Chat no admiten las siguientes entidades de tarjeta: |
ActionStatus
Representa el estado de una solicitud para invocar o enviar un diálogo.
Representación JSON |
---|
{
"statusCode": enum ( |
Campos | |
---|---|
statusCode |
El código de estado |
userFacingMessage |
Es el mensaje para enviar a los usuarios sobre el estado de su solicitud. Si no se establece, se envía un mensaje genérico basado en |
Código
Los códigos de error canónicos para las API de gRPC.
A veces, es posible que se apliquen varios códigos de error. Los servicios deben mostrar el código de error más específico que corresponda. Por ejemplo, es preferible OUT_OF_RANGE
en lugar de FAILED_PRECONDITION
si se aplican ambos códigos. Del mismo modo, prefiere NOT_FOUND
o ALREADY_EXISTS
en lugar de FAILED_PRECONDITION
.
Enumeradores | |
---|---|
OK |
No es un error. que se muestran con éxito. Asignación HTTP: 200 OK |
CANCELLED |
La operación se canceló (por lo general, la cancela el emisor). Asignación HTTP: 499 Solicitudes cerradas por el cliente |
UNKNOWN |
Error desconocido Por ejemplo, este error puede mostrarse cuando un valor Asignación HTTP: Error interno del servidor 500 |
INVALID_ARGUMENT |
El cliente especificó un argumento no válido. Ten en cuenta que esto difiere de Asignación HTTP: 400 Solicitud incorrecta |
DEADLINE_EXCEEDED |
El plazo venció antes de que la operación se pudiera completar. En el caso de las operaciones que cambian el estado del sistema, es probable que se muestre este error incluso si la operación se completó correctamente. Por ejemplo, una respuesta correcta desde un servidor podría haberse retrasado lo suficiente como para que el plazo venciera. Asignación HTTP: Tiempo de espera de la puerta de enlace 504 |
NOT_FOUND |
No se encontró alguna entidad solicitada (p. ej., un archivo o un directorio). Nota para los desarrolladores de servidores: si se niega una solicitud a una clase completa de usuarios, como el lanzamiento gradual de funciones o una lista de permisos no documentada, se puede usar Asignación HTTP: 404 No encontrado |
ALREADY_EXISTS |
La entidad que un cliente intentó crear (p.ej., un archivo o un directorio) ya existe. Asignación HTTP: 409 Conflicto |
PERMISSION_DENIED |
El emisor de la llamada no tiene permiso para ejecutar la operación especificada. No se debe usar Asignación HTTP: 403 Prohibido |
UNAUTHENTICATED |
La solicitud no tiene credenciales de autenticación válidas para la operación. Asignación HTTP: 401 No autorizado |
RESOURCE_EXHAUSTED |
Algunos recursos se agotaron, tal vez una cuota por usuario, o tal vez se agotó el espacio de todo el sistema de archivos. Asignación HTTP: 429 Demasiadas solicitudes |
FAILED_PRECONDITION |
La operación se rechazó debido a que el sistema no se encuentra en un estado necesario para la ejecución de la operación. Por ejemplo, el directorio que se borrará no está vacío, se aplicará una operación rmdir a un directorio que no sea de directorio, etcétera. Los implementadores de servicios pueden usar los siguientes lineamientos para decidir entre Asignación HTTP: 400 Solicitud incorrecta |
ABORTED |
La operación se anuló, generalmente debido a un problema de simultaneidad, como una falla en la verificación del secuenciador o la anulación de la transacción. Consulta los lineamientos anteriores para decidir entre Asignación HTTP: 409 Conflicto |
OUT_OF_RANGE |
La operación se intentó fuera del rango válido. Por ejemplo, buscar o leer el final del archivo. A diferencia de Hay una leve superposición entre Asignación HTTP: 400 Solicitud incorrecta |
UNIMPLEMENTED |
La operación no se implementó, no se admite o no está habilitada en este servicio. Asignación HTTP: 501 No implementado |
INTERNAL |
Errores internos. Esto significa que algunos invariantes que espera el sistema subyacente están rotos. Este código de error está reservado para errores graves. Asignación HTTP: Error interno del servidor 500 |
UNAVAILABLE |
El servicio no está disponible actualmente. Lo más probable es que esta sea una condición transitoria y que se pueda corregir si vuelves a intentar una retirada. Ten en cuenta que no siempre es seguro reintentar operaciones no idempotentes. Consulta los lineamientos anteriores para decidir entre Asignación HTTP: 503 Servicio no disponible |
DATA_LOSS |
Daño o pérdida de datos no recuperable. Asignación HTTP: Error interno del servidor 500 |
UpdatedWidget
La respuesta del widget actualizado. Se usa para proporcionar opciones de autocompletar para un widget.
Representación JSON |
---|
{ "widget": string, // Union field |
Campos | |
---|---|
widget |
El ID del widget actualizado. El ID debe coincidir con el del widget que activó la solicitud de actualización. |
Campo de unión updated_widget . El widget se actualiza en respuesta a una acción del usuario. Las direcciones (updated_widget ) solo pueden ser una de las siguientes opciones: |
|
suggestions |
Lista de resultados de autocompletado de widgets |
SelectionItems
Lista de resultados de autocompletado de widgets.
Representación JSON |
---|
{
"items": [
{
object ( |
Campos | |
---|---|
items[] |
Un array de los objetos SelectionItem. |
SlashCommand
Un comando de barra en Google Chat
Representación JSON |
---|
{ "commandId": string } |
Campos | |
---|---|
commandId |
El ID del comando de barra que se invocó. |
MatchedUrl
Una URL coincidente en un mensaje de Chat Las apps de Chat pueden obtener una vista previa de las URLs coincidentes. Para obtener más información, consulta Vista previa de los vínculos.
Representación JSON |
---|
{ "url": string } |
Campos | |
---|---|
url |
Solo salida. La URL con la que se encontraron coincidencias. |
EmojiReactionSummary
Es la cantidad de personas que reaccionaron a un mensaje con un emoji específico.
Representación JSON |
---|
{
"emoji": {
object ( |
Campos | |
---|---|
emoji |
Emoji asociado con las reacciones. |
reactionCount |
Es la cantidad total de reacciones con el emoji asociado. |
DeletionMetadata
Información sobre un mensaje borrado. Se borra un mensaje cuando se configura deleteTime
.
Representación JSON |
---|
{
"deletionType": enum ( |
Campos | |
---|---|
deletionType |
Indica quién borró el mensaje. |
DeletionType
Quién borró el mensaje y cómo se eliminó
Enumeradores | |
---|---|
DELETION_TYPE_UNSPECIFIED |
Este valor no se usa. |
CREATOR |
El usuario borró su propio mensaje. |
SPACE_OWNER |
El propietario del espacio borró el mensaje. |
ADMIN |
Un administrador de Google Workspace borró el mensaje. |
APP_MESSAGE_EXPIRY |
Una app de Chat borró su propio mensaje cuando venció. |
CREATOR_VIA_APP |
Una app de Chat borró el mensaje en nombre del usuario. |
SPACE_OWNER_VIA_APP |
Una app de Chat borró el mensaje en nombre del propietario del espacio. |
QuotedMessageMetadata
Información sobre un mensaje citado.
Representación JSON |
---|
{ "name": string, "lastUpdateTime": string } |
Campos | |
---|---|
name |
Solo salida. Nombre del recurso del mensaje citado. Formato: |
lastUpdateTime |
Solo salida. La marca de tiempo de cuándo se creó el mensaje citado o cuándo se actualizó por última vez. |
AttachedGif
Es una imagen GIF especificada por una URL.
Representación JSON |
---|
{ "uri": string } |
Campos | |
---|---|
uri |
Solo salida. La URL que aloja la imagen GIF. |
AccessoryWidget
Uno o más widgets interactivos que aparecen en la parte inferior de un mensaje. Para obtener más información, consulta Cómo agregar widgets interactivos al final de un mensaje.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión action . Es el tipo de acción. Las direcciones (action ) solo pueden ser una de las siguientes opciones: |
|
buttonList |
Una lista de botones. |
Métodos |
|
---|---|
|
Crea un mensaje en un espacio de Google Chat. |
|
Borra un mensaje. |
|
Devuelve detalles sobre un mensaje. |
|
Muestra una lista de los mensajes de un espacio del que es miembro el emisor, incluidos los mensajes de los espacios y los miembros bloqueados. |
|
Actualiza un mensaje. |
|
Actualiza un mensaje. |