Desarrolla con Google Chat
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
En esta página, se proporciona una descripción general de la API de Google Chat y las apps de Google Chat.
Descripción general de la API de Google Chat
La API de Chat consta de servicios de gRPC o recursos y métodos de REST que otorgan acceso a Chat, incluidos los espacios, los miembros de espacios, los mensajes, las reacciones a los mensajes, los archivos adjuntos de los mensajes, los eventos de espacios y los estados de lectura de los usuarios.
Conceptos
En la siguiente sección, se definen los servicios, los recursos y los métodos de la API de Chat:
- Espacios
Los espacios son lugares donde las personas y las apps pueden conversar y compartir archivos. Existen varios tipos de espacios. Los mensajes directos (MD) son conversaciones 1:1 entre dos usuarios o entre un usuario y una app de Chat. Los chats grupales son conversaciones entre tres o más usuarios y apps de Chat. Los espacios con nombre son lugares persistentes donde las personas envían mensajes, comparten archivos y colaboran.
Referencia del recurso:
Para ver un ejemplo de uso, consulta lo siguiente:
- Miembros
Los miembros son los usuarios y las apps de Chat que se unieron a un espacio o que recibieron una invitación para unirse a él.
Referencia del recurso:
Para ver un ejemplo de uso, consulta lo siguiente:
- Mensajes
Los mensajes incluyen comunicaciones de texto y tarjetas que se publican en los espacios. Los mensajes pueden tener archivos adjuntos.
Las personas pueden reaccionar a los mensajes agregándoles emojis.
Referencia del recurso:
Para ver un ejemplo de uso, consulta lo siguiente:
- Reacciones
Las reacciones representan los emojis que las personas usan para reaccionar a un mensaje, como 👍, 🚲 y 🌞.
Referencia del recurso:
Para ver un ejemplo de uso, consulta lo siguiente:
- Emojis personalizados
Los emojis personalizados representan los emojis personalizados que se crearon y compartieron dentro de la organización en Google Chat. Los emojis personalizados se pueden incluir en el contenido de un mensaje o usarse para reaccionar a un mensaje.
Referencia del recurso:
Para ver un ejemplo de uso, consulta lo siguiente:
- Contenido multimedia y archivos adjuntos
Media representa un archivo subido a Google Chat, como imágenes, videos y documentos.
Referencia del recurso multimedia (no disponible en RPC):
Los archivos adjuntos son instancias de contenido multimedia (archivos) adjuntos a los mensajes.
Referencia del recurso:
Para ver un ejemplo de uso, consulta lo siguiente:
- Eventos de Space
Los eventos de espacio representan cambios en un espacio o en sus recursos secundarios, incluidos sus miembros, mensajes y reacciones.
Referencia del recurso:
Para ver un ejemplo de uso, consulta lo siguiente:
- Estados de lectura del usuario
Los estados de lectura del usuario son recursos singleton que representan detalles sobre el último mensaje leído de un usuario específico en un espacio de Google Chat o en un hilo de mensajes.
Referencia del recurso de estado de lectura del espacio:
Referencia del recurso de estado de lectura del subproceso:
Para ver un ejemplo de uso, consulta lo siguiente:
- Configuración de notificaciones del espacio del usuario
La configuración de notificaciones del espacio del usuario son recursos singleton que representan la configuración de notificaciones de un usuario especificado en un espacio de Google Chat.
Referencia del recurso:
Autenticación
Para llamar a la API de Chat, se requiere autenticación. Cada método de la API de Chat requiere autenticación del usuario (para realizar acciones o acceder a datos en nombre de un usuario) o autenticación de la app (para realizar acciones o acceder a datos como una app de Chat). Algunos métodos admiten la autenticación de usuarios y la autenticación de apps.
Para obtener más información sobre la autenticación en Chat, consulta Descripción general de la autenticación.
Bibliotecas cliente
La forma recomendada para que la mayoría de los desarrolladores llamen a la API de Google Chat es con nuestras bibliotecas cliente de Cloud compatibles oficialmente para tu lenguaje preferido, como Python, Java o Node.js.
Si escribes código con Google Apps Script, usa el servicio de Chat avanzado en lugar de instalar una biblioteca cliente.
Compila apps de Chat
La API de Chat te permite crear apps de Google Chat que incorporan tus servicios y recursos directamente en Google Chat. Puedes crear apps de chat para realizar cualquiera de las siguientes acciones:
- Recupera información según las consultas de texto estructurado o libre que ingresa el usuario.
- Generar informes de incidentes o artefactos similares con la información proporcionada por el usuario
- Mejorar la colaboración del equipo, por ejemplo, proporcionando "memoria del equipo" o programando recursos
Puedes diseñar tu app de Chat con varios estilos de arquitectura diferentes, incluidos los siguientes:
- Apps interactivas: Responden a la interacción del usuario, como las @menciones o los comandos de barra, y presentan información o guían a los usuarios a través de un flujo de trabajo con tarjetas y diálogos.
- Apps de línea de comandos o webhooks: Envían mensajes proactivos, como alarmas o notificaciones, desde otro sistema a un espacio. Los usuarios no pueden interactuar directamente con este tipo de apps.
- Apps basadas en eventos: Suscríbete a la actividad en un espacio de Chat y reacciona a ella, por ejemplo, cuando se une un miembro nuevo. En respuesta a un evento, la app puede enviar un mensaje o realizar otra acción.
Para obtener detalles sobre el diseño de tu app de Chat, consulta Elige una arquitectura de app de Google Chat.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-08-04 (UTC)
[null,null,["Última actualización: 2025-08-04 (UTC)"],[[["\u003cp\u003eGoogle Chat apps integrate services directly into chats, enabling users to access information and take action without leaving the conversation.\u003c/p\u003e\n"],["\u003cp\u003eThese apps support various functionalities, including workflow management, data collection, and interactive elements like dialogs and slash commands.\u003c/p\u003e\n"],["\u003cp\u003eChoose from interactive, non-interactive, or event-driven architectures to build apps that cater to your specific needs and use cases.\u003c/p\u003e\n"],["\u003cp\u003eGoogle Chat apps can be built using various platforms like AppSheet, Google Apps Script, and Dialogflow.\u003c/p\u003e\n"],["\u003cp\u003eAccess to user data beyond basic identity requires authentication and user consent, ensuring privacy and security.\u003c/p\u003e\n"]]],["Google Chat apps integrate services directly into conversations, allowing users to access information and perform actions without leaving the chat. These apps can send text or card messages within spaces or direct messages. They can be interactive, responding to mentions and commands, or non-interactive, sending messages without user interaction. Apps can retrieve information, file tickets, and coordinate team efforts. Developers can build these apps using diverse platforms, manage deployments, and publish them on the Google Workspace Marketplace.\n"],null,["# Develop with Google Chat\n\nThis page provides an overview of the Google Chat API and Google Chat apps.\n\nGoogle Chat API overview\n------------------------\n\nThe Chat API consists of\n[gRPC services or REST resources and methods](https://cloud.google.com/apis/docs/client-libraries-explained)\nthat grant access to Chat, including spaces, space members,\nmessages, message reactions, message attachments, space events, and user read\nstates.\n\n### Concepts\n\nThe following section defines the services, resources, and methods for the\nChat API:\n\n*Spaces*\n\n: *Spaces* are places where people and apps can converse and share files. There\n are several types of spaces. Direct messages (DMs) are 1:1 conversations\n between two users or a user and a Chat app. Group\n chats are conversations between three or more users and\n Chat apps. Named spaces are persistent places where people send\n messages, share files, and collaborate.\n\n: Resource reference:\n\n - [RPC reference](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.Space)\n - [REST reference](/workspace/chat/api/reference/rest/v1/spaces)\n\n: For example usage, see:\n\n - [Create a space](/workspace/chat/create-spaces)\n - [Set up a space](/workspace/chat/set-up-spaces)\n - [Get a space](/workspace/chat/get-spaces)\n - [List spaces](/workspace/chat/list-spaces)\n - [Update a space](/workspace/chat/update-spaces)\n - [Delete a space](/workspace/chat/delete-spaces)\n - [Find a direct message (DM)](/workspace/chat/find-direct-message-in-spaces)\n\n*Members*\n\n: *Members* are users and Chat apps that have joined or are\n invited to a space.\n\n: Resource reference:\n\n - [RPC reference](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.Membership)\n - [REST reference](/workspace/chat/api/reference/rest/v1/spaces.members)\n\n: For example usage, see:\n\n - [Create a membership](/workspace/chat/create-members)\n - [Get a membership](/workspace/chat/get-members)\n - [List memberships](/workspace/chat/list-members)\n - [Update a membership](/workspace/chat/update-members)\n - [Delete a membership](/workspace/chat/delete-members)\n\n*Messages*\n\n: *Messages* include\n [text](/workspace/chat/api/reference/rest/v1/spaces.messages)\n and\n [card](/workspace/chat/api/reference/rest/v1/cards)\n communications posted in spaces. Messages can have files attached to them.\n People can react to messages by appending emoji to them.\n\n: Resource reference:\n\n - [RPC reference](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.Message)\n - [REST reference](/workspace/chat/api/reference/rest/v1/spaces.messages)\n\n: For example usage, see:\n\n - [Create a message](/workspace/chat/create-messages)\n - [Get a message](/workspace/chat/get-messages)\n - [List messages](/workspace/chat/list-messages)\n - [Update a message](/workspace/chat/update-messages)\n - [Delete a message](/workspace/chat/delete-messages)\n\n*Reactions*\n\n: *Reactions* represent the emoji people use to react to a message, such as\n 👍, 🚲, and 🌞.\n\n: Resource reference:\n\n - [RPC reference](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.Reaction)\n - [REST reference](/workspace/chat/api/reference/rest/v1/spaces.messages.reactions)\n\n: For example usage, see:\n\n - [Create a reaction](/workspace/chat/create-reactions)\n - [List reactions](/workspace/chat/list-reactions)\n - [Delete a reaction](/workspace/chat/delete-reactions)\n\n*Custom emoji*\n\n: *Custom emoji* represent custom emoji created and shared within the\n organization in Google Chat. Custom emoji can be included in the content of\n a message or used to react to a message.\n\n: Resource reference:\n\n - [RPC reference](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.CustomEmoji)\n - [REST reference](/workspace/chat/api/reference/rest/v1/customEmojis)\n\n: For example usage, see:\n\n - [Create a custom emoji](/workspace/chat/create-custom-emoji)\n - [Delete a custom emoji](/workspace/chat/delete-custom-emoji)\n - [Get details about a custom emoji](/workspace/chat/get-custom-emoji)\n - [List custom emojis in an organization](/workspace/chat/list-custom-emojis)\n\n*Media and attachments*\n\n: *Media* represents a file uploaded to Google Chat, like images, videos, and\n documents.\n\n: Media resource reference (Unavailable in RPC):\n\n - [REST reference](/workspace/chat/api/reference/rest/v1/media)\n\n: *Attachments* are instances of media (files) attached to messages.\n\n: Resource reference:\n\n - [RPC reference](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.Attachment)\n - [REST reference](/workspace/chat/api/reference/rest/v1/spaces.messages.attachments)\n\n: For example usage, see:\n\n - [Upload media as an attachment](/workspace/chat/upload-media-attachments)\n - [Download media as an attachment](/workspace/chat/download-media-attachments)\n - [Get an attachment](/workspace/chat/get-media-attachments)\n\n*Space events*\n\n: *Space events* represent changes to a space or its\n child resources, including its members, messages, and reactions.\n\n: Resource reference:\n\n - [RPC reference](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.SpaceEvent)\n - [REST reference](/workspace/chat/api/reference/rest/v1/spaces.spaceEvents)\n\n: For example usage, see:\n\n - [Get space read state](/workspace/chat/get-space-read-state)\n - [Update space read state](/workspace/chat/update-space-read-state)\n - [Get thread read state](/workspace/chat/get-thread-read-state)\n\n*User read states*\n\n: *User read states* are singleton resources that represent details about a\n specified user's last read message in a Google Chat space or a message\n thread.\n\n: Space read state resource reference:\n\n - [RPC reference](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.SpaceReadState)\n - [REST reference](/workspace/chat/api/reference/rest/v1/users.spaces)\n\n: Thread read state resource reference:\n\n - [RPC reference](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.ThreadReadState)\n - [REST reference](/workspace/chat/api/reference/rest/v1/users.spaces.threads)\n\n: For example usage, see:\n\n - [Get space read state](/workspace/chat/get-space-read-state)\n - [Update space read state](/workspace/chat/update-space-read-state)\n - [Get thread read state](/workspace/chat/get-thread-read-state)\n\n*User space notification settings*\n\n: *User space notification settings* are singleton resources that represent a\n specified user notification settings in a Google Chat space.\n\n: Resource reference:\n\n - [RPC reference](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.SpaceNotificationSetting)\n - [REST reference](/workspace/chat/api/reference/rest/v1/users.spaces.spaceNotificationSetting)\n\n### Authentication\n\nCalling the Chat API requires authentication. Each\nChat API method requires either\n[user authentication](/workspace/chat/authenticate-authorize-chat-user)\n(to perform actions or access\ndata on behalf of a user) or\n[app authentication](/workspace/chat/authenticate-authorize-chat-app)\n(to perform actions or access data as a Chat app). Some\nmethods support both user authentication and app authentication.\n\nTo learn more about authentication in Chat, see\n[Authentication overview](/workspace/chat/authenticate-authorize).\n\n### Client libraries\n\nThe recommended way for most developers to call the Google Chat API\nis with our officially supported\n[Cloud Client Libraries](/workspace/chat/libraries)\nfor your preferred language, like Python, Java, or Node.js.\n\nIf you're coding with Google Apps Script, use the\n[Advanced Chat service](/apps-script/advanced/chat)\ninstead of installing a client library.\n\nBuild Chat apps\n---------------\n\nThe Chat API lets you build Google Chat apps that bring your\nservices and resources right into Google Chat. You can build\nChat apps to do any of the following:\n\n- Retrieve information based on structured or free text queries entered by the user.\n- Generate incident reports or other artifacts, using information provided by the user.\n- Enhance team collaboration, such as providing \"team memory\" or scheduling resources.\n\nYou can design your Chat app using several different\narchitecture styles, including the following:\n\n- **Interactive apps**: Respond to user interaction, such as @mentions or slash commands, and present information or guide users through a workflow with cards and dialogs.\n- **Command-line apps or webhooks**: Send proactive messages, such as alarms or notifications, from another system into a space. Users can't directly interact with this type of app.\n- **Event-driven apps**: Subscribe to and react to activity in a Chat space, such as a new member joining. In response to an event, the app can send a message or perform another action.\n\nFor details about designing your Chat app, see\n[Choose a Google Chat app architecture](/workspace/chat/structure).\n\nRelated topics\n--------------\n\n- [Explore Google Chat app samples](/workspace/chat/samples).\n- [Build interactive Google Chat apps](/workspace/chat/interact-users-overview).\n- [Choose a Google Chat app architecture](/workspace/chat/structure).\n\n|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| | Want to see the Google Chat API in action? The Google Workspace Developers channel offers videos about tips, tricks, and the latest features. [Subscribe now](https://www.youtube.com/channel/UCUcg6az6etU_gRtZVAhBXaw) |"]]
