Package google.chat.v1

Índice

• ChatService (interfaz)
• AccessoryWidget (mensaje)
• ActionResponse (mensaje)
• ActionResponse.ResponseType (enumeración)
• ActionResponse.SelectionItems (mensaje)
• ActionResponse.UpdatedWidget (mensaje)
• ActionStatus (mensaje)
• Annotation (mensaje)
• AnnotationType (enumeración)
• AppCommandMetadata (mensaje)
• AppCommandMetadata.AppCommandType (enumeración)
• AttachedGif (mensaje)
• Attachment (mensaje)
• Attachment.Source (enumeración)
• AttachmentDataRef (mensaje)
• CalendarEventLinkData (mensaje)
• CardWithId (mensaje)
• ChatSpaceLinkData (mensaje)
• CompleteImportSpaceRequest (mensaje)
• CompleteImportSpaceResponse (mensaje)
• ContextualAddOnMarkup (mensaje)
• ContextualAddOnMarkup.Card (mensaje)
• ContextualAddOnMarkup.Card.CardAction (mensaje)
• ContextualAddOnMarkup.Card.CardHeader (mensaje)
• ContextualAddOnMarkup.Card.CardHeader.ImageStyle (enumeración)
• ContextualAddOnMarkup.Card.Section (mensaje)
• CreateCustomEmojiRequest (mensaje)
• CreateMembershipRequest (mensaje)
• CreateMessageRequest (mensaje)
• CreateMessageRequest.MessageReplyOption (enumeración)
• CreateReactionRequest (mensaje)
• CreateSpaceRequest (mensaje)
• CustomEmoji (mensaje)
• CustomEmoji.CustomEmojiPayload (mensaje)
• CustomEmojiMetadata (mensaje)
• DeleteCustomEmojiRequest (mensaje)
• DeleteMembershipRequest (mensaje)
• DeleteMessageRequest (mensaje)
• DeleteReactionRequest (mensaje)
• DeleteSpaceRequest (mensaje)
• DeletionMetadata (mensaje)
• DeletionMetadata.DeletionType (enumeración)
• Dialog (mensaje)
• DialogAction (mensaje)
• DriveDataRef (mensaje)
• DriveLinkData (mensaje)
• Emoji (mensaje)
• EmojiReactionSummary (mensaje)
• FindDirectMessageRequest (mensaje)
• GetAttachmentRequest (mensaje)
• GetCustomEmojiRequest (mensaje)
• GetMembershipRequest (mensaje)
• GetMessageRequest (mensaje)
• GetSpaceEventRequest (mensaje)
• GetSpaceNotificationSettingRequest (mensaje)
• GetSpaceReadStateRequest (mensaje)
• GetSpaceRequest (mensaje)
• GetThreadReadStateRequest (mensaje)
• Group (mensaje)
• HistoryState (enumeración)
• ListCustomEmojisRequest (mensaje)
• ListCustomEmojisResponse (mensaje)
• ListMembershipsRequest (mensaje)
• ListMembershipsResponse (mensaje)
• ListMessagesRequest (mensaje)
• ListMessagesResponse (mensaje)
• ListReactionsRequest (mensaje)
• ListReactionsResponse (mensaje)
• ListSpaceEventsRequest (mensaje)
• ListSpaceEventsResponse (mensaje)
• ListSpacesRequest (mensaje)
• ListSpacesResponse (mensaje)
• MatchedUrl (mensaje)
• MeetSpaceLinkData (mensaje)
• MeetSpaceLinkData.HuddleStatus (enumeración)
• MeetSpaceLinkData.Type (enumeración)
• Membership (mensaje)
• Membership.MembershipRole (enumeración)
• Membership.MembershipState (enumeración)
• MembershipBatchCreatedEventData (mensaje)
• MembershipBatchDeletedEventData (mensaje)
• MembershipBatchUpdatedEventData (mensaje)
• MembershipCreatedEventData (mensaje)
• MembershipDeletedEventData (mensaje)
• MembershipUpdatedEventData (mensaje)
• Message (mensaje)
• MessageBatchCreatedEventData (mensaje)
• MessageBatchDeletedEventData (mensaje)
• MessageBatchUpdatedEventData (mensaje)
• MessageCreatedEventData (mensaje)
• MessageDeletedEventData (mensaje)
• MessageUpdatedEventData (mensaje)
• QuotedMessageMetadata (mensaje)
• Reaction (mensaje)
• ReactionBatchCreatedEventData (mensaje)
• ReactionBatchDeletedEventData (mensaje)
• ReactionCreatedEventData (mensaje)
• ReactionDeletedEventData (mensaje)
• RichLinkMetadata (mensaje)
• RichLinkMetadata.RichLinkType (enumeración)
• SearchSpacesRequest (mensaje)
• SearchSpacesResponse (mensaje)
• SetUpSpaceRequest (mensaje)
• SlashCommand (mensaje)
• SlashCommandMetadata (mensaje)
• SlashCommandMetadata.Type (enumeración)
• Space (mensaje)
• Space.AccessSettings (mensaje)
• Space.AccessSettings.AccessState (enumeración)
• Space.MembershipCount (mensaje)
• Space.PermissionSetting (mensaje)
• Space.PermissionSettings (mensaje)
• Space.PredefinedPermissionSettings (enumeración)
• Space.SpaceDetails (mensaje)
• Space.SpaceThreadingState (enumeración)
• Space.SpaceType (enumeración)
• Space.Type (enumeración)
• SpaceBatchUpdatedEventData (mensaje)
• SpaceEvent (mensaje)
• SpaceNotificationSetting (mensaje)
• SpaceNotificationSetting.MuteSetting (enumeración)
• SpaceNotificationSetting.NotificationSetting (enumeración)
• SpaceReadState (mensaje)
• SpaceUpdatedEventData (mensaje)
• Thread (mensaje)
• ThreadReadState (mensaje)
• UpdateMembershipRequest (mensaje)
• UpdateMessageRequest (mensaje)
• UpdateSpaceNotificationSettingRequest (mensaje)
• UpdateSpaceReadStateRequest (mensaje)
• UpdateSpaceRequest (mensaje)
• User (mensaje)
• User.Type (enumeración)
• UserMentionMetadata (mensaje)
• UserMentionMetadata.Type (enumeración)
• WidgetMarkup (mensaje)
• WidgetMarkup.Button (mensaje)
• WidgetMarkup.FormAction (mensaje)
• WidgetMarkup.FormAction.ActionParameter (mensaje)
• WidgetMarkup.Icon (enumeración)
• WidgetMarkup.Image (mensaje)
• WidgetMarkup.ImageButton (mensaje)
• WidgetMarkup.KeyValue (mensaje)
• WidgetMarkup.OnClick (mensaje)
• WidgetMarkup.OpenLink (mensaje)
• WidgetMarkup.TextButton (mensaje)
• WidgetMarkup.TextParagraph (mensaje)

ChatService

Permite a los desarrolladores compilar apps e 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 del usuario y delegación para todo el dominio con el alcance de autorización: https://www.googleapis.com/auth/chat.import Para obtener más información, consulta Autoriza 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. Los emojis personalizados solo están disponibles para las cuentas de Google Workspace, y el administrador debe activarlos para la organización. Para obtener más información, consulta Más información sobre los emojis personalizados en Google Chat y Cómo administrar los permisos de los emojis personalizados. Requiere autenticación del usuario con el alcance de autorización: https://www.googleapis.com/auth/chat.customemojis 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 admite la creación de membresías para otras apps de Chat. Cuando creas una membresía, si el miembro especificado tiene desactivada la política de aceptación automática, se le envía una invitación y debe aceptarla para unirse al espacio. De lo contrario, crear una membresía agrega al miembro directamente al espacio especificado. Admite los siguientes tipos de autenticación: Autenticación de la app con aprobación del administrador y el alcance de autorización: https://www.googleapis.com/auth/chat.app.memberships Autenticación de usuarios con uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.app (para agregar la app de llamadas al espacio) https://www.googleapis.com/auth/chat.import (solo espacios de modo de importación) La autenticación de usuarios otorga privilegios de administrador cuando se autentica una cuenta de administrador, use_admin_access es true y se usa el siguiente alcance de autorización: https://www.googleapis.com/auth/chat.admin.memberships La autenticación de la app no es compatible con los siguientes casos de uso: Invitar a usuarios externos a la organización de Workspace propietaria del espacio Agregar un Grupo de Google a un espacio Agregar una app de Chat a un espacio Para ver un ejemplo de uso, consulta lo siguiente: Invita o agrega a un usuario a un espacio. Invita o agrega un Grupo de Google a un espacio. Agrega la app de Chat a un espacio. 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 Envía un mensaje. Admite los siguientes tipos de autenticación: Autenticación de la app con el alcance de autorización: https://www.googleapis.com/auth/chat.bot Autenticación de usuarios con uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.messages.create https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.import (solo espacios de modo de importación) Chat atribuye el remitente del mensaje de manera 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 la app. En Chat, la app de Chat aparece como remitente del mensaje. El contenido del mensaje puede incluir texto (text), tarjetas (cardsV2) y widgets de accesorios (accessoryWidgets). En la siguiente imagen, se muestra cómo Chat atribuye un mensaje cuando usas la autenticación de usuarios. Chat muestra al usuario como remitente del mensaje y atribuye la app de Chat al mensaje mostrando su nombre. El contenido del mensaje solo puede incluir texto (text). El tamaño máximo del mensaje, incluido su contenido, es de 32,000 bytes. En el caso de las solicitudes de webhook, la respuesta no contiene el mensaje completo. La respuesta solo completa los campos name y thread.name, además de la información que se encontraba en la solicitud. 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. Para ver un ejemplo, consulta Cómo agregar una reacción a un mensaje. Requiere autenticación del usuario con uno de los siguientes alcances de autorización: https://www.googleapis.com/auth/chat.messages.reactions.create https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.import (solo espacios de modo de importación) 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. 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. Admite los siguientes tipos de autenticación: Autenticación de la app con aprobación del administrador y uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.app.spaces.create https://www.googleapis.com/auth/chat.app.spaces Autenticación de usuarios con uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.spaces.create https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.import (solo espacios de modo de importación) Cuando se autentica como una app, se debe configurar el campo space.customer en la solicitud. Cuando se realiza la autenticación como una app, la app de Chat se agrega como miembro del espacio. Sin embargo, a diferencia de la autenticación humana, la app de Chat no se agrega como administrador del espacio. De forma predeterminada, todos los miembros del espacio pueden quitar la app de Chat del espacio. Para permitir que solo los administradores del espacio quiten la app de un espacio, establece space.permission_settings.manage_apps en managers_allowed. La membresía del espacio en el momento de la creación depende de si el espacio se creó en Import mode: Modo de importación: No se crean miembros. Todos los demás modos: El usuario que llama se agrega como miembro. Esto es: La app en sí cuando se usa la autenticación de la app Es el usuario humano cuando se usa la autenticación de usuarios. Si recibes el mensaje de error ALREADY_EXISTS cuando creas un espacio, prueba con otro displayName. Es posible que un espacio existente dentro de la organización de Google Workspace ya use este nombre visible. 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. De forma predeterminada, los usuarios solo pueden borrar los emojis personalizados que crearon. Los administradores de emojis asignados por el administrador pueden borrar cualquier emoji personalizado de la organización. Consulta Más información sobre los emojis personalizados en Google Chat. Los emojis personalizados solo están disponibles para las cuentas de Google Workspace, y el administrador debe activarlos para la organización. Para obtener más información, consulta Más información sobre los emojis personalizados en Google Chat y Cómo administrar los permisos de los emojis personalizados. Requiere autenticación del usuario con el alcance de autorización: https://www.googleapis.com/auth/chat.customemojis 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: Autenticación de la app con aprobación del administrador y el alcance de autorización: https://www.googleapis.com/auth/chat.app.memberships Autenticación de usuarios con uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.app (para quitar la app de llamadas del espacio) https://www.googleapis.com/auth/chat.import (solo espacios de modo de importación) La autenticación de usuarios otorga privilegios de administrador cuando se autentica una cuenta de administrador, use_admin_access es true y se usa el siguiente alcance de autorización: https://www.googleapis.com/auth/chat.admin.memberships La autenticación de la app no es compatible con los siguientes casos de uso: Se quita un grupo de Google de un espacio. Quitar una app de Chat de un espacio Para borrar membresías de administradores del espacio, el solicitante debe ser administrador del espacio. Si usas la autenticación de la app, la app de Chat debe ser la creadora del espacio. 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: Autenticación de la app con el alcance de autorización: https://www.googleapis.com/auth/chat.bot Autenticación de usuarios con uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.import (solo espacios de modo de importación) Cuando se usa la autenticación de la app, 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. Para ver un ejemplo, consulta Borra una reacción. Requiere autenticación del usuario con uno de los siguientes alcances de autorización: https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.import (solo espacios de modo de importación) 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 un borrado 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 Cómo borrar un espacio. Admite los siguientes tipos de autenticación: Autenticación de la app con aprobación del administrador y el alcance de autorización: https://www.googleapis.com/auth/chat.app.delete (solo en los espacios que creó la app) Autenticación de usuarios con uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.delete https://www.googleapis.com/auth/chat.import (solo espacios de modo de importación) La autenticación de usuarios otorga privilegios de administrador cuando se autentica una cuenta de administrador, use_admin_access es true y se usa el siguiente alcance de autorización: https://www.googleapis.com/auth/chat.admin.delete 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) Devuelve el mensaje directo existente con el usuario especificado. Si no se encuentra ningún espacio de mensaje directo, se devuelve un error 404 NOT_FOUND. Para ver un ejemplo, consulta Cómo encontrar un mensaje directo. Con la autenticación de la app, devuelve el espacio de mensajes directos entre el usuario especificado y la app de Chat que llama. Con la autenticación de usuarios, devuelve el espacio de mensajes directos entre el usuario especificado y el usuario autenticado. Admite los siguientes tipos de autenticación: Autenticación de la app con el alcance de autorización: https://www.googleapis.com/auth/chat.bot Autenticación de usuarios con uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.spaces 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 del mensaje. Los datos adjuntos se recuperan con la API de medios. Para ver un ejemplo, consulta Cómo obtener metadatos sobre un adjunto de mensaje. Requiere autenticación de la app con el alcance de autorización: https://www.googleapis.com/auth/chat.bot 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) Devuelve detalles sobre un emoji personalizado. Los emojis personalizados solo están disponibles para las cuentas de Google Workspace, y el administrador debe activarlos para la organización. Para obtener más información, consulta Más información sobre los emojis personalizados en Google Chat y Cómo administrar los permisos de los emojis personalizados. Requiere autenticación del usuario con uno de los siguientes alcances de autorización: https://www.googleapis.com/auth/chat.customemojis.readonly https://www.googleapis.com/auth/chat.customemojis 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) Devuelve detalles sobre una membresía. Para ver un ejemplo, consulta Cómo obtener detalles sobre la membresía de un usuario o una app de Google Chat. Admite los siguientes tipos de autenticación: Autenticación de la app con uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.app.memberships (requiere aprobación del administrador) Autenticación de usuarios con uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.memberships.readonly https://www.googleapis.com/auth/chat.memberships La autenticación de usuarios otorga privilegios de administrador cuando se autentica una cuenta de administrador, use_admin_access es true y se usa uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.admin.memberships.readonly https://www.googleapis.com/auth/chat.admin.memberships 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.app.memberships 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) Devuelve detalles sobre un mensaje. Para ver un ejemplo, consulta Cómo obtener detalles sobre un mensaje. Admite los siguientes tipos de autenticación: Autenticación de la app con el alcance de autorización: https://www.googleapis.com/auth/chat.bot Autenticación de usuarios con uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.messages Nota: Es posible que devuelva 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) Devuelve detalles sobre un espacio. Para ver un ejemplo, consulta Cómo obtener detalles sobre un espacio. Admite los siguientes tipos de autenticación: Autenticación de la app con uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.app.spaces con aprobación del administrador Autenticación de usuarios con uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.spaces La autenticación de usuarios otorga privilegios de administrador cuando se autentica una cuenta de administrador, use_admin_access es true y se usa uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.admin.spaces.readonly https://www.googleapis.com/auth/chat.admin.spaces La autenticación de la app tiene las siguientes limitaciones: space.access_settings solo se propaga cuando se usa el alcance chat.app.spaces. space.predefind_permission_settings y space.permission_settings solo se completan cuando se usa el alcance chat.app.spaces y solo para los espacios que creó la app. 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) Devuelve 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 devolverá el recurso Message actualizado en la carga útil del evento. Nota: El campo permissionSettings no se devuelve en el objeto Space de los datos del evento de Space para esta solicitud. Requiere autenticación del usuario con un alcance de autorización adecuado para leer los datos solicitados: https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.reactions.readonly https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.memberships.readonly https://www.googleapis.com/auth/chat.memberships Para obtener un evento, el usuario autenticado debe ser miembro del espacio. Para ver un ejemplo, consulta Cómo obtener detalles sobre un evento 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.

GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting) Obtiene la configuración de notificaciones del espacio. Para ver un ejemplo, consulta Cómo obtener la configuración de notificaciones del espacio de la persona que llama. Requiere autenticación del usuario con el alcance de autorización: https://www.googleapis.com/auth/chat.users.spacesettings 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 en un espacio, que se usa para identificar los mensajes leídos y no leídos. Para ver un ejemplo, consulta Cómo obtener detalles sobre el estado de lectura del espacio de un usuario. Requiere autenticación del usuario con uno de los siguientes alcances de autorización: https://www.googleapis.com/auth/chat.users.readstate.readonly https://www.googleapis.com/auth/chat.users.readstate 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) Devuelve detalles sobre el estado de lectura de un usuario dentro de un subproceso, 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 con uno de los siguientes alcances de autorización: https://www.googleapis.com/auth/chat.users.readstate.readonly https://www.googleapis.com/auth/chat.users.readstate 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) Enumera los emojis personalizados visibles para el usuario autenticado. Los emojis personalizados solo están disponibles para las cuentas de Google Workspace, y el administrador debe activarlos para la organización. Para obtener más información, consulta Más información sobre los emojis personalizados en Google Chat y Cómo administrar los permisos de los emojis personalizados. Requiere autenticación del usuario con uno de los siguientes alcances de autorización: https://www.googleapis.com/auth/chat.customemojis.readonly https://www.googleapis.com/auth/chat.customemojis 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) Enumera las membresías en un espacio. Para ver un ejemplo, consulta Cómo enumerar usuarios y apps de Google Chat en un espacio. En la lista de membresías con autenticación de la app, se incluyen las membresías en los espacios a los que tiene acceso la app de Chat, pero se excluyen las membresías de la app de Chat, incluida la suya. La opción User authentication de la lista de membresías muestra las membresías en los espacios a los que tiene acceso el usuario autenticado. Admite los siguientes tipos de autenticación: Autenticación de la app con uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.app.memberships (requiere aprobación del administrador) Autenticación de usuarios con uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.memberships.readonly https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.import (solo espacios de modo de importación) La autenticación de usuarios otorga privilegios de administrador cuando se autentica una cuenta de administrador, use_admin_access es true y se usa uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.admin.memberships.readonly https://www.googleapis.com/auth/chat.admin.memberships 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.app.memberships https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.import 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) Enumera los mensajes en un espacio del que el llamador es miembro, incluidos los mensajes de miembros y espacios bloqueados. Si enumeras los mensajes de un espacio que no tiene 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 enumerar mensajes. Requiere autenticación del usuario con uno de los siguientes alcances de autorización: https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.import (solo espacios de modo de importación) 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) Enumera las reacciones a un mensaje. Para ver un ejemplo, consulta Cómo enumerar las reacciones a un mensaje. Requiere autenticación del usuario con uno de los siguientes alcances de autorización: https://www.googleapis.com/auth/chat.messages.reactions.readonly https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.messages 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) Enumera los eventos de un espacio de Google Chat. Para cada evento, la carga útil contiene la versión más reciente del recurso Chat. Por ejemplo, si enumeras eventos sobre miembros nuevos del espacio, el servidor devuelve recursos Membership que contienen los detalles de membresía más recientes. Si se quitaron miembros nuevos durante el período solicitado, la carga útil del evento contendrá un recurso Membership vacío. Requiere autenticación del usuario con un alcance de autorización adecuado para leer los datos solicitados: https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.reactions.readonly https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.memberships.readonly https://www.googleapis.com/auth/chat.memberships Para enumerar eventos, el usuario autenticado debe ser miembro del espacio. Para ver un ejemplo, consulta Cómo enumerar 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) Enumera los espacios de los que el llamador es miembro. Los chats en grupo y los MD no aparecen en la lista hasta que se envía el primer mensaje. Para ver un ejemplo, consulta Cómo enumerar espacios. Admite los siguientes tipos de autenticación: Autenticación de la app con el alcance de autorización: https://www.googleapis.com/auth/chat.bot Autenticación de usuarios con uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.spaces Para enumerar todos los espacios con nombre por organización de Google Workspace, usa el método spaces.search() con 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 de usuario con privilegios de administrador y uno de los siguientes alcances de autorización: https://www.googleapis.com/auth/chat.admin.spaces.readonly https://www.googleapis.com/auth/chat.admin.spaces 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 llama se agrega automáticamente al espacio y no debe especificarse como miembro en la solicitud. Para ver un ejemplo, consulta Cómo configurar 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}, 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 People o el id del usuario en la API de Directory. Por ejemplo, si el ID del perfil de persona de la API de People para [e-mail] es 123456789, puedes agregar el usuario al espacio configurando membership.member.name como users/[e-mail] 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 Cloud Identity Groups para recuperar el ID 123456789 del correo electrónico del grupo [e-mail] y, luego, agregar el grupo al espacio configurando membership.group_member.name como groups/123456789. No se admiten los correos electrónicos grupales, y los grupos de Google solo se pueden agregar como miembros en espacios con nombre. En el caso de un espacio con nombre o un chat en grupo, si el llamador bloquea a algunos miembros o es bloqueado por ellos, o no tiene permiso para agregar a algunos miembros, esos miembros no se agregarán al espacio creado. Para crear un mensaje directo (MD) entre el usuario que llama y otro usuario humano, especifica exactamente una membresía para representar al usuario humano. Si uno de los usuarios bloquea al otro, la solicitud falla y no se crea el MD. Para crear un MD entre el usuario que llama y la app que llama, 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 de 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, se devolverá el MD existente, incluso si uno de los usuarios bloquea al otro en el momento en que se realiza la solicitud. No se admiten los espacios con respuestas en hilos. Si recibes el mensaje de error ALREADY_EXISTS cuando configuras un espacio, prueba con otro displayName. Es posible que un espacio existente dentro de la organización de Google Workspace ya use este nombre visible. Requiere autenticación del usuario con uno de los siguientes alcances de autorización: https://www.googleapis.com/auth/chat.spaces.create https://www.googleapis.com/auth/chat.spaces 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: Autenticación de la app con aprobación del administrador y el alcance de autorización: https://www.googleapis.com/auth/chat.app.memberships (solo en los espacios que creó la app) Autenticación de usuarios con uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.import (solo espacios de modo de importación) La autenticación de usuarios otorga privilegios de administrador cuando se autentica una cuenta de administrador, use_admin_access es true y se usa el siguiente alcance de autorización: https://www.googleapis.com/auth/chat.admin.memberships 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: Autenticación de la app con el alcance de autorización: https://www.googleapis.com/auth/chat.bot Autenticación de usuarios con uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.import (solo espacios de modo de importación) Cuando se usa la autenticación de la app, 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 Actualiza un espacio. Si actualizas el campo displayName y recibes el mensaje de error ALREADY_EXISTS, prueba con otro nombre visible. 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: Autenticación de la app con aprobación del administrador y uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.app.spaces Autenticación de usuarios con uno de los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.import (solo espacios de modo de importación) La autenticación de usuarios otorga privilegios de administrador cuando se autentica una cuenta de administrador, use_admin_access es true y se usan los siguientes permisos de autorización: https://www.googleapis.com/auth/chat.admin.spaces La autenticación de la app tiene las siguientes limitaciones: Para actualizar space.predefined_permission_settings o space.permission_settings, la app debe ser la creadora del espacio. No se admite la actualización de space.access_settings.audience para la autenticación de apps. 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 de notificaciones del espacio. Para ver un ejemplo, consulta Cómo actualizar la configuración de notificaciones del espacio de la persona que llama. Requiere autenticación del usuario con el alcance de autorización: https://www.googleapis.com/auth/chat.users.spacesettings 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 en un espacio, que se usa para identificar los mensajes leídos y no leídos. Para ver un ejemplo, consulta Actualiza el estado de lectura del espacio de un usuario. Requiere autenticación del usuario con el alcance de autorización: https://www.googleapis.com/auth/chat.users.readstate 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 Es una lista de botones.

ActionResponse

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

Campos
type	ResponseType Solo entrada. Es el tipo de respuesta de la app de Chat.
url	string Solo entrada. Es la URL para que los usuarios se autentiquen o realicen la configuración. (Solo para los 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 estar acompañado de ResponseType.Dialog.
updated_widget	UpdatedWidget Solo entrada. Es la respuesta del widget actualizado.

ResponseType

Es el tipo de respuesta de la app de Chat.

Enumeraciones
TYPE_UNSPECIFIED	Es el tipo predeterminado que se controla como NEW_MESSAGE.
NEW_MESSAGE	Publicar como un mensaje nuevo en el tema
UPDATE_MESSAGE	Actualiza el mensaje de la app de Chat. Esto solo se permite en un evento CARD_CLICKED en el que el tipo de remitente del mensaje es BOT.
UPDATE_USER_MESSAGE_CARDS	Actualiza las tarjetas en el mensaje de un usuario. Esto solo se permite como respuesta a un evento MESSAGE con una URL coincidente o a un evento CARD_CLICKED en el que el tipo de remitente del mensaje sea HUMAN. Se ignora el texto.
REQUEST_CONFIG	Solicitar de forma privada al usuario autenticación o configuración adicionales
DIALOG	Presenta un diálogo.
UPDATE_WIDGET	Es una consulta de opciones de autocompletado de texto del widget.

SelectionItems

Es la lista de resultados de autocompletar del widget.

Campos
items[]	SelectionItem Es un array de objetos SelectionItem.

UpdatedWidget

En el caso de los widgets selectionInput, devuelve sugerencias de autocompletado para un menú de selección múltiple.

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. Es el widget que 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 de autocompletar del widget

ActionStatus

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

Campos
status_code	Code Es el código de estado.
user_facing_message	string Es el mensaje que se les enviará a los usuarios sobre el estado de su solicitud. Si no se configura, se envía un mensaje genérico basado en status_code.

Anotación

Las anotaciones se pueden asociar con el cuerpo de texto sin formato del mensaje o con chips que vinculan a recursos de Google Workspace, como Documentos o Hojas de cálculo de Google, con start_index y length de 0. Para agregar formato básico a un mensaje de texto, consulta Cómo dar formato a los mensajes de texto.

Ejemplo de cuerpo del mensaje de texto sin formato:

Hello @FooBot how are you!"

Los metadatos de anotaciones correspondientes:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]

Campos
type	AnnotationType Es el tipo de esta anotación.
length	int32 Longitud de la subcadena en el cuerpo del mensaje de texto sin formato al que corresponde esta anotación. Si no está presente, indica una longitud de 0.
start_index	int32 Índice de inicio (basado 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 del usuario.
slash_command	SlashCommandMetadata Son los metadatos de un comando de barra.
rich_link_metadata	RichLinkMetadata Son los metadatos de un vínculo enriquecido.
custom_emoji_metadata	CustomEmojiMetadata Son los metadatos de un emoji personalizado.

AnnotationType

Es el tipo de anotación.

Enumeraciones
ANNOTATION_TYPE_UNSPECIFIED	Es el valor predeterminado para la enumeración. No lo uses.
USER_MENTION	Se menciona a un usuario.
SLASH_COMMAND	Se invoca un comando de barra.
RICH_LINK	Es una anotación de vínculo enriquecido.
CUSTOM_EMOJI	Es una anotación de emoji personalizado.

AppCommandMetadata

Son metadatos sobre un comando de la app de Chat.

Campos
app_command_id	int32 Es el ID del comando especificado en la configuración de la API de Chat.
app_command_type	AppCommandType Es el tipo de comando de la app de Chat.

AppCommandType

Es el tipo de comando de la app de Chat. Para obtener más información, consulta Tipos de comandos de apps de Chat.

Enumeraciones
APP_COMMAND_TYPE_UNSPECIFIED	Valor predeterminado Sin especificar.
SLASH_COMMAND	Un comando de barra El usuario envía el comando en un mensaje de Chat.
QUICK_COMMAND	Un comando rápido El usuario selecciona el comando en el menú de Chat del área de respuesta del mensaje.

AttachedGif

Imagen GIF especificada por una URL.

Campos
uri	string Solo salida. Es la URL que aloja la imagen GIF.

Archivo adjunto

Es un archivo adjunto en Google Chat.

Campos
name	string Opcional. Nombre del recurso del adjunto, con el formato spaces/{space}/messages/{message}/attachments/{attachment}.
content_name	string Solo salida. Nombre de archivo original del contenido, no la ruta completa.
content_type	string Solo salida. Tipo de contenido (tipo de MIME) del archivo.
thumbnail_uri	string Solo salida. Es la URL de la miniatura que se debe usar para mostrar una vista previa del adjunto a un usuario humano. Las apps de chat no deben usar esta URL para descargar contenido de archivos adjuntos.
download_uri	string Solo salida. Es la URL de descarga que se debe usar para permitir que un usuario humano descargue el adjunto. Las apps de chat no deben usar esta URL para descargar contenido de archivos adjuntos.
source	Source Solo salida. Es la fuente del adjunto.
Campo de unión data_ref. Es la referencia de datos del 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 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 adjuntos. Este campo se usa con la API de medios para descargar los datos adjuntos.
attachment_upload_token	string Opcional. Es un token opaco que contiene una referencia a un adjunto subido. Los clientes lo tratan como una cadena opaca y se usa para crear o actualizar mensajes de Chat con archivos adjuntos.

CalendarEventLinkData

Son los datos de los vínculos a eventos de calendario.

Campos
calendar_id	string Es el identificador del calendario del calendario vinculado.
event_id	string Es el identificador del evento del evento de Calendario vinculado.

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 usuario, el mensaje no puede contener tarjetas.

Diseña y obtén una vista previa de las tarjetas con Card Builder.

Abrir el Creador de tarjetas

Campos
card_id	string Se requiere 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

Son los datos de los vínculos a 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 del espacio de Chat vinculado. Formato: spaces/{space}/messages/{message}

CompleteImportSpaceRequest

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

Campos
name	string Es obligatorio. Nombre del recurso del espacio del modo de importación. Formato: spaces/{space}

CompleteImportSpaceResponse

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

Campos
space	Space Es el espacio del modo de importación.

ContextualAddOnMarkup

Este tipo no tiene campos.

Es el lenguaje de marcado que los desarrolladores pueden usar para especificar 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 una línea divisoria.
card_actions[]	CardAction Son las acciones de esta tarjeta.
name	string Nombre de la tarjeta.

CardAction

Una acción de tarjeta es la acción asociada a 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.

No es compatible con las apps de Google Chat.

Campos
action_label	string Es la etiqueta que se usaba para mostrar el elemento del menú de acciones.
on_click	OnClick Es la acción onclick para 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 Tipo de la 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, float).

Campos
header	string Es el encabezado de la sección. Se admite el texto con formato. Para obtener más información sobre el formato de 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 Es obligatorio. Es el emoji personalizado que se creará.

CreateMembershipRequest

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

Campos
parent	string Es obligatorio. Es el nombre del recurso del espacio para el que se creará la membresía. Formato: spaces/{space}
membership	Membership Es obligatorio. Es la relación de membresía que se creará. El campo memberType debe contener un usuario con los campos user.name y user.type completados. El servidor asignará un nombre de recurso y sobrescribirá todo lo que se haya especificado. 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 autentiques como usuario, se requiere el permiso de autorización chat.memberships. Cuando se autentica como una app, se requiere el alcance de autorización chat.app.memberships. Establece user.type en HUMAN y user.name con el formato 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 del perfil de persona de la API de People para [e-mail] es 123456789, puedes agregar el usuario al espacio configurando membership.member.name como users/[e-mail] o users/123456789. Para invitar a usuarios externos a la organización de Workspace propietaria del espacio, se requiere autenticación de usuarios. Cuando una app de Chat crea una relación de membresía para sí misma, debe autenticarse como usuario y usar el alcance 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 llama debe ser administrador de Google Workspace y tener 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 ajenos a la organización de Google Workspace del administrador con acceso de administrador.

CreateMessageRequest

Crea un mensaje.

Campos
parent	string Es obligatorio. Es el nombre del recurso del espacio en el que se creará un mensaje. Formato: spaces/{space}
message	Message Es obligatorio. Cuerpo del mensaje.
thread_key (deprecated)	string Este elemento es obsoleto. Opcional. Obsoleto: Usa thread.thread_key en su lugar. ID del subproceso. Admite hasta 4,000 caracteres. Para iniciar o agregar contenido a una conversación, crea un mensaje y especifica un threadKey o el thread.name. Para ver un ejemplo de uso, consulta Cómo iniciar o responder un hilo de mensajes.
request_id	string Opcional. Es un ID de solicitud único para este mensaje. Si se especifica un ID de solicitud existente, se devuelve 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 a una. Solo se admite en espacios con nombre. Cuando se responde 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 hilo nuevo.
message_id	string Opcional. Es 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 nombrar 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 un hilo nuevo. 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 respuesta al hilo especificado por thread ID o thread_key. Si falla, el mensaje inicia un nuevo hilo.
REPLY_MESSAGE_OR_FAIL	Crea el mensaje como respuesta al hilo especificado por thread ID o thread_key. Si se usa un thread_key nuevo, se crea un hilo nuevo. Si falla la creación del mensaje, se devuelve un error NOT_FOUND.

CreateReactionRequest

Crea una reacción a un mensaje.

Campos
parent	string Es obligatorio. Es el mensaje en el que se crea la reacción. Formato: spaces/{space}/messages/{message}
reaction	Reaction Es obligatorio. Es la reacción que se creará.

CreateSpaceRequest

Es una solicitud para crear un espacio con nombre sin miembros.

Campos
space	Space Es obligatorio. Se deben completar 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 se especifica un ID de solicitud existente, se devuelve el espacio creado con ese ID en lugar de crear uno nuevo. Si se especifica un ID de solicitud existente de la misma app de Chat con un usuario autenticado diferente, se devuelve un error.

CustomEmoji

Representa un emoji personalizado.

Campos
name	string Identificador. Es el nombre del recurso del emoji personalizado, asignado por el servidor. Formato: customEmojis/{customEmoji}
uid	string Solo salida. Es la clave única del recurso de emoji personalizado.
emoji_name	string Opcional. Inmutable. Nombre proporcionado por el usuario para el emoji personalizado, que es único dentro de la organización. Se requiere cuando se crea el emoji personalizado. De lo contrario, es solo salida. Los nombres de los emojis deben comenzar y terminar con dos puntos, deben estar en minúsculas y solo pueden contener 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. Es una URL de imagen temporal para el emoji personalizado, válida durante al menos 10 minutos. Ten en cuenta que este campo no se completa en la respuesta cuando se crea el emoji personalizado.
payload	CustomEmojiPayload Opcional. Solo entrada. Son los datos de carga útil. Se requiere cuando se crea el emoji personalizado.

CustomEmojiPayload

Son los datos de carga útil del emoji personalizado.

Campos
file_content	bytes Es 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 cuadrada y de entre 64 y 500 píxeles. Las restricciones están sujetas a cambios.
filename	string Es obligatorio. Solo entrada. Nombre del archivo de imagen. Extensiones de archivos compatibles: .png, .jpg, .gif.

CustomEmojiMetadata

Son los metadatos de anotación para emojis personalizados.

Campos
custom_emoji	CustomEmoji Es el emoji personalizado.

DeleteCustomEmojiRequest

Es una solicitud para borrar un emoji personalizado.

Campos
name	string Es 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:, donde :example-emoji: es el nombre de un emoji personalizado.

DeleteMembershipRequest

Solicitud para borrar una membresía en un espacio.

Campos
name	string Es 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 suyas propias. Las apps de chat no pueden borrar las membresías de otras apps. Cuando se borra una membresía humana, se requiere el alcance chat.memberships con autenticación del usuario o el alcance chat.memberships.app con autenticación de la app y el formato spaces/{space}/members/{member}. Puedes usar el correo electrónico como alias para {member}. Por ejemplo, spaces/{space}/members/[e-mail], donde [e-mail] 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 llama debe ser administrador de Google Workspace y tener 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 el borrado de membresías de apps en un espacio con acceso de administrador.

DeleteMessageRequest

Es la solicitud para borrar un mensaje.

Campos
name	string Es 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 nombrar un mensaje.
force	bool Opcional. Cuando true, borrar un mensaje también borra sus respuestas en subprocesos. Cuando es false, si un mensaje tiene respuestas en subprocesos, 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 Es obligatorio. Es el nombre de la reacción que se borrará. Formato: spaces/{space}/messages/{message}/reactions/{reaction}

DeleteSpaceRequest

Es la solicitud para borrar un espacio.

Campos
name	string Es 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 llama debe ser administrador de Google Workspace y tener el privilegio para administrar el chat y las conversaciones de los espacios. Requiere el permiso de OAuth 2.0 chat.admin.delete.

DeletionMetadata

Es información sobre un mensaje borrado. Se borra un mensaje cuando se establece 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. Consulta Edita o borra un mensaje en Google Chat para obtener detalles sobre cuándo se pueden borrar los mensajes.

Enumeraciones
DELETION_TYPE_UNSPECIFIED	Este valor no se usa.
CREATOR	El usuario borró su propio mensaje.
SPACE_OWNER	Un administrador del espacio borró el mensaje.
ADMIN	Un administrador de Google Workspace borró el mensaje. Los administradores pueden borrar cualquier mensaje del espacio, incluidos los que envíen los miembros del espacio o la app de Chat.
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 creador (con autenticación del usuario).
SPACE_OWNER_VIA_APP	Una app de Chat borró el mensaje en nombre de un administrador del espacio (con autenticación del usuario).
SPACE_MEMBER	Un miembro del espacio borró el mensaje. Los usuarios pueden borrar los mensajes que envían las apps.

Diálogo

Es un 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, 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 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 ID del archivo de Drive. Se usa con la API de Drive.

DriveLinkData

Son los datos de los vínculos de Google Drive.

Campos
drive_data_ref	DriveDataRef Un objeto DriveDataRef que hace referencia a un archivo de Google Drive.
mime_type	string Es el tipo de MIME del recurso de Google Drive vinculado.

Emoji

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

Campos
Campo de unión content. Es obligatorio. Es el contenido del emoji. Las direcciones (content) solo pueden ser una de las siguientes opciones:
unicode	string Opcional. Es un emoji básico representado por una cadena Unicode.
custom_emoji	CustomEmoji Un emoji personalizado.

EmojiReactionSummary

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

Campos
emoji	Emoji Solo salida. Es el emoji asociado a las reacciones.
reaction_count	int32 Solo salida. Es la cantidad total de reacciones con el emoji asociado.

FindDirectMessageRequest

Es una solicitud para obtener un espacio de mensajes directos basado en el recurso del usuario.

Campos

name

string Es obligatorio. Es el nombre del recurso del usuario con el que se busca un 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 autenticas como usuario, puedes usar el correo electrónico como alias para {user}. Por ejemplo, users/[e-mail], donde [e-mail] es el correo electrónico del usuario de Google Chat.

GetAttachmentRequest

Es una solicitud para obtener un archivo adjunto.

Campos
name	string Es obligatorio. Nombre del recurso del adjunto, con el formato spaces/{space}/messages/{message}/attachments/{attachment}.

GetCustomEmojiRequest

Es una solicitud para devolver un solo emoji personalizado.

Campos
name	string Es 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:, donde :example-emoji: es el nombre de un emoji personalizado.

GetMembershipRequest

Solicitud para obtener la membresía de un espacio.

Campos
name	string Es obligatorio. Nombre del recurso de la membresía que se recuperará. Para obtener la membresía propia de la app con 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/[e-mail], donde [e-mail] 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 llama debe ser administrador de Google Workspace y tener 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 admite la obtención de membresías de apps en un espacio cuando se usa el acceso de administrador.

GetMessageRequest

Es una solicitud para obtener un mensaje.

Campos
name	string Es 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 nombrar un mensaje.

GetSpaceEventRequest

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

Campos
name	string Es 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 del espacio. Solo admite la obtención de la configuración de notificaciones para el usuario que llama.

Campos
name	string Es obligatorio. Formato: users/{user}/spaces/{space}/spaceNotificationSetting users/me/spaces/{space}/spaceNotificationSetting O users/[e-mail]/spaces/{space}/spaceNotificationSetting O users/123456789/spaces/{space}/spaceNotificationSetting. Nota: Solo se permite el ID de usuario o el correo electrónico de la persona que llama en la ruta.

GetSpaceReadStateRequest

Es el mensaje de solicitud para la API de GetSpaceReadState.

Campos

name

string Es obligatorio. Nombre del recurso del estado de lectura del espacio que se recuperará. Solo admite la obtención del estado de lectura para el usuario que llama. Para hacer referencia al usuario que llama, configura uno de los siguientes parámetros: Es el alias de me. Por ejemplo, users/me/spaces/{space}/spaceReadState Su dirección de correo electrónico de Workspace Por ejemplo, users/[e-mail]/spaces/{space}/spaceReadState. Su ID de usuario. Por ejemplo, users/123456789/spaces/{space}/spaceReadState. Formato: users/{user}/spaces/{space}/spaceReadState

GetSpaceRequest

Es una solicitud para devolver un solo espacio.

Campos
name	string Es obligatorio. 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 llama debe ser administrador de Google Workspace y tener 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

Es el mensaje de solicitud para la API de GetThreadReadStateRequest.

Campos

name

string Es obligatorio. Nombre del recurso del estado de lectura del subproceso que se recuperará. Solo admite la obtención del estado de lectura para el usuario que llama. Para hacer referencia al usuario que llama, configura uno de los siguientes parámetros: Es el alias de me. Por ejemplo, users/me/spaces/{space}/threads/{thread}/threadReadState Su dirección de correo electrónico de Workspace Por ejemplo, users/[e-mail]/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 del recurso de un Grupo de Google. Representa un grupo en la API de Cloud Identity Groups. Formato: groups/{group}

HistoryState

Es el estado del historial de mensajes y espacios. Especifica cuánto tiempo se conservan los mensajes y los hilos de conversación 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	El historial está 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

Es una solicitud para devolver una lista de emojis personalizados.

Campos
page_size	int32 Opcional. Es la cantidad máxima de emojis personalizados que se devuelven. El servicio puede devolver 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 búsqueda anterior). Es un token de página que se recibió de una llamada anterior a la lista de emojis personalizados. 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. Si pasas un valor diferente, es posible que se generen resultados inesperados.
filter	string Opcional. Es un filtro de búsqueda. 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 los creó el usuario que llama o no. Por ejemplo, la siguiente consulta devuelve los emojis personalizados creados por el llamador: creator("users/me") Las consultas no válidas se rechazan con un error INVALID_ARGUMENT.

ListCustomEmojisResponse

Es una respuesta para enumerar emojis personalizados.

Campos
custom_emojis[]	CustomEmoji Lista sin ordenar. Es la lista de emojis personalizados.
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 siguientes.

ListMembershipsRequest

Es el mensaje de solicitud para enumerar membresías.

Campos
parent	string Es obligatorio. Es el nombre del recurso del espacio para el que se recuperará una lista de miembros. Formato: spaces/{space}
page_size	int32 Opcional. Es la cantidad máxima de membresías que se devolverán. El servicio puede devolver menos que 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, 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 que se recibió de 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. Si pasas valores diferentes a los otros parámetros, es posible que obtengas resultados inesperados.
filter	string Opcional. Es un filtro de búsqueda. Puedes filtrar las membresías por el rol (role) y el tipo (member.type) de un miembro. Para filtrar por rol, configura role como ROLE_MEMBER o ROLE_MANAGER. Para filtrar por tipo, establece member.type en HUMAN o BOT. También puedes filtrar por 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 otros 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 devuelve las membresías asociadas a un Google Group, además de otros tipos de membresías. Si se establece un filter, no se devuelven las membresías de Google Group que no coinciden con los criterios del filtro.
show_invited	bool Opcional. Cuando es true, también devuelve las membresías asociadas a los miembros de invited, además de otros tipos de membresías. Si se establece un filtro, no se devuelven 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 llama debe ser administrador de Google Workspace y tener el privilegio para administrar el chat y las conversaciones de los espacios. Requiere el permiso de OAuth 2.0 chat.admin.memberships.readonly o chat.admin.memberships. No se admite la inclusión de membresías de apps en un espacio cuando se usa el acceso de administrador.

ListMembershipsResponse

Es la respuesta a la lista de membresías del espacio.

Campos
memberships[]	Membership Lista sin ordenar. Es la lista de membresías en la página solicitada (o en la 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 siguientes.

ListMessagesRequest

Enumera los mensajes del espacio especificado del que el usuario es miembro.

Campos
parent	string Es obligatorio. Es el nombre del recurso del espacio del que se enumerará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 devolverán, como máximo, 25. El valor máximo es 1,000. Si usas un valor superior a 1,000, 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 que se recibió de una llamada a list messages 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. Si pasas valores diferentes a los otros parámetros, es posible que obtengas resultados inesperados.
filter	string Opcional. Es un filtro de búsqueda. Puedes filtrar los mensajes por fecha (create_time) y conversación (thread.name). Para filtrar mensajes por la fecha en que se crearon, especifica 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 un thread.name por búsqueda. Para filtrar por subproceso 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. Es el orden en que se muestra la lista de mensajes. Especifica un valor para ordenar por una operación de ordenamiento. Los valores válidos de la operación de ordenamiento son los siguientes: ASC para ascendente. DESC para ordenar de forma descendente. El orden predeterminado es create_time ASC.
show_deleted	bool Opcional. Indica si se deben incluir los mensajes borrados. Los mensajes borrados incluyen la hora de eliminación y los metadatos sobre su eliminación, pero el contenido del mensaje no está disponible.

ListMessagesResponse

Es el 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 siguientes.

ListReactionsRequest

Enumera las reacciones a un mensaje.

Campos
parent	string Es obligatorio. Es 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 devolver 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 búsqueda anterior). Es un token de página que se recibió 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. Si pasas un valor diferente, es posible que se generen resultados inesperados.
filter	string Opcional. Es un filtro de búsqueda. Puedes filtrar las reacciones por emoji (emoji.unicode o emoji.custom_emoji.uid) y usuario (user.name). Para filtrar las 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 las reacciones por emoji y usuario, usa el operador AND, como emoji.unicode = "🙂" AND user.name = "users/AAAAAA". Si tu búsqueda 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}" Las consultas no válidas se rechazan con un error INVALID_ARGUMENT.

ListReactionsResponse

Es la respuesta a una solicitud de reacciones de lista.

Campos
reactions[]	Reaction Es la lista de reacciones en la página solicitada (o en la primera).
next_page_token	string Es el token de continuación para recuperar la siguiente página de resultados. Está vacío para la última página de resultados.

ListSpaceEventsRequest

Es el mensaje de solicitud para enumerar eventos de espacio.

Campos
parent	string Es obligatorio. Es el nombre del recurso del espacio de Google Chat en el que se produjeron los eventos. Formato: spaces/{space}.
page_size	int32 Opcional. Es la cantidad máxima de eventos de espacio que se devuelven. El servicio puede devolver menos que 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 list space events anterior. Proporciona esto para recuperar la página siguiente. Cuando se realiza la paginación, todos los demás parámetros proporcionados a list space events deben guardar correspondencia con la llamada que proporcionó el token de la página. Si pasas valores diferentes a los otros parámetros, es posible que obtengas resultados inesperados.
filter	string Es obligatorio. Es un filtro de búsqueda. Debes especificar al menos un tipo de evento (event_type) con el operador has :. Para filtrar por varios tipos de eventos, usa el operador OR. Omite los tipos de eventos por lotes en tu filtro. La solicitud devuelve automáticamente cualquier evento de lote relacionado. Por ejemplo, si filtras por reacciones nuevas (google.workspace.chat.reaction.v1.created), el servidor también devuelve 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 la marca de tiempo exclusiva a partir de la cual se comenzará a enumerar los eventos de espacio. Puedes enumerar los eventos que ocurrieron hasta hace 28 días. 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 que se enumeran los eventos de espacio. 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

Es el mensaje de respuesta para enumerar los eventos del 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 devuelve en el objeto Space para las solicitudes de lista.
next_page_token	string Es el token de continuación 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 el llamador es miembro.

Campos
page_size	int32 Opcional. Es la cantidad máxima de espacios que se devolverán. El servicio puede devolver menos que este valor. Si no se especifica, se devolverán, como máximo, 100 espacios. El valor máximo es 1,000. Si usas un valor superior a 1,000, 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. Si pasas un valor diferente, es posible que se generen resultados inesperados.
filter	string Opcional. Es un filtro de búsqueda. Puedes filtrar los espacios por tipo (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 espacio, 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 a una solicitud de lista de espacios.

Campos
spaces[]	Space Es la lista de espacios en la página solicitada (o en la primera). Nota: El campo permissionSettings no se devuelve 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 siguientes.

MatchedUrl

Es 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 Vistas previas de vínculos.

Campos
url	string Solo salida. Es la URL que coincidió.

MeetSpaceLinkData

Son los datos de los vínculos de espacios de Meet.

Campos
meeting_code	string Es el código de la reunión del espacio de Meet vinculado.
type	Type Indica el tipo de espacio de Meet.
huddle_status	HuddleStatus Opcional. Solo salida. Si la reunión de Meet es una reunión improvisada, indica el estado de la reunión. De lo contrario, no se establece.

HuddleStatus

El estado de la reunión

Enumeraciones
HUDDLE_STATUS_UNSPECIFIED	Es el valor predeterminado para la enumeración. No lo uses.
STARTED	Comenzó el huddle.
ENDED	Finalizó el huddle. En este caso, el URI y los identificadores del espacio de Meet ya no serán válidos.
MISSED	Se perdió la llamada de Huddle. En este caso, el URI y los identificadores del espacio de Meet ya no serán válidos.

Tipo

Es el tipo de espacio de Meet.

Enumeraciones
TYPE_UNSPECIFIED	Es el valor predeterminado para la enumeración. No lo uses.
MEETING	El espacio de Meet es una reunión.
HUDDLE	El espacio de Meet es una reunión.

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, forma parte de él o no está presente en él.

Campos
name	string Identificador. Es el nombre del recurso de la membresía, asignado por el servidor. Formato: spaces/{space}/members/{member}
state	MembershipState Solo salida. Estado de la membresía.
role	MembershipRole Opcional. Es el rol del usuario en 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. Es la fecha y hora de creación de la membresía, por ejemplo, cuando un miembro se unió o recibió una invitación para unirse a un espacio. Este campo es de solo salida, excepto cuando se usa para importar membresías históricas en espacios en modo de importación.
delete_time	Timestamp Opcional. Inmutable. Es la fecha y hora de eliminación de la membresía, por ejemplo, cuando un miembro abandonó un espacio o se lo quitó de él. Este campo es de solo salida, excepto cuando se usa para importar membresías históricas en espacios en modo de importación.
Campo de unión memberType. Es el miembro asociado a 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. Es el usuario o la app de Google Chat a los que corresponde la membresía. Si tu app de Chat se autentica como usuario, el resultado completará los objetos user name y type.
group_member	Group Opcional. Es el grupo de Google al que corresponde la membresía. Para leer o mutar membresías de Grupos de Google, se requiere 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	Es 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 los 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 no lo hizo.
NOT_A_MEMBER	El usuario no pertenece al espacio y no tiene una invitación pendiente para unirse a él.

MembershipBatchCreatedEventData

Es la carga útil del evento para varias membresías nuevas.

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

Campos
memberships[]	MembershipCreatedEventData Es una lista de membresías nuevas.

MembershipBatchDeletedEventData

Es la carga útil del evento para varias membresías borradas.

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

Campos
memberships[]	MembershipDeletedEventData Es una lista de membresías borradas.

MembershipBatchUpdatedEventData

Es la 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

Es la carga útil del evento para una membresía nueva.

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

Campos
membership	Membership La nueva membresía

MembershipDeletedEventData

Es la carga útil del evento para una membresía borrada.

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

Campos
membership	Membership Es la membresía borrada. Solo se propagan los campos name y state.

MembershipUpdatedEventData

Es la carga útil del evento para una membresía actualizada.

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

Campos
membership	Membership Es la membresía actualizada.

Mensaje

Es un mensaje en un espacio de Google Chat.

Campos
name	string Identificador. Es el nombre del recurso del mensaje. Formato: spaces/{space}/messages/{message} Aquí, {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 estableces un ID personalizado cuando creas un mensaje, puedes usarlo para especificar el mensaje en una solicitud reemplazando {message} por el valor del campo clientAssignedMessageId. Por ejemplo, spaces/AAAAAAAAAAA/messages/client-custom-name. Para obtener más información, consulta Cómo nombrar un mensaje.
sender	User Solo salida. Es el usuario que creó el mensaje. Si tu app de Chat se autentica como usuario, el resultado completará los objetos user name y type.
create_time	Timestamp Opcional. Inmutable. Para los espacios creados en Chat, es la fecha y hora en que se creó el mensaje. Este campo es solo de salida, excepto cuando se usa en espacios en modo de importación. En el caso de los espacios en modo de importación, establece este campo en la marca de tiempo histórica en la que se creó el mensaje en la fuente para conservar la hora de creación original.
last_update_time	Timestamp Solo salida. Fecha y 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. Fecha y hora en que se borró el mensaje en Google Chat. Si el mensaje nunca se borra, este campo estará vacío.
text	string Opcional. 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 Envía 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 negrita, cursiva, tachado, monoespacio, bloque monoespacio 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 Este elemento es obsoleto. Obsoleto: Usa cards_v2 en su lugar. 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. Las tarjetas suelen mostrarse 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. Es un array de tarjetas. Solo las apps de Chat pueden crear tarjetas. Si tu app de Chat se autentica como usuario, los mensajes no pueden contener tarjetas. Para obtener información sobre cómo crear un mensaje que contenga tarjetas, consulta Envía un mensaje. Diseña y obtén una vista previa de las tarjetas con Card Builder. Abrir el Creador de tarjetas
annotations[]	Annotation Solo salida. Las anotaciones se pueden asociar con el cuerpo de texto sin formato del mensaje o con chips que vinculan a recursos de Google Workspace, como Documentos o Hojas de cálculo de Google, con start_index y length de 0.
thread	Thread Es el subproceso al que pertenece el mensaje. Para ver un ejemplo de uso, consulta Cómo iniciar o responder un hilo de mensajes.
space	Space Solo salida. Si tu app de Chat se autentica como usuario, el resultado solo propagará el objeto name de espacio.
fallback_text	string Opcional. Es una descripción en texto simple de las tarjetas del mensaje que se usa cuando no se pueden mostrar las tarjetas reales, por ejemplo, en las notificaciones para dispositivos móviles.
action_response	ActionResponse Solo entrada. Son los 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 con todas las menciones de la app de Chat quitadas.
slash_command	SlashCommand Solo salida. Información del comando de barra, si corresponde
attachment[]	Attachment Opcional. Es un archivo adjunto subido por el usuario.
matched_url	MatchedUrl Solo salida. Es una URL en spaces.messages.text que coincide 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 un hilo de respuestas. Cuando es false, el mensaje se muestra en la conversación de nivel superior del espacio como el primer mensaje de un hilo o como un mensaje sin respuestas intercaladas. Si el espacio no admite respuestas en hilos, este campo siempre es false.
client_assigned_message_id	string Opcional. Es un ID personalizado para el mensaje. Puedes usar el campo para identificar un mensaje, o bien para obtener, borrar o actualizar un mensaje. Para establecer un ID personalizado, especifica el campo messageId cuando crees el mensaje. Para obtener más información, consulta Cómo nombrar un mensaje.
emoji_reaction_summaries[]	EmojiReactionSummary Solo salida. Es la lista de resúmenes de reacciones con emojis en el mensaje.
private_message_viewer	User Opcional. Inmutable. Es la entrada para crear un mensaje; de lo contrario, solo es la salida. Es el usuario que puede ver el mensaje. Cuando se configura, el mensaje es privado y solo lo ven 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 la app y omitir lo siguiente: Archivos adjuntos Widgets de accesorios Para obtener más información, consulta Cómo enviar un mensaje de forma privada.
deletion_metadata	DeletionMetadata Solo salida. Es información sobre un mensaje borrado. Se borra un mensaje cuando se establece delete_time.
quoted_message_metadata	QuotedMessageMetadata Solo salida. Es información sobre un mensaje que un usuario de Google Chat cita 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 se admite para 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

Es la carga útil del evento para varios mensajes nuevos.

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

Campos
messages[]	MessageCreatedEventData Es una lista de mensajes nuevos.

MessageBatchDeletedEventData

Es la carga útil del evento para varios mensajes borrados.

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

Campos
messages[]	MessageDeletedEventData Es una lista de mensajes borrados.

MessageBatchUpdatedEventData

Es la 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

Es la carga útil del evento para un mensaje nuevo.

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

Campos
message	Message Es el mensaje nuevo.

MessageDeletedEventData

Es la carga útil del evento para un mensaje borrado.

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

Campos
message	Message Es el mensaje borrado. Solo se propagan los campos name, createTime, deleteTime y deletionMetadata.

MessageUpdatedEventData

Es la carga útil del evento para un mensaje actualizado.

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

Campos
message	Message Es el mensaje actualizado.

QuotedMessageMetadata

Es la 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 en que se actualizó por última vez.

Reacciones

Es 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. Es el usuario que creó la reacción.
emoji	Emoji Es obligatorio. Es el emoji que se usa en la reacción.

ReactionBatchCreatedEventData

Es la carga útil del evento para varias reacciones nuevas.

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

Campos
reactions[]	ReactionCreatedEventData Es una lista de reacciones nuevas.

ReactionBatchDeletedEventData

Es la carga útil del evento para varias reacciones borradas.

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

Campos
reactions[]	ReactionDeletedEventData Es una lista de reacciones borradas.

ReactionCreatedEventData

Es la carga útil del evento para una reacción nueva.

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

Campos
reaction	Reaction Es la reacción nueva.

ReactionDeletedEventData

Es la carga útil del evento para una reacción borrada.

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

Campos
reaction	Reaction Es la reacción borrada.

RichLinkMetadata

Es un vínculo enriquecido a un recurso. Los vínculos enriquecidos se pueden asociar con el cuerpo de texto sin formato del mensaje o representar chips que se vinculan a recursos de Google Workspace, como Documentos o Hojas de cálculo de Google, con start_index y length de 0.

Campos
uri	string Es el URI de este vínculo.
rich_link_type	RichLinkType Es el tipo de vínculo enriquecido.
Campo de unión data. Son los datos del recurso vinculado. Las direcciones (data) solo pueden ser una de las siguientes opciones:
drive_link_data	DriveLinkData Son los datos de un vínculo de Drive.
chat_space_link_data	ChatSpaceLinkData Son los datos de un vínculo a un espacio de Chat.
meet_space_link_data	MeetSpaceLinkData Son los datos de un vínculo a un espacio de Meet.
calendar_event_link_data	CalendarEventLinkData Son los datos de un vínculo a un evento de calendario.

RichLinkType

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

Enumeraciones
RICH_LINK_TYPE_UNSPECIFIED	Es el valor predeterminado para la enumeración. No lo uses.
DRIVE_FILE	Es un tipo de vínculo enriquecido de Google Drive.
CHAT_SPACE	Es un tipo de vínculo enriquecido de espacio de Chat. Por ejemplo, un chip inteligente de espacio.
MEET_SPACE	Es un tipo de vínculo enriquecido de mensaje de Meet. Por ejemplo, un chip de Meet.
CALENDAR_EVENT	Es un tipo de vínculo enriquecido de mensaje de Calendar. Por ejemplo, un chip de Calendario.

SearchSpacesRequest

Es una solicitud para buscar una lista de espacios según 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 llama debe ser administrador de Google Workspace y tener el privilegio para administrar el chat y las conversaciones de los espacios. Requiere el permiso 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 devolverán. El servicio puede mostrar menos que este valor. Si no se especifica, se devolverán, como máximo, 100 espacios. El valor máximo es 1,000. Si usas un valor superior a 1,000, se cambiará automáticamente a 1,000.
page_token	string Es un token que se recibió de la llamada anterior a los espacios de búsqueda. 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. Si pasas valores diferentes a los otros parámetros, es posible que obtengas resultados inesperados.
query	string Es obligatorio. Es una búsqueda. Puedes realizar búsquedas con los siguientes parámetros: 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 (:). Primero, el texto que se debe hacer coincidir se tokeniza en unidades, y cada unidad se compara con el prefijo de forma independiente y sin distinguir mayúsculas de 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". Entre 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. Orden en que se muestra la lista de espacios. Los atributos admitidos 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 la fecha y hora en que se agregó el último elemento apto a cualquier tema de este espacio. create_time: Indica la fecha y 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 ordenar de forma descendente. La sintaxis admitida es la siguiente: 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 que corresponden a la solicitud de espacios de búsqueda.

Campos
spaces[]	Space Es 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 siguientes.
total_size	int32 Es la cantidad total de espacios que coinciden con la búsqueda en todas las páginas. Si el resultado supera los 10,000 espacios, este valor es una estimación.

SetUpSpaceRequest

Solicitud para crear un espacio y agregar usuarios especificados a él.

Campos
space	Space Es obligatorio. El campo Space.spaceType es obligatorio. Para crear un espacio, configura Space.spaceType en SPACE y establece Space.displayName. Si recibes el mensaje de error ALREADY_EXISTS cuando configuras un espacio, prueba con otro displayName. 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, configura Space.spaceType como GROUP_CHAT. No establezcas Space.displayName. Para crear una conversación 1:1 entre personas, establece Space.spaceType en DIRECT_MESSAGE y Space.singleUserBotDm en false. No establezcas 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 establezcas Space.displayName ni Space.spaceDetails. Si ya existe un espacio de DIRECT_MESSAGE, se devuelve 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 se especifica un ID de solicitud existente, se devuelve el espacio creado con ese ID en lugar de crear uno nuevo. Si se especifica un ID de solicitud existente de la misma app de Chat con un usuario autenticado diferente, se devuelve un error.
memberships[]	Membership Opcional. Usuarios o grupos de Google Chat a los que se invitará a unirse al espacio. Omitir al usuario que llama, ya que se agrega automáticamente Actualmente, el conjunto permite hasta 49 membresías (además de la del llamador). En el caso de la membresía humana, el campo Membership.member debe contener un user con name completado (formato: users/{user}) y type establecido en User.Type.HUMAN. Solo puedes agregar usuarios humanos cuando configuras un espacio (agregar apps de Chat solo se admite para la configuración de mensajes directos con la app de llamadas). También puedes agregar miembros usando el correo electrónico del usuario como alias para {user}. Por ejemplo, user.name puede ser users/[e-mail]. Para invitar a usuarios de Gmail o de dominios externos de Google Workspace, se debe usar el correo electrónico del usuario para {user}. En el caso de la membresía de Grupos de Google, el campo Membership.group_member debe contener un group con name completado (formato groups/{group}). Solo puedes agregar Grupos de Google cuando configuras Space.spaceType como SPACE. Es opcional cuando se establece Space.spaceType en SPACE. Se requiere cuando se establece Space.spaceType en GROUP_CHAT, junto con al menos dos membresías. Se requiere 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 de llamadas (cuando se configura Space.spaceType como DIRECT_MESSAGE y Space.singleUserBotDm como true).

SlashCommand

Son metadatos sobre un comando de barra en Google Chat.

Campos
command_id	int64 Es el ID del comando de barra.

SlashCommandMetadata

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

Campos
bot	User Es 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 Es 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 para 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} Aquí, {space} representa el ID asignado por el sistema para el espacio. Puedes obtener el ID del espacio llamando 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 Este elemento es obsoleto. Solo salida. Obsoleto: Usa space_type en su lugar. Es el tipo de espacio.
space_type	SpaceType Opcional. Es el tipo de espacio. Se requiere cuando se crea un espacio o se actualiza el tipo de espacio. Solo salida para otros usos.
single_user_bot_dm	bool Opcional. Indica si el espacio es un MD entre una app de Chat y una sola persona.
threaded (deprecated)	bool Este elemento es obsoleto. Solo salida. Obsoleto: Usa spaceThreadingState en su lugar. Indica si los mensajes se agrupan en hilos en este espacio.
display_name	string Opcional. Es el nombre visible del espacio. Se requiere 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. Indica si este espacio permite que cualquier usuario de Google Chat sea miembro. Es la entrada 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 personal (cuenta de usuario no administrada). De forma predeterminada, un espacio creado por una cuenta de consumidor permite a cualquier usuario de Google Chat. En el caso de los espacios existentes, este campo es solo de salida.
space_threading_state	SpaceThreadingState Solo salida. Es el estado de los hilos en el espacio de Chat.
space_details	SpaceDetails Opcional. Son los detalles del espacio, como la descripción y las reglas.
space_history_state	HistoryState Opcional. Es el estado del historial de mensajes y conversaciones en este espacio.
import_mode	bool Opcional. Indica si este espacio se creó en Import Mode como parte de una migración de datos a Google Workspace. Mientras se importan los espacios, los usuarios no los pueden ver hasta que se complete la importación. Para crear un espacio en Import Mode, se requiere la autenticación del usuario.
create_time	Timestamp Opcional. Inmutable. Fecha y hora de creación de los espacios creados en Chat. Este campo es solo de salida, excepto cuando se usa en espacios en modo de importación. En el caso de los espacios en 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. Es la 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, indica si el espacio fue creado por un administrador de Google Workspace. 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 por parte del administrador, tu app de Chat debe incluir la mensajería directa.
membership_count	MembershipCount Solo salida. Es el recuento de las membresías a las que se unieron los usuarios, agrupadas por tipo de miembro. Se propaga cuando space_type es SPACE, DIRECT_MESSAGE o GROUP_CHAT.
access_settings	AccessSettings Opcional. Especifica el parámetro de configuración de acceso del espacio. Solo se propaga cuando space_type es SPACE.
space_uri	string Solo salida. Es el URI para que un usuario acceda al espacio.
import_mode_expire_time	Timestamp Solo salida. Es la fecha y hora en que el sistema borrará automáticamente el espacio si permanece en el modo de importación. Cada espacio creado en el modo de importación debe salir de este modo antes de la fecha de vencimiento con spaces.completeImport. Este campo solo se completa para los espacios que se crearon con el modo de importación.
customer	string Opcional. Inmutable. Es el ID de cliente del dominio del espacio. Solo se requiere cuando se crea un espacio con autenticación de la app y SpaceType es SPACE. De lo contrario, no se debe configurar. En el formato customers/{customer}, donde customer es el id del [recurso customer 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 MD, este campo no se completa. Versión preliminar para desarrolladores: Disponible como parte del Programa de versión preliminar para desarrolladores de Google Workspace, que otorga acceso anticipado a ciertas funciones.
Campo de unión space_permission_settings. Representa la configuración de permisos de un espacio. Solo se propaga cuando space_type es SPACE. space_permission_settings solo puede ser uno de los siguientes:
predefined_permission_settings	PredefinedPermissionSettings Opcional. Solo entrada. Son parámetros de configuración de permisos de espacio predefinidos que solo se pueden ingresar cuando se crea un espacio. Si no se establece el campo, se crea un espacio de colaboración. Después de crear el espacio, se completará la configuración en el campo PermissionSettings. La configuración de permisos predefinida admite lo siguiente: Autenticación de la app con aprobación del administrador con los alcances chat.app.spaces o chat.app.spaces.create Autenticación de usuarios
permission_settings	PermissionSettings Opcional. Es la configuración de permisos del espacio para los espacios existentes. Es la entrada para actualizar la configuración de permisos de espacio exactos, en la que se reemplaza la configuración de permisos existente. El resultado muestra la configuración de permisos actual. La lectura y actualización de la configuración de permisos admite lo siguiente: Autenticación de la app con aprobación del administrador con el alcance chat.app.spaces Solo se propaga y se puede configurar cuando la app de Chat creó el espacio. Autenticación de usuarios

AccessSettings

Representa el parámetro de 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 que contiene. Si no se configura, solo los usuarios o los Grupos de Google que se hayan invitado o agregado individualmente al espacio podrán acceder a él. 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 el valor en audiences/default. La lectura del público objetivo admite lo siguiente: Autenticación de usuarios Autenticación de la app con aprobación del administrador con el alcance chat.app.spaces Este campo no se propaga cuando se usa el alcance chat.bot con la autenticación de la app. 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	El administrador del espacio otorgó acceso a un público objetivo al espacio. Los usuarios o los Grupos de Google que se agregaron o invitaron individualmente 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 ser miembros de un grupo unido.
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 permiso de espacio.

Campos
managers_allowed	bool Opcional. Indica si los administradores de espacios tienen este permiso.
members_allowed	bool Opcional. Indica 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 crees un espacio, especifica el campo PredefinedPermissionSettings en tu solicitud.

Campos
manage_members_and_groups	PermissionSetting Opcional. Es el parámetro de configuración para administrar miembros y grupos en un espacio.
modify_space_details	PermissionSetting Opcional. Parámetro de configuración para actualizar el nombre, el avatar, la descripción y los lineamientos del espacio.
toggle_history	PermissionSetting Opcional. Es el parámetro de configuración para activar y desactivar el historial de espacios.
use_at_mention_all	PermissionSetting Opcional. Es el parámetro de configuración para usar @todos en un espacio.
manage_apps	PermissionSetting Opcional. Es un parámetro de configuración para administrar apps en un espacio.
manage_webhooks	PermissionSetting Opcional. Es un parámetro de configuración para administrar webhooks en un espacio.
post_messages	PermissionSetting Solo salida. Es el parámetro de configuración para publicar mensajes en un espacio.
reply_messages	PermissionSetting Opcional. Es el parámetro de configuración para responder mensajes en un espacio.

PredefinedPermissionSettings

Son parámetros de configuración de permisos predefinidos 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 para los espacios con nombre, consulta Obtén información sobre los espacios.

Enumeraciones
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED	Sin especificar. No lo uses.
COLLABORATION_SPACE	Parámetro de configuración para convertir el espacio en un espacio de colaboración en el que todos los miembros pueden publicar mensajes.
ANNOUNCEMENT_SPACE	Es el parámetro de configuración para convertir el espacio en un espacio de anuncios en el que solo los administradores del espacio pueden publicar mensajes.

SpaceDetails

Son los detalles del espacio, como la descripción y las reglas.

Campos
description	string Opcional. Es 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 hilos de mensajes Cuando los usuarios responden un mensaje, pueden hacerlo en el mismo hilo, 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. Se requiere cuando se crea o actualiza un espacio. Solo salida para otros usos.

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 entre 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 simples. Ten en cuenta que esto no incluye los mensajes directos entre dos personas.

SpaceBatchUpdatedEventData

Es la 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

Es un evento que representa un cambio o una actividad en un espacio de Google Chat. Para obtener más información, consulta Trabaja 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 Fecha y hora en que ocurrió el evento.
event_type	string Es el tipo de evento de espacio. Cada tipo de evento tiene una versión por lotes, que representa varias instancias del tipo de evento que ocurren en un período corto. En el caso de las solicitudes de spaceEvents.list(), omite los tipos de eventos por lotes en el filtro de la consulta. De forma predeterminada, el servidor devuelve 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 membresías: Membresía nueva: 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 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 del 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 Es la carga útil del evento para un mensaje nuevo. Tipo de evento: google.workspace.chat.message.v1.created
message_updated_event_data	MessageUpdatedEventData Es la carga útil del evento para un mensaje actualizado. Tipo de evento: google.workspace.chat.message.v1.updated
message_deleted_event_data	MessageDeletedEventData Es la carga útil del evento para un mensaje borrado. Tipo de evento: google.workspace.chat.message.v1.deleted
message_batch_created_event_data	MessageBatchCreatedEventData Es la carga útil del evento para varios mensajes nuevos. Tipo de evento: google.workspace.chat.message.v1.batchCreated
message_batch_updated_event_data	MessageBatchUpdatedEventData Es la carga útil del evento para varios mensajes actualizados. Tipo de evento: google.workspace.chat.message.v1.batchUpdated
message_batch_deleted_event_data	MessageBatchDeletedEventData Es la carga útil del evento para varios mensajes borrados. Tipo de evento: google.workspace.chat.message.v1.batchDeleted
space_updated_event_data	SpaceUpdatedEventData Es la carga útil del evento para una actualización del espacio. Tipo de evento: google.workspace.chat.space.v1.updated
space_batch_updated_event_data	SpaceBatchUpdatedEventData Es la carga útil del evento para varias actualizaciones de un espacio. Tipo de evento: google.workspace.chat.space.v1.batchUpdated
membership_created_event_data	MembershipCreatedEventData Es la carga útil del evento para una membresía nueva. Tipo de evento: google.workspace.chat.membership.v1.created
membership_updated_event_data	MembershipUpdatedEventData Es la carga útil del evento para una membresía actualizada. Tipo de evento: google.workspace.chat.membership.v1.updated
membership_deleted_event_data	MembershipDeletedEventData Es la carga útil del evento para una membresía borrada. Tipo de evento: google.workspace.chat.membership.v1.deleted
membership_batch_created_event_data	MembershipBatchCreatedEventData Es la carga útil del evento para varias membresías nuevas. Tipo de evento: google.workspace.chat.membership.v1.batchCreated
membership_batch_updated_event_data	MembershipBatchUpdatedEventData Es la carga útil del evento para varias membresías actualizadas. Tipo de evento: google.workspace.chat.membership.v1.batchUpdated
membership_batch_deleted_event_data	MembershipBatchDeletedEventData Es la carga útil del evento para varias membresías borradas. Tipo de evento: google.workspace.chat.membership.v1.batchDeleted
reaction_created_event_data	ReactionCreatedEventData Es la carga útil del evento para una reacción nueva. Tipo de evento: google.workspace.chat.reaction.v1.created
reaction_deleted_event_data	ReactionDeletedEventData Es la carga útil del evento para una reacción borrada. Tipo de evento: google.workspace.chat.reaction.v1.deleted
reaction_batch_created_event_data	ReactionBatchCreatedEventData Es la carga útil del evento para varias reacciones nuevas. Tipo de evento: google.workspace.chat.reaction.v1.batchCreated
reaction_batch_deleted_event_data	ReactionBatchDeletedEventData Es la carga útil del evento para varias reacciones borradas. Tipo de evento: google.workspace.chat.reaction.v1.batchDeleted

SpaceNotificationSetting

Es el parámetro de configuración de notificaciones de un usuario en un espacio.

Campos
name	string Identificador. Es el nombre del recurso del parámetro de configuración de notificaciones del espacio. Formato: users/{user}/spaces/{space}/spaceNotificationSetting.
notification_setting	NotificationSetting Es el parámetro de configuración de la notificación.
mute_setting	MuteSetting Es el parámetro de configuración de silencio de notificaciones del espacio.

MuteSetting

Son los tipos de configuración para silenciar las notificaciones de espacios.

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

NotificationSetting

Son los tipos de configuración de notificaciones. Es posible que se admitan otros tipos en el futuro.

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

SpaceReadState

Es el estado de lectura de un usuario en 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. Fecha y hora en que se actualizó el estado de lectura del espacio del usuario. Por lo general, esto corresponde a la marca de tiempo del último mensaje leído o a una marca de tiempo especificada por el usuario para marcar la última posición de lectura en un espacio.

SpaceUpdatedEventData

Es la carga útil del evento para un espacio actualizado.

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

Campos
space	Space Es el espacio actualizado.

Conversación

Es un hilo en un espacio de Google Chat. Para ver un ejemplo de uso, consulta Cómo iniciar o responder un hilo de mensajes.

Si especificas un subproceso cuando creas un mensaje, puedes configurar el campo messageReplyOption para determinar qué sucede si no se encuentra ningún subproceso coincidente.

Campos
name	string Identificador. Es el nombre del recurso del subproceso. Ejemplo: spaces/{space}/threads/{thread}
thread_key	string Opcional. Es la entrada para crear o actualizar un subproceso. De lo contrario, solo salida. 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 publicarán en conversaciones diferentes. Para responder en un hilo creado por una persona o por otra app de Chat, especifica el campo name.

ThreadReadState

Es el estado de lectura de un usuario dentro de un subproceso, 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 Fecha y hora en que se actualizó el estado de lectura del hilo del usuario. Por lo general, corresponde a la marca de tiempo del último mensaje leído en un hilo.

UpdateMembershipRequest

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

Campos
membership	Membership Es obligatorio. Es la membresía que se actualizará. Solo se actualizan los campos especificados por update_mask.
update_mask	FieldMask Es obligatorio. Son las rutas de acceso a los campos que se actualizarán. Separa varios valores con comas o usa * para actualizar todas las rutas de campo. Rutas de campos 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 llama debe ser administrador de Google Workspace y tener 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 Es obligatorio. Mensaje con campos actualizados.
update_mask	FieldMask Es obligatorio. Son las rutas de acceso a los campos que se actualizarán. Separa varios valores con comas o usa * para actualizar todas las rutas de campo. Rutas de campos admitidas actualmente: text attachment cards (Requiere autenticación de la app). cards_v2 (Requiere autenticación de la app). accessory_widgets (Requiere autenticación de la app).
allow_missing	bool Opcional. Si no se encuentra true ni el mensaje, se crea un mensaje 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 llama.

Campos
space_notification_setting	SpaceNotificationSetting Es obligatorio. El nombre del recurso para la configuración de notificaciones del espacio debe completarse con el formato users/{user}/spaces/{space}/spaceNotificationSetting. Solo se actualizan los campos especificados por update_mask.
update_mask	FieldMask Es obligatorio. Rutas de campos admitidas: notification_setting mute_setting

UpdateSpaceReadStateRequest

Es el mensaje de solicitud para la API de UpdateSpaceReadState.

Campos
space_read_state	SpaceReadState Es obligatorio. Estado de lectura del espacio y campos que se actualizarán. Solo admite la actualización del estado de lectura para el usuario que llama. Para hacer referencia al usuario que llama, configura uno de los siguientes parámetros: Es el alias de me. Por ejemplo, users/me/spaces/{space}/spaceReadState Su dirección de correo electrónico de Workspace Por ejemplo, users/[e-mail]/spaces/{space}/spaceReadState. Su ID de usuario. Por ejemplo, users/123456789/spaces/{space}/spaceReadState. Formato: users/{user}/spaces/{space}/spaceReadState
update_mask	FieldMask Es obligatorio. Son las rutas de acceso a los campos que se actualizarán. Rutas de campos admitidas actualmente: last_read_time Cuando el valor de last_read_time es anterior a la fecha y 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) a la hora de creación del mensaje más reciente. El last_read_time se fuerza para que coincida 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 los subprocesos no se ven afectadas por esta marca de tiempo y, en cambio, dependen del estado de lectura del subproceso.

UpdateSpaceRequest

Es una solicitud para actualizar un solo espacio.

Campos
space	Space Es obligatorio. Es un espacio con los campos que se actualizarán. Space.name debe completarse en el formato spaces/{space}. Solo se actualizan los campos especificados por update_mask.
update_mask	FieldMask Es obligatorio. Son las rutas de acceso de los campos actualizados, 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 el cambio de 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 producirá 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 organización de Google Workspace tiene habilitada la configuración del historial. Para actualizar el estado del historial del espacio, 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 donde 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 se autentica debe ser administrador del espacio y omitir todas las demás máscaras de campo en su 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 el cambio de la configuración de permisos de un espacio. Cuando actualices la configuración de permisos, solo podrás especificar máscaras de campo permissionSettings. No podrás actualizar otras máscaras de campo al mismo tiempo. permissionSettings no es compatible con useAdminAccess. Las máscaras de campo admitidas 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 llama debe ser administrador de Google Workspace y tener 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 se admiten con acceso de administrador. Para obtener más información, consulta la descripción de update_mask.

Usuario

Es un usuario de Google Chat. Cuando se devuelve como resultado de una solicitud, si tu app de Chat se autentica como usuario, el resultado de un recurso User solo completa los campos name y type del usuario.

Campos
name	string Es el nombre del 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. En el caso de human users, {user} es el mismo identificador de usuario que en los siguientes casos: Es el id del objeto 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 persona 123456789 en la API de People. Es 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 de {user} en las solicitudes a la API. Por ejemplo, si el ID del perfil de la API de People para [e-mail] es 123456789, puedes usar users/[e-mail] como alias para hacer referencia a users/123456789. La API solo devolverá el nombre canónico del recurso (por ejemplo, users/123456789).
display_name	string Solo salida. Nombre visible del usuario.
domain_id	string Es el identificador único del dominio de Google Workspace del usuario.
type	Type Es el tipo de usuario.
is_anonymous	bool Solo salida. Cuando es true, se borra al usuario o no se ve su perfil.

Tipo

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

UserMentionMetadata

Son los metadatos de anotación para las menciones de usuarios (@).

Campos
user	User Es el usuario al que se menciona.
type	Type Es el tipo de mención del usuario.

Tipo

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

WidgetMarkup

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

Campos
buttons[]	Button Es una lista de botones. Los botones también son 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 un botón 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 la acción onclick.
image_button	ImageButton Un botón con una imagen y una acción de 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 devuelve 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 activan un comportamiento común.
parameters[]	ActionParameter Es la lista de parámetros de acción.

ActionParameter

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

Campos
key	string Es el nombre del parámetro para el script de 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

Imagen especificada por una URL que puede tener una acción onclick.

Campos
image_url	string Es la URL de la imagen.
on_click	OnClick Es 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 configura, el servidor lo completa con la recuperación previa de la imagen.

ImageButton

Botón de imagen con una acción onclick.

Campos
on_click	OnClick Es la acción onclick.
name	string Es el nombre de este image_button que se usa para la accesibilidad. Se proporciona un valor predeterminado si no se especifica este nombre.
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 Ícono especificado por un enum que indexa un ícono proporcionado por la API de Chat.
icon_url	string Í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 texto con formato. Para obtener más información sobre el formato de 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 texto con formato y siempre es obligatorio. Para obtener más información sobre el formato de 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 Indica si el contenido debe ser de varias líneas.
bottom_label	string Es el texto de la etiqueta inferior. Se admite texto con formato. Para obtener más información sobre el formato de 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 Es 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 del ícono correspondiente.
icon_url	string Ícono especificado por una URL.
Campo de unión control. Es 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 de 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.
open_link	OpenLink Esta acción onclick activa una acción de vínculo abierto si se especifica.

OpenLink

Un vínculo que abre una ventana nueva.

Campos
url	string Es la URL que se abrirá.

TextButton

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

Campos
text	string El texto del botón
on_click	OnClick Acción onclick del botón.

TextParagraph

Es un párrafo de texto. Se admite texto con formato. Para obtener más información sobre el formato de 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