Package google.chat.v1

Índice

ChatService

Permite a los desarrolladores compilar apps y integraciones de Chat en la plataforma de Google Chat.

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

Completa el proceso de importación del espacio especificado y lo hace visible para los usuarios.

Requiere autenticación de apps y delegación de todo el dominio. Para obtener más información, consulta Cómo autorizar apps de Google Chat para importar datos.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/chat.import

Para obtener más información, consulta la Guía de autorización.
CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

Crea un emoji personalizado.

Requiere autenticación del usuario.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/chat.customemojis

Para obtener más información, consulta la Guía de autorización.
CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Crea una membresía para la app de Chat de llamadas, un usuario o un Grupo de Google. No se admiten membresías para otras apps de Chat. Cuando crees una membresía, si el miembro especificado tiene desactivada la política de aceptación automática, se le enviará una invitación y deberá aceptarla antes de unirse. De lo contrario, si creas una membresía, el miembro se agregará directamente al espacio especificado.

Admite los siguientes tipos de autenticación:

Para ver ejemplos de uso, consulta lo siguiente:

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

Para obtener más información, consulta la Guía de autorización.
CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

Crea un mensaje en un espacio de Google Chat. Para ver un ejemplo, consulta Cómo enviar un mensaje.

El método create() requiere autenticación del usuario o autenticación de la app. Chat atribuye al remitente del mensaje de forma diferente según el tipo de autenticación que uses en tu solicitud.

En la siguiente imagen, se muestra cómo Chat atribuye un mensaje cuando usas la autenticación de apps. Chat muestra la app de Chat como el remitente del mensaje. El contenido del mensaje puede incluir texto (text), tarjetas (cardsV2) y widgets de accesorios (accessoryWidgets).

Mensaje enviado con autenticación de la app

En la siguiente imagen, se muestra cómo Chat atribuye un mensaje cuando usas la autenticación de usuarios. Chat muestra al usuario como el remitente del mensaje y atribuye la app de Chat al mensaje mostrando su nombre. El contenido del mensaje solo puede contener texto (text).

Mensaje enviado con autenticación del usuario

El tamaño máximo del mensaje, incluido el contenido, es de 32,000 bytes.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

Para obtener más información, consulta la Guía de autorización.
CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

Crea una reacción y la agrega a un mensaje. Solo se admiten emojis Unicode. Para ver un ejemplo, consulta Cómo agregar una reacción a un mensaje.

Requiere autenticación del usuario.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

Para obtener más información, consulta la Guía de autorización.
CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

Crea un espacio sin miembros. Se puede usar para crear un espacio con nombre o un chat en grupo en Import mode. Para ver un ejemplo, consulta Crea un espacio.

Si recibes el mensaje de error ALREADY_EXISTS cuando creas un espacio, prueba con un displayName diferente. Es posible que un espacio existente dentro de la organización de Google Workspace ya use este nombre visible.

Admite los siguientes tipos de autenticación:

Cuando te autenticas como una app, se debe configurar el campo space.customer en la solicitud.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.app.spaces.create
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

Para obtener más información, consulta la Guía de autorización.
DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

Borra un emoji personalizado.

Requiere autenticación del usuario.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/chat.customemojis

Para obtener más información, consulta la Guía de autorización.
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

Borra una membresía. Para ver un ejemplo, consulta Cómo quitar un usuario o una app de Google Chat de un espacio.

Admite los siguientes tipos de autenticación:

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

Para obtener más información, consulta la Guía de autorización.
DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

Borra un mensaje. Para ver un ejemplo, consulta Cómo borrar un mensaje.

Admite los siguientes tipos de autenticación:

Cuando se usa la autenticación de apps, las solicitudes solo pueden borrar los mensajes creados por la app de Chat que realiza la llamada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

Para obtener más información, consulta la Guía de autorización.
DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

Borra una reacción a un mensaje. Solo se admiten emojis Unicode. Para ver un ejemplo, consulta Borra una reacción.

Requiere autenticación del usuario.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions

Para obtener más información, consulta la Guía de autorización.
DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

Borra un espacio con nombre. Siempre realiza una eliminación en cascada, lo que significa que también se borran los recursos secundarios del espacio, como los mensajes publicados en él y las membresías. Para ver un ejemplo, consulta Borra un espacio.

Admite los siguientes tipos de autenticación:

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.app.delete
  • https://www.googleapis.com/auth/chat.admin.delete
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.delete

Para obtener más información, consulta la Guía de autorización.
FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

Muestra el mensaje directo existente con el usuario especificado. Si no se encuentra un espacio de mensaje directo, se muestra un error 404 NOT_FOUND. Para ver un ejemplo, consulta Cómo encontrar un mensaje directo.

Con la autenticación de apps, muestra el espacio de mensajes directos entre el usuario especificado y la app de Chat que realiza la llamada.

Con la autenticación del usuario, muestra el espacio de mensajes directos entre el usuario especificado y el usuario autenticado.

// Admite los siguientes tipos de autenticación:

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

Para obtener más información, consulta la Guía de autorización.
GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

Obtiene los metadatos de un archivo adjunto de un mensaje. Los datos de los archivos adjuntos se recuperan con la API de Media. Para ver un ejemplo, consulta Obtén metadatos sobre un archivo adjunto de un mensaje. Requiere autenticación de apps.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/chat.bot

Para obtener más información, consulta la Guía de autorización.
GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

Muestra detalles sobre un emoji personalizado.

Requiere autenticación del usuario.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

Para obtener más información, consulta la Guía de autorización.
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

Muestra los detalles de una membresía. Para ver un ejemplo, consulta Cómo obtener detalles sobre la membresía de un usuario o de la app de Google Chat.

Admite los siguientes tipos de autenticación:

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Para obtener más información, consulta la Guía de autorización.
GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

Muestra los detalles de un mensaje. Para ver un ejemplo, consulta Obtén detalles sobre un mensaje.

Admite los siguientes tipos de autenticación:

Nota: Es posible que se muestre un mensaje de un miembro o espacio bloqueado.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

Para obtener más información, consulta la Guía de autorización.
GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

Muestra los detalles de un espacio. Para ver un ejemplo, consulta Obtén detalles sobre un espacio.

Admite los siguientes tipos de autenticación:

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.app.spaces

Para obtener más información, consulta la Guía de autorización.
GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

Muestra un evento de un espacio de Google Chat. La carga útil del evento contiene la versión más reciente del recurso que cambió. Por ejemplo, si solicitas un evento sobre un mensaje nuevo, pero el mensaje se actualizó más tarde, el servidor muestra el recurso Message actualizado en la carga útil del evento.

Nota: El campo permissionSettings no se muestra en el objeto Space de los datos del evento de Space para esta solicitud.

Requiere autenticación del usuario. Para obtener un evento, el usuario autenticado debe ser miembro del espacio.

Para ver un ejemplo, consulta Cómo obtener detalles sobre un evento desde un espacio de Google Chat.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Para obtener más información, consulta la Guía de autorización.
GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Obtiene la configuración del estado de las notificaciones del espacio.

Requiere autenticación del usuario.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/chat.users.spacesettings

Para obtener más información, consulta la Guía de autorización.
GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

Devuelve detalles sobre el estado de lectura de un usuario dentro de un espacio, que se usa para identificar los mensajes leídos y no leídos. Para ver un ejemplo, consulta Obtén detalles sobre el estado de lectura de un espacio de un usuario.

Requiere autenticación del usuario.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

Para obtener más información, consulta la Guía de autorización.
GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

Muestra detalles sobre el estado de lectura de un usuario dentro de una conversación, que se usa para identificar los mensajes leídos y no leídos. Para ver un ejemplo, consulta Obtén detalles sobre el estado de lectura de un subproceso de un usuario.

Requiere autenticación del usuario.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

Para obtener más información, consulta la Guía de autorización.
ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

Muestra una lista de los emojis personalizados visibles para el usuario autenticado.

Requiere autenticación del usuario.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

Para obtener más información, consulta la Guía de autorización.
ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

Muestra las membresías de un espacio. Para ver un ejemplo, consulta Cómo mostrar una lista de usuarios y apps de Google Chat en un espacio. La ficha de membresías con autenticación de apps muestra las membresías en los espacios a los que la app de Chat tiene acceso, pero excluye las membresías de la app de Chat, incluidas las propias. La lista de membresías con autenticación del usuario muestra las membresías en los espacios a los que el usuario autenticado tiene acceso.

Admite los siguientes tipos de autenticación:

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Para obtener más información, consulta la Guía de autorización.
ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Muestra una lista de los mensajes de un espacio del que el emisor es miembro, incluidos los mensajes de miembros y espacios bloqueados. Si enumeras mensajes de un espacio sin mensajes, la respuesta será un objeto vacío. Cuando se usa una interfaz REST/HTTP, la respuesta contiene un objeto JSON vacío, {}. Para ver un ejemplo, consulta Cómo mostrar mensajes en una lista.

Requiere autenticación del usuario.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

Para obtener más información, consulta la Guía de autorización.
ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

Muestra las reacciones a un mensaje. Para ver un ejemplo, consulta Cómo mostrar una lista de reacciones a un mensaje.

Requiere autenticación del usuario.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Para obtener más información, consulta la Guía de autorización.
ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

Muestra una lista de eventos de un espacio de Google Chat. Para cada evento, la carga útil contiene la versión más reciente del recurso de chat. Por ejemplo, si enumeras eventos sobre miembros nuevos del espacio, el servidor muestra recursos Membership que contienen los detalles más recientes de la membresía. Si se quitaron miembros nuevos durante el período solicitado, la carga útil del evento contiene un recurso Membership vacío.

Requiere autenticación del usuario. Para mostrar una lista de eventos, el usuario autenticado debe ser miembro del espacio.

Para ver un ejemplo, consulta Cómo crear una lista de eventos de un espacio de Google Chat.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Para obtener más información, consulta la Guía de autorización.
ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

Muestra una lista de los espacios de los que es miembro el llamador. Los chats en grupo y los MD no aparecerán en la lista hasta que se envíe el primer mensaje. Para ver un ejemplo, consulta Cómo enumerar espacios.

Admite los siguientes tipos de autenticación:

Para enumerar todos los espacios nombrados por organización de Google Workspace, usa el método spaces.search() con los privilegios de administrador de Workspace.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

Para obtener más información, consulta la Guía de autorización.
SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

Devuelve una lista de espacios en una organización de Google Workspace según la búsqueda de un administrador.

Requiere autenticación del usuario con privilegios de administrador. En la solicitud, configura use_admin_access como true.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

Para obtener más información, consulta la Guía de autorización.
SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

Crea un espacio y agrega a los usuarios especificados. El usuario que realiza la llamada se agrega automáticamente al espacio y no se debe especificar como una membresía en la solicitud. Para ver un ejemplo, consulta Configura un espacio con miembros iniciales.

Para especificar los miembros humanos que se agregarán, agrega membresías con el membership.member.name adecuado. Para agregar un usuario humano, usa users/{user}, en el que {user} puede ser la dirección de correo electrónico del usuario. Para los usuarios de la misma organización de Workspace, {user} también puede ser el id de la persona de la API de People o el id del usuario en la API de Directory. Por ejemplo, si el ID de perfil de la persona de la API de People para user@example.com es 123456789, puedes agregar al usuario al espacio configurando membership.member.name como users/user@example.com o users/123456789.

Para especificar los grupos de Google que se agregarán, agrega membresías con el membership.group_member.name adecuado. Para agregar o invitar a un grupo de Google, usa groups/{group}, donde {group} es el id del grupo de la API de Cloud Identity Groups. Por ejemplo, puedes usar la API de búsqueda de Grupos de Cloud Identity para recuperar el ID 123456789 del correo electrónico del grupo group@example.com y, luego, configurar membership.group_member.name como groups/123456789 para agregar el grupo al espacio. No se admiten correos electrónicos de grupo, y los Grupos de Google solo se pueden agregar como miembros en espacios con nombre.

En el caso de un espacio o chat en grupo con nombre, si el emisor bloquea a algunos miembros o si algunos miembros lo bloquean, o si no tiene permiso para agregar a algunos miembros, estos no se agregarán al espacio creado.

Para crear un mensaje directo (MD) entre el usuario que realiza la llamada y otro usuario humano, especifica exactamente una membresía para representar al usuario humano. Si un usuario bloquea al otro, la solicitud falla y no se crea el MD.

Para crear un MD entre el usuario que realiza la llamada y la app que la realiza, establece Space.singleUserBotDm en true y no especifiques ninguna membresía. Solo puedes usar este método para configurar un MD con la app de llamadas. Para agregar la app de llamadas como miembro de un espacio o a un MD existente entre dos usuarios humanos, consulta Cómo invitar o agregar un usuario o una app a un espacio.

Si ya existe un MD entre dos usuarios, incluso cuando uno bloquea al otro en el momento en que se realiza una solicitud, se muestra el MD existente.

No se admiten espacios con respuestas en conversaciones. Si recibes el mensaje de error ALREADY_EXISTS cuando configuras un espacio, prueba con un displayName diferente. Es posible que un espacio existente dentro de la organización de Google Workspace ya use este nombre visible.

Requiere autenticación del usuario.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

Para obtener más información, consulta la Guía de autorización.
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

Actualiza una membresía. Para ver un ejemplo, consulta Cómo actualizar la membresía de un usuario en un espacio.

Admite los siguientes tipos de autenticación:

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships

Para obtener más información, consulta la Guía de autorización.
UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

Actualiza un mensaje. Hay una diferencia entre los métodos patch y update. El método patch usa una solicitud patch, mientras que el método update usa una solicitud put. Te recomendamos que uses el método patch. Para ver un ejemplo, consulta Cómo actualizar un mensaje.

Admite los siguientes tipos de autenticación:

Cuando se usa la autenticación de apps, las solicitudes solo pueden actualizar los mensajes creados por la app de Chat que realiza la llamada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

Para obtener más información, consulta la Guía de autorización.
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

Actualiza un espacio. Para ver un ejemplo, consulta Cómo actualizar un espacio.

Si actualizas el campo displayName y recibes el mensaje de error ALREADY_EXISTS, prueba con un nombre visible diferente. Es posible que un espacio existente dentro de la organización de Google Workspace ya use este nombre visible.

Admite los siguientes tipos de autenticación:

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

Para obtener más información, consulta la Guía de autorización.
UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Actualiza la configuración del estado de las notificaciones del espacio.

Requiere autenticación del usuario.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/chat.users.spacesettings

Para obtener más información, consulta la Guía de autorización.
UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

Actualiza el estado de lectura de un usuario dentro de un espacio, que se usa para identificar los mensajes leídos y no leídos. Para ver un ejemplo, consulta Cómo actualizar el estado de lectura del espacio de un usuario.

Requiere autenticación del usuario.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/chat.users.readstate

Para obtener más información, consulta la Guía de autorización.

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 en la parte inferior de un mensaje.

Campos
Campo de unión action. Es el tipo de acción. Las direcciones (action) solo pueden ser una de las siguientes opciones:
button_list

ButtonList

Una lista de botones.

ActionResponse

Son parámetros que una app de chat puede usar para configurar cómo se publica su respuesta.

Campos
type

ResponseType

Solo entrada. El tipo de respuesta de la app de Chat.
url

string

Solo entrada. Es la URL que los usuarios deben autenticar o configurar. (Solo para tipos de respuesta REQUEST_CONFIG).
dialog_action

DialogAction

Solo entrada. Es una respuesta a un evento de interacción relacionado con un diálogo. Debe ir acompañado de ResponseType.Dialog.
updated_widget

UpdatedWidget

Solo entrada. Es la respuesta del widget actualizado.

ResponseType

El tipo de respuesta de la app de Chat.

Enumeraciones
TYPE_UNSPECIFIED Es el tipo predeterminado que se controla como NEW_MESSAGE.
NEW_MESSAGE Publica 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 Actualiza las tarjetas del mensaje de un usuario. Esto solo se permite como respuesta a un evento MESSAGE con una URL coincidente o un evento CARD_CLICKED en el que el tipo de remitente del mensaje es HUMAN. Se ignora el texto.
REQUEST_CONFIG Solicita al usuario autenticación o configuración adicionales de forma privada.
DIALOG Presenta un diálogo.
UPDATE_WIDGET Búsqueda de opciones de autocompletado de texto del widget

SelectionItems

Es la lista de resultados del autocompletado del widget.

Campos
items[]

SelectionItem

Un array de objetos SelectionItem.

UpdatedWidget

Es la respuesta del widget actualizado. Se usa para proporcionar opciones de autocompletado para un widget.

Campos
widget

string

Es 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 actualizó en respuesta a una acción del usuario. Las direcciones (updated_widget) solo pueden ser una de las siguientes opciones:
suggestions

SelectionItems

Lista de resultados del widget de autocompletado

ActionStatus

Representa el estado de una solicitud para invocar o enviar un diálogo.

Campos
status_code

Code

El código de estado.
user_facing_message

string

Es el mensaje que se enviará a los usuarios sobre el estado de su solicitud. Si no se establece, se envía un mensaje genérico basado en status_code.

Anotación

Solo salida. Son anotaciones asociadas con el cuerpo del mensaje de texto sin formato. Para agregar formato básico a un mensaje de texto, consulta Cómo dar formato a los mensajes de texto.

Ejemplo de cuerpo de 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"
   }
}]
Campos
type

AnnotationType

Es el tipo de esta anotación.
length

int32

Es la longitud de la subcadena en el cuerpo del mensaje de texto sin formato a la que corresponde esta anotación.
start_index

int32

Es el índice de inicio (con base en 0 inclusive) en el cuerpo del mensaje de texto sin formato al que corresponde esta anotación.
Campo de unión metadata. Son metadatos adicionales sobre la anotación. Las direcciones (metadata) solo pueden ser una de las siguientes opciones:
user_mention

UserMentionMetadata

Son los metadatos de la mención de un usuario.
slash_command

SlashCommandMetadata

Los metadatos de un comando de barra.

AnnotationType

Es el tipo de anotación.

Enumeraciones
ANNOTATION_TYPE_UNSPECIFIED Es el valor predeterminado de la enumeración. No lo uses.
USER_MENTION Se menciona a un usuario.
SLASH_COMMAND Se invoca un comando de barra.

AttachedGif

Es una imagen GIF especificada por una URL.

Campos
uri

string

Solo salida. Es la URL que aloja la imagen GIF.

Archivo adjunto

Un archivo adjunto en Google Chat.

Campos
name

string

Opcional. Es el nombre del recurso del archivo adjunto, con el formato spaces/{space}/messages/{message}/attachments/{attachment}.
content_name

string

Solo salida. Es el nombre de archivo original del contenido, no la ruta de acceso completa.
content_type

string

Solo salida. Es el tipo de contenido (tipo MIME) del archivo.
thumbnail_uri

string

Solo salida. Es la URL de la miniatura que se debe usar para obtener una vista previa del archivo adjunto para un usuario humano. Las apps de chat no deben usar esta URL para descargar el contenido de los archivos adjuntos.
download_uri

string

Solo salida. Es la URL de descarga que se debe usar para permitir que un usuario humano descargue el archivo adjunto. Las apps de chat no deben usar esta URL para descargar el contenido de los archivos adjuntos.
source

Source

Solo salida. Es la fuente del archivo adjunto.
Campo de unión data_ref. Es la referencia de datos al archivo adjunto. Las direcciones (data_ref) solo pueden ser una de las siguientes opciones:
attachment_data_ref

AttachmentDataRef

Opcional. Es una referencia a los datos del archivo adjunto. Este campo se usa para crear o actualizar mensajes con archivos adjuntos, o con la API de Media para descargar los datos de los archivos adjuntos.
drive_data_ref

DriveDataRef

Solo salida. Es una referencia al archivo adjunto de Google Drive. Este campo se usa con la API de Google Drive.

Fuente

Es la fuente del archivo adjunto.

Enumeraciones
SOURCE_UNSPECIFIED Reservado.
DRIVE_FILE El archivo es de Google Drive.
UPLOADED_CONTENT El archivo se subirá a Chat.

AttachmentDataRef

Es una referencia a los datos del archivo adjunto.

Campos
resource_name

string

Opcional. Es el nombre del recurso de los datos del archivo adjunto. Este campo se usa con la API de Media para descargar los datos del archivo adjunto.
attachment_upload_token

string

Opcional. Es un token opaco que contiene una referencia a un archivo adjunto subido. Los clientes lo tratan como una cadena opaca y lo usan para crear o actualizar mensajes de chat con archivos adjuntos.

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 y obtén vistas previas de las tarjetas con el Creador de tarjetas.

Abre el compilador de tarjetas

Campos
card_id

string

Obligatorio si el mensaje contiene varias tarjetas. Es un identificador único para una tarjeta en un mensaje.
card

Card

Una tarjeta El tamaño máximo es de 32 KB.

ChatSpaceLinkData

Datos para los vínculos de espacios de Chat

Campos
space

string

Es el espacio del recurso de espacio de Chat vinculado.

Formato: spaces/{space}
thread

string

Es el subproceso del recurso del espacio de Chat vinculado.

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

string

Es el mensaje del recurso de espacio de Chat vinculado.

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

CompleteImportSpaceRequest

Mensaje de solicitud para completar el proceso de importación de un espacio.

Campos
name

string

Obligatorio. Es el nombre del recurso del espacio del modo de importación.

Formato: spaces/{space}

CompleteImportSpaceResponse

Mensaje de respuesta para completar el proceso de importación de un espacio.

Campos
space

Space

El espacio del modo de importación.

ContextualAddOnMarkup

Este tipo no tiene campos.

Es el lenguaje de marcado para que los desarrolladores especifiquen el contenido de un complemento contextual.

Tarjeta

Una tarjeta es un elemento de la IU que puede contener widgets de la IU, como texto e imágenes.

Campos
header

CardHeader

Es el encabezado de la tarjeta. Por lo general, un encabezado contiene un título y una imagen.
sections[]

Section

Las secciones están separadas por un divisor de línea.
card_actions[]

CardAction

Las acciones de esta tarjeta.
name

string

Es el nombre de la tarjeta.

CardAction

Una acción de tarjeta es la acción asociada con la tarjeta. En el caso de una tarjeta de factura, una acción típica sería borrar la factura, enviarla por correo electrónico o abrirla en el navegador.

Las apps de Google Chat no son compatibles con esta opción.

Campos
action_label

string

La etiqueta solía mostrarse en el elemento del menú de acciones.
on_click

OnClick

Es la acción onclick de este elemento de acción.

CardHeader

Campos
title

string

Se debe especificar el título. El encabezado tiene una altura fija: si se especifican un título y un subtítulo, cada uno ocupa una línea. Si solo se especifica el título, este ocupará ambas líneas.
subtitle

string

Es el subtítulo del encabezado de la tarjeta.
image_style

ImageStyle

Es el tipo de imagen (por ejemplo, borde cuadrado o borde circular).
image_url

string

Es la URL de la imagen en el encabezado de la tarjeta.

ImageStyle

Enumeraciones
IMAGE_STYLE_UNSPECIFIED
IMAGE Borde cuadrado.
AVATAR Borde circular.

Sección

Una sección contiene una colección de widgets que se renderizan (verticalmente) en el orden en que se especifican. En todas las plataformas, las tarjetas tienen un ancho fijo estrecho, por lo que, actualmente, no se necesitan propiedades de diseño (por ejemplo, flotante).

Campos
header

string

Es el encabezado de la sección. Se admite el texto con formato. Para obtener más información sobre cómo dar formato al texto, consulta Cómo dar formato al texto en las apps de Google Chat y Cómo dar formato al texto en los complementos de Google Workspace.
widgets[]

WidgetMarkup

Una sección debe contener al menos un widget.

CreateCustomEmojiRequest

Es una solicitud para crear un emoji personalizado.

Campos
custom_emoji

CustomEmoji

Obligatorio. El emoji personalizado que se creará.

CreateMembershipRequest

Es el mensaje de solicitud para crear una membresía.

Campos
parent

string

Obligatorio. Es el nombre del recurso del espacio para el que se creará la membresía.

Formato: spaces/{space}
membership

Membership

Obligatorio. La relación de membresía que se creará.

El campo memberType debe contener un usuario con los campos user.name y user.type propagados. El servidor asignará un nombre de recurso y reemplazará todo lo que se especifique.

Cuando una app de chat crea una relación de membresía para un usuario humano, debe usar ciertos permisos de autorización y establecer valores específicos para ciertos campos:

  • Cuando te autenticas como usuario, se requiere el permiso de autorización chat.memberships.

  • Cuando te autenticas como una app, se requiere el permiso de autorización chat.app.memberships. La autenticación como app está disponible en

  • Establece user.type en HUMAN y user.name con el formato users/{user}, donde {user} puede ser la dirección de correo electrónico del usuario. Para los usuarios de la misma organización de Workspace, {user} también puede ser el id de la persona de la API de Personas o el id del usuario en la API de Directory. Por ejemplo, si el ID de perfil de la persona de la API de People para user@example.com es 123456789, puedes agregar al usuario al espacio configurando membership.member.name como users/user@example.com o users/123456789.

Cuando una app de Chat crea una relación de membresía para sí misma, debe autenticarse como usuario y usar el permiso chat.memberships.app, establecer user.type en BOT y establecer user.name en users/app.
use_admin_access

bool

Opcional. Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que realiza la llamada debe ser un administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere el permiso de OAuth 2.0 chat.admin.memberships.

No se admite la creación de membresías de apps ni de membresías para usuarios fuera de la organización de Google Workspace del administrador con el acceso de administrador.

CreateMessageRequest

Crea un mensaje.

Campos
parent

string

Obligatorio. Es el nombre del recurso del espacio en el que se creará un mensaje.

Formato: spaces/{space}
message

Message

Obligatorio. Cuerpo del mensaje.
thread_key
(deprecated)

string

Opcional. Obsoleto: Usa thread.thread_key en su lugar. Es el ID del subproceso. Admite hasta 4,000 caracteres. Para iniciar una conversación o agregarla a una existente, crea un mensaje y especifica un threadKey o el thread.name. Para ver un ejemplo de uso, consulta Cómo iniciar o responder una conversación de mensajes.
request_id

string

Opcional. Un ID de solicitud único para este mensaje. Si especificas un ID de solicitud existente, se muestra el mensaje creado con ese ID en lugar de crear uno nuevo.
message_reply_option

MessageReplyOption

Opcional. Especifica si un mensaje inicia una conversación o responde una. Solo se admite en espacios con nombre.

Cuando respondes a las interacciones del usuario, se ignora este campo. En el caso de las interacciones dentro de una conversación, la respuesta se crea en la misma conversación. De lo contrario, la respuesta se crea como un subproceso nuevo.
message_id

string

Opcional. Un ID personalizado para un mensaje. Permite que las apps de Chat obtengan, actualicen o borren un mensaje sin necesidad de almacenar el ID asignado por el sistema en el nombre del recurso del mensaje (representado en el campo name del mensaje).

El valor de este campo debe cumplir con los siguientes requisitos:

  • Comienza con client-. Por ejemplo, client-custom-name es un ID personalizado válido, pero custom-name no lo es.
  • Contiene hasta 63 caracteres y solo letras minúsculas, números y guiones.
  • Es único dentro de un espacio. Una app de chat no puede usar el mismo ID personalizado para diferentes mensajes.

Para obtener más información, consulta Cómo asignar un nombre a un mensaje.

MessageReplyOption

Especifica cómo responder un mensaje. Es posible que se agreguen más estados en el futuro.

Enumeraciones
MESSAGE_REPLY_OPTION_UNSPECIFIED Predeterminado. Inicia una conversación nueva. Si usas esta opción, se ignorará cualquier thread ID o thread_key que se incluya.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Crea el mensaje como una respuesta a la conversación especificada por thread ID o thread_key. Si falla, el mensaje inicia una conversación nueva.
REPLY_MESSAGE_OR_FAIL Crea el mensaje como una respuesta a la conversación especificada por thread ID o thread_key. Si se usa un thread_key nuevo, se crea un subproceso nuevo. Si falla la creación del mensaje, se muestra un error NOT_FOUND.

CreateReactionRequest

Crea una reacción a un mensaje.

Campos
parent

string

Obligatorio. Es el mensaje en el que se crea la reacción.

Formato: spaces/{space}/messages/{message}
reaction

Reaction

Obligatorio. La reacción que se creará.

CreateSpaceRequest

Una solicitud para crear un espacio con nombre sin miembros.

Campos
space

Space

Obligatorio. Se deben propagar los campos displayName y spaceType. Solo se admiten SpaceType.SPACE y SpaceType.GROUP_CHAT. SpaceType.GROUP_CHAT solo se puede usar si importMode se establece como verdadero.

Si recibes el mensaje de error ALREADY_EXISTS, prueba con otro displayName. Es posible que un espacio existente dentro de la organización de Google Workspace ya use este nombre visible.

El espacio name se asigna en el servidor, por lo que se ignorará todo lo que se especifique en este campo.
request_id

string

Opcional. Es un identificador único para esta solicitud. Se recomienda usar un UUID aleatorio. Si especificas un ID de solicitud existente, se muestra el espacio creado con ese ID en lugar de crear uno nuevo. Si especificas un ID de solicitud existente de la misma app de Chat con un usuario autenticado diferente, se muestra un error.

CustomEmoji

Representa un emoji personalizado.

Campos
name

string

Identificador. Es el nombre del recurso del emoji personalizado que asigna el servidor.

Formato: customEmojis/{customEmoji}

uid

string

Solo salida. Es la clave única del recurso de emoji personalizado.
emoji_name

string

Opcional. Inmutable. Es el nombre que proporciona el usuario para el emoji personalizado, que es único dentro de la organización.

Es obligatorio cuando se crea el emoji personalizado; de lo contrario, solo se muestra la salida.

Los nombres de los emojis deben comenzar y terminar con dos puntos, deben escribirse en minúsculas y solo pueden incluir caracteres alfanuméricos, guiones y guiones bajos. Los guiones y guiones bajos deben usarse para separar palabras y no pueden usarse consecutivamente.

Ejemplo: :valid-emoji-name:

temporary_image_uri

string

Solo salida. La URL de la imagen del emoji personalizado, válida durante al menos 10 minutos Ten en cuenta que no se propaga en la respuesta cuando se crea el emoji personalizado.

payload

CustomEmojiPayload

Opcional. Solo entrada. Datos de carga útil Obligatorio cuando se crea el emoji personalizado.

CustomEmojiPayload

Datos de carga útil para el emoji personalizado

Campos
file_content

bytes

Obligatorio. Solo entrada. Es la imagen que se usa para el emoji personalizado.

La carga útil debe ser inferior a 256 KB y la dimensión de la imagen debe ser de entre 64 y 500 píxeles. Las restricciones están sujetas a cambios.
filename

string

Obligatorio. Solo entrada. Es el nombre del archivo de imagen.

Extensiones de archivo compatibles: .png, .jpg, .gif.

DeleteCustomEmojiRequest

Solicitud para borrar un emoji personalizado.

Campos
name

string

Obligatorio. Es el nombre del recurso del emoji personalizado que se borrará.

Formato: customEmojis/{customEmoji}

Puedes usar el nombre del emoji como alias para {customEmoji}. Por ejemplo, customEmojis/:example-emoji:, en la que :example-emoji: es el nombre del emoji personalizado.

DeleteMembershipRequest

Solicitud para borrar una membresía en un espacio.

Campos
name

string

Obligatorio. Es el nombre del recurso de la membresía que se borrará. Las apps de chat pueden borrar las membresías de los usuarios humanos o las propias. Las apps de chat no pueden borrar las membresías de otras apps.

Cuando se borra una membresía humana, se requiere el permiso chat.memberships y el formato spaces/{space}/members/{member}. Puedes usar el correo electrónico como alias para {member}. Por ejemplo, spaces/{space}/members/example@gmail.com, donde example@gmail.com es el correo electrónico del usuario de Google Chat.

Cuando se borra una membresía de la app, se requiere el alcance chat.memberships.app y el formato spaces/{space}/members/app.

Formato: spaces/{space}/members/{member} o spaces/{space}/members/app
use_admin_access

bool

Opcional. Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que realiza la llamada debe ser un administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere el permiso de OAuth 2.0 chat.admin.memberships.

No se admite la eliminación de membresías de apps en un espacio con acceso de administrador.

DeleteMessageRequest

Solicitud para borrar un mensaje.

Campos
name

string

Obligatorio. Es el nombre del recurso del mensaje.

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

Si estableciste un ID personalizado para tu mensaje, puedes usar el valor del campo clientAssignedMessageId para {message}. Para obtener más información, consulta Cómo asignar un nombre a un mensaje.
force

bool

Opcional. Cuando true, borrar un mensaje también borra sus respuestas en el subproceso. Cuando false, si un mensaje tiene respuestas en una conversación, la eliminación falla.

Solo se aplica cuando se autentica como usuario. No tiene efecto cuando se autentica como una app de chat.

DeleteReactionRequest

Borra una reacción a un mensaje.

Campos
name

string

Obligatorio. Es el nombre de la reacción que se borrará.

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

DeleteSpaceRequest

Solicitud para borrar un espacio.

Campos
name

string

Obligatorio. Es el nombre del recurso del espacio que se borrará.

Formato: spaces/{space}
use_admin_access

bool

Opcional. Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que realiza la llamada debe ser un administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere el permiso de OAuth 2.0 chat.admin.delete.

DeletionMetadata

Información sobre un mensaje borrado. Un mensaje se borra cuando se configura delete_time.

Campos
deletion_type

DeletionType

Indica quién borró el mensaje.

DeletionType

Quién borró el mensaje y cómo se borró Es posible que se agreguen más valores en el futuro.

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

Diálogo

Es el wrapper alrededor del cuerpo de la tarjeta del diálogo.

Campos
body

Card

Solo entrada. Es el cuerpo del diálogo, que se renderiza en un elemento modal. Las apps de Google Chat no admiten las siguientes entidades de tarjetas: DateTimePicker y OnChangeAction.

DialogAction

Contiene un diálogo y un código de estado de la solicitud.

Campos
action_status

ActionStatus

Solo entrada. Es el 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

Dialog

Solo entrada. Diálogo para la solicitud.

DriveDataRef

Es una referencia a los datos de un archivo adjunto de Drive.

Campos
drive_file_id

string

El ID del archivo de Drive. Se usa con la API de Drive.

DriveLinkData

Datos de los vínculos de Google Drive

Campos
drive_data_ref

DriveDataRef

Un DriveDataRef que hace referencia a un archivo de Google Drive.
mime_type

string

Es el tipo MIME del recurso de Google Drive vinculado.

Emoji

Un emoji que se usa como reacción a un mensaje.

Campos
Campo de unión content. Obligatorio. Es el contenido del emoji. Las direcciones (content) solo pueden ser una de las siguientes opciones:
unicode

string

Opcional. Un emoji básico representado por una cadena Unicode.
custom_emoji

CustomEmoji

Solo salida. Un emoji personalizado

EmojiReactionSummary

La cantidad de personas que reaccionaron a un mensaje con un emoji específico.

Campos
emoji

Emoji

Solo salida. Emoji asociado con las reacciones.
reaction_count

int32

Solo salida. Es la cantidad total de reacciones con el emoji asociado.

FindDirectMessageRequest

Es una solicitud para obtener espacio de mensajes directos según el recurso del usuario.

Campos
name

string

Obligatorio. Es el nombre del recurso del usuario con el que se busca el mensaje directo.

Formato: users/{user}, donde {user} es el id de la persona de la API de People o el id del usuario en la API de Directory. Por ejemplo, si el ID de perfil de la API de People es 123456789, puedes encontrar un mensaje directo con esa persona usando users/123456789 como name. Cuando te autentiques como usuario, podrás usar el correo electrónico como alias para {user}. Por ejemplo, users/example@gmail.com, donde example@gmail.com es el correo electrónico del usuario de Google Chat.

GetAttachmentRequest

Solicitar un archivo adjunto

Campos
name

string

Obligatorio. Es el nombre del recurso del archivo adjunto, con el formato spaces/{space}/messages/{message}/attachments/{attachment}.

GetCustomEmojiRequest

Una solicitud para mostrar un solo emoji personalizado.

Campos
name

string

Obligatorio. Es el nombre del recurso del emoji personalizado.

Formato: customEmojis/{customEmoji}

Puedes usar el nombre del emoji como alias para {customEmoji}. Por ejemplo, customEmojis/:example-emoji:, en la que :example-emoji: es el nombre del emoji personalizado.

GetMembershipRequest

Solicitud para obtener una membresía de un espacio.

Campos
name

string

Obligatorio. Es el nombre del recurso de la membresía que se recuperará.

Para obtener la membresía de la app mediante la autenticación del usuario, puedes usar spaces/{space}/members/app de forma opcional.

Formato: spaces/{space}/members/{member} o spaces/{space}/members/app

Puedes usar el correo electrónico del usuario como alias para {member}. Por ejemplo, spaces/{space}/members/example@gmail.com, donde example@gmail.com es el correo electrónico del usuario de Google Chat.
use_admin_access

bool

Opcional. Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que realiza la llamada debe ser un administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere los permisos de OAuth 2.0 chat.admin.memberships o chat.admin.memberships.readonly.

No se admiten membresías de apps en un espacio cuando se usa el acceso de administrador.

GetMessageRequest

Solicitar un mensaje

Campos
name

string

Obligatorio. Es el nombre del recurso del mensaje.

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

Si estableciste un ID personalizado para tu mensaje, puedes usar el valor del campo clientAssignedMessageId para {message}. Para obtener más información, consulta Cómo asignar un nombre a un mensaje.

GetSpaceEventRequest

Es el mensaje de solicitud para obtener un evento de espacio.

Campos
name

string

Obligatorio. Es el nombre del recurso del evento de espacio.

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

GetSpaceNotificationSettingRequest

Es el mensaje de solicitud para obtener la configuración de notificaciones de espacio. Solo admite la obtención de la configuración de notificaciones para el usuario que realiza la llamada.

Campos
name

string

Obligatorio. Formato: users/{user}/spaces/{space}/spaceNotificationSetting

  • users/me/spaces/{space}/spaceNotificationSetting, O
  • users/user@example.com/spaces/{space}/spaceNotificationSetting, O
  • users/123456789/spaces/{space}/spaceNotificationSetting. Nota: Solo se permite el ID de usuario o el correo electrónico del llamador en la ruta.

GetSpaceReadStateRequest

Mensaje de solicitud para la API de GetSpaceReadState.

Campos
name

string

Obligatorio. Es el nombre del recurso del estado de lectura del espacio que se recuperará.

Solo admite obtener el estado de lectura del usuario que realiza la llamada.

Para hacer referencia al usuario que llama, establece una de las siguientes opciones:

  • El alias me. Por ejemplo, users/me/spaces/{space}/spaceReadState

  • Su dirección de correo electrónico de Workspace Por ejemplo, users/user@example.com/spaces/{space}/spaceReadState.

  • Su ID de usuario Por ejemplo, users/123456789/spaces/{space}/spaceReadState.

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

GetSpaceRequest

Una solicitud para mostrar un solo espacio.

Campos
name

string

Obligatorio. Es el nombre del recurso del espacio, con el formato spaces/{space}.

Formato: spaces/{space}
use_admin_access

bool

Opcional. Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que realiza la llamada debe ser un administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere los permisos de OAuth 2.0 chat.admin.spaces o chat.admin.spaces.readonly.

GetThreadReadStateRequest

Mensaje de solicitud para la API de GetThreadReadStateRequest.

Campos
name

string

Obligatorio. Es el nombre del recurso del estado de lectura del subproceso que se recuperará.

Solo admite obtener el estado de lectura del usuario que realiza la llamada.

Para hacer referencia al usuario que llama, establece una de las siguientes opciones:

  • El alias me. Por ejemplo, users/me/spaces/{space}/threads/{thread}/threadReadState

  • Su dirección de correo electrónico de Workspace Por ejemplo, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState.

  • Su ID de usuario Por ejemplo, users/123456789/spaces/{space}/threads/{thread}/threadReadState.

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

Grupo

Un Grupo de Google en Google Chat.

Campos
name

string

Es el nombre de recurso de un Grupo de Google.

Representa un grupo en la API de Grupos de Cloud Identity.

Formato: groups/{group}

HistoryState

Es el estado del historial de mensajes y espacios. Especifica durante cuánto tiempo se conservan los mensajes y las conversaciones después de su creación.

Enumeraciones
HISTORY_STATE_UNSPECIFIED Valor predeterminado No lo utilices.
HISTORY_OFF Historial desactivado. Los mensajes y las conversaciones se conservan durante 24 horas.
HISTORY_ON Historial activado. Las reglas de retención de Vault de la organización especifican por cuánto tiempo se conservan los mensajes y los subprocesos.

ListCustomEmojisRequest

Una solicitud para mostrar una lista de emojis personalizados.

Campos
page_size

int32

Opcional. Es la cantidad máxima de emojis personalizados que se devuelven. El servicio puede mostrar menos emojis personalizados que este valor. Si no se especifica, el valor predeterminado es 25. El valor máximo es 200; los valores superiores a 200 se cambian a 200.
page_token

string

Opcional. (si se reanuda desde una consulta anterior).

Un token de página recibido de una llamada anterior a emojis personalizados de la lista. Proporciona esto para recuperar la página siguiente.

Cuando se realiza la paginación, el valor del filtro debe coincidir con la llamada que proporcionó el token de página. Pasar un valor diferente puede generar resultados inesperados.
filter

string

Opcional. Un filtro de consulta

Admite el filtrado por creador.

Para filtrar por creador, debes especificar un valor válido. Actualmente, solo se aceptan creator("users/me") y NOT creator("users/me") para filtrar emojis personalizados según si el usuario que realiza la llamada los creó o no.

Por ejemplo, la siguiente consulta muestra el emoji personalizado que creó el llamador:

creator("users/me")

El servidor rechaza las consultas no válidas con un error INVALID_ARGUMENT.

ListCustomEmojisResponse

Es una respuesta a una lista de emojis personalizados.

Campos
custom_emojis[]

CustomEmoji

Lista sin ordenar. Es la lista de emojis personalizados en la página solicitada (o primera).
next_page_token

string

Es un token que puedes enviar como pageToken para recuperar la siguiente página de resultados. Si está vacío, no hay páginas posteriores.

ListMembershipsRequest

Es el mensaje de solicitud para enumerar membresías.

Campos
parent

string

Obligatorio. Es el nombre del recurso del espacio para el que se recuperará una lista de membresías.

Formato: spaces/{space}
page_size

int32

Opcional. Es la cantidad máxima de membresías que se mostrarán. Es posible que el servicio devuelva menos de este valor.

Si no se especifica, se devuelven, como máximo, 100 membresías.

El valor máximo es 1,000. Si usas un valor superior a 1,000, este se cambiará automáticamente a 1,000.

Los valores negativos muestran un error INVALID_ARGUMENT.
page_token

string

Opcional. Es un token de página, recibido desde una llamada anterior para enumerar membresías. Proporciona este parámetro para recuperar la página siguiente.

Cuando se realiza la paginación, todos los demás parámetros proporcionados deben coincidir con la llamada que proporcionó el token de página. Pasar diferentes valores a los otros parámetros puede generar resultados inesperados.
filter

string

Opcional. Un filtro de consulta

Puedes filtrar las membresías por el rol (role) y el tipo (member.type) de un miembro.

Para filtrar por rol, establece role en ROLE_MEMBER o ROLE_MANAGER.

Para filtrar por tipo, establece member.type en HUMAN o BOT. También puedes filtrar member.type con el operador !=.

Para filtrar por rol y tipo, usa el operador AND. Para filtrar por rol o tipo, usa el operador OR.

Se requiere member.type = "HUMAN" o member.type != "BOT" cuando use_admin_access se establece como verdadero. Se rechazarán los demás filtros de tipo de miembro.

Por ejemplo, las siguientes consultas son válidas:

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

member.type != "BOT"

Las siguientes consultas no son válidas:

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

El servidor rechaza las consultas no válidas con un error INVALID_ARGUMENT.
show_groups

bool

Opcional. Cuando es true, también muestra las membresías asociadas con un Google Group, además de otros tipos de membresías. Si se establece un filter, no se muestran las membresías de Google Group que no coinciden con los criterios del filtro.
show_invited

bool

Opcional. Cuando es true, también muestra las membresías asociadas con los miembros invited, además de otros tipos de membresías. Si se establece un filtro, no se muestran las membresías de invited que no coinciden con los criterios del filtro.

Actualmente, requiere autenticación del usuario.
use_admin_access

bool

Opcional. Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que realiza la llamada debe ser un administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere el alcance de OAuth 2.0 chat.admin.memberships.readonly o chat.admin.memberships.

No se admiten las membresías de apps en un espacio cuando se usa el acceso de administrador.

ListMembershipsResponse

Respuesta para mostrar las membresías del espacio.

Campos
memberships[]

Membership

Lista sin ordenar. Es la lista de membresías en la página solicitada (o primera).
next_page_token

string

Es un token que puedes enviar como pageToken para recuperar la siguiente página de resultados. Si está vacío, no hay páginas posteriores.

ListMessagesRequest

Muestra una lista de los mensajes del espacio especificado en el que el usuario es miembro.

Campos
parent

string

Obligatorio. Es el nombre del recurso del espacio del que se mostrarán los mensajes.

Formato: spaces/{space}
page_size

int32

Opcional. Es la cantidad máxima de mensajes que se devuelven. Es posible que el servicio devuelva menos mensajes que este valor.

Si no se especifica, se mostrarán como máximo 25.

El valor máximo es 1,000. Si usas un valor superior a 1,000, este se cambiará automáticamente a 1,000.

Los valores negativos muestran un error INVALID_ARGUMENT.
page_token

string

Opcional. Un token de página recibido de una llamada a listMessages anterior. Proporciona este parámetro para recuperar la página siguiente.

Cuando se realiza la paginación, todos los demás parámetros proporcionados deben coincidir con la llamada que proporcionó el token de página. Pasar diferentes valores a los otros parámetros puede generar resultados inesperados.
filter

string

Opcional. Un filtro de consulta

Puedes filtrar los mensajes por fecha (create_time) y conversación (thread.name).

Para filtrar mensajes por la fecha en que se crearon, especifica el create_time con una marca de tiempo en formato RFC-3339 y comillas dobles. Por ejemplo, "2023-04-21T11:30:00-04:00". Puedes usar el operador mayor que > para enumerar los mensajes que se crearon después de una marca de tiempo o el operador menor que < para enumerar los mensajes que se crearon antes de una marca de tiempo. Para filtrar mensajes dentro de un intervalo de tiempo, usa el operador AND entre dos marcas de tiempo.

Para filtrar por subproceso, especifica el thread.name con el formato spaces/{space}/threads/{thread}. Solo puedes especificar una thread.name por consulta.

Para filtrar por conversación y fecha, usa el operador AND en tu consulta.

Por ejemplo, las siguientes consultas son válidas:

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

El servidor rechaza las consultas no válidas con un error INVALID_ARGUMENT.
order_by

string

Opcional. Indica cómo se ordena la lista de mensajes. Especifica un valor para ordenar según una operación de ordenamiento. Los valores válidos de la operación de ordenamiento son los siguientes:

  • ASC para ascendente.

  • DESC para descendente.

El orden predeterminado es create_time ASC.
show_deleted

bool

Opcional. Si se incluyen los mensajes borrados. Los mensajes borrados incluyen la hora de eliminación y metadatos sobre la eliminación, pero el contenido del mensaje no está disponible.

ListMessagesResponse

Mensaje de respuesta para enumerar mensajes.

Campos
messages[]

Message

Lista de mensajes.
next_page_token

string

Puedes enviar un token como pageToken para recuperar la siguiente página de resultados. Si está vacío, no hay páginas posteriores.

ListReactionsRequest

Muestra las reacciones a un mensaje.

Campos
parent

string

Obligatorio. El mensaje al que reaccionaron los usuarios

Formato: spaces/{space}/messages/{message}
page_size

int32

Opcional. Es la cantidad máxima de reacciones que se devuelven. El servicio puede mostrar menos reacciones que este valor. Si no se especifica, el valor predeterminado es 25. El valor máximo es 200; los valores superiores a 200 se cambian a 200.
page_token

string

Opcional. (si se reanuda desde una consulta anterior).

Un token de página recibido de una llamada a list reactions anterior. Proporciona esto para recuperar la página siguiente.

Cuando se realiza la paginación, el valor del filtro debe coincidir con la llamada que proporcionó el token de página. Pasar un valor diferente puede generar resultados inesperados.
filter

string

Opcional. Un filtro de consulta

Puedes filtrar las reacciones por emoji (emoji.unicode o emoji.custom_emoji.uid) y usuario (user.name).

Para filtrar reacciones de varios emojis o usuarios, une campos similares con el operador OR, como emoji.unicode = "🙂" OR emoji.unicode = "👍" y user.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

Para filtrar reacciones por emoji y usuario, usa el operador AND, como emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

Si tu consulta usa AND y OR, agrúpalos con paréntesis.

Por ejemplo, las siguientes consultas son válidas:

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}"

Las siguientes consultas no son válidas:

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}"

El servidor rechaza las consultas no válidas con un error INVALID_ARGUMENT.

ListReactionsResponse

Es la respuesta a una solicitud de reacciones de una lista.

Campos
reactions[]

Reaction

Es la lista de reacciones en la página solicitada (o primera).
next_page_token

string

Es un token de Continuation para recuperar la siguiente página de resultados. Está vacía para la última página de resultados.

ListSpaceEventsRequest

Es el mensaje de solicitud para enumerar eventos espaciales.

Campos
parent

string

Obligatorio. Es el nombre del recurso del espacio de Google Chat en el que ocurrieron los eventos.

Formato: spaces/{space}.
page_size

int32

Opcional. Es la cantidad máxima de eventos de espacio que se devuelven. Es posible que el servicio devuelva menos de este valor.

Los valores negativos muestran un error INVALID_ARGUMENT.
page_token

string

Opcional. Es un token de página, recibido desde una llamada a eventos de espacio de lista anterior. Proporciona esto para recuperar la página siguiente.

Cuando se realiza la paginación, todos los demás parámetros proporcionados a los eventos de lista de espacios deben coincidir con la llamada que proporcionó el token de página. Pasar diferentes valores a los otros parámetros puede generar resultados inesperados.
filter

string

Obligatorio. Un filtro de consulta

Debes especificar al menos un tipo de evento (event_type) con el operador tiene :. Para filtrar por varios tipos de eventos, usa el operador OR. Omite los tipos de eventos por lotes en tu filtro. La solicitud muestra automáticamente todos los eventos de lotes relacionados. Por ejemplo, si filtras por reacciones nuevas (google.workspace.chat.reaction.v1.created), el servidor también muestra eventos de reacciones nuevas por lotes (google.workspace.chat.reaction.v1.batchCreated). Para obtener una lista de los tipos de eventos admitidos, consulta la documentación de referencia de SpaceEvents.

De manera opcional, también puedes filtrar por hora de inicio (start_time) y hora de finalización (end_time):

  • start_time: Es una marca de tiempo exclusiva desde la que se comienzan a enumerar los eventos espaciales. Puedes enumerar los eventos que ocurrieron hasta 28 días atrás. Si no se especifica, se enumeran los eventos de espacio de los últimos 28 días.
  • end_time: Es la marca de tiempo inclusiva hasta la cual se enumeran los eventos espaciales. Si no se especifica, se enumeran los eventos hasta el momento de la solicitud.

Para especificar una hora de inicio o finalización, usa el operador igual = y el formato RFC-3339. Para filtrar por start_time y end_time, usa el operador AND.

Por ejemplo, las siguientes consultas son válidas:

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")

Las siguientes consultas no son válidas:

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"

El servidor rechaza las consultas no válidas con un error INVALID_ARGUMENT.

ListSpaceEventsResponse

Mensaje de respuesta para enumerar los eventos de espacio.

Campos
space_events[]

SpaceEvent

Los resultados se muestran en orden cronológico (el evento más antiguo primero). Nota: El campo permissionSettings no se muestra en el objeto Space para las solicitudes de lista.
next_page_token

string

Es el token de Continuation que se usa para recuperar más eventos. Si se omite este campo, no habrá páginas siguientes.

ListSpacesRequest

Es una solicitud para enumerar los espacios de los que es miembro el llamador.

Campos
page_size

int32

Opcional. Es la cantidad máxima de espacios que se mostrarán. Es posible que el servicio devuelva menos de este valor.

Si no se especifica, se mostrarán como máximo 100 espacios.

El valor máximo es 1,000. Si usas un valor superior a 1,000, este se cambiará automáticamente a 1,000.

Los valores negativos muestran un error INVALID_ARGUMENT.
page_token

string

Opcional. Es un token de página, recibido desde una llamada a list spaces anterior. Proporciona este parámetro para recuperar la página siguiente.

Cuando se realiza la paginación, el valor del filtro debe coincidir con la llamada que proporcionó el token de página. Pasar un valor diferente puede generar resultados inesperados.
filter

string

Opcional. Un filtro de consulta

Puedes filtrar los espacios por tipo de espacio (space_type).

Para filtrar por tipo de espacio, debes especificar un valor de enumeración válido, como SPACE o GROUP_CHAT (space_type no puede ser SPACE_TYPE_UNSPECIFIED). Para consultar varios tipos de espacios, usa el operador OR.

Por ejemplo, las siguientes consultas son válidas:

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

El servidor rechaza las consultas no válidas con un error INVALID_ARGUMENT.

ListSpacesResponse

Es la respuesta de una solicitud de lista de espacios.

Campos
spaces[]

Space

Es la lista de espacios de la página solicitada (o primera). Nota: El campo permissionSettings no se muestra en el objeto Space para las solicitudes de lista.
next_page_token

string

Puedes enviar un token como pageToken para recuperar la siguiente página de resultados. Si está vacío, no hay páginas posteriores.

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 Cómo obtener una vista previa de los vínculos.

Campos
url

string

Solo salida. La URL que coincidió.

Membresía

Representa una relación de membresía en Google Chat, por ejemplo, si un usuario o una app de Chat está invitado a un espacio, es parte de él o no está presente.

Campos
name

string

Identificador. Es el nombre del recurso de la membresía que asignó el servidor.

Formato: spaces/{space}/members/{member}
state

MembershipState

Solo salida. Estado de la membresía.
role

MembershipRole

Opcional. Es el rol del usuario dentro de un espacio de Chat, que determina las acciones permitidas en el espacio.

Este campo solo se puede usar como entrada en UpdateMembership.
create_time

Timestamp

Opcional. Inmutable. La hora de creación de la membresía, como el momento en que un miembro se unió a un espacio o se le invitó a unirse a él. Este campo solo se usa para generar resultados, excepto cuando se usa para importar membresías históricas en espacios en modo de importación.
delete_time

Timestamp

Opcional. Inmutable. La hora de eliminación de la membresía, por ejemplo, cuándo un miembro abandonó un espacio o se quitó de él Este campo solo se usa para generar resultados, excepto cuando se usa para importar membresías históricas en espacios en modo de importación.
Campo de unión memberType. Miembro asociado con esta membresía. Es posible que se admitan otros tipos de miembros en el futuro. Las direcciones (memberType) solo pueden ser una de las siguientes opciones:
member

User

Opcional. El usuario o la app de Google Chat a la que corresponde la membresía. Si tu app de Chat se autentica como un usuario, el resultado propaga los name y type del usuario.
group_member

Group

Opcional. El Grupo de Google al que corresponde la membresía.

Para leer o modificar las membresías de Grupos de Google, se requiere la autenticación del usuario.

MembershipRole

Representa las acciones permitidas de un usuario en un espacio de Chat. Es posible que se agreguen más valores de enumeración en el futuro.

Enumeraciones
MEMBERSHIP_ROLE_UNSPECIFIED Valor predeterminado En el caso de users, no es miembro del espacio, pero se le puede invitar. Para Google Groups: Siempre se les asigna este rol (es posible que se usen otros valores de enumeración en el futuro).
ROLE_MEMBER Un miembro del espacio. El usuario tiene permisos básicos, como enviar mensajes al espacio. En las conversaciones 1:1 y en grupo sin nombre, todos tienen este rol.
ROLE_MANAGER Un administrador del espacio El usuario tiene todos los permisos básicos, además de permisos administrativos que le permiten administrar el espacio, como agregar o quitar miembros. Solo se admite en SpaceType.SPACE.

MembershipState

Especifica la relación del miembro con un espacio. Es posible que se admitan otros estados de membresía en el futuro.

Enumeraciones
MEMBERSHIP_STATE_UNSPECIFIED Valor predeterminado No lo uses.
JOINED El usuario se agrega al espacio y puede participar en él.
INVITED Se invitó al usuario a unirse al espacio, pero aún no lo hizo.
NOT_A_MEMBER El usuario no pertenece al espacio y no tiene una invitación pendiente para unirse a él.

MembershipBatchCreatedEventData

Carga útil del evento para varias membresías nuevas.

Tipo de evento: google.workspace.chat.membership.v1.batchCreated

Campos
memberships[]

MembershipCreatedEventData

Una lista de membresías nuevas.

MembershipBatchDeletedEventData

Carga útil del evento para varias membresías borradas.

Tipo de evento: google.workspace.chat.membership.v1.batchDeleted

Campos
memberships[]

MembershipDeletedEventData

Una lista de las membresías borradas.

MembershipBatchUpdatedEventData

Carga útil del evento para varias membresías actualizadas.

Tipo de evento: google.workspace.chat.membership.v1.batchUpdated

Campos
memberships[]

MembershipUpdatedEventData

Es una lista de membresías actualizadas.

MembershipCreatedEventData

Carga útil del evento para una membresía nueva.

Tipo de evento: google.workspace.chat.membership.v1.created.

Campos
membership

Membership

La membresía nueva.

MembershipDeletedEventData

Carga útil del evento para una membresía borrada.

Tipo de evento: google.workspace.chat.membership.v1.deleted

Campos
membership

Membership

La membresía borrada Solo se propagan los campos name y state.

MembershipUpdatedEventData

Carga útil del evento para una membresía actualizada.

Tipo de evento: google.workspace.chat.membership.v1.updated

Campos
membership

Membership

La membresía actualizada.

Mensaje

Un mensaje en un espacio de Google Chat.

Campos
name

string

Identificador. Es el nombre del recurso del mensaje.

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

En el que {space} es el ID del espacio en el que se publicó el mensaje y {message} es un ID asignado por el sistema para el mensaje. Por ejemplo, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

Si configuras un ID personalizado cuando creas un mensaje, puedes usar este ID para especificar el mensaje en una solicitud. Para ello, reemplaza {message} por el valor del campo clientAssignedMessageId. Por ejemplo, spaces/AAAAAAAAAAA/messages/client-custom-name. Para obtener más información, consulta Cómo asignar un nombre a un mensaje.
sender

User

Solo salida. El usuario que creó el mensaje. Si tu app de Chat se autentica como un usuario, el resultado propaga los name y type del usuario.
create_time

Timestamp

Opcional. Inmutable. En el caso de los espacios creados en Chat, la hora en que se creó el mensaje Este campo es solo de salida, excepto cuando se usa en espacios de modo de importación.

En el caso de los espacios del 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.
last_update_time

Timestamp

Solo salida. Es la hora en la que un usuario editó el mensaje por última vez. Si el mensaje nunca se editó, este campo estará vacío.
delete_time

Timestamp

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

string

Opcional. 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 todos los miembros del espacio.

Para obtener información sobre cómo crear mensajes de texto, consulta Cómo enviar un mensaje.
formatted_text

string

Solo salida. Contiene el mensaje text con marcas agregadas para comunicar el formato. Es posible que este campo no capture todo el formato visible en la IU, pero incluye lo siguiente:

  • Sintaxis de marcado para texto en negrita, itálico, tachado, monoespaciado, bloque monoespaciado y lista con viñetas.

  • Menciones de usuarios con el formato <users/{user}>

  • Hipervínculos personalizados con el formato <{url}|{rendered_text}>, en el que la primera cadena es la URL y la segunda es el texto renderizado, por ejemplo, <http://example.com|custom text>.

  • Emoji personalizado con el formato :{emoji_name}:, por ejemplo, :smile:. Esto no se aplica a los emojis Unicode, como U+1F600 para un emoji de cara sonriente.

Para obtener más información, consulta Cómo ver el formato de texto enviado en un mensaje.
cards[]
(deprecated)

Card

Obsoleto: Usa cards_v2 en su lugar.

Son tarjetas interactivas, enriquecidas y con formato que puedes usar para mostrar elementos de la IU, como textos con formato, botones e imágenes en las que se puede hacer clic. Por lo general, las tarjetas se muestran debajo del cuerpo de texto sin formato del mensaje. cards y cards_v2 pueden tener un tamaño máximo de 32 KB.
cards_v2[]

CardWithId

Opcional. 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 aprender a crear un mensaje que contenga tarjetas, consulta Cómo enviar un mensaje.

Diseña y obtén vistas previas de las tarjetas con el Creador de tarjetas.

Abre el compilador de tarjetas
annotations[]

Annotation

Solo salida. Anotaciones asociadas con el text en este mensaje.
thread

Thread

Es el subproceso al que pertenece el mensaje. Para ver un ejemplo de uso, consulta Cómo iniciar o responder una conversación de mensajes.
space

Space

Solo salida. Si tu app de Chat se autentica como un usuario, el resultado solo propaga el espacio name.
fallback_text

string

Opcional. Es una descripción en texto sin formato de las tarjetas del mensaje, que se usa cuando no se pueden mostrar las tarjetas reales (por ejemplo, notificaciones para dispositivos móviles).
action_response

ActionResponse

Solo entrada. Son parámetros que una app de chat puede usar para configurar cómo se publica su respuesta.
argument_text

string

Solo salida. Cuerpo del mensaje en texto sin formato sin las menciones a la app de Chat
slash_command

SlashCommand

Solo salida. Información del comando de barra, si corresponde
attachment[]

Attachment

Opcional. Archivo adjunto subido por el usuario.
matched_url

MatchedUrl

Solo salida. Una URL en spaces.messages.text que coincida con un patrón de vista previa de vínculo. Para obtener más información, consulta Vínculos de vista previa.
thread_reply

bool

Solo salida. Cuando es true, el mensaje es una respuesta en una conversación de respuestas. Cuando es false, el mensaje se puede ver en la conversación de nivel superior del espacio como el primer mensaje de una conversación o como un mensaje sin respuestas intercaladas.

Si el espacio no admite respuestas en conversaciones, este campo siempre es false.
client_assigned_message_id

string

Opcional. Un ID personalizado para el mensaje. Puedes usar el campo para identificar un mensaje o para obtener, borrar o actualizar un mensaje. Para establecer un ID personalizado, especifica el campo messageId cuando crees el mensaje. Para obtener más información, consulta Cómo asignar un nombre a un mensaje.
emoji_reaction_summaries[]

EmojiReactionSummary

Solo salida. La lista de resúmenes de reacciones con emojis en el mensaje
private_message_viewer

User

Opcional. Inmutable. Entrada para crear un mensaje; de lo contrario, solo salida. El usuario que puede ver el mensaje. Cuando se establece, el mensaje es privado y solo lo pueden ver el usuario especificado y la app de Chat. Para incluir este campo en tu solicitud, debes llamar a la API de Chat con la autenticación de apps y omitir lo siguiente:

Para obtener más información, consulta Cómo enviar un mensaje de forma privada.
deletion_metadata

DeletionMetadata

Solo salida. Información sobre un mensaje borrado. Un mensaje se borra cuando se configura delete_time.
quoted_message_metadata

QuotedMessageMetadata

Solo salida. Información sobre un mensaje que cita un usuario de Google Chat en un espacio. Los usuarios de Google Chat pueden citar un mensaje para responderlo.
attached_gifs[]

AttachedGif

Solo salida. Imágenes GIF adjuntas al mensaje
accessory_widgets[]

AccessoryWidget

Opcional. Uno o más widgets interactivos que aparecen en la parte inferior de un mensaje. Puedes agregar widgets de accesorios a los mensajes que contienen texto, tarjetas o ambos. No es compatible con los mensajes que contienen diálogos. Para obtener más información, consulta Cómo agregar widgets interactivos en la parte inferior de un mensaje.

Para crear un mensaje con widgets de accesorios, se requiere la autenticación de la app.

MessageBatchCreatedEventData

Carga útil del evento para varios mensajes nuevos.

Tipo de evento: google.workspace.chat.message.v1.batchCreated

Campos
messages[]

MessageCreatedEventData

Una lista de mensajes nuevos.

MessageBatchDeletedEventData

Carga útil del evento para varios mensajes eliminados.

Tipo de evento: google.workspace.chat.message.v1.batchDeleted

Campos
messages[]

MessageDeletedEventData

Una lista de los mensajes borrados.

MessageBatchUpdatedEventData

Carga útil del evento para varios mensajes actualizados.

Tipo de evento: google.workspace.chat.message.v1.batchUpdated

Campos
messages[]

MessageUpdatedEventData

Es una lista de mensajes actualizados.

MessageCreatedEventData

Carga útil del evento para un mensaje nuevo.

Tipo de evento: google.workspace.chat.message.v1.created

Campos
message

Message

El mensaje nuevo.

MessageDeletedEventData

Carga útil del evento para un mensaje borrado.

Tipo de evento: google.workspace.chat.message.v1.deleted

Campos
message

Message

El mensaje borrado. Solo se completan los campos name, createTime, deleteTime y deletionMetadata.

MessageUpdatedEventData

Carga útil del evento para un mensaje actualizado.

Tipo de evento: google.workspace.chat.message.v1.updated

Campos
message

Message

El mensaje actualizado.

QuotedMessageMetadata

Información sobre un mensaje citado.

Campos
name

string

Solo salida. Es el nombre del recurso del mensaje citado.

Formato: spaces/{space}/messages/{message}
last_update_time

Timestamp

Solo salida. Es la marca de tiempo del momento en que se creó el mensaje citado o cuando se actualizó por última vez.

Reacciones

Una reacción a un mensaje.

Campos
name

string

Identificador. Es el nombre del recurso de la reacción.

Formato: spaces/{space}/messages/{message}/reactions/{reaction}
user

User

Solo salida. El usuario que creó la reacción.
emoji

Emoji

Obligatorio. Es el emoji que se usó en la reacción.

ReactionBatchCreatedEventData

Carga útil del evento para varias reacciones nuevas.

Tipo de evento: google.workspace.chat.reaction.v1.batchCreated

Campos
reactions[]

ReactionCreatedEventData

Una lista de reacciones nuevas.

ReactionBatchDeletedEventData

Carga útil del evento para varias reacciones borradas.

Tipo de evento: google.workspace.chat.reaction.v1.batchDeleted

Campos
reactions[]

ReactionDeletedEventData

Una lista de las reacciones borradas.

ReactionCreatedEventData

Carga útil del evento para una reacción nueva.

Tipo de evento: google.workspace.chat.reaction.v1.created

Campos
reaction

Reaction

La reacción nueva

ReactionDeletedEventData

Carga útil del evento para una reacción borrada.

Tipo: google.workspace.chat.reaction.v1.deleted

Campos
reaction

Reaction

La reacción borrada

RichLinkMetadata

Es un vínculo enriquecido a un recurso.

Campos
uri

string

El URI de este vínculo.
Campo de unión data. Datos del recurso vinculado. Las direcciones (data) solo pueden ser una de las siguientes opciones:

RichLinkType

El tipo de vínculo enriquecido. Es posible que se agreguen más tipos en el futuro.

Enumeraciones
DRIVE_FILE Es un tipo de vínculo enriquecido de Google Drive.
CHAT_SPACE Un tipo de vínculo enriquecido de espacio de Chat. Por ejemplo, un chip inteligente de espacio.

SearchSpacesRequest

Solicitud para buscar una lista de espacios en función de una consulta.

Campos
use_admin_access

bool

Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que realiza la llamada debe ser un administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere el alcance de OAuth 2.0 chat.admin.spaces.readonly o chat.admin.spaces.

Actualmente, este método solo admite acceso de administrador, por lo que solo se acepta true para este campo.
page_size

int32

Es la cantidad máxima de espacios que se mostrarán. El servicio puede mostrar menos que este valor.

Si no se especifica, se mostrarán como máximo 100 espacios.

El valor máximo es 1,000. Si usas un valor superior a 1,000, este se cambiará automáticamente a 1,000.
page_token

string

Es un token que se recibió de la llamada a espacios de búsqueda anterior. Proporciona este parámetro para recuperar la página siguiente.

Cuando se realiza la paginación, todos los demás parámetros proporcionados deben coincidir con la llamada que proporcionó el token de página. Pasar diferentes valores a los otros parámetros puede generar resultados inesperados.
query

string

Obligatorio. Una búsqueda.

Puedes usar los siguientes parámetros para realizar búsquedas:

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

create_time y last_active_time aceptan una marca de tiempo en formato RFC-3339, y los operadores de comparación admitidos son: =, <, >, <= y >=.

customer es obligatorio y se usa para indicar de qué cliente se deben recuperar los espacios. customers/my_customer es el único valor admitido.

display_name solo acepta el operador HAS (:). El texto que debe coincidir primero se divide en tokens, y cada token se compara con un prefijo de forma independiente y sin distinción de mayúsculas o minúsculas como una subcadena en cualquier parte del display_name del espacio. Por ejemplo, Fun Eve coincide con Fun event o The evening was fun, pero no con notFun event o even.

external_user_allowed acepta true o false.

space_history_state solo acepta valores del campo historyState de un recurso space.

space_type es obligatorio y el único valor válido es SPACE.

En diferentes campos, solo se admiten operadores AND. Un ejemplo válido es space_type = "SPACE" AND display_name:"Hello" y un ejemplo no válido es space_type = "SPACE" OR display_name:"Hello".

En el mismo campo, space_type no admite los operadores AND ni OR. display_name, "space_history_state" y "external_user_allowed" solo admiten operadores OR. last_active_time y create_time admiten los operadores AND y OR. AND solo se puede usar para representar un intervalo, como last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00".

Las siguientes consultas de ejemplo son válidas:

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")
order_by

string

Opcional. Indica cómo se ordena la lista de espacios.

Los atributos compatibles para ordenar son los siguientes:

  • membership_count.joined_direct_human_user_count: Indica la cantidad de usuarios humanos que se unieron directamente a un espacio.
  • last_active_time: Indica el momento en que se agregó el último elemento apto a cualquier tema de este espacio.
  • create_time: Indica la hora de creación del espacio.

Los valores válidos de la operación de ordenamiento son los siguientes:

  • ASC para ascendente. Valor predeterminado

  • DESC para descendente.

Las sintaxis admitidas son las siguientes:

  • 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

SearchSpacesResponse

Es la respuesta con una lista de espacios correspondientes a la solicitud de espacios de búsqueda.

Campos
spaces[]

Space

Una página de los espacios solicitados.
next_page_token

string

Es un token que se puede usar para recuperar la página siguiente. Si este campo está vacío, no hay páginas posteriores.
total_size

int32

Es la cantidad total de espacios que coinciden con la búsqueda en todas las páginas. Si el resultado es superior a 10,000 espacios, este valor es una estimación.

SetUpSpaceRequest

Solicitar la creación de un espacio y agregar a él a los usuarios especificados

Campos
space

Space

Obligatorio. El campo Space.spaceType es obligatorio.

Para crear un espacio, configura Space.spaceType en SPACE y Space.displayName. Si recibes el mensaje de error ALREADY_EXISTS cuando configuras un espacio, prueba con un displayName diferente. Es posible que un espacio existente dentro de la organización de Google Workspace ya use este nombre visible.

Para crear un chat en grupo, establece Space.spaceType en GROUP_CHAT. No configures Space.displayName.

Para crear una conversación 1:1 entre humanos, establece Space.spaceType en DIRECT_MESSAGE y Space.singleUserBotDm en false. No configures Space.displayName ni Space.spaceDetails.

Para crear una conversación 1:1 entre una persona y la app de Chat que realiza la llamada, establece Space.spaceType en DIRECT_MESSAGE y Space.singleUserBotDm en true. No configures Space.displayName ni Space.spaceDetails.

Si ya existe un espacio DIRECT_MESSAGE, se muestra ese espacio en lugar de crear uno nuevo.
request_id

string

Opcional. Es un identificador único para esta solicitud. Se recomienda usar un UUID aleatorio. Si especificas un ID de solicitud existente, se muestra el espacio creado con ese ID en lugar de crear uno nuevo. Si especificas un ID de solicitud existente de la misma app de Chat con un usuario autenticado diferente, se muestra un error.
memberships[]

Membership

Opcional. Los usuarios o grupos de Google Chat a los que quieres invitar a unirse al espacio Omite al usuario que realiza la llamada, ya que se agrega automáticamente.

Actualmente, el conjunto permite hasta 20 membresías (además del llamador).

Para la membresía humana, el campo Membership.member debe contener un user con name propagado (formato: users/{user}) y type establecido en User.Type.HUMAN. Solo puedes agregar usuarios humanos cuando configuras un espacio (agregar apps de Chat solo es compatible con la configuración de mensajes directos con la app de llamadas). También puedes agregar miembros con el correo electrónico del usuario como alias para {user}. Por ejemplo, user.name puede ser users/example@gmail.com. Para invitar a usuarios de Gmail o de dominios externos de Google Workspace, se debe usar el correo electrónico del usuario para {user}.

Para la membresía de Grupos de Google, el campo Membership.group_member debe contener un group con name propagado (formato groups/{group}). Solo puedes agregar Grupos de Google cuando configuras Space.spaceType como SPACE.

Opcional cuando se establece Space.spaceType en SPACE.

Obligatorio cuando se establece Space.spaceType en GROUP_CHAT, junto con al menos dos membresías.

Obligatorio cuando se establece Space.spaceType en DIRECT_MESSAGE con un usuario humano, junto con exactamente una membresía.

Debe estar vacío cuando se crea una conversación 1:1 entre una persona y la app de Chat que realiza la llamada (cuando se establece Space.spaceType en DIRECT_MESSAGE y Space.singleUserBotDm en true).

SlashCommand

Un comando de barra en Google Chat.

Campos
command_id

int64

Es el ID del comando de barra invocado.

SlashCommandMetadata

Metadatos de anotación para los comandos de barra (/).

Campos
bot

User

La app de Chat cuyo comando se invocó
type

Type

Es el tipo de comando de barra.
command_name

string

Es el nombre del comando de barra invocado.
command_id

int64

El ID del comando de barra invocado.
triggers_dialog

bool

Indica si el comando de barra es para un diálogo.

Tipo

Enumeraciones
TYPE_UNSPECIFIED Es el valor predeterminado de la enumeración. No lo uses.
ADD Agrega la app de Chat al espacio.
INVOKE Invoca el comando de barra en el espacio.

Espacio

Un espacio en Google Chat. Los espacios son conversaciones entre dos o más usuarios, o bien mensajes 1:1 entre un usuario y una app de Chat.

Campos
name

string

Identificador. Es el nombre del recurso del espacio.

Formato: spaces/{space}

En el que {space} representa el ID asignado por el sistema para el espacio. Para obtener el ID del espacio, llama al método spaces.list() o desde la URL del espacio. Por ejemplo, si la URL del espacio es https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, el ID del espacio es AAAAAAAAA.
type
(deprecated)

Type

Solo salida. Obsoleto: Usa space_type en su lugar. Es el tipo de un espacio.
space_type

SpaceType

Opcional. Es el tipo de espacio. Obligatorio cuando se crea un espacio o se actualiza el tipo de espacio. Solo salida para otro uso.
single_user_bot_dm

bool

Opcional. Si el espacio es un MD entre una app de chat y una sola persona.
threaded
(deprecated)

bool

Solo salida. Obsoleto: Usa spaceThreadingState en su lugar. Si los mensajes se organizan en conversaciones en este espacio.
display_name

string

Opcional. Es el nombre visible del espacio. Obligatorio cuando se crea un espacio con un spaceType de SPACE. Si recibes el mensaje de error ALREADY_EXISTS cuando creas un espacio o actualizas el displayName, prueba con otro displayName. Es posible que un espacio existente dentro de la organización de Google Workspace ya use este nombre visible.

En el caso de los mensajes directos, este campo puede estar vacío.

Admite hasta 128 caracteres.
external_user_allowed

bool

Opcional. Inmutable. Si este espacio permite que cualquier usuario de Google Chat sea miembro. Se ingresa cuando se crea un espacio en una organización de Google Workspace. Omite este campo cuando crees espacios en las siguientes condiciones:

  • El usuario autenticado usa una cuenta de consumidor (cuenta de usuario no administrada). De forma predeterminada, un espacio creado por una cuenta de consumidor permite a cualquier usuario de Google Chat.

Para los espacios existentes, este campo es solo de salida.
space_threading_state

SpaceThreadingState

Solo salida. El estado de los subprocesos en el espacio de Chat
space_details

SpaceDetails

Opcional. Detalles sobre el espacio, incluida la descripción y las reglas
space_history_state

HistoryState

Opcional. El estado del historial de mensajes de los mensajes y las conversaciones de este espacio.
import_mode

bool

Opcional. Si este espacio se crea en Import Mode como parte de una migración de datos a Google Workspace Mientras se importan los espacios, los usuarios no pueden verlos hasta que se completa la importación.

Para crear un espacio en Import Mode, se requiere la autenticación del usuario.
create_time

Timestamp

Opcional. Inmutable. En el caso de los espacios creados en Chat, la hora en que se creó el espacio Este campo es solo de salida, excepto cuando se usa en espacios de modo de importación.

En el caso de los espacios del modo de importación, establece este campo en la marca de tiempo histórica en la que se creó el espacio en la fuente para conservar la hora de creación original.

Solo se propaga en el resultado cuando spaceType es GROUP_CHAT o SPACE.
last_active_time

Timestamp

Solo salida. Marca de tiempo del último mensaje en el espacio.

admin_installed

bool

Solo salida. En el caso de los espacios de mensajes directos (MD) con una app de Chat, si un administrador de Google Workspace creó el espacio. Los administradores pueden instalar y configurar un mensaje directo con una app de Chat en nombre de los usuarios de su organización.

Para admitir la instalación de administrador, tu app de Chat debe incluir mensajes directos.
membership_count

MembershipCount

Solo salida. Es el recuento de membresías unidas agrupadas por tipo de miembro. Se propaga cuando space_type es SPACE, DIRECT_MESSAGE o GROUP_CHAT.

access_settings

AccessSettings

Opcional. Especifica la configuración de acceso del espacio. Solo se propaga cuando space_type es SPACE.
space_uri

string

Solo salida. Es el URI que permite que un usuario acceda al espacio.
customer

string

Opcional. Inmutable. El ID de cliente del dominio del espacio. Solo es obligatorio cuando se crea un espacio con autenticación de apps y SpaceType es SPACE. De lo contrario, no se debe establecer.

En el formato customers/{customer}, donde customer es el id del [recurso de cliente del SDK de Admin]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Las apps privadas también pueden usar el alias customers/my_customer para crear el espacio en la misma organización de Google Workspace que la app.

En el caso de los mensajes directos, este campo no se completa.

Campo de unión space_permission_settings. Representa la configuración de permisos de un espacio. Solo se propaga cuando space_type es SPACE.

Requiere autenticación del usuario. Las direcciones (space_permission_settings) solo pueden ser una de las siguientes opciones:
predefined_permission_settings

PredefinedPermissionSettings

Opcional. Solo entrada. Configuración predefinida de permisos del espacio, que se ingresa solo cuando se crea un espacio. Si no se establece el campo, se crea un espacio de colaboración. Después de crear el espacio, la configuración se propaga en el campo PermissionSettings.
permission_settings

PermissionSettings

Opcional. Configuración de permisos de los espacios existentes Entrada para actualizar la configuración exacta de permisos de espacio, en la que se reemplaza la configuración de permisos existente. El resultado muestra la configuración de permisos actual.

AccessSettings

Representa la configuración de acceso del espacio.

Campos
access_state

AccessState

Solo salida. Indica el estado de acceso del espacio.
audience

string

Opcional. Es el nombre del recurso del público objetivo que puede descubrir el espacio, unirse a él y obtener una vista previa de los mensajes. Si no se establece, solo podrán acceder al espacio los usuarios o los Grupos de Google a los que se haya invitado o agregado de forma individual. Para obtener más información, consulta Cómo hacer que un espacio sea detectable para un público objetivo.

Formato: audiences/{audience}

Para usar el público objetivo predeterminado de la organización de Google Workspace, establece audiences/default.

Leer el público objetivo permite lo siguiente:

Este campo no se propaga cuando se usa el alcance chat.bot con la autenticación de apps.

Para configurar el público objetivo, se requiere la autenticación del usuario.

AccessState

Representa el estado de acceso del espacio.

Enumeraciones
ACCESS_STATE_UNSPECIFIED El estado de acceso es desconocido o no se admite en esta API.
PRIVATE Solo los usuarios o los Grupos de Google que otros usuarios o administradores de Google Workspace hayan agregado o invitado de forma individual pueden descubrir el espacio y acceder a él.
DISCOVERABLE

Un administrador del espacio le otorgó acceso a un público objetivo. Los usuarios o Grupos de Google que se hayan agregado o invitado de forma individual al espacio también pueden descubrirlo y acceder a él. Para obtener más información, consulta Cómo hacer que un espacio sea detectable para usuarios específicos.

Para crear espacios detectables, se requiere la autenticación del usuario.

MembershipCount

Representa el recuento de membresías de un espacio, agrupadas en categorías.

Campos
joined_direct_human_user_count

int32

Solo salida. Es el recuento de usuarios humanos que se unieron directamente al espacio, sin contar a los usuarios que se unieron por tener membresía en un grupo al que se unieron.
joined_group_count

int32

Solo salida. Es el recuento de todos los grupos que se unieron directamente al espacio.

PermissionSetting

Representa un parámetro de configuración de permisos de espacio.

Campos
managers_allowed

bool

Opcional. Si los administradores de espacios tienen este permiso
members_allowed

bool

Opcional. Si los miembros que no son administradores tienen este permiso

PermissionSettings

Configuración de permisos que puedes especificar cuando actualizas un espacio con nombre existente.

Para establecer la configuración de permisos cuando creas un espacio, especifica el campo PredefinedPermissionSettings en tu solicitud.

Campos
manage_members_and_groups

PermissionSetting

Opcional. Configuración para administrar miembros y grupos en un espacio.
modify_space_details

PermissionSetting

Opcional. Configuración para actualizar el nombre, el avatar, la descripción y los lineamientos del espacio
toggle_history

PermissionSetting

Opcional. Configuración para activar o desactivar el historial del espacio.
use_at_mention_all

PermissionSetting

Opcional. Configuración para usar @todos en un espacio
manage_apps

PermissionSetting

Opcional. Configuración para administrar apps en un espacio.
manage_webhooks

PermissionSetting

Opcional. Configuración para administrar webhooks en un espacio.
post_messages

PermissionSetting

Solo salida. Configuración para publicar mensajes en un espacio.
reply_messages

PermissionSetting

Opcional. Configuración para responder mensajes en un espacio.

PredefinedPermissionSettings

Configuración de permisos predefinida que solo puedes especificar cuando creas un espacio con nombre. Es posible que se agreguen más parámetros de configuración en el futuro. Para obtener detalles sobre la configuración de permisos de los espacios nombrados, consulta Obtén información sobre los espacios.

Enumeraciones
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Sin especificar. No lo uses.
COLLABORATION_SPACE Es la configuración para hacer que el espacio sea de colaboración, en el que todos los miembros puedan publicar mensajes.
ANNOUNCEMENT_SPACE Es la configuración para hacer que el espacio sea un espacio de anuncios en el que solo los administradores del espacio puedan publicar mensajes.

SpaceDetails

Detalles sobre el espacio, incluida la descripción y las reglas

Campos
description

string

Opcional. Una descripción del espacio Por ejemplo, describe el tema de debate, el propósito funcional o los participantes del espacio.

Admite hasta 150 caracteres.
guidelines

string

Opcional. Las reglas, las expectativas y la etiqueta del espacio

Admite hasta 5,000 caracteres.

SpaceThreadingState

Especifica el tipo de estado de subprocesos en el espacio de Chat.

Enumeraciones
SPACE_THREADING_STATE_UNSPECIFIED Reservado.
THREADED_MESSAGES Espacios con nombre que admiten conversaciones de mensajes Cuando los usuarios responden un mensaje, pueden hacerlo en la conversación, lo que mantiene su respuesta en el contexto del mensaje original.
GROUPED_MESSAGES Espacios con nombre en los que la conversación se organiza por tema. Los temas y sus respuestas se agrupan.
UNTHREADED_MESSAGES Mensajes directos (MD) entre dos personas y conversaciones grupales entre 3 o más personas.

SpaceType

Es el tipo de espacio. Obligatorio cuando se crea o actualiza un espacio. Solo salida para otro uso.

Enumeraciones
SPACE_TYPE_UNSPECIFIED Reservado.
SPACE Un lugar donde las personas envían mensajes, comparten archivos y colaboran. Un SPACE puede incluir apps de Chat.
GROUP_CHAT Conversaciones grupales entre 3 o más personas Un GROUP_CHAT puede incluir apps de Chat.
DIRECT_MESSAGE Mensajes 1:1 entre dos personas o una persona y una app de Chat

Tipo

Obsoleto: Usa SpaceType en su lugar.

Enumeraciones
TYPE_UNSPECIFIED Reservado.
ROOM Conversaciones entre dos o más personas.
DM Mensaje directo 1:1 entre una persona y una app de chat, en el que todos los mensajes son planos. Ten en cuenta que esto no incluye los mensajes directos entre dos personas.

SpaceBatchUpdatedEventData

Carga útil del evento para varias actualizaciones de un espacio.

Tipo de evento: google.workspace.chat.space.v1.batchUpdated

Campos
spaces[]

SpaceUpdatedEventData

Es una lista de espacios actualizados.

SpaceEvent

Un evento que representa un cambio o una actividad en un espacio de Google Chat. Para obtener más información, consulta Cómo trabajar con eventos de Google Chat.

Campos
name

string

Es el nombre del recurso del evento de espacio.

Formato: spaces/{space}/spaceEvents/{spaceEvent}
event_time

Timestamp

Hora en la que ocurrió el evento.
event_type

string

Es el tipo de evento espacial. Cada tipo de evento tiene una versión por lotes, que representa varias instancias del tipo de evento que ocurren en un período breve. En el caso de las solicitudes spaceEvents.list(), omite los tipos de eventos por lotes en el filtro de consulta. De forma predeterminada, el servidor muestra el tipo de evento y su versión por lotes.

Tipos de eventos admitidos para mensajes:

  • Mensaje nuevo: google.workspace.chat.message.v1.created
  • Mensaje actualizado: google.workspace.chat.message.v1.updated
  • Mensaje borrado: google.workspace.chat.message.v1.deleted
  • Varios mensajes nuevos: google.workspace.chat.message.v1.batchCreated
  • Varios mensajes actualizados: google.workspace.chat.message.v1.batchUpdated
  • Varios mensajes borrados: google.workspace.chat.message.v1.batchDeleted

Tipos de eventos admitidos para las membresías:

  • Nueva membresía: google.workspace.chat.membership.v1.created
  • Membresía actualizada: google.workspace.chat.membership.v1.updated
  • Membresía borrada: google.workspace.chat.membership.v1.deleted
  • Varias membresías nuevas: google.workspace.chat.membership.v1.batchCreated
  • Varias membresías actualizadas: google.workspace.chat.membership.v1.batchUpdated
  • Varias membresías borradas: google.workspace.chat.membership.v1.batchDeleted

Tipos de eventos admitidos para las reacciones:

  • Nueva reacción: google.workspace.chat.reaction.v1.created
  • Se borró la reacción: google.workspace.chat.reaction.v1.deleted
  • Varias reacciones nuevas: google.workspace.chat.reaction.v1.batchCreated
  • Varias reacciones borradas: google.workspace.chat.reaction.v1.batchDeleted

Tipos de eventos admitidos sobre el espacio:

  • Espacio actualizado: google.workspace.chat.space.v1.updated
  • Varias actualizaciones de espacio: google.workspace.chat.space.v1.batchUpdated

Campo de unión payload.

payload puede ser una de las siguientes opciones:
message_created_event_data

MessageCreatedEventData

Carga útil del evento para un mensaje nuevo.

Tipo de evento: google.workspace.chat.message.v1.created
message_updated_event_data

MessageUpdatedEventData

Carga útil del evento para un mensaje actualizado.

Tipo de evento: google.workspace.chat.message.v1.updated
message_deleted_event_data

MessageDeletedEventData

Carga útil del evento para un mensaje borrado.

Tipo de evento: google.workspace.chat.message.v1.deleted
message_batch_created_event_data

MessageBatchCreatedEventData

Carga útil del evento para varios mensajes nuevos.

Tipo de evento: google.workspace.chat.message.v1.batchCreated
message_batch_updated_event_data

MessageBatchUpdatedEventData

Carga útil del evento para varios mensajes actualizados.

Tipo de evento: google.workspace.chat.message.v1.batchUpdated
message_batch_deleted_event_data

MessageBatchDeletedEventData

Carga útil del evento para varios mensajes eliminados.

Tipo de evento: google.workspace.chat.message.v1.batchDeleted
space_updated_event_data

SpaceUpdatedEventData

Carga útil del evento para una actualización de espacio.

Tipo de evento: google.workspace.chat.space.v1.updated
space_batch_updated_event_data

SpaceBatchUpdatedEventData

Carga útil del evento para varias actualizaciones de un espacio.

Tipo de evento: google.workspace.chat.space.v1.batchUpdated
membership_created_event_data

MembershipCreatedEventData

Carga útil del evento para una membresía nueva.

Tipo de evento: google.workspace.chat.membership.v1.created
membership_updated_event_data

MembershipUpdatedEventData

Carga útil del evento para una membresía actualizada.

Tipo de evento: google.workspace.chat.membership.v1.updated
membership_deleted_event_data

MembershipDeletedEventData

Carga útil del evento para una membresía borrada.

Tipo de evento: google.workspace.chat.membership.v1.deleted
membership_batch_created_event_data

MembershipBatchCreatedEventData

Carga útil del evento para varias membresías nuevas.

Tipo de evento: google.workspace.chat.membership.v1.batchCreated
membership_batch_updated_event_data

MembershipBatchUpdatedEventData

Carga útil del evento para varias membresías actualizadas.

Tipo de evento: google.workspace.chat.membership.v1.batchUpdated
membership_batch_deleted_event_data

MembershipBatchDeletedEventData

Carga útil del evento para varias membresías borradas.

Tipo de evento: google.workspace.chat.membership.v1.batchDeleted
reaction_created_event_data

ReactionCreatedEventData

Carga útil del evento para una reacción nueva.

Tipo de evento: google.workspace.chat.reaction.v1.created
reaction_deleted_event_data

ReactionDeletedEventData

Carga útil del evento para una reacción borrada.

Tipo de evento: google.workspace.chat.reaction.v1.deleted
reaction_batch_created_event_data

ReactionBatchCreatedEventData

Carga útil del evento para varias reacciones nuevas.

Tipo de evento: google.workspace.chat.reaction.v1.batchCreated
reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

Carga útil del evento para varias reacciones borradas.

Tipo de evento: google.workspace.chat.reaction.v1.batchDeleted

SpaceNotificationSetting

Es la configuración de notificaciones de un usuario en un espacio.

Campos
name

string

Identificador. Es el nombre del recurso de la configuración de notificaciones del espacio. Formato: users/{user}/spaces/{space}/spaceNotificationSetting.
notification_setting

NotificationSetting

Es la configuración de notificaciones.
mute_setting

MuteSetting

La configuración de silenciamiento de notificaciones del espacio

MuteSetting

Los tipos de configuración de silenciamiento de notificaciones del espacio

Enumeraciones
MUTE_SETTING_UNSPECIFIED Reservado.
UNMUTED El usuario recibirá notificaciones del espacio según la configuración de notificaciones.
MUTED El usuario no recibirá ninguna notificación del espacio, independientemente de la configuración de notificaciones.

NotificationSetting

Son los tipos de configuración de notificaciones.

Enumeraciones
NOTIFICATION_SETTING_UNSPECIFIED Reservado.
ALL Las notificaciones se activan con @menciones, conversaciones que sigues y el primer mensaje de conversaciones nuevas. Se sigue automáticamente todos los hilos nuevos, a menos que el usuario deje de seguirlos de forma manual.
MAIN_CONVERSATIONS Las notificaciones se activan con @menciones, conversaciones que sigues y el primer mensaje de conversaciones nuevas. No está disponible para los mensajes directos 1:1.
FOR_YOU Las notificaciones se activan con @menciones y conversaciones que sigues. No está disponible para los mensajes directos 1:1.
OFF La notificación está desactivada.

SpaceReadState

Es el estado de lectura de un usuario dentro de un espacio, que se usa para identificar los mensajes leídos y no leídos.

Campos
name

string

Es el nombre del recurso del estado de lectura del espacio.

Formato: users/{user}/spaces/{space}/spaceReadState
last_read_time

Timestamp

Opcional. Es la hora en la que se actualizó el estado de lectura del espacio del usuario. Por lo general, corresponde a la marca de tiempo del último mensaje leído o a una marca de tiempo que especifica el usuario para marcar la última posición de lectura en un espacio.

SpaceUpdatedEventData

Carga útil del evento para un espacio actualizado.

Tipo de evento: google.workspace.chat.space.v1.updated

Campos
space

Space

El espacio actualizado.

Conversación

Una conversación en un espacio de Google Chat. Para ver un ejemplo 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 coincidente.

Campos
name

string

Identificador. Es el nombre del recurso del subproceso.

Ejemplo: spaces/{space}/threads/{thread}
thread_key

string

Opcional. Entrada para crear o actualizar una conversación. De lo contrario, solo se muestra la salida. Es el ID del subproceso. Admite hasta 4,000 caracteres.

Este ID es único para la app de Chat que lo establece. Por ejemplo, si varias apps de Chat crean un mensaje con la misma clave de conversación, los mensajes se publican en conversaciones diferentes. Para responder en una conversación creada por una persona o por otra app de Chat, especifica el campo name de la conversación.

ThreadReadState

Es el estado de lectura de un usuario dentro de una conversación, que se usa para identificar los mensajes leídos y no leídos.

Campos
name

string

Es el nombre del recurso del estado de lectura del subproceso.

Formato: users/{user}/spaces/{space}/threads/{thread}/threadReadState
last_read_time

Timestamp

Es la hora en la que se actualizó el estado de lectura del subproceso del usuario. Por lo general, corresponde a la marca de tiempo del último mensaje leído en una conversación.

UpdateMembershipRequest

Es un mensaje de solicitud para actualizar una membresía.

Campos
membership

Membership

Obligatorio. Es la membresía que se actualizará. Solo se actualizan los campos especificados por update_mask.
update_mask

FieldMask

Obligatorio. Las rutas de campo que se actualizarán. Separa varios valores con comas o usa * para actualizar todas las rutas de campo.

Rutas de campo admitidas actualmente:

  • role
use_admin_access

bool

Opcional. Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que realiza la llamada debe ser un administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere el permiso de OAuth 2.0 chat.admin.memberships.

UpdateMessageRequest

Es una solicitud para actualizar un mensaje.

Campos
message

Message

Obligatorio. Mensaje con campos actualizados.
update_mask

FieldMask

Obligatorio. Las rutas de campo que se actualizarán. Separa varios valores con comas o usa * para actualizar todas las rutas de campo.

Rutas de campo admitidas actualmente:
allow_missing

bool

Opcional. Si no se encuentra true ni el mensaje, se crea uno nuevo y se ignora updateMask. El ID de mensaje especificado debe ser asignado por el cliente o la solicitud fallará.

UpdateSpaceNotificationSettingRequest

Solicitud para actualizar la configuración de notificaciones del espacio. Solo admite la actualización de la configuración de notificaciones para el usuario que realiza la llamada.

Campos
space_notification_setting

SpaceNotificationSetting

Obligatorio. El nombre del recurso para la configuración de notificaciones del espacio debe propagarse en el formato users/{user}/spaces/{space}/spaceNotificationSetting. Solo se actualizan los campos especificados por update_mask.
update_mask

FieldMask

Obligatorio. Rutas de campo compatibles: - notification_setting - mute_setting

UpdateSpaceReadStateRequest

Es el mensaje de solicitud para la API de UpdateSpaceReadState.

Campos
space_read_state

SpaceReadState

Obligatorio. El estado de lectura del espacio y los campos que se deben actualizar

Solo admite la actualización del estado de lectura para el usuario que realiza la llamada.

Para hacer referencia al usuario que llama, establece una de las siguientes opciones:

  • El alias me. Por ejemplo, users/me/spaces/{space}/spaceReadState

  • Su dirección de correo electrónico de Workspace Por ejemplo, users/user@example.com/spaces/{space}/spaceReadState.

  • Su ID de usuario Por ejemplo, users/123456789/spaces/{space}/spaceReadState.

Formato: users/{user}/spaces/{space}/spaceReadState
update_mask

FieldMask

Obligatorio. Las rutas de campo que se actualizarán. Rutas de campo admitidas actualmente:

  • last_read_time

Cuando el last_read_time es anterior a la hora de creación del mensaje más reciente, el espacio aparece como no leído en la IU.

Para marcar el espacio como leído, establece last_read_time en cualquier valor posterior (mayor) que la hora de creación del mensaje más reciente. El last_read_time se obliga a coincidir con la hora de creación del mensaje más reciente. Ten en cuenta que el estado de lectura del espacio solo afecta el estado de lectura de los mensajes que son visibles en la conversación de nivel superior del espacio. Las respuestas en las conversaciones no se ven afectadas por esta marca de tiempo, sino que dependen del estado de lectura de la conversación.

UpdateSpaceRequest

Es una solicitud para actualizar un solo espacio.

Campos
space

Space

Obligatorio. Espacio con campos que se actualizarán. Space.name se debe propagar en el formato spaces/{space}. Solo se actualizan los campos especificados por update_mask.
update_mask

FieldMask

Obligatorio. Las rutas de acceso de los campos actualizadas, separadas por comas si hay varias.

Puedes actualizar los siguientes campos de un espacio:

space_details: Actualiza la descripción del espacio. Admite hasta 150 caracteres.

display_name: Solo admite la actualización del nombre visible para los espacios en los que el campo spaceType es SPACE. Si recibes el mensaje de error ALREADY_EXISTS, prueba con otro valor. Es posible que un espacio existente dentro de la organización de Google Workspace ya use este nombre visible.

space_type: Solo admite cambiar un tipo de espacio GROUP_CHAT a SPACE. Incluye display_name junto con space_type en la máscara de actualización y asegúrate de que el espacio especificado tenga un nombre visible no vacío y el tipo de espacio SPACE. Incluir la máscara space_type y el tipo SPACE en el espacio especificado cuando se actualiza el nombre visible es opcional si el espacio existente ya tiene el tipo SPACE. Si intentas actualizar el tipo de espacio de otras maneras, se mostrará un error de argumento no válido. space_type no es compatible con useAdminAccess.

space_history_state: Actualiza la configuración del historial del espacio activando o desactivando el historial del espacio. Solo se admite si la configuración del historial está habilitada para la organización de Google Workspace. Para actualizar el estado del historial de espacios, debes omitir todas las demás máscaras de campo en tu solicitud. space_history_state no es compatible con useAdminAccess.

access_settings.audience: Actualiza la configuración de acceso de quién puede descubrir el espacio, unirse a él y obtener una vista previa de los mensajes en el espacio con nombre en el que el campo spaceType es SPACE. Si el espacio existente tiene un público objetivo, puedes quitarlo y restringir el acceso al espacio omitiendo un valor para esta máscara de campo. Para actualizar la configuración de acceso de un espacio, el usuario que realiza la autenticación debe ser administrador del espacio y omitir todas las demás máscaras de campo en la solicitud. No puedes actualizar este campo si el espacio está en modo de importación. Para obtener más información, consulta Cómo hacer que un espacio sea detectable para usuarios específicos. access_settings.audience no es compatible con useAdminAccess.

permission_settings: Admite cambiar la configuración de permisos de un espacio. Cuando actualizas la configuración de permisos, solo puedes especificar máscaras de campo permissionSettings. No puedes actualizar otras máscaras de campo al mismo tiempo. permissionSettings no es compatible con useAdminAccess. Entre las máscaras de campo admitidas, se incluyen las siguientes:

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

bool

Opcional. Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que realiza la llamada debe ser un administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere el permiso de OAuth 2.0 chat.admin.spaces.

Algunos valores de FieldMask no son compatibles con el acceso de administrador. Para obtener más información, consulta la descripción de update_mask.

Usuario

Un usuario en Google Chat. Cuando se muestra como un resultado de una solicitud, si tu app de Chat se autentica como un usuario, el resultado de un recurso User solo propaga los name y type del usuario.

Campos
name

string

Es el nombre de recurso de un user de Google Chat.

Formato: users/{user}. users/app se puede usar como alias para el usuario bot de la app que realiza la llamada.

Para human users, {user} es el mismo identificador de usuario que el siguiente:

  • el id para Person en la API de People. Por ejemplo, users/123456789 en la API de Chat representa a la misma persona que el ID de perfil de la persona 123456789 en la API de People.

  • el id de un usuario en la API de Directory del SDK de Admin.

  • La dirección de correo electrónico del usuario se puede usar como alias para {user} en las solicitudes a la API. Por ejemplo, si el ID de perfil de persona de la API de People para user@example.com es 123456789, puedes usar users/user@example.com como alias para hacer referencia a users/123456789. La API solo mostrará el nombre del recurso canónico (por ejemplo, users/123456789).
display_name

string

Solo salida. El nombre visible del usuario.
domain_id

string

Es el identificador único del dominio de Google Workspace del usuario.
type

Type

Tipo de usuario.
is_anonymous

bool

Solo salida. Cuando true, el usuario se borra o su perfil no es visible.

Tipo

Enumeraciones
TYPE_UNSPECIFIED Es el valor predeterminado de la enumeración. NO USAR.
HUMAN Usuario humano.
BOT Usuario de la app de chat

UserMentionMetadata

Metadatos de anotación para menciones de usuarios (@).

Campos
user

User

El usuario mencionado.
type

Type

Es el tipo de mención de usuario.

Tipo

Enumeraciones
TYPE_UNSPECIFIED Es el valor predeterminado de la enumeración. No lo uses.
ADD Agrega el usuario al espacio.
MENTION Mencionar al usuario en el espacio

WidgetMarkup

Un widget es un elemento de la IU que presenta texto e imágenes.

Campos
buttons[]

Button

Una lista de botones. Buttons también es oneof data y solo se debe establecer uno de estos campos.
Campo de unión data. Un WidgetMarkup solo puede tener uno de los siguientes elementos. Puedes usar varios campos WidgetMarkup para mostrar más elementos. data solo puede ser uno de los siguientes:
text_paragraph

TextParagraph

Muestra un párrafo de texto en este widget.
image

Image

Muestra una imagen en este widget.
key_value

KeyValue

Muestra un elemento de valor clave en este widget.

Botón

Un botón. Puede ser un botón de texto o de imagen.

Campos

Campo de unión type.

type puede ser una de las siguientes opciones:
text_button

TextButton

Un botón con texto y acción onclick.
image_button

ImageButton

Un botón con imagen y acción onclick.

FormAction

Una acción de formulario describe el comportamiento cuando se envía el formulario. Por ejemplo, puedes invocar Apps Script para controlar el formulario.

Campos
action_method_name

string

El nombre del método se usa para identificar qué parte del formulario activó el envío. Esta información se vuelve a enviar a la app de Chat como parte del evento de clic en la tarjeta. Puedes usar el mismo nombre de método para varios elementos que activen un comportamiento común.
parameters[]

ActionParameter

Es la lista de parámetros de acción.

ActionParameter

Es una lista de parámetros de cadena que se deben proporcionar cuando se invoca el método de acción. Por ejemplo, considera tres botones para posponer: posponer ahora, posponer un día y posponer la próxima semana. Puedes usar action method = snooze() y pasar el tipo de posposición y la hora de posposición en la lista de parámetros de cadena.

Campos
key

string

Es el nombre del parámetro de la secuencia de comandos de la acción.
value

string

El valor del parámetro.

Ícono

Es el conjunto de íconos admitidos.

Enumeraciones
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

Imagen

Es una imagen especificada por una URL y puede tener una acción onclick.

Campos
image_url

string

Es la URL de la imagen.
on_click

OnClick

La acción onclick
aspect_ratio

double

Es la relación de aspecto de esta imagen (ancho y alto). Este campo te permite reservar la altura correcta para la imagen mientras esperas a que se cargue. No está diseñado para anular la relación de aspecto integrada de la imagen. Si no se establece, el servidor la completa a través de la precarga de la imagen.

ImageButton

Un botón de imagen con una acción onclick.

Campos
on_click

OnClick

La acción onclick
name

string

Es el nombre de este image_button que se usa para la accesibilidad. Si no se especifica este nombre, se proporciona el valor predeterminado.
Campo de unión icons. El ícono se puede especificar con un Icon enum o una URL. icons solo puede ser uno de los siguientes:
icon

Icon

Es el ícono especificado por un enum que indexa a un ícono proporcionado por la API de Chat.
icon_url

string

Es el ícono especificado por una URL.

KeyValue

Un elemento de la IU contiene una clave (etiqueta) y un valor (contenido). Este elemento también puede contener algunas acciones, como el botón onclick.

Campos
top_label

string

Es el texto de la etiqueta superior. Se admite el texto con formato. Para obtener más información sobre cómo dar formato al texto, consulta Cómo dar formato al texto en las apps de Google Chat y Cómo dar formato al texto en los complementos de Google Workspace.
content

string

Es el texto del contenido. Se admite el texto con formato y siempre es obligatorio. Para obtener más información sobre cómo dar formato al texto, consulta Cómo dar formato al texto en las apps de Google Chat y Cómo dar formato al texto en los complementos de Google Workspace.
content_multiline

bool

Si el contenido debe ser de varias líneas.
bottom_label

string

Es el texto de la etiqueta inferior. Se admite el texto con formato. Para obtener más información sobre cómo dar formato al texto, consulta Cómo dar formato al texto en las apps de Google Chat y Cómo dar formato al texto en los complementos de Google Workspace.
on_click

OnClick

La acción onclick Solo se puede hacer clic en la etiqueta superior, la etiqueta inferior y la región de contenido.
Campo de unión icons. Se debe definir al menos uno de los íconos, top_label y bottom_label. icons solo puede ser uno de los siguientes:
icon

Icon

Es un valor de enumeración que la API de Chat reemplaza por la imagen de ícono correspondiente.
icon_url

string

Es el ícono especificado por una URL.
Campo de unión control. Un widget de control. Puedes configurar button o switch_widget, pero no ambos. control solo puede ser uno de los siguientes:
button

Button

Es un botón en el que se puede hacer clic para activar una acción.

OnClick

Una acción onclick (por ejemplo, abrir un vínculo)

Campos

Campo de unión data.

data puede ser una de las siguientes opciones:
action

FormAction

Si se especifica, esta acción onclick activa una acción de formulario.

TextButton

Un botón con texto y acción onclick.

Campos
text

string

El texto del botón
on_click

OnClick

La acción onclick del botón.

TextParagraph

Un párrafo de texto. Se admite el texto con formato. Para obtener más información sobre cómo dar formato al texto, consulta Cómo dar formato al texto en las apps de Google Chat y Cómo dar formato al texto en los complementos de Google Workspace.

Campos
text

string