In diesem Leitfaden wird erläutert, wie Sie die
get()
Methode für die Message Ressource der Google Chat API verwenden, um Details zu einer
Text- oder Kartenmitteilung zurückzugeben.
In der Chat API wird eine Chat-Nachricht durch die
Message Ressource dargestellt.
Während Chat-Nutzer nur Nachrichten mit Text senden können, können Chat-Apps viele andere Messaging-Funktionen verwenden, darunter das Anzeigen statischer oder interaktiver Benutzeroberflächen, das Erfassen von Informationen von Nutzern und das private Senden von Nachrichten. Weitere Informationen zu den Messaging
Funktionen, die für die Chat API verfügbar sind, finden Sie in der
Übersicht zu Google Chat-Nachrichten.
Vorbereitung
Node.js
- Ein Google Workspace-Konto für Unternehmen oder Enterprise mit Zugriff auf Google Chat.
- Umgebung einrichten:
- Google Cloud-Projekt erstellen.
- OAuth-Zustimmungsbildschirm konfigurieren.
- Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, Symbol und einer Beschreibung für Ihre Chat-App.
- Installieren Sie die Cloud-Clientbibliothek für Node.js.
- Erstellen Sie Zugriffsanmeldedaten basierend darauf, wie Sie sich in Ihrer Google Chat API
Anfrage:
- Wenn Sie sich als Chat-Nutzer authentifizieren möchten,
erstellen Sie Anmeldedaten für die OAuth-Client-ID und speichern Sie sie als JSON-Datei mit dem Namen
credentials.jsonin Ihrem lokalen Verzeichnis. - Wenn Sie sich als Chat-App authentifizieren möchten,
erstellen Sie Anmeldedaten für das Dienstkonto und speichern Sie sie als JSON-Datei mit dem Namen
credentials.json.
- Wenn Sie sich als Chat-Nutzer authentifizieren möchten,
erstellen Sie Anmeldedaten für die OAuth-Client-ID und speichern Sie sie als JSON-Datei mit dem Namen
- Wählen Sie einen Autorisierungsbereich aus, je nachdem, ob Sie sich als Nutzer oder als die Chat-App authentifizieren möchten.
- Ein Google Chat-Bereich, in dem der authentifizierte Nutzer oder die aufrufende Chat-App Mitglied ist. Wenn Sie sich als die Chat-App authentifizieren möchten, fügen Sie die Chat-App dem Bereich hinzu.
Python
- Ein Google Workspace-Konto für Unternehmen oder Enterprise mit Zugriff auf Google Chat.
- Umgebung einrichten:
- Google Cloud-Projekt erstellen.
- OAuth-Zustimmungsbildschirm konfigurieren.
- Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, Symbol und einer Beschreibung für Ihre Chat-App.
- Installieren Sie die Cloud-Clientbibliothek für Python.
- Erstellen Sie Zugriffsanmeldedaten basierend darauf, wie Sie sich in Ihrer Google Chat API
Anfrage:
- Wenn Sie sich als Chat-Nutzer authentifizieren möchten,
erstellen Sie Anmeldedaten für die OAuth-Client-ID und speichern Sie sie als JSON-Datei mit dem Namen
credentials.jsonin Ihrem lokalen Verzeichnis. - Wenn Sie sich als Chat-App authentifizieren möchten,
erstellen Sie Anmeldedaten für das Dienstkonto und speichern Sie sie als JSON-Datei mit dem Namen
credentials.json.
- Wenn Sie sich als Chat-Nutzer authentifizieren möchten,
erstellen Sie Anmeldedaten für die OAuth-Client-ID und speichern Sie sie als JSON-Datei mit dem Namen
- Wählen Sie einen Autorisierungsbereich aus, je nachdem, ob Sie sich als Nutzer oder als die Chat-App authentifizieren möchten.
- Ein Google Chat-Bereich, in dem der authentifizierte Nutzer oder die aufrufende Chat-App Mitglied ist. Wenn Sie sich als die Chat-App authentifizieren möchten, fügen Sie die Chat-App dem Bereich hinzu.
Java
- Ein Google Workspace-Konto für Unternehmen oder Enterprise mit Zugriff auf Google Chat.
- Umgebung einrichten:
- Google Cloud-Projekt erstellen.
- OAuth-Zustimmungsbildschirm konfigurieren.
- Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, Symbol und einer Beschreibung für Ihre Chat-App.
- Installieren Sie die Cloud-Clientbibliothek für Java.
- Erstellen Sie Zugriffsanmeldedaten basierend darauf, wie Sie sich in Ihrer Google Chat API
Anfrage:
- Wenn Sie sich als Chat-Nutzer authentifizieren möchten,
erstellen Sie Anmeldedaten für die OAuth-Client-ID und speichern Sie sie als JSON-Datei mit dem Namen
credentials.jsonin Ihrem lokalen Verzeichnis. - Wenn Sie sich als Chat-App authentifizieren möchten,
erstellen Sie Anmeldedaten für das Dienstkonto und speichern Sie sie als JSON-Datei mit dem Namen
credentials.json.
- Wenn Sie sich als Chat-Nutzer authentifizieren möchten,
erstellen Sie Anmeldedaten für die OAuth-Client-ID und speichern Sie sie als JSON-Datei mit dem Namen
- Wählen Sie einen Autorisierungsbereich aus, je nachdem, ob Sie sich als Nutzer oder als die Chat-App authentifizieren möchten.
- Ein Google Chat-Bereich, in dem der authentifizierte Nutzer oder die aufrufende Chat-App Mitglied ist. Wenn Sie sich als die Chat-App authentifizieren möchten, fügen Sie die Chat-App dem Bereich hinzu.
Apps Script
- Ein Google Workspace-Konto für Unternehmen oder Enterprise mit Zugriff auf Google Chat.
- Umgebung einrichten:
- Google Cloud-Projekt erstellen.
- OAuth-Zustimmungsbildschirm konfigurieren.
- Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, Symbol und einer Beschreibung für Ihre Chat-App.
- Erstellen Sie ein eigenständiges Apps Script-Projekt, und aktivieren Sie den erweiterten Chat-Dienst.
- In diesem Leitfaden müssen Sie entweder die Nutzer oder die App-Authentifizierung verwenden. Wenn Sie sich als Chat-App authentifizieren möchten, erstellen Sie Anmeldedaten für das Dienstkonto. Eine Anleitung finden Sie unter Als Google Chat-App authentifizieren und autorisieren.
- Wählen Sie einen Autorisierungsbereich aus, je nachdem, ob Sie sich als Nutzer oder als die Chat-App authentifizieren möchten.
- Ein Google Chat-Bereich, in dem der authentifizierte Nutzer oder die aufrufende Chat-App Mitglied ist. Wenn Sie sich als die Chat-App authentifizieren möchten, fügen Sie die Chat-App dem Bereich hinzu.
Nachricht mit Nutzerauthentifizierung abrufen
Wenn Sie Details zu einer Nachricht mit Nutzerauthentifizierung, abrufen möchten, übergeben Sie Folgendes in Ihrer Anfrage:
- Geben Sie den
chat.messages.readonlyoderchat.messagesAutorisierungsbereich an. - Rufen Sie die
GetMessage()Methode auf. - Legen Sie
nameauf den Ressourcennamen der abzurufenden Nachricht fest.
Im folgenden Beispiel wird eine Nachricht mit Nutzerauthentifizierung abgerufen:
Node.js
Python
Java
Apps Script
Ersetzen Sie die folgenden Werte, um dieses Beispiel auszuführen:
SPACE_NAME: die ID aus dem Bereichsname. Sie können die ID abrufen, indem Sie dieListSpaces()Methode aufrufen oder die URL des Bereichs verwenden.MESSAGE_NAME: die ID aus demnameder Nachricht. Sie können die ID aus dem Antworttext abrufen, der nach dem asynchronen Erstellen einer Nachricht mit der Chat API zurückgegeben wird, oder mit dem benutzerdefinierten Namen , der der Nachricht beim Erstellen zugewiesen wurde.
Die Chat API gibt eine Instanz von
Message
zurück, die Details zur angegebenen Nachricht enthält.
Nachricht mit App-Authentifizierung abrufen
Wenn Sie Details zu einer Nachricht mit App-Authentifizierung, abrufen möchten, übergeben Sie Folgendes in Ihrer Anfrage:
- Geben Sie einen Autorisierungsbereich an. In den Beispielen in diesem Abschnitt wird der Bereich
chat.botverwendet, der allgemein verfügbar ist und keine Administratorgenehmigung erfordert. Alternativ können Sie sich mit Administratorgenehmigung als Chat-App autorisieren. - Rufen Sie die
GetMessage()Methode auf. - Legen Sie
nameauf den Ressourcennamen der abzurufenden Nachricht fest.
Im folgenden Beispiel wird eine Nachricht mit App-Authentifizierung abgerufen:
Node.js
Python
Java
Apps Script
Ersetzen Sie die folgenden Werte, um dieses Beispiel auszuführen:
SPACE_NAME: die ID aus dem Bereichsname. Sie können die ID abrufen, indem Sie dieListSpaces()Methode aufrufen oder die URL des Bereichs verwenden.MESSAGE_NAME: die ID aus demnameder Nachricht. Sie können die ID aus dem Antworttext abrufen, der nach dem asynchronen Erstellen einer Nachricht mit der Chat API zurückgegeben wird, oder mit dem benutzerdefinierten Namen , der der Nachricht beim Erstellen zugewiesen wurde.
Die Chat API gibt eine Instanz von
Message
zurück, die Details zur angegebenen Nachricht enthält.
Nachricht als Chat-App mit Administratorgenehmigung abrufen
Für die App-Authentifizierung mit einem chat.app.*-Autorisierungsbereich ist eine einmalige
Administratorgenehmigung erforderlich.
Wenn Sie Details zu einer Nachricht mit App-Authentifizierung über die Chat REST API, abrufen möchten, übergeben Sie Folgendes in Ihrer Anfrage:
- Rufen Sie die
GetMessage()Methode auf. - Geben Sie den Autorisierungsbereich
chat.app.messages.readonlyan. - Legen Sie
nameauf den Ressourcennamen der abzurufenden Nachricht fest.
Skript schreiben, das die Chat API aufruft
So rufen Sie Details zu einer Nachricht mit App-Authentifizierung und Administratorgenehmigung sowie der Chat REST API ab:
Python
- Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
chat_messages_get_admin_app.py. Fügen Sie den folgenden Code in
chat_messages_get_admin_app.pyein:from google.oauth2 import service_account from apiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.app.messages.readonly"] def main(): ''' Authenticates with Chat API using app authentication, then gets details about a message. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.spaces().messages().get( # The message to get details about. # # Replace SPACE_NAME with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE_NAME/messages/MESSAGE_NAME', ).execute() # Print Chat API's response in your command line interface. print(result) if __name__ == '__main__': main()Ersetzen Sie im Code Folgendes:
SPACE_NAME: die ID aus dem Bereichsname. Sie können die ID abrufen, indem Sie dieListSpaces()Methode aufrufen oder die URL des Bereichs verwenden.MESSAGE_NAME: die ID aus demnameder Nachricht. Sie können die ID aus dem Antworttext abrufen, der nach dem asynchronen Erstellen einer Nachricht mit der Chat API zurückgegeben wird, oder mit dem benutzerdefinierten Namen , der der Nachricht beim Erstellen zugewiesen wurde.
Erstellen Sie das Beispiel in Ihrem Arbeitsverzeichnis und führen Sie es aus:
python3 chat_messages_get_admin_app.py
Die Chat API gibt eine Instanz von
Message
zurück, die Details zur angegebenen Nachricht enthält.
Weitere Informationen
- Nachricht formatieren.
- Nachricht löschen.
- Nachrichten in einem Bereich auflisten.
- Nachricht aktualisieren.
- Nachricht senden.
- Nachrichten suchen.