Entwickeln mit Google Chat
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Auf dieser Seite erhalten Sie einen Überblick über die Google Chat API und Google Chat-Apps.
Google Chat API – Übersicht
Die Chat API besteht aus gRPC-Diensten oder REST-Ressourcen und -Methoden, die Zugriff auf Chat gewähren, einschließlich Gruppenbereiche, Gruppenbereichsmitglieder, Nachrichten, Nachrichtenreaktionen, Nachrichtenanhänge, Gruppenbereichsereignisse und Nutzerlesestatus.
Konzepte
Im folgenden Abschnitt werden die Dienste, Ressourcen und Methoden für die Chat API definiert:
- Gruppenbereiche
Gruppenbereiche sind Orte, an denen sich Personen und Apps austauschen und Dateien teilen können. Es gibt verschiedene Arten von Bereichen. Direktnachrichten sind 1:1-Unterhaltungen zwischen zwei Nutzern oder einem Nutzer und einer Chat-App. Gruppenchats sind Unterhaltungen zwischen drei oder mehr Nutzern und Chat-Apps. Benannte Gruppenbereiche sind dauerhafte Orte, an denen Nutzer Nachrichten senden, Dateien teilen und zusammenarbeiten können.
Ressourcenreferenz:
Beispiele zur Verwendung finden Sie unter:
- Mitglieder
Mitglieder sind Nutzer und Chat-Apps, die einem Gruppenbereich beigetreten sind oder in einen Gruppenbereich eingeladen wurden.
Ressourcenreferenz:
Beispiele zur Verwendung finden Sie unter:
- Nachrichten
Nachrichten umfassen Text und Karten>, die in Gruppenbereichen gepostet werden. Nachrichten können Dateien enthalten.
Nutzer können auf Nachrichten reagieren, indem sie Emojis anhängen.
Ressourcenreferenz:
Beispiele zur Verwendung finden Sie unter:
- Reaktionen
Reaktionen sind die Emojis, mit denen Nutzer auf eine Nachricht reagieren, z. B. 👍, 🚲 und 🌞.
Ressourcenreferenz:
Beispiele zur Verwendung finden Sie unter:
- Benutzerdefinierte Emojis
Benutzerdefinierte Emojis sind benutzerdefinierte Emojis, die in Google Chat erstellt und innerhalb der Organisation geteilt wurden. Benutzerdefinierte Emojis können in den Inhalt einer Nachricht eingefügt oder verwendet werden, um auf eine Nachricht zu reagieren.
Ressourcenreferenz:
Beispiele zur Verwendung finden Sie unter:
- Medien und Anhänge
Media steht für eine in Google Chat hochgeladene Datei, z. B. Bilder, Videos und Dokumente.
Referenz zur Media-Ressource (nicht in RPC verfügbar):
Anhänge sind Instanzen von Medien (Dateien), die an Nachrichten angehängt sind.
Ressourcenreferenz:
Beispiele zur Verwendung finden Sie unter:
- Space-Events
Gruppenbereichsereignisse stellen Änderungen an einem Gruppenbereich oder seinen untergeordneten Ressourcen dar, einschließlich seiner Mitglieder, Nachrichten und Reaktionen.
Ressourcenreferenz:
Beispiele zur Verwendung finden Sie unter:
- Lesestatus von Nutzern
Lesestatus von Nutzern sind Singleton-Ressourcen, die Details zur zuletzt gelesenen Nachricht eines bestimmten Nutzers in einem Google Chat-Gruppenbereich oder einem Nachrichten-Thread enthalten.
Ressourcenreferenz für den Lesestatus von Bereichen:
Referenz zur Ressource für den Lesestatus von Threads:
Beispiele zur Verwendung finden Sie unter:
- Benachrichtigungseinstellungen für Nutzerbereiche
Benachrichtigungseinstellungen für Nutzerbereiche sind Singleton-Ressourcen, die die Benachrichtigungseinstellungen eines bestimmten Nutzers in einem Google Chat-Gruppenbereich darstellen.
Ressourcenreferenz:
Authentifizierung
Für den Aufruf der Chat API ist eine Authentifizierung erforderlich. Für jede Chat API-Methode ist entweder eine Nutzerauthentifizierung (zum Ausführen von Aktionen oder zum Zugriff auf Daten im Namen eines Nutzers) oder eine App-Authentifizierung (zum Ausführen von Aktionen oder zum Zugriff auf Daten als Chat-App) erforderlich. Einige Methoden unterstützen sowohl die Nutzer- als auch die App-Authentifizierung.
Weitere Informationen zur Authentifizierung in Chat finden Sie unter Authentifizierung.
Clientbibliotheken
Die empfohlene Methode für die meisten Entwickler, die Google Chat API aufzurufen, sind unsere offiziell unterstützten Cloud-Clientbibliotheken für Ihre bevorzugte Sprache wie Python, Java oder Node.js.
Wenn Sie mit Google Apps Script programmieren, verwenden Sie den erweiterten Chat-Dienst, anstatt eine Clientbibliothek zu installieren.
Chat-Apps erstellen
Mit der Chat API können Sie Google Chat-Apps entwickeln, mit denen Sie Ihre Dienste und Ressourcen direkt in Google Chat einbinden können. Sie können Chat-Apps für die folgenden Zwecke erstellen:
- Informationen auf Grundlage von strukturierten oder Freitextanfragen abrufen, die vom Nutzer eingegeben wurden.
- Erstellen von Vorfallberichten oder anderen Artefakten anhand von Informationen, die vom Nutzer bereitgestellt werden.
- Zusammenarbeit im Team verbessern, z. B. durch Bereitstellung eines „Teamgedächtnisses“ oder durch Planen von Ressourcen.
Sie können Ihre Chat-App mit verschiedenen Architekturstilen entwerfen, darunter:
- Interaktive Apps: Reagieren auf Nutzerinteraktionen wie @Erwähnungen oder Schrägstrichbefehle und präsentieren Informationen oder führen Nutzer mit Karten und Dialogfeldern durch einen Workflow.
- Befehlszeilen-Apps oder Webhooks: Proaktive Nachrichten wie Alarme oder Benachrichtigungen aus einem anderen System in einen Gruppenbereich senden. Nutzer können nicht direkt mit dieser Art von App interagieren.
- Ereignisgesteuerte Apps: Abonnieren Sie Aktivitäten in einem Chat-Gruppenbereich und reagieren Sie darauf, z. B. wenn ein neues Mitglied beitritt. Als Reaktion auf ein Ereignis kann die App eine Nachricht senden oder eine andere Aktion ausführen.
Weitere Informationen zum Entwerfen Ihrer Chat-App finden Sie unter Google Chat-App-Architektur auswählen.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-08-04 (UTC).
[null,null,["Zuletzt aktualisiert: 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) |"]]
